org.mustangproject

Class TradeParty

java.lang.Object

org.mustangproject.TradeParty

All Implemented Interfaces:

IZUGFeRDExportableTradeParty

public class TradeParty
extends java.lang.Object
implements IZUGFeRDExportableTradeParty

A organisation, i.e. usually a company

Field Summary

Fields

Modifier and Type	Field and Description
protected java.lang.String	additionalAddress
protected java.lang.String	additionalAddressExtension
protected java.util.List<BankDetails>	bankDetails
protected Contact	contact
protected java.lang.String	country
protected java.util.List<IZUGFeRDTradeSettlementDebit>	debitDetails
protected SchemedID	globalId
protected java.lang.String	ID
protected LegalOrganisation	legalOrg
protected java.lang.String	location
protected java.lang.String	name
protected java.lang.String	street
protected java.lang.String	taxID
protected java.lang.String	vatID
protected java.lang.String	zip

Constructor Summary

Constructors

Constructor and Description
TradeParty() Default constructor.
TradeParty(org.w3c.dom.NodeList nodes) XML parsing constructor
TradeParty(java.lang.String name, java.lang.String street, java.lang.String zip, java.lang.String location, java.lang.String country)

Method Summary

Modifier and Type	Method and Description
TradeParty	addBankDetails(BankDetails s) required (for senders, if payment is not debit): the BIC and IBAN
TradeParty	addDebitDetails(IZUGFeRDTradeSettlementDebit debitDetail) (optional)
TradeParty	addGlobalID(SchemedID schemedID)
TradeParty	addTaxID(java.lang.String taxID) a general tax ID
TradeParty	addVATID(java.lang.String vatID) the USt-ID
java.lang.String	getAdditionalAddress() returns additional address information which is display in xml tag "LineTwo" e.g.
java.lang.String	getAdditionalAddressExtension() Returns even advanced additional address information, e.g. which floor (if LineTwo=setAdditionalAddress has already been used e.g. for which building)
IZUGFeRDTradeSettlement[]	getAsTradeSettlement()
java.util.List<BankDetails>	getBankDetails()
IZUGFeRDExportableContact	getContact()
java.lang.String	getCountry() two-letter country code of the contact
java.lang.String	getGlobalID() customer global identification assigned by the seller
java.lang.String	getGlobalIDScheme() customer global identification scheme
java.lang.String	getID() customer identification assigned by the seller
IZUGFeRDLegalOrganisation	getLegalOrganisation() gets the official representation
java.lang.String	getLocation() Returns the city of the contact
java.lang.String	getName() First and last name of the recipient
java.lang.String	getStreet() Returns the street address (street+number) of the contact
java.lang.String	getTaxID() obligatory for sender but not for recipient
java.lang.String	getVatID()
java.lang.String	getVATID() VAT ID (Umsatzsteueridentifikationsnummer) of the contact
java.lang.String	getZIP() Postal code of the recipient
TradeParty	setAdditionalAddress(java.lang.String additionalAddress) additional info of the address, e.g. which building or which floor.
TradeParty	setAdditionalAddress(java.lang.String additionalAddress1, java.lang.String additionalAddress2) Sets two parts of additional address at once, e.g. which building and which floor (if building is not in question which floor can also be set with the first part only :-))
TradeParty	setAdditionalAddressExtension(java.lang.String additionalAddress2) Sets even advanced additional address information, e.g. which floor (if LineTwo has already been used e.g. for which building) This could sometimes be BT-165?
TradeParty	setContact(Contact c) (optional) a named contact person
TradeParty	setCountry(java.lang.String country) two-letter ISO code of the country
TradeParty	setID(java.lang.String ID) if it's a customer, this can e.g. be the customer ID
TradeParty	setLegalOrganisation(LegalOrganisation legalOrganisation)
TradeParty	setLocation(java.lang.String location) usually set in constructor, usually required in germany, the city of the organisation
TradeParty	setName(java.lang.String name) required, usually done in the constructor: the complete name of the organisation
TradeParty	setStreet(java.lang.String street) usually set in constructor, required in germany, street and house number
TradeParty	setTaxID(java.lang.String tax)
TradeParty	setVATID(java.lang.String VATid)
TradeParty	setZIP(java.lang.String zip) usually set in the constructor, required for recipients in german invoices: postcode

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

