oasis.names.specification.ubl.schema.xsd.commonaggregatecomponents_2

Class EndorsementType

java.lang.Object

oasis.names.specification.ubl.schema.xsd.commonaggregatecomponents_2.EndorsementType

All Implemented Interfaces:

Serializable

public class EndorsementType
extends Object
implements Serializable

 <?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:cbc="urn:oasis:names:specification:ubl:schema:xsd:CommonBasicComponents-2" xmlns:qdt="urn:oasis:names:specification:ubl:schema:xsd:QualifiedDatatypes-2" xmlns:udt="urn:un:unece:uncefact:data:specification:UnqualifiedDataTypesSchemaModule:2" xmlns:xsd="http://www.w3.org/2001/XMLSchema"><ccts:ComponentType>ABIE</ccts:ComponentType><ccts:DictionaryEntryName>Endorsement. Details</ccts:DictionaryEntryName><ccts:Definition>Details of an endorsement on the document.</ccts:Definition><ccts:ObjectClass>Endorsement</ccts:ObjectClass></ccts:Component>
 

Java class for EndorsementType complex type.

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

 <complexType name="EndorsementType">
   <complexContent>
     <restriction base="{http://www.w3.org/2001/XMLSchema}anyType">
       <sequence>
         <element ref="{urn:oasis:names:specification:ubl:schema:xsd:CommonBasicComponents-2}DocumentID"/>
         <element ref="{urn:oasis:names:specification:ubl:schema:xsd:CommonBasicComponents-2}ApprovalStatus"/>
         <element ref="{urn:oasis:names:specification:ubl:schema:xsd:CommonBasicComponents-2}Remarks" maxOccurs="unbounded" minOccurs="0"/>
         <element ref="{urn:oasis:names:specification:ubl:schema:xsd:CommonAggregateComponents-2}EndorserParty"/>
         <element ref="{urn:oasis:names:specification:ubl:schema:xsd:CommonAggregateComponents-2}Signature" maxOccurs="unbounded" minOccurs="0"/>
       </sequence>
     </restriction>
   </complexContent>
 </complexType>
 

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
EndorsementType() Default constructor Created by ph-ubl-jaxb-plugin -Xph-ubl-value

Method Summary

Methods

Modifier and Type	Method and Description
boolean	equals(Object o) Created by ph-jaxb22-plugin -Xph-equalshashcode
ApprovalStatusType	getApprovalStatus() <?
String	getApprovalStatusValue() Get the value of the contained ApprovalStatusType object Created by ph-ubl-jaxb-plugin -Xph-ubl-value
DocumentIDType	getDocumentID() <?
String	getDocumentIDValue() Get the value of the contained DocumentIDType object Created by ph-ubl-jaxb-plugin -Xph-ubl-value
EndorserPartyType	getEndorserParty() <?
List<RemarksType>	getRemarks() <?
RemarksType	getRemarksAtIndex(int index) Created by ph-jaxb22-plugin -Xph-list-extension
int	getRemarksCount() Created by ph-jaxb22-plugin -Xph-list-extension
List<SignatureType>	getSignature() <?
SignatureType	getSignatureAtIndex(int index) Created by ph-jaxb22-plugin -Xph-list-extension
int	getSignatureCount() Created by ph-jaxb22-plugin -Xph-list-extension
int	hashCode() Created by ph-jaxb22-plugin -Xph-equalshashcode
boolean	hasNoRemarksEntries() Created by ph-jaxb22-plugin -Xph-list-extension
boolean	hasNoSignatureEntries() Created by ph-jaxb22-plugin -Xph-list-extension
boolean	hasRemarksEntries() Created by ph-jaxb22-plugin -Xph-list-extension
boolean	hasSignatureEntries() Created by ph-jaxb22-plugin -Xph-list-extension
void	setApprovalStatus(ApprovalStatusType value) Sets the value of the approvalStatus property.
ApprovalStatusType	setApprovalStatus(String valueParam) Special setter with value of type String Created by ph-ubl-jaxb-plugin -Xph-ubl-value
void	setDocumentID(DocumentIDType value) Sets the value of the documentID property.
DocumentIDType	setDocumentID(String valueParam) Special setter with value of type String Created by ph-ubl-jaxb-plugin -Xph-ubl-value
void	setEndorserParty(EndorserPartyType value) Sets the value of the endorserParty property.
void	setRemarks(List<RemarksType> aList) Created by ph-jaxb22-plugin -Xph-list-extension
void	setSignature(List<SignatureType> aList) Created by ph-jaxb22-plugin -Xph-list-extension
String	toString() Created by ph-jaxb22-plugin -Xph-tostring

Methods inherited from class java.lang.Object

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

Constructor Detail

EndorsementType

public EndorsementType()

Default constructor Created by ph-ubl-jaxb-plugin -Xph-ubl-value

Method Detail

getDocumentID

@Nullable
public DocumentIDType getDocumentID()

 <?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:cbc="urn:oasis:names:specification:ubl:schema:xsd:CommonBasicComponents-2" xmlns:qdt="urn:oasis:names:specification:ubl:schema:xsd:QualifiedDatatypes-2" xmlns:udt="urn:un:unece:uncefact:data:specification:UnqualifiedDataTypesSchemaModule:2" xmlns:xsd="http://www.w3.org/2001/XMLSchema"><ccts:ComponentType>BBIE</ccts:ComponentType><ccts:DictionaryEntryName>Endorsement. Document. Identifier</ccts:DictionaryEntryName><ccts:Definition>Identifies the endorsement.</ccts:Definition><ccts:Cardinality>1</ccts:Cardinality><ccts:ObjectClass>Endorsement</ccts:ObjectClass><ccts:PropertyTerm>Document</ccts:PropertyTerm><ccts:RepresentationTerm>Identifier</ccts:RepresentationTerm><ccts:DataType>Identifier. Type</ccts:DataType></ccts:Component>
 

Returns:

possible object is DocumentIDType

setDocumentID

public void setDocumentID(@Nullable
                 DocumentIDType value)

Sets the value of the documentID property.

Parameters:

value - allowed object is DocumentIDType

getApprovalStatus

@Nullable
public ApprovalStatusType getApprovalStatus()

 <?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:cbc="urn:oasis:names:specification:ubl:schema:xsd:CommonBasicComponents-2" xmlns:qdt="urn:oasis:names:specification:ubl:schema:xsd:QualifiedDatatypes-2" xmlns:udt="urn:un:unece:uncefact:data:specification:UnqualifiedDataTypesSchemaModule:2" xmlns:xsd="http://www.w3.org/2001/XMLSchema"><ccts:ComponentType>BBIE</ccts:ComponentType><ccts:DictionaryEntryName>Endorsement. Approval Status. Text</ccts:DictionaryEntryName><ccts:Definition>Specifies the status of the endorsement.</ccts:Definition><ccts:Cardinality>1</ccts:Cardinality><ccts:ObjectClass>Endorsement</ccts:ObjectClass><ccts:PropertyTerm>Approval Status</ccts:PropertyTerm><ccts:RepresentationTerm>Text</ccts:RepresentationTerm><ccts:DataType>Text. Type</ccts:DataType><ccts:AlternativeBusinessTerms>Authentication Code</ccts:AlternativeBusinessTerms></ccts:Component>
 

Returns:

possible object is ApprovalStatusType

setApprovalStatus

public void setApprovalStatus(@Nullable
                     ApprovalStatusType value)

Sets the value of the approvalStatus property.

Parameters:

value - allowed object is ApprovalStatusType

getRemarks

@Nonnull
@ReturnsMutableObject(reason="JAXB implementation style")
public List<RemarksType> getRemarks()

 <?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:cbc="urn:oasis:names:specification:ubl:schema:xsd:CommonBasicComponents-2" xmlns:qdt="urn:oasis:names:specification:ubl:schema:xsd:QualifiedDatatypes-2" xmlns:udt="urn:un:unece:uncefact:data:specification:UnqualifiedDataTypesSchemaModule:2" xmlns:xsd="http://www.w3.org/2001/XMLSchema"><ccts:ComponentType>BBIE</ccts:ComponentType><ccts:DictionaryEntryName>Endorsement. Remarks. Text</ccts:DictionaryEntryName><ccts:Definition>Remarks by the endorsing party.</ccts:Definition><ccts:Cardinality>0..n</ccts:Cardinality><ccts:ObjectClass>Endorsement</ccts:ObjectClass><ccts:PropertyTerm>Remarks</ccts:PropertyTerm><ccts:RepresentationTerm>Text</ccts:RepresentationTerm><ccts:DataType>Text. Type</ccts:DataType></ccts:Component>
 

Gets the value of the remarks 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 remarks property.

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

    getRemarks().add(newItem);
 

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

getEndorserParty

@Nullable
public EndorserPartyType getEndorserParty()

 <?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:cbc="urn:oasis:names:specification:ubl:schema:xsd:CommonBasicComponents-2" xmlns:qdt="urn:oasis:names:specification:ubl:schema:xsd:QualifiedDatatypes-2" xmlns:udt="urn:un:unece:uncefact:data:specification:UnqualifiedDataTypesSchemaModule:2" xmlns:xsd="http://www.w3.org/2001/XMLSchema"><ccts:ComponentType>ASBIE</ccts:ComponentType><ccts:DictionaryEntryName>Endorsement. Endorser Party</ccts:DictionaryEntryName><ccts:Definition>The type of party providing the endorsement.</ccts:Definition><ccts:Cardinality>1</ccts:Cardinality><ccts:ObjectClass>Endorsement</ccts:ObjectClass><ccts:PropertyTerm>Endorser Party</ccts:PropertyTerm><ccts:AssociatedObjectClass>Endorser Party</ccts:AssociatedObjectClass></ccts:Component>
 

Returns:

possible object is EndorserPartyType

setEndorserParty

public void setEndorserParty(@Nullable
                    EndorserPartyType value)

Sets the value of the endorserParty property.

Parameters:

value - allowed object is EndorserPartyType

getSignature

@Nonnull
@ReturnsMutableObject(reason="JAXB implementation style")
public List<SignatureType> getSignature()

 <?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:cbc="urn:oasis:names:specification:ubl:schema:xsd:CommonBasicComponents-2" xmlns:qdt="urn:oasis:names:specification:ubl:schema:xsd:QualifiedDatatypes-2" xmlns:udt="urn:un:unece:uncefact:data:specification:UnqualifiedDataTypesSchemaModule:2" xmlns:xsd="http://www.w3.org/2001/XMLSchema"><ccts:ComponentType>ASBIE</ccts:ComponentType><ccts:DictionaryEntryName>Endorsement. Signature</ccts:DictionaryEntryName><ccts:Definition>One or more signatures applied to the endorsement.</ccts:Definition><ccts:Cardinality>0..n</ccts:Cardinality><ccts:ObjectClass>Endorsement</ccts:ObjectClass><ccts:PropertyTerm>Signature</ccts:PropertyTerm><ccts:AssociatedObjectClass>Signature</ccts:AssociatedObjectClass></ccts:Component>
 

Gets the value of the signature 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 signature property.

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

    getSignature().add(newItem);
 

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

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

setRemarks

public void setRemarks(@Nullable
              List<RemarksType> aList)

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

Parameters:

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

setSignature

public void setSignature(@Nullable
                List<SignatureType> aList)

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

Parameters:

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

hasRemarksEntries

public boolean hasRemarksEntries()

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

Returns:

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

hasNoRemarksEntries

public boolean hasNoRemarksEntries()

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

Returns:

true if no item is contained, false otherwise.

getRemarksCount

@Nonnegative
public int getRemarksCount()

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

Returns:

The number of contained elements. Always ≥ 0.

getRemarksAtIndex

@Nullable
public RemarksType getRemarksAtIndex(@Nonnegative
                                     int index)

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:

ArrayIndexOutOfBoundsException - if the index is invalid!

hasSignatureEntries

public boolean hasSignatureEntries()

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

Returns:

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

hasNoSignatureEntries

public boolean hasNoSignatureEntries()

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

Returns:

true if no item is contained, false otherwise.

getSignatureCount

@Nonnegative
public int getSignatureCount()

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

Returns:

The number of contained elements. Always ≥ 0.

getSignatureAtIndex

@Nullable
public SignatureType getSignatureAtIndex(@Nonnegative
                                         int index)

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:

ArrayIndexOutOfBoundsException - if the index is invalid!

setApprovalStatus

@Nonnull
public ApprovalStatusType setApprovalStatus(@Nullable
                                           String valueParam)

Special setter with value of type String Created by ph-ubl-jaxb-plugin -Xph-ubl-value

Parameters:

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

Returns:

The created intermediary object of type ApprovalStatusType and never null

setDocumentID

@Nonnull
public DocumentIDType setDocumentID(@Nullable
                                   String valueParam)

Special setter with value of type String Created by ph-ubl-jaxb-plugin -Xph-ubl-value

Parameters:

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

Returns:

The created intermediary object of type DocumentIDType and never null

getDocumentIDValue

@Nullable
public String getDocumentIDValue()

Get the value of the contained DocumentIDType object Created by ph-ubl-jaxb-plugin -Xph-ubl-value

Returns:

Either the value of the contained DocumentIDType object or null

getApprovalStatusValue

@Nullable
public String getApprovalStatusValue()

Get the value of the contained ApprovalStatusType object Created by ph-ubl-jaxb-plugin -Xph-ubl-value

Returns:

Either the value of the contained ApprovalStatusType object or null