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

Class SignatureType

java.lang.Object

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

public class SignatureType
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>Signature. Details</ccts:DictionaryEntryName>
                <ccts:Definition>A class to define a signature.</ccts:Definition>
                <ccts:ObjectClass>Signature</ccts:ObjectClass>
             </ccts:Component>
 

Java class for SignatureType complex type.

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

 <complexType name="SignatureType">
   <complexContent>
     <restriction base="{http://www.w3.org/2001/XMLSchema}anyType">
       <sequence>
         <element ref="{urn:oasis:names:specification:ubl:schema:xsd:CommonBasicComponents-2}ID"/>
         <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:CommonBasicComponents-2}ValidationDate" minOccurs="0"/>
         <element ref="{urn:oasis:names:specification:ubl:schema:xsd:CommonBasicComponents-2}ValidationTime" minOccurs="0"/>
         <element ref="{urn:oasis:names:specification:ubl:schema:xsd:CommonBasicComponents-2}ValidatorID" minOccurs="0"/>
         <element ref="{urn:oasis:names:specification:ubl:schema:xsd:CommonBasicComponents-2}CanonicalizationMethod" minOccurs="0"/>
         <element ref="{urn:oasis:names:specification:ubl:schema:xsd:CommonBasicComponents-2}SignatureMethod" minOccurs="0"/>
         <element ref="{urn:oasis:names:specification:ubl:schema:xsd:CommonAggregateComponents-2}SignatoryParty" minOccurs="0"/>
         <element ref="{urn:oasis:names:specification:ubl:schema:xsd:CommonAggregateComponents-2}DigitalSignatureAttachment" minOccurs="0"/>
         <element ref="{urn:oasis:names:specification:ubl:schema:xsd:CommonAggregateComponents-2}OriginalDocumentReference" minOccurs="0"/>
       </sequence>
     </restriction>
   </complexContent>
 </complexType>
 

Field Summary

Fields

Modifier and Type	Field and Description
protected CanonicalizationMethodType	canonicalizationMethod
protected AttachmentType	digitalSignatureAttachment
protected IDType	id
protected List<NoteType>	note
protected DocumentReferenceType	originalDocumentReference
protected PartyType	signatoryParty
protected SignatureMethodType	signatureMethod
protected ValidationDateType	validationDate
protected ValidationTimeType	validationTime
protected ValidatorIDType	validatorID

Constructor Summary

Constructors

Constructor and Description
SignatureType()

Method Summary

Modifier and Type	Method and Description
CanonicalizationMethodType	getCanonicalizationMethod() <?
AttachmentType	getDigitalSignatureAttachment() <?
IDType	getID() <?
List<NoteType>	getNote() <?
DocumentReferenceType	getOriginalDocumentReference() <?
PartyType	getSignatoryParty() <?
SignatureMethodType	getSignatureMethod() <?
ValidationDateType	getValidationDate() <?
ValidationTimeType	getValidationTime() <?
ValidatorIDType	getValidatorID() <?
void	setCanonicalizationMethod(CanonicalizationMethodType value) Sets the value of the canonicalizationMethod property.
void	setDigitalSignatureAttachment(AttachmentType value) Sets the value of the digitalSignatureAttachment property.
void	setID(IDType value) Sets the value of the id property.
void	setOriginalDocumentReference(DocumentReferenceType value) Sets the value of the originalDocumentReference property.
void	setSignatoryParty(PartyType value) Sets the value of the signatoryParty property.
void	setSignatureMethod(SignatureMethodType value) Sets the value of the signatureMethod property.
void	setValidationDate(ValidationDateType value) Sets the value of the validationDate property.
void	setValidationTime(ValidationTimeType value) Sets the value of the validationTime property.
void	setValidatorID(ValidatorIDType value) Sets the value of the validatorID property.

Methods inherited from class java.lang.Object

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

Field Detail

id

protected IDType id

note

protected List<NoteType> note

validationDate

protected ValidationDateType validationDate

validationTime

protected ValidationTimeType validationTime

validatorID

protected ValidatorIDType validatorID

canonicalizationMethod

protected CanonicalizationMethodType canonicalizationMethod

signatureMethod

protected SignatureMethodType signatureMethod

signatoryParty

protected PartyType signatoryParty

digitalSignatureAttachment

protected AttachmentType digitalSignatureAttachment

originalDocumentReference

protected DocumentReferenceType originalDocumentReference

Constructor Detail

SignatureType

public SignatureType()

Method Detail

getID

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>Signature. Identifier</ccts:DictionaryEntryName>
                      <ccts:Definition>An identifier for this signature.</ccts:Definition>
                      <ccts:Cardinality>1</ccts:Cardinality>
                      <ccts:ObjectClass>Signature</ccts:ObjectClass>
                      <ccts:PropertyTerm>Identifier</ccts:PropertyTerm>
                      <ccts:RepresentationTerm>Identifier</ccts:RepresentationTerm>
                      <ccts:DataType>Identifier. Type</ccts:DataType>
                   </ccts:Component>
 

Returns:

possible object is IDType

setID

public void setID(IDType value)

Sets the value of the id property.

Parameters:

value - allowed object is IDType

getNote

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>Signature. Note. Text</ccts:DictionaryEntryName>
                      <ccts:Definition>Free-form text conveying information that is not contained explicitly in other structures; in particular, information regarding the circumstances in which the signature is being used.</ccts:Definition>
                      <ccts:Cardinality>0..n</ccts:Cardinality>
                      <ccts:ObjectClass>Signature</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

getValidationDate

public ValidationDateType getValidationDate()

 <?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>Signature. Validation Date. Date</ccts:DictionaryEntryName>
                      <ccts:Definition>The date upon which this signature was verified.</ccts:Definition>
                      <ccts:Cardinality>0..1</ccts:Cardinality>
                      <ccts:ObjectClass>Signature</ccts:ObjectClass>
                      <ccts:PropertyTerm>Validation Date</ccts:PropertyTerm>
                      <ccts:RepresentationTerm>Date</ccts:RepresentationTerm>
                      <ccts:DataType>Date. Type</ccts:DataType>
                   </ccts:Component>
 

Returns:

possible object is ValidationDateType

setValidationDate

public void setValidationDate(ValidationDateType value)

Sets the value of the validationDate property.

Parameters:

value - allowed object is ValidationDateType

getValidationTime

public ValidationTimeType getValidationTime()

 <?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>Signature. Validation Time. Time</ccts:DictionaryEntryName>
                      <ccts:Definition>The time at which this signature was verified.</ccts:Definition>
                      <ccts:Cardinality>0..1</ccts:Cardinality>
                      <ccts:ObjectClass>Signature</ccts:ObjectClass>
                      <ccts:PropertyTerm>Validation Time</ccts:PropertyTerm>
                      <ccts:RepresentationTerm>Time</ccts:RepresentationTerm>
                      <ccts:DataType>Time. Type</ccts:DataType>
                   </ccts:Component>
 

Returns:

possible object is ValidationTimeType

setValidationTime

public void setValidationTime(ValidationTimeType value)

Sets the value of the validationTime property.

Parameters:

value - allowed object is ValidationTimeType

getValidatorID

public ValidatorIDType getValidatorID()

 <?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>Signature. Validator. Identifier</ccts:DictionaryEntryName>
                      <ccts:Definition>An identifier for the organization, person, service, or server that verified this signature.</ccts:Definition>
                      <ccts:Cardinality>0..1</ccts:Cardinality>
                      <ccts:ObjectClass>Signature</ccts:ObjectClass>
                      <ccts:PropertyTerm>Validator</ccts:PropertyTerm>
                      <ccts:RepresentationTerm>Identifier</ccts:RepresentationTerm>
                      <ccts:DataType>Identifier. Type</ccts:DataType>
                   </ccts:Component>
 

Returns:

possible object is ValidatorIDType

setValidatorID

public void setValidatorID(ValidatorIDType value)

Sets the value of the validatorID property.

Parameters:

value - allowed object is ValidatorIDType

getCanonicalizationMethod

public CanonicalizationMethodType getCanonicalizationMethod()

 <?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>Signature. Canonicalization Method. Text</ccts:DictionaryEntryName>
                      <ccts:Definition>The method used to perform XML canonicalization of this signature.</ccts:Definition>
                      <ccts:Cardinality>0..1</ccts:Cardinality>
                      <ccts:ObjectClass>Signature</ccts:ObjectClass>
                      <ccts:PropertyTerm>Canonicalization Method</ccts:PropertyTerm>
                      <ccts:RepresentationTerm>Text</ccts:RepresentationTerm>
                      <ccts:DataType>Text. Type</ccts:DataType>
                   </ccts:Component>
 

Returns:

possible object is CanonicalizationMethodType

setCanonicalizationMethod

public void setCanonicalizationMethod(CanonicalizationMethodType value)

Sets the value of the canonicalizationMethod property.

Parameters:

value - allowed object is CanonicalizationMethodType

getSignatureMethod

public SignatureMethodType getSignatureMethod()

 <?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>Signature. Signature Method. Text</ccts:DictionaryEntryName>
                      <ccts:Definition>Text describing the method of signature.</ccts:Definition>
                      <ccts:Cardinality>0..1</ccts:Cardinality>
                      <ccts:ObjectClass>Signature</ccts:ObjectClass>
                      <ccts:PropertyTerm>Signature Method</ccts:PropertyTerm>
                      <ccts:RepresentationTerm>Text</ccts:RepresentationTerm>
                      <ccts:DataType>Text. Type</ccts:DataType>
                   </ccts:Component>
 

Returns:

possible object is SignatureMethodType

setSignatureMethod

public void setSignatureMethod(SignatureMethodType value)

Sets the value of the signatureMethod property.

Parameters:

value - allowed object is SignatureMethodType

getSignatoryParty

public PartyType getSignatoryParty()

 <?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>Signature. Signatory_ Party. Party</ccts:DictionaryEntryName>
                      <ccts:Definition>The signing party.</ccts:Definition>
                      <ccts:Cardinality>0..1</ccts:Cardinality>
                      <ccts:ObjectClass>Signature</ccts:ObjectClass>
                      <ccts:PropertyTermQualifier>Signatory</ccts:PropertyTermQualifier>
                      <ccts:PropertyTerm>Party</ccts:PropertyTerm>
                      <ccts:AssociatedObjectClass>Party</ccts:AssociatedObjectClass>
                      <ccts:RepresentationTerm>Party</ccts:RepresentationTerm>
                   </ccts:Component>
 

Returns:

possible object is PartyType

setSignatoryParty

public void setSignatoryParty(PartyType value)

Sets the value of the signatoryParty property.

Parameters:

value - allowed object is PartyType

getDigitalSignatureAttachment

public AttachmentType getDigitalSignatureAttachment()

 <?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>Signature. Digital Signature_ Attachment. Attachment</ccts:DictionaryEntryName>
                      <ccts:Definition>The actual encoded signature (e.g., in XMLDsig format).</ccts:Definition>
                      <ccts:Cardinality>0..1</ccts:Cardinality>
                      <ccts:ObjectClass>Signature</ccts:ObjectClass>
                      <ccts:PropertyTermQualifier>Digital Signature</ccts:PropertyTermQualifier>
                      <ccts:PropertyTerm>Attachment</ccts:PropertyTerm>
                      <ccts:AssociatedObjectClass>Attachment</ccts:AssociatedObjectClass>
                      <ccts:RepresentationTerm>Attachment</ccts:RepresentationTerm>
                   </ccts:Component>
 

Returns:

possible object is AttachmentType

setDigitalSignatureAttachment

public void setDigitalSignatureAttachment(AttachmentType value)

Sets the value of the digitalSignatureAttachment property.

Parameters:

value - allowed object is AttachmentType

getOriginalDocumentReference

public DocumentReferenceType getOriginalDocumentReference()

 <?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>Signature. Original_ Document Reference. Document Reference</ccts:DictionaryEntryName>
                      <ccts:Definition>A reference to the document that the signature applies to. For evidentiary purposes, this may be the document image that the signatory party saw when applying their signature.</ccts:Definition>
                      <ccts:Cardinality>0..1</ccts:Cardinality>
                      <ccts:ObjectClass>Signature</ccts:ObjectClass>
                      <ccts:PropertyTermQualifier>Original</ccts:PropertyTermQualifier>
                      <ccts:PropertyTerm>Document Reference</ccts:PropertyTerm>
                      <ccts:AssociatedObjectClass>Document Reference</ccts:AssociatedObjectClass>
                      <ccts:RepresentationTerm>Document Reference</ccts:RepresentationTerm>
                   </ccts:Component>
 

Returns:

possible object is DocumentReferenceType

setOriginalDocumentReference

public void setOriginalDocumentReference(DocumentReferenceType value)

Sets the value of the originalDocumentReference property.

Parameters:

value - allowed object is DocumentReferenceType