name

protected java.lang.String name

zip

protected java.lang.String zip

street

protected java.lang.String street

location

protected java.lang.String location

country

protected java.lang.String country

taxID

protected java.lang.String taxID

vatID

protected java.lang.String vatID

ID

protected java.lang.String ID

additionalAddress

protected java.lang.String additionalAddress

additionalAddressExtension

protected java.lang.String additionalAddressExtension

bankDetails

protected java.util.List<BankDetails> bankDetails

debitDetails

protected java.util.List<IZUGFeRDTradeSettlementDebit> debitDetails

contact

protected Contact contact

legalOrg

protected LegalOrganisation legalOrg

globalId

protected SchemedID globalId

Constructor Detail

TradeParty

public TradeParty()

Default constructor. Probably a bad idea but might be needed by jackson or similar

TradeParty

public TradeParty(java.lang.String name,
                  java.lang.String street,
                  java.lang.String zip,
                  java.lang.String location,
                  java.lang.String country)

Parameters:

name - of the company

street - street and number (use setAdditionalAddress for more parts)

zip - postcode of the company

location - city of the company

country - two letter ISO code

TradeParty

public TradeParty(org.w3c.dom.NodeList nodes)

XML parsing constructor

Parameters:

nodes - the nodelist returned e.g. from xpath

Method Detail

getID

public java.lang.String getID()

Description copied from interface: IZUGFeRDExportableTradeParty

customer identification assigned by the seller

Specified by:

getID in interface IZUGFeRDExportableTradeParty

Returns:

customer identification

getGlobalID

public java.lang.String getGlobalID()

Description copied from interface: IZUGFeRDExportableTradeParty

customer global identification assigned by the seller

Specified by:

getGlobalID in interface IZUGFeRDExportableTradeParty

Returns:

customer identification

getGlobalIDScheme

public java.lang.String getGlobalIDScheme()

Description copied from interface: IZUGFeRDExportableTradeParty

customer global identification scheme

Specified by:

getGlobalIDScheme in interface IZUGFeRDExportableTradeParty

Returns:

customer identification

setID

public TradeParty setID(java.lang.String ID)

if it's a customer, this can e.g. be the customer ID

Parameters:

ID - customer/seller number

Returns:

fluent setter

setContact

public TradeParty setContact(Contact c)

(optional) a named contact person

Parameters:

c - the named contact person

Returns:

fluent setter

See Also:

Contact

addGlobalID

public TradeParty addGlobalID(SchemedID schemedID)

addBankDetails

public TradeParty addBankDetails(BankDetails s)

required (for senders, if payment is not debit): the BIC and IBAN

Parameters:

s - bank credentials

Returns:

fluent setter

addDebitDetails

public TradeParty addDebitDetails(IZUGFeRDTradeSettlementDebit debitDetail)

(optional)

Parameters:

debitDetail - e.g. containing IBAN and mandate

Returns:

fluent setter

getLegalOrganisation

public IZUGFeRDLegalOrganisation getLegalOrganisation()

Description copied from interface: IZUGFeRDExportableTradeParty

gets the official representation

Specified by:

getLegalOrganisation in interface IZUGFeRDExportableTradeParty

Returns:

the interface with the attributes of the legal organisation

setLegalOrganisation

public TradeParty setLegalOrganisation(LegalOrganisation legalOrganisation)

getBankDetails

public java.util.List<BankDetails> getBankDetails()

addTaxID

public TradeParty addTaxID(java.lang.String taxID)

a general tax ID

Parameters:

taxID - tax number of the organisation

Returns:

fluent setter

addVATID

public TradeParty addVATID(java.lang.String vatID)

the USt-ID

Parameters:

vatID - Ust-ID

Returns:

fluent setter

getVATID

public java.lang.String getVATID()

Description copied from interface: IZUGFeRDExportableTradeParty

VAT ID (Umsatzsteueridentifikationsnummer) of the contact

Specified by:

getVATID in interface IZUGFeRDExportableTradeParty

Returns:

VAT ID (Umsatzsteueridentifikationsnummer) of the contact

setVATID

public TradeParty setVATID(java.lang.String VATid)

getTaxID

public java.lang.String getTaxID()

Description copied from interface: IZUGFeRDExportableTradeParty

obligatory for sender but not for recipient

Specified by:

getTaxID in interface IZUGFeRDExportableTradeParty

Returns:

the tax id as string

setTaxID

public TradeParty setTaxID(java.lang.String tax)

getName

public java.lang.String getName()

Description copied from interface: IZUGFeRDExportableTradeParty

First and last name of the recipient

Specified by:

getName in interface IZUGFeRDExportableTradeParty

Returns:

First and last name of the recipient

setName

public TradeParty setName(java.lang.String name)

required, usually done in the constructor: the complete name of the organisation

Parameters:

name - complete legal name

Returns:

fluent setter

getZIP

public java.lang.String getZIP()

Description copied from interface: IZUGFeRDExportableTradeParty

Postal code of the recipient

Specified by:

getZIP in interface IZUGFeRDExportableTradeParty

Returns:

Postal code of the recipient

setZIP

public TradeParty setZIP(java.lang.String zip)

usually set in the constructor, required for recipients in german invoices: postcode

Parameters:

zip - postcode

Returns:

fluent setter

getStreet

public java.lang.String getStreet()

Description copied from interface: IZUGFeRDExportableTradeParty

Returns the street address (street+number) of the contact

Specified by:

getStreet in interface IZUGFeRDExportableTradeParty

Returns:

street address (street+number) of the contact

setStreet

public TradeParty setStreet(java.lang.String street)

usually set in constructor, required in germany, street and house number

Parameters:

street - street name and number

Returns:

fluent setter

getLocation

public java.lang.String getLocation()

Description copied from interface: IZUGFeRDExportableTradeParty

Returns the city of the contact

Specified by:

getLocation in interface IZUGFeRDExportableTradeParty

Returns:

Returns the city of the recipient

setLocation

public TradeParty setLocation(java.lang.String location)

usually set in constructor, usually required in germany, the city of the organisation

Parameters:

location - city

Returns:

fluent setter

getCountry

public java.lang.String getCountry()

Description copied from interface: IZUGFeRDExportableTradeParty

two-letter country code of the contact

Specified by:

getCountry in interface IZUGFeRDExportableTradeParty

Returns:

two-letter iso country code of the contact

setCountry

public TradeParty setCountry(java.lang.String country)

two-letter ISO code of the country

Parameters:

country - two-letter-code

Returns:

fluent setter

getVatID

public java.lang.String getVatID()

getContact

public IZUGFeRDExportableContact getContact()

Specified by:

getContact in interface IZUGFeRDExportableTradeParty

getAsTradeSettlement

public IZUGFeRDTradeSettlement[] getAsTradeSettlement()

getAdditionalAddress

public java.lang.String getAdditionalAddress()

Description copied from interface: IZUGFeRDExportableTradeParty

returns additional address information which is display in xml tag "LineTwo" e.g. "Rear building"

Specified by:

getAdditionalAddress in interface IZUGFeRDExportableTradeParty

Returns:

additional address information

setAdditionalAddress

public TradeParty setAdditionalAddress(java.lang.String additionalAddress)

additional info of the address, e.g. which building or which floor. Street address will become "lineOne", this will become "lineTwo". (see setAdditionalAddressExtension for "lineThree")

Parameters:

additionalAddress - additional address description

Returns:

fluent setter

setAdditionalAddress

public TradeParty setAdditionalAddress(java.lang.String additionalAddress1,
                                       java.lang.String additionalAddress2)

Sets two parts of additional address at once, e.g. which building and which floor (if building is not in question which floor can also be set with the first part only :-))

Parameters:

additionalAddress1 - first part of additional info, e.g. "Rear building"

additionalAddress2 - second part of additional address info, e.g. "2nd floor"

Returns:

fluent setter

setAdditionalAddressExtension

public TradeParty setAdditionalAddressExtension(java.lang.String additionalAddress2)

Sets even advanced additional address information, e.g. which floor (if LineTwo has already been used e.g. for which building) This could sometimes be BT-165?

Parameters:

additionalAddress2 -

Returns:

fluent setter

getAdditionalAddressExtension

public java.lang.String getAdditionalAddressExtension()

Returns even advanced additional address information, e.g. which floor (if LineTwo=setAdditionalAddress has already been used e.g. for which building)

Specified by:

getAdditionalAddressExtension in interface IZUGFeRDExportableTradeParty

Returns:

lineThree