oasis.names.specification.ubl.schema.xsd.commonaggregatecomponents_21

Class ContactType

java.lang.Object

oasis.names.specification.ubl.schema.xsd.commonaggregatecomponents_21.ContactType

All Implemented Interfaces:

com.helger.commons.lang.IExplicitlyCloneable, Serializable, Cloneable

@CodingStyleguideUnaware
public class ContactType
extends Object
implements Serializable, com.helger.commons.lang.IExplicitlyCloneable

 <?xml version="1.0" encoding="UTF-8"?><ccts:Component xmlns:ccts="urn:un:unece:uncefact:documentation:2" xmlns="urn:oasis:names:specification:ubl:schema:xsd:CommonAggregateComponents-2" xmlns:cac="urn:oasis:names:specification:ubl:schema:xsd:CommonAggregateComponents-2" xmlns:cbc="urn:oasis:names:specification:ubl:schema:xsd:CommonBasicComponents-2" xmlns:xsd="http://www.w3.org/2001/XMLSchema"><ccts:ComponentType>ABIE</ccts:ComponentType><ccts:DictionaryEntryName>Contact. Details</ccts:DictionaryEntryName><ccts:Definition>A class to describe a contactable person or department in an organization.</ccts:Definition><ccts:ObjectClass>Contact</ccts:ObjectClass></ccts:Component>
 

Java class for ContactType complex type.

The following schema fragment specifies the expected content contained within this class.

 <complexType name="ContactType">
   <complexContent>
     <restriction base="{http://www.w3.org/2001/XMLSchema}anyType">
       <sequence>
         <element ref="{urn:oasis:names:specification:ubl:schema:xsd:CommonBasicComponents-2}ID" minOccurs="0"/>
         <element ref="{urn:oasis:names:specification:ubl:schema:xsd:CommonBasicComponents-2}Name" minOccurs="0"/>
         <element ref="{urn:oasis:names:specification:ubl:schema:xsd:CommonBasicComponents-2}Telephone" minOccurs="0"/>
         <element ref="{urn:oasis:names:specification:ubl:schema:xsd:CommonBasicComponents-2}Telefax" minOccurs="0"/>
         <element ref="{urn:oasis:names:specification:ubl:schema:xsd:CommonBasicComponents-2}ElectronicMail" minOccurs="0"/>
         <element ref="{urn:oasis:names:specification:ubl:schema:xsd:CommonBasicComponents-2}Note" maxOccurs="unbounded" minOccurs="0"/>
         <element ref="{urn:oasis:names:specification:ubl:schema:xsd:CommonAggregateComponents-2}OtherCommunication" maxOccurs="unbounded" minOccurs="0"/>
       </sequence>
     </restriction>
   </complexContent>
 </complexType>
 

This class was annotated by ph-jaxb22-plugin -Xph-annotate

This class contains methods created by ph-jaxb22-plugin -Xph-equalshashcode

This class contains methods created by ph-jaxb22-plugin -Xph-tostring

This class contains methods created by ph-jaxb22-plugin -Xph-list-extension

This class contains methods created by ph-jaxb22-plugin -Xph-cloneable2

This class contains methods created by ph-jaxb22-plugin -Xph-value-extender

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
ContactType() Default constructor Note: automatically created by ph-jaxb22-plugin -Xph-value-extender

Method Summary

