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

Class PaymentMandateType

java.lang.Object

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

public class PaymentMandateType
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>Payment Mandate. Details</ccts:DictionaryEntryName>
                <ccts:Definition>A class to describe a payment mandate.</ccts:Definition>
                <ccts:ObjectClass>Payment Mandate</ccts:ObjectClass>
             </ccts:Component>
 

Java class for PaymentMandateType complex type.

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

 <complexType name="PaymentMandateType">
   <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}MandateTypeCode" minOccurs="0"/>
         <element ref="{urn:oasis:names:specification:ubl:schema:xsd:CommonBasicComponents-2}MaximumPaymentInstructionsNumeric" minOccurs="0"/>
         <element ref="{urn:oasis:names:specification:ubl:schema:xsd:CommonBasicComponents-2}MaximumPaidAmount" minOccurs="0"/>
         <element ref="{urn:oasis:names:specification:ubl:schema:xsd:CommonBasicComponents-2}SignatureID" minOccurs="0"/>
         <element ref="{urn:oasis:names:specification:ubl:schema:xsd:CommonAggregateComponents-2}PayerParty" minOccurs="0"/>
         <element ref="{urn:oasis:names:specification:ubl:schema:xsd:CommonAggregateComponents-2}PayerFinancialAccount" minOccurs="0"/>
         <element ref="{urn:oasis:names:specification:ubl:schema:xsd:CommonAggregateComponents-2}ValidityPeriod" minOccurs="0"/>
         <element ref="{urn:oasis:names:specification:ubl:schema:xsd:CommonAggregateComponents-2}PaymentReversalPeriod" minOccurs="0"/>
         <element ref="{urn:oasis:names:specification:ubl:schema:xsd:CommonAggregateComponents-2}Clause" maxOccurs="unbounded" minOccurs="0"/>
       </sequence>
     </restriction>
   </complexContent>
 </complexType>
 

Field Summary

Fields

Modifier and Type	Field and Description
protected List<ClauseType>	clause
protected IDType	id
protected MandateTypeCodeType	mandateTypeCode
protected MaximumPaidAmountType	maximumPaidAmount
protected MaximumPaymentInstructionsNumericType	maximumPaymentInstructionsNumeric
protected FinancialAccountType	payerFinancialAccount
protected PartyType	payerParty
protected PeriodType	paymentReversalPeriod
protected SignatureIDType	signatureID
protected PeriodType	validityPeriod

Constructor Summary

Constructors

Constructor and Description
PaymentMandateType()

Method Summary

Modifier and Type	Method and Description
List<ClauseType>	getClause() <?
IDType	getID() <?
MandateTypeCodeType	getMandateTypeCode() <?
MaximumPaidAmountType	getMaximumPaidAmount() <?
MaximumPaymentInstructionsNumericType	getMaximumPaymentInstructionsNumeric() <?
FinancialAccountType	getPayerFinancialAccount() <?
PartyType	getPayerParty() <?
PeriodType	getPaymentReversalPeriod() <?
SignatureIDType	getSignatureID() <?
PeriodType	getValidityPeriod() <?
void	setID(IDType value) Sets the value of the id property.
void	setMandateTypeCode(MandateTypeCodeType value) Sets the value of the mandateTypeCode property.
void	setMaximumPaidAmount(MaximumPaidAmountType value) Sets the value of the maximumPaidAmount property.
void	setMaximumPaymentInstructionsNumeric(MaximumPaymentInstructionsNumericType value) Sets the value of the maximumPaymentInstructionsNumeric property.
void	setPayerFinancialAccount(FinancialAccountType value) Sets the value of the payerFinancialAccount property.
void	setPayerParty(PartyType value) Sets the value of the payerParty property.
void	setPaymentReversalPeriod(PeriodType value) Sets the value of the paymentReversalPeriod property.
void	setSignatureID(SignatureIDType value) Sets the value of the signatureID property.
void	setValidityPeriod(PeriodType value) Sets the value of the validityPeriod 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

mandateTypeCode

protected MandateTypeCodeType mandateTypeCode

maximumPaymentInstructionsNumeric

protected MaximumPaymentInstructionsNumericType maximumPaymentInstructionsNumeric

maximumPaidAmount

protected MaximumPaidAmountType maximumPaidAmount

signatureID

protected SignatureIDType signatureID

payerParty

protected PartyType payerParty

payerFinancialAccount

protected FinancialAccountType payerFinancialAccount

validityPeriod

protected PeriodType validityPeriod

paymentReversalPeriod

protected PeriodType paymentReversalPeriod

clause

protected List<ClauseType> clause

Constructor Detail

PaymentMandateType

public PaymentMandateType()

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>Payment Mandate. Identifier</ccts:DictionaryEntryName>
                      <ccts:Definition>An identifier for this payment mandate.</ccts:Definition>
                      <ccts:Cardinality>0..1</ccts:Cardinality>
                      <ccts:ObjectClass>Payment Mandate</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

getMandateTypeCode

public MandateTypeCodeType getMandateTypeCode()

 <?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>Payment Mandate. Mandate Type Code. Code</ccts:DictionaryEntryName>
                      <ccts:Definition>A code signifying the type of this payment mandate.</ccts:Definition>
                      <ccts:Cardinality>0..1</ccts:Cardinality>
                      <ccts:ObjectClass>Payment Mandate</ccts:ObjectClass>
                      <ccts:PropertyTerm>Mandate Type Code</ccts:PropertyTerm>
                      <ccts:RepresentationTerm>Code</ccts:RepresentationTerm>
                      <ccts:DataType>Code. Type</ccts:DataType>
                   </ccts:Component>
 

Returns:

possible object is MandateTypeCodeType

setMandateTypeCode

public void setMandateTypeCode(MandateTypeCodeType value)

Sets the value of the mandateTypeCode property.

Parameters:

value - allowed object is MandateTypeCodeType

getMaximumPaymentInstructionsNumeric

public MaximumPaymentInstructionsNumericType getMaximumPaymentInstructionsNumeric()

 <?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>Payment Mandate. Maximum Payment Instructions. Numeric</ccts:DictionaryEntryName>
                      <ccts:Definition>The number of maximum payment instructions allowed within the validity period.</ccts:Definition>
                      <ccts:Cardinality>0..1</ccts:Cardinality>
                      <ccts:ObjectClass>Payment Mandate</ccts:ObjectClass>
                      <ccts:PropertyTerm>Maximum Payment Instructions</ccts:PropertyTerm>
                      <ccts:RepresentationTerm>Numeric</ccts:RepresentationTerm>
                      <ccts:DataType>Numeric. Type</ccts:DataType>
                   </ccts:Component>
 

Returns:

possible object is MaximumPaymentInstructionsNumericType

setMaximumPaymentInstructionsNumeric

public void setMaximumPaymentInstructionsNumeric(MaximumPaymentInstructionsNumericType value)

Sets the value of the maximumPaymentInstructionsNumeric property.

Parameters:

value - allowed object is MaximumPaymentInstructionsNumericType

getMaximumPaidAmount

public MaximumPaidAmountType getMaximumPaidAmount()

 <?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>Payment Mandate. Maximum_ Paid Amount. Amount</ccts:DictionaryEntryName>
                      <ccts:Definition>The maximum amount to be paid within a single instruction.</ccts:Definition>
                      <ccts:Cardinality>0..1</ccts:Cardinality>
                      <ccts:ObjectClass>Payment Mandate</ccts:ObjectClass>
                      <ccts:PropertyTermQualifier>Maximum</ccts:PropertyTermQualifier>
                      <ccts:PropertyTerm>Paid Amount</ccts:PropertyTerm>
                      <ccts:RepresentationTerm>Amount</ccts:RepresentationTerm>
                      <ccts:DataType>Amount. Type</ccts:DataType>
                   </ccts:Component>
 

Returns:

possible object is MaximumPaidAmountType

setMaximumPaidAmount

public void setMaximumPaidAmount(MaximumPaidAmountType value)

Sets the value of the maximumPaidAmount property.

Parameters:

value - allowed object is MaximumPaidAmountType

getSignatureID

public SignatureIDType getSignatureID()

 <?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>Payment Mandate. Signature Identifier. Identifier</ccts:DictionaryEntryName>
                      <ccts:Definition>An identifier for a signature applied by a signatory party.</ccts:Definition>
                      <ccts:Cardinality>0..1</ccts:Cardinality>
                      <ccts:ObjectClass>Payment Mandate</ccts:ObjectClass>
                      <ccts:PropertyTerm>Signature Identifier</ccts:PropertyTerm>
                      <ccts:RepresentationTerm>Identifier</ccts:RepresentationTerm>
                      <ccts:DataType>Identifier. Type</ccts:DataType>
                   </ccts:Component>
 

Returns:

possible object is SignatureIDType

setSignatureID

public void setSignatureID(SignatureIDType value)

Sets the value of the signatureID property.

Parameters:

value - allowed object is SignatureIDType

getPayerParty

public PartyType getPayerParty()

 <?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>Payment Mandate. Payer_ Party. Party</ccts:DictionaryEntryName>
                      <ccts:Definition>The payer party (if different from the debtor).</ccts:Definition>
                      <ccts:Cardinality>0..1</ccts:Cardinality>
                      <ccts:ObjectClass>Payment Mandate</ccts:ObjectClass>
                      <ccts:PropertyTermQualifier>Payer</ccts:PropertyTermQualifier>
                      <ccts:PropertyTerm>Party</ccts:PropertyTerm>
                      <ccts:AssociatedObjectClass>Party</ccts:AssociatedObjectClass>
                      <ccts:RepresentationTerm>Party</ccts:RepresentationTerm>
                   </ccts:Component>
 

Returns:

possible object is PartyType

setPayerParty

public void setPayerParty(PartyType value)

Sets the value of the payerParty property.

Parameters:

value - allowed object is PartyType

getPayerFinancialAccount

public FinancialAccountType getPayerFinancialAccount()

 <?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>Payment Mandate. Payer_ Financial Account. Financial Account</ccts:DictionaryEntryName>
                      <ccts:Definition>The payer's financial account.</ccts:Definition>
                      <ccts:Cardinality>0..1</ccts:Cardinality>
                      <ccts:ObjectClass>Payment Mandate</ccts:ObjectClass>
                      <ccts:PropertyTermQualifier>Payer</ccts:PropertyTermQualifier>
                      <ccts:PropertyTerm>Financial Account</ccts:PropertyTerm>
                      <ccts:AssociatedObjectClass>Financial Account</ccts:AssociatedObjectClass>
                      <ccts:RepresentationTerm>Financial Account</ccts:RepresentationTerm>
                   </ccts:Component>
 

Returns:

possible object is FinancialAccountType

setPayerFinancialAccount

public void setPayerFinancialAccount(FinancialAccountType value)

Sets the value of the payerFinancialAccount property.

Parameters:

value - allowed object is FinancialAccountType

getValidityPeriod

public PeriodType getValidityPeriod()

 <?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>Payment Mandate. Validity_ Period. Period</ccts:DictionaryEntryName>
                      <ccts:Definition>The period during which this mandate is valid.</ccts:Definition>
                      <ccts:Cardinality>0..1</ccts:Cardinality>
                      <ccts:ObjectClass>Payment Mandate</ccts:ObjectClass>
                      <ccts:PropertyTermQualifier>Validity</ccts:PropertyTermQualifier>
                      <ccts:PropertyTerm>Period</ccts:PropertyTerm>
                      <ccts:AssociatedObjectClass>Period</ccts:AssociatedObjectClass>
                      <ccts:RepresentationTerm>Period</ccts:RepresentationTerm>
                   </ccts:Component>
 

Returns:

possible object is PeriodType

setValidityPeriod

public void setValidityPeriod(PeriodType value)

Sets the value of the validityPeriod property.

Parameters:

value - allowed object is PeriodType

getPaymentReversalPeriod

public PeriodType getPaymentReversalPeriod()

 <?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>Payment Mandate. Payment Reversal_ Period. Period</ccts:DictionaryEntryName>
                      <ccts:Definition>The period of the reverse payment.</ccts:Definition>
                      <ccts:Cardinality>0..1</ccts:Cardinality>
                      <ccts:ObjectClass>Payment Mandate</ccts:ObjectClass>
                      <ccts:PropertyTermQualifier>Payment Reversal</ccts:PropertyTermQualifier>
                      <ccts:PropertyTerm>Period</ccts:PropertyTerm>
                      <ccts:AssociatedObjectClass>Period</ccts:AssociatedObjectClass>
                      <ccts:RepresentationTerm>Period</ccts:RepresentationTerm>
                   </ccts:Component>
 

Returns:

possible object is PeriodType

setPaymentReversalPeriod

public void setPaymentReversalPeriod(PeriodType value)

Sets the value of the paymentReversalPeriod property.

Parameters:

value - allowed object is PeriodType

getClause

public List<ClauseType> getClause()

 <?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>Payment Mandate. Clause</ccts:DictionaryEntryName>
                      <ccts:Definition>A clause applicable to this payment mandate.</ccts:Definition>
                      <ccts:Cardinality>0..n</ccts:Cardinality>
                      <ccts:ObjectClass>Payment Mandate</ccts:ObjectClass>
                      <ccts:PropertyTerm>Clause</ccts:PropertyTerm>
                      <ccts:AssociatedObjectClass>Clause</ccts:AssociatedObjectClass>
                      <ccts:RepresentationTerm>Clause</ccts:RepresentationTerm>
                   </ccts:Component>
 

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

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

    getClause().add(newItem);
 

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