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

Class EndorsementType

java.lang.Object

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

public class EndorsementType
extends Object

 <?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>Endorsement. Details</ccts:DictionaryEntryName>
                <ccts:Definition>A class to describe an endorsement of a 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>
 

Field Summary

Fields

Modifier and Type	Field and Description
protected ApprovalStatusType	approvalStatus
protected DocumentIDType	documentID
protected EndorserPartyType	endorserParty
protected List<RemarksType>	remarks
protected List<SignatureType>	signature

Constructor Summary

Constructors

Constructor and Description
EndorsementType()

Method Summary

Modifier and Type	Method and Description
ApprovalStatusType	getApprovalStatus() <?
DocumentIDType	getDocumentID() <?
EndorserPartyType	getEndorserParty() <?
List<RemarksType>	getRemarks() <?
List<SignatureType>	getSignature() <?
void	setApprovalStatus(ApprovalStatusType value) Sets the value of the approvalStatus property.
void	setDocumentID(DocumentIDType value) Sets the value of the documentID property.
void	setEndorserParty(EndorserPartyType value) Sets the value of the endorserParty property.

Methods inherited from class java.lang.Object

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

Field Detail

documentID

protected DocumentIDType documentID

approvalStatus

protected ApprovalStatusType approvalStatus

remarks

protected List<RemarksType> remarks

endorserParty

protected EndorserPartyType endorserParty

signature

protected List<SignatureType> signature

Constructor Detail

EndorsementType

public EndorsementType()

Method Detail

getDocumentID

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: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>Endorsement. Document. Identifier</ccts:DictionaryEntryName>
                      <ccts:Definition>An identifier for this 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(DocumentIDType value)

Sets the value of the documentID property.

Parameters:

value - allowed object is DocumentIDType

getApprovalStatus

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: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>Endorsement. Approval Status. Text</ccts:DictionaryEntryName>
                      <ccts:Definition>The status of this 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(ApprovalStatusType value)

Sets the value of the approvalStatus property.

Parameters:

value - allowed object is ApprovalStatusType

getRemarks

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: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>Endorsement. Remarks. Text</ccts:DictionaryEntryName>
                      <ccts:Definition>Remarks provided 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

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: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>Endorsement. Endorser Party</ccts:DictionaryEntryName>
                      <ccts:Definition>The type of party providing this 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:RepresentationTerm>Endorser Party</ccts:RepresentationTerm>
                   </ccts:Component>
 

Returns:

possible object is EndorserPartyType

setEndorserParty

public void setEndorserParty(EndorserPartyType value)

Sets the value of the endorserParty property.

Parameters:

value - allowed object is EndorserPartyType

getSignature

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: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>Endorsement. Signature</ccts:DictionaryEntryName>
                      <ccts:Definition>A signature applied to this 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:RepresentationTerm>Signature</ccts:RepresentationTerm>
                   </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