Modifier and Type	Method and Description
void	addNote(NoteType elem) Created by ph-jaxb22-plugin -Xph-list-extension
void	addOtherCommunication(CommunicationType elem) Created by ph-jaxb22-plugin -Xph-list-extension
ContactType	clone() Created by ph-jaxb22-plugin -Xph-cloneable2
void	cloneTo(ContactType ret) This method clones all values from this to the passed object.
boolean	equals(Object o) Created by ph-jaxb22-plugin -Xph-equalshashcode
ElectronicMailType	getElectronicMail() <?
String	getElectronicMailValue() Get the value of the contained ElectronicMailType object Note: automatically created by ph-jaxb22-plugin -Xph-value-extender
IDType	getID() <?
String	getIDValue() Get the value of the contained IDType object Note: automatically created by ph-jaxb22-plugin -Xph-value-extender
NameType	getName() <?
String	getNameValue() Get the value of the contained NameType object Note: automatically created by ph-jaxb22-plugin -Xph-value-extender
List<NoteType>	getNote() <?
NoteType	getNoteAtIndex(int index) Created by ph-jaxb22-plugin -Xph-list-extension
int	getNoteCount() Created by ph-jaxb22-plugin -Xph-list-extension
List<CommunicationType>	getOtherCommunication() <?
CommunicationType	getOtherCommunicationAtIndex(int index) Created by ph-jaxb22-plugin -Xph-list-extension
int	getOtherCommunicationCount() Created by ph-jaxb22-plugin -Xph-list-extension
TelefaxType	getTelefax() <?
String	getTelefaxValue() Get the value of the contained TelefaxType object Note: automatically created by ph-jaxb22-plugin -Xph-value-extender
TelephoneType	getTelephone() <?
String	getTelephoneValue() Get the value of the contained TelephoneType object Note: automatically created by ph-jaxb22-plugin -Xph-value-extender
int	hashCode() Created by ph-jaxb22-plugin -Xph-equalshashcode
boolean	hasNoNoteEntries() Created by ph-jaxb22-plugin -Xph-list-extension
boolean	hasNoOtherCommunicationEntries() Created by ph-jaxb22-plugin -Xph-list-extension
boolean	hasNoteEntries() Created by ph-jaxb22-plugin -Xph-list-extension
boolean	hasOtherCommunicationEntries() Created by ph-jaxb22-plugin -Xph-list-extension
void	setElectronicMail(ElectronicMailType value) Sets the value of the electronicMail property.
ElectronicMailType	setElectronicMail(String valueParam) Special setter with value of type String Note: automatically created by ph-jaxb22-plugin -Xph-value-extender
void	setID(IDType value) Sets the value of the id property.
IDType	setID(String valueParam) Special setter with value of type String Note: automatically created by ph-jaxb22-plugin -Xph-value-extender
void	setName(NameType value) Sets the value of the name property.
NameType	setName(String valueParam) Special setter with value of type String Note: automatically created by ph-jaxb22-plugin -Xph-value-extender
void	setNote(List<NoteType> aList) Created by ph-jaxb22-plugin -Xph-list-extension
void	setOtherCommunication(List<CommunicationType> aList) Created by ph-jaxb22-plugin -Xph-list-extension
TelefaxType	setTelefax(String valueParam) Special setter with value of type String Note: automatically created by ph-jaxb22-plugin -Xph-value-extender
void	setTelefax(TelefaxType value) Sets the value of the telefax property.
TelephoneType	setTelephone(String valueParam) Special setter with value of type String Note: automatically created by ph-jaxb22-plugin -Xph-value-extender
void	setTelephone(TelephoneType value) Sets the value of the telephone property.
String	toString() Created by ph-jaxb22-plugin -Xph-tostring

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

ContactType

public ContactType()

Default constructor
Note: automatically created by ph-jaxb22-plugin -Xph-value-extender

Method Detail

getID

@Nullable
public IDType getID()

 <?xml version="1.0" encoding="UTF-8"?><ccts:Component xmlns:ccts="urn:un:unece:uncefact:documentation:2" xmlns="urn:oasis:names:specification:ubl:schema:xsd:CommonAggregateComponents-2" xmlns:cac="urn:oasis:names:specification:ubl:schema:xsd:CommonAggregateComponents-2" xmlns:cbc="urn:oasis:names:specification:ubl:schema:xsd:CommonBasicComponents-2" xmlns:xsd="http://www.w3.org/2001/XMLSchema"><ccts:ComponentType>BBIE</ccts:ComponentType><ccts:DictionaryEntryName>Contact. Identifier</ccts:DictionaryEntryName><ccts:Definition>An identifier for this contact.</ccts:Definition><ccts:Cardinality>0..1</ccts:Cardinality><ccts:ObjectClass>Contact</ccts:ObjectClass><ccts:PropertyTerm>Identifier</ccts:PropertyTerm><ccts:RepresentationTerm>Identifier</ccts:RepresentationTerm><ccts:DataType>Identifier. Type</ccts:DataType><ccts:Examples>Receivals Clerk </ccts:Examples></ccts:Component>
 

Returns:

possible object is IDType

setID

public void setID(@Nullable
                  IDType value)

Sets the value of the id property.

Parameters:

value - allowed object is IDType

getName

@Nullable
public NameType getName()

 <?xml version="1.0" encoding="UTF-8"?><ccts:Component xmlns:ccts="urn:un:unece:uncefact:documentation:2" xmlns="urn:oasis:names:specification:ubl:schema:xsd:CommonAggregateComponents-2" xmlns:cac="urn:oasis:names:specification:ubl:schema:xsd:CommonAggregateComponents-2" xmlns:cbc="urn:oasis:names:specification:ubl:schema:xsd:CommonBasicComponents-2" xmlns:xsd="http://www.w3.org/2001/XMLSchema"><ccts:ComponentType>BBIE</ccts:ComponentType><ccts:DictionaryEntryName>Contact. Name</ccts:DictionaryEntryName><ccts:Definition>The name of this contact. It is recommended that this be used for a functional name and not a personal name.</ccts:Definition><ccts:Cardinality>0..1</ccts:Cardinality><ccts:ObjectClass>Contact</ccts:ObjectClass><ccts:PropertyTerm>Name</ccts:PropertyTerm><ccts:RepresentationTerm>Name</ccts:RepresentationTerm><ccts:DataType>Name. Type</ccts:DataType><ccts:Examples>Delivery Dock </ccts:Examples></ccts:Component>
 

Returns:

possible object is NameType

setName

public void setName(@Nullable
                    NameType value)

Sets the value of the name property.

Parameters:

value - allowed object is NameType

getTelephone

@Nullable
public TelephoneType getTelephone()

 <?xml version="1.0" encoding="UTF-8"?><ccts:Component xmlns:ccts="urn:un:unece:uncefact:documentation:2" xmlns="urn:oasis:names:specification:ubl:schema:xsd:CommonAggregateComponents-2" xmlns:cac="urn:oasis:names:specification:ubl:schema:xsd:CommonAggregateComponents-2" xmlns:cbc="urn:oasis:names:specification:ubl:schema:xsd:CommonBasicComponents-2" xmlns:xsd="http://www.w3.org/2001/XMLSchema"><ccts:ComponentType>BBIE</ccts:ComponentType><ccts:DictionaryEntryName>Contact. Telephone. Text</ccts:DictionaryEntryName><ccts:Definition>The primary telephone number of this contact.</ccts:Definition><ccts:Cardinality>0..1</ccts:Cardinality><ccts:ObjectClass>Contact</ccts:ObjectClass><ccts:PropertyTerm>Telephone</ccts:PropertyTerm><ccts:RepresentationTerm>Text</ccts:RepresentationTerm><ccts:DataType>Text. Type</ccts:DataType></ccts:Component>
 

Returns:

possible object is TelephoneType

setTelephone

public void setTelephone(@Nullable
                         TelephoneType value)

Sets the value of the telephone property.

Parameters:

value - allowed object is TelephoneType

getTelefax

@Nullable
public TelefaxType getTelefax()

 <?xml version="1.0" encoding="UTF-8"?><ccts:Component xmlns:ccts="urn:un:unece:uncefact:documentation:2" xmlns="urn:oasis:names:specification:ubl:schema:xsd:CommonAggregateComponents-2" xmlns:cac="urn:oasis:names:specification:ubl:schema:xsd:CommonAggregateComponents-2" xmlns:cbc="urn:oasis:names:specification:ubl:schema:xsd:CommonBasicComponents-2" xmlns:xsd="http://www.w3.org/2001/XMLSchema"><ccts:ComponentType>BBIE</ccts:ComponentType><ccts:DictionaryEntryName>Contact. Telefax. Text</ccts:DictionaryEntryName><ccts:Definition>The primary fax number of this contact.</ccts:Definition><ccts:Cardinality>0..1</ccts:Cardinality><ccts:ObjectClass>Contact</ccts:ObjectClass><ccts:PropertyTerm>Telefax</ccts:PropertyTerm><ccts:RepresentationTerm>Text</ccts:RepresentationTerm><ccts:DataType>Text. Type</ccts:DataType></ccts:Component>
 

Returns:

possible object is TelefaxType

setTelefax

public void setTelefax(@Nullable
                       TelefaxType value)

Sets the value of the telefax property.

Parameters:

value - allowed object is TelefaxType

getElectronicMail

@Nullable
public ElectronicMailType getElectronicMail()

 <?xml version="1.0" encoding="UTF-8"?><ccts:Component xmlns:ccts="urn:un:unece:uncefact:documentation:2" xmlns="urn:oasis:names:specification:ubl:schema:xsd:CommonAggregateComponents-2" xmlns:cac="urn:oasis:names:specification:ubl:schema:xsd:CommonAggregateComponents-2" xmlns:cbc="urn:oasis:names:specification:ubl:schema:xsd:CommonBasicComponents-2" xmlns:xsd="http://www.w3.org/2001/XMLSchema"><ccts:ComponentType>BBIE</ccts:ComponentType><ccts:DictionaryEntryName>Contact. Electronic_ Mail. Text</ccts:DictionaryEntryName><ccts:Definition>The primary email address of this contact.</ccts:Definition><ccts:Cardinality>0..1</ccts:Cardinality><ccts:ObjectClass>Contact</ccts:ObjectClass><ccts:PropertyTermQualifier>Electronic</ccts:PropertyTermQualifier><ccts:PropertyTerm>Mail</ccts:PropertyTerm><ccts:RepresentationTerm>Text</ccts:RepresentationTerm><ccts:DataType>Text. Type</ccts:DataType></ccts:Component>
 

Returns:

possible object is ElectronicMailType

setElectronicMail

public void setElectronicMail(@Nullable
                              ElectronicMailType value)

Sets the value of the electronicMail property.

Parameters:

value - allowed object is ElectronicMailType

getNote

@Nonnull
 @ReturnsMutableObject(value="JAXB implementation style")
public List<NoteType> getNote()

 <?xml version="1.0" encoding="UTF-8"?><ccts:Component xmlns:ccts="urn:un:unece:uncefact:documentation:2" xmlns="urn:oasis:names:specification:ubl:schema:xsd:CommonAggregateComponents-2" xmlns:cac="urn:oasis:names:specification:ubl:schema:xsd:CommonAggregateComponents-2" xmlns:cbc="urn:oasis:names:specification:ubl:schema:xsd:CommonBasicComponents-2" xmlns:xsd="http://www.w3.org/2001/XMLSchema"><ccts:ComponentType>BBIE</ccts:ComponentType><ccts:DictionaryEntryName>Contact. Note. Text</ccts:DictionaryEntryName><ccts:Definition>Free-form text conveying information that is not contained explicitly in other structures; in particular, a textual description of the circumstances under which this contact can be used (e.g., "emergency" or "after hours").</ccts:Definition><ccts:Cardinality>0..n</ccts:Cardinality><ccts:ObjectClass>Contact</ccts:ObjectClass><ccts:PropertyTerm>Note</ccts:PropertyTerm><ccts:RepresentationTerm>Text</ccts:RepresentationTerm><ccts:DataType>Text. Type</ccts:DataType></ccts:Component>
 

Gets the value of the note property.

This accessor method returns a reference to the live list, not a snapshot. Therefore any modification you make to the returned list will be present inside the JAXB object. This is why there is not a set method for the note property.

For example, to add a new item, do as follows:

    getNote().add(newItem);
 

Objects of the following type(s) are allowed in the list NoteType

getOtherCommunication

@Nonnull
 @ReturnsMutableObject(value="JAXB implementation style")
public List<CommunicationType> getOtherCommunication()

 <?xml version="1.0" encoding="UTF-8"?><ccts:Component xmlns:ccts="urn:un:unece:uncefact:documentation:2" xmlns="urn:oasis:names:specification:ubl:schema:xsd:CommonAggregateComponents-2" xmlns:cac="urn:oasis:names:specification:ubl:schema:xsd:CommonAggregateComponents-2" xmlns:cbc="urn:oasis:names:specification:ubl:schema:xsd:CommonBasicComponents-2" xmlns:xsd="http://www.w3.org/2001/XMLSchema"><ccts:ComponentType>ASBIE</ccts:ComponentType><ccts:DictionaryEntryName>Contact. Other_ Communication. Communication</ccts:DictionaryEntryName><ccts:Definition>Another means of communication with this contact.</ccts:Definition><ccts:Cardinality>0..n</ccts:Cardinality><ccts:ObjectClass>Contact</ccts:ObjectClass><ccts:PropertyTermQualifier>Other</ccts:PropertyTermQualifier><ccts:PropertyTerm>Communication</ccts:PropertyTerm><ccts:AssociatedObjectClass>Communication</ccts:AssociatedObjectClass><ccts:RepresentationTerm>Communication</ccts:RepresentationTerm></ccts:Component>
 

Gets the value of the otherCommunication property.

This accessor method returns a reference to the live list, not a snapshot. Therefore any modification you make to the returned list will be present inside the JAXB object. This is why there is not a set method for the otherCommunication property.

For example, to add a new item, do as follows:

    getOtherCommunication().add(newItem);
 

Objects of the following type(s) are allowed in the list CommunicationType

equals

public boolean equals(Object o)

Created by ph-jaxb22-plugin -Xph-equalshashcode

Overrides:

equals in class Object

hashCode

public int hashCode()

Created by ph-jaxb22-plugin -Xph-equalshashcode

Overrides:

hashCode in class Object

toString

public String toString()

Created by ph-jaxb22-plugin -Xph-tostring

Overrides:

toString in class Object

setNote

public void setNote(@Nullable
                    List<NoteType> aList)

Created by ph-jaxb22-plugin -Xph-list-extension

Parameters:

aList - The new list member to set. May be null.

setOtherCommunication

public void setOtherCommunication(@Nullable
                                  List<CommunicationType> aList)

Created by ph-jaxb22-plugin -Xph-list-extension

Parameters:

aList - The new list member to set. May be null.

hasNoteEntries

public boolean hasNoteEntries()

Created by ph-jaxb22-plugin -Xph-list-extension

Returns:

true if at least one item is contained, false otherwise.

hasNoNoteEntries

public boolean hasNoNoteEntries()

Created by ph-jaxb22-plugin -Xph-list-extension

Returns:

true if no item is contained, false otherwise.

getNoteCount

@Nonnegative
public int getNoteCount()

Created by ph-jaxb22-plugin -Xph-list-extension

Returns:

The number of contained elements. Always ≥ 0.

getNoteAtIndex

@Nullable
public NoteType getNoteAtIndex(@Nonnegative
                                          int index)
                                   throws IndexOutOfBoundsException

Created by ph-jaxb22-plugin -Xph-list-extension

Parameters:

index - The index to retrieve

Returns:

The element at the specified index. May be null

Throws:

IndexOutOfBoundsException - if the index is invalid!

addNote

public void addNote(@Nonnull
                    NoteType elem)

Created by ph-jaxb22-plugin -Xph-list-extension

Parameters:

elem - The element to be added. May not be null.

hasOtherCommunicationEntries

public boolean hasOtherCommunicationEntries()

Created by ph-jaxb22-plugin -Xph-list-extension

Returns:

true if at least one item is contained, false otherwise.

hasNoOtherCommunicationEntries

public boolean hasNoOtherCommunicationEntries()

Created by ph-jaxb22-plugin -Xph-list-extension

Returns:

true if no item is contained, false otherwise.

getOtherCommunicationCount

@Nonnegative
public int getOtherCommunicationCount()

Created by ph-jaxb22-plugin -Xph-list-extension

Returns:

The number of contained elements. Always ≥ 0.

getOtherCommunicationAtIndex

@Nullable
public CommunicationType getOtherCommunicationAtIndex(@Nonnegative
                                                                 int index)
                                                          throws IndexOutOfBoundsException

Created by ph-jaxb22-plugin -Xph-list-extension

Parameters:

index - The index to retrieve

Returns:

The element at the specified index. May be null

Throws:

IndexOutOfBoundsException - if the index is invalid!

addOtherCommunication

public void addOtherCommunication(@Nonnull
                                  CommunicationType elem)

Created by ph-jaxb22-plugin -Xph-list-extension

Parameters:

elem - The element to be added. May not be null.

cloneTo

public void cloneTo(@Nonnull
                    ContactType ret)

This method clones all values from this to the passed object. All data in the parameter object is overwritten!Created by ph-jaxb22-plugin -Xph-cloneable2

Parameters:

ret - The target object to clone to. May not be null.

clone

@Nonnull
 @ReturnsMutableCopy
public ContactType clone()

Created by ph-jaxb22-plugin -Xph-cloneable2

Specified by:

clone in interface com.helger.commons.lang.IExplicitlyCloneable

Overrides:

clone in class Object

Returns:

The cloned object. Never null.

setID

@Nonnull
public IDType setID(@Nullable
                              String valueParam)

Special setter with value of type String
Note: automatically created by ph-jaxb22-plugin -Xph-value-extender

Parameters:

valueParam - The value to be set. May be null.

Returns:

The created intermediary object of type IDType and never null

setTelephone

@Nonnull
public TelephoneType setTelephone(@Nullable
                                            String valueParam)

Special setter with value of type String
Note: automatically created by ph-jaxb22-plugin -Xph-value-extender

Parameters:

valueParam - The value to be set. May be null.

Returns:

The created intermediary object of type TelephoneType and never null

setTelefax

@Nonnull
public TelefaxType setTelefax(@Nullable
                                        String valueParam)

Special setter with value of type String
Note: automatically created by ph-jaxb22-plugin -Xph-value-extender

Parameters:

valueParam - The value to be set. May be null.

Returns:

The created intermediary object of type TelefaxType and never null

setElectronicMail

@Nonnull
public ElectronicMailType setElectronicMail(@Nullable
                                                      String valueParam)

Special setter with value of type String
Note: automatically created by ph-jaxb22-plugin -Xph-value-extender

Parameters:

valueParam - The value to be set. May be null.

Returns:

The created intermediary object of type ElectronicMailType and never null

setName

@Nonnull
public NameType setName(@Nullable
                                  String valueParam)

Special setter with value of type String
Note: automatically created by ph-jaxb22-plugin -Xph-value-extender

Parameters:

valueParam - The value to be set. May be null.

Returns:

The created intermediary object of type NameType and never null

getIDValue

@Nullable
public String getIDValue()

Get the value of the contained IDType object
Note: automatically created by ph-jaxb22-plugin -Xph-value-extender

Returns:

Either the value of the contained IDType object or null

getNameValue

@Nullable
public String getNameValue()

Get the value of the contained NameType object
Note: automatically created by ph-jaxb22-plugin -Xph-value-extender

Returns:

Either the value of the contained NameType object or null

getTelephoneValue

@Nullable
public String getTelephoneValue()

Get the value of the contained TelephoneType object
Note: automatically created by ph-jaxb22-plugin -Xph-value-extender

Returns:

Either the value of the contained TelephoneType object or null

getTelefaxValue

@Nullable
public String getTelefaxValue()

Get the value of the contained TelefaxType object
Note: automatically created by ph-jaxb22-plugin -Xph-value-extender

Returns:

Either the value of the contained TelefaxType object or null

getElectronicMailValue

@Nullable
public String getElectronicMailValue()

Get the value of the contained ElectronicMailType object
Note: automatically created by ph-jaxb22-plugin -Xph-value-extender

Returns:

Either the value of the contained ElectronicMailType object or null