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

Class NotificationRequirementType

java.lang.Object

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

public class NotificationRequirementType
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>Notification Requirement. Details</ccts:DictionaryEntryName>
                <ccts:Definition>A class to describe a notification requirement.</ccts:Definition>
                <ccts:ObjectClass>Notification Requirement</ccts:ObjectClass>
             </ccts:Component>
 

Java class for NotificationRequirementType complex type.

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

 <complexType name="NotificationRequirementType">
   <complexContent>
     <restriction base="{http://www.w3.org/2001/XMLSchema}anyType">
       <sequence>
         <element ref="{urn:oasis:names:specification:ubl:schema:xsd:CommonBasicComponents-2}NotificationTypeCode"/>
         <element ref="{urn:oasis:names:specification:ubl:schema:xsd:CommonBasicComponents-2}PostEventNotificationDurationMeasure" minOccurs="0"/>
         <element ref="{urn:oasis:names:specification:ubl:schema:xsd:CommonBasicComponents-2}PreEventNotificationDurationMeasure" minOccurs="0"/>
         <element ref="{urn:oasis:names:specification:ubl:schema:xsd:CommonAggregateComponents-2}NotifyParty" maxOccurs="unbounded" minOccurs="0"/>
         <element ref="{urn:oasis:names:specification:ubl:schema:xsd:CommonAggregateComponents-2}NotificationPeriod" maxOccurs="unbounded" minOccurs="0"/>
         <element ref="{urn:oasis:names:specification:ubl:schema:xsd:CommonAggregateComponents-2}NotificationLocation" maxOccurs="unbounded" minOccurs="0"/>
       </sequence>
     </restriction>
   </complexContent>
 </complexType>
 

Field Summary

Fields

Modifier and Type	Field and Description
protected List<LocationType>	notificationLocation
protected List<PeriodType>	notificationPeriod
protected NotificationTypeCodeType	notificationTypeCode
protected List<PartyType>	notifyParty
protected PostEventNotificationDurationMeasureType	postEventNotificationDurationMeasure
protected PreEventNotificationDurationMeasureType	preEventNotificationDurationMeasure

Constructor Summary

Constructors

Constructor and Description
NotificationRequirementType()

Method Summary

Modifier and Type	Method and Description
List<LocationType>	getNotificationLocation() <?
List<PeriodType>	getNotificationPeriod() <?
NotificationTypeCodeType	getNotificationTypeCode() <?
List<PartyType>	getNotifyParty() <?
PostEventNotificationDurationMeasureType	getPostEventNotificationDurationMeasure() <?
PreEventNotificationDurationMeasureType	getPreEventNotificationDurationMeasure() <?
void	setNotificationTypeCode(NotificationTypeCodeType value) Sets the value of the notificationTypeCode property.
void	setPostEventNotificationDurationMeasure(PostEventNotificationDurationMeasureType value) Sets the value of the postEventNotificationDurationMeasure property.
void	setPreEventNotificationDurationMeasure(PreEventNotificationDurationMeasureType value) Sets the value of the preEventNotificationDurationMeasure property.

Methods inherited from class java.lang.Object

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

Field Detail

notificationTypeCode

protected NotificationTypeCodeType notificationTypeCode

postEventNotificationDurationMeasure

protected PostEventNotificationDurationMeasureType postEventNotificationDurationMeasure

preEventNotificationDurationMeasure

protected PreEventNotificationDurationMeasureType preEventNotificationDurationMeasure

notifyParty

protected List<PartyType> notifyParty

notificationPeriod

protected List<PeriodType> notificationPeriod

notificationLocation

protected List<LocationType> notificationLocation

Constructor Detail

NotificationRequirementType

public NotificationRequirementType()

Method Detail

getNotificationTypeCode

public NotificationTypeCodeType getNotificationTypeCode()

 <?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>Notification Requirement. Notification Type Code. Code</ccts:DictionaryEntryName>
                      <ccts:Definition>A code signifying the type of notification (e.g., pickup status).</ccts:Definition>
                      <ccts:Cardinality>1</ccts:Cardinality>
                      <ccts:ObjectClass>Notification Requirement</ccts:ObjectClass>
                      <ccts:PropertyTerm>Notification Type Code</ccts:PropertyTerm>
                      <ccts:RepresentationTerm>Code</ccts:RepresentationTerm>
                      <ccts:DataType>Code. Type</ccts:DataType>
                   </ccts:Component>
 

Returns:

possible object is NotificationTypeCodeType

setNotificationTypeCode

public void setNotificationTypeCode(NotificationTypeCodeType value)

Sets the value of the notificationTypeCode property.

Parameters:

value - allowed object is NotificationTypeCodeType

getPostEventNotificationDurationMeasure

public PostEventNotificationDurationMeasureType getPostEventNotificationDurationMeasure()

 <?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>Notification Requirement. Post Event Notification Duration. Measure</ccts:DictionaryEntryName>
                      <ccts:Definition>The length of time between the occurrence of a given event and the issuance of a notification.</ccts:Definition>
                      <ccts:Cardinality>0..1</ccts:Cardinality>
                      <ccts:ObjectClass>Notification Requirement</ccts:ObjectClass>
                      <ccts:PropertyTerm>Post Event Notification Duration</ccts:PropertyTerm>
                      <ccts:RepresentationTerm>Measure</ccts:RepresentationTerm>
                      <ccts:DataType>Measure. Type</ccts:DataType>
                   </ccts:Component>
 

Returns:

possible object is PostEventNotificationDurationMeasureType

setPostEventNotificationDurationMeasure

public void setPostEventNotificationDurationMeasure(PostEventNotificationDurationMeasureType value)

Sets the value of the postEventNotificationDurationMeasure property.

Parameters:

value - allowed object is PostEventNotificationDurationMeasureType

getPreEventNotificationDurationMeasure

public PreEventNotificationDurationMeasureType getPreEventNotificationDurationMeasure()

 <?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>Notification Requirement. Pre Event Notification Duration. Measure</ccts:DictionaryEntryName>
                      <ccts:Definition>The length of time to elapse between the issuance of a notification and the occurrence of the event it relates to.</ccts:Definition>
                      <ccts:Cardinality>0..1</ccts:Cardinality>
                      <ccts:ObjectClass>Notification Requirement</ccts:ObjectClass>
                      <ccts:PropertyTerm>Pre Event Notification Duration</ccts:PropertyTerm>
                      <ccts:RepresentationTerm>Measure</ccts:RepresentationTerm>
                      <ccts:DataType>Measure. Type</ccts:DataType>
                   </ccts:Component>
 

Returns:

possible object is PreEventNotificationDurationMeasureType

setPreEventNotificationDurationMeasure

public void setPreEventNotificationDurationMeasure(PreEventNotificationDurationMeasureType value)

Sets the value of the preEventNotificationDurationMeasure property.

Parameters:

value - allowed object is PreEventNotificationDurationMeasureType

getNotifyParty

public List<PartyType> getNotifyParty()

 <?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>Notification Requirement. Notify_ Party. Party</ccts:DictionaryEntryName>
                      <ccts:Definition>A party to be notified.</ccts:Definition>
                      <ccts:Cardinality>0..n</ccts:Cardinality>
                      <ccts:ObjectClass>Notification Requirement</ccts:ObjectClass>
                      <ccts:PropertyTermQualifier>Notify</ccts:PropertyTermQualifier>
                      <ccts:PropertyTerm>Party</ccts:PropertyTerm>
                      <ccts:AssociatedObjectClass>Party</ccts:AssociatedObjectClass>
                      <ccts:RepresentationTerm>Party</ccts:RepresentationTerm>
                   </ccts:Component>
 

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

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

    getNotifyParty().add(newItem);
 

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

getNotificationPeriod

public List<PeriodType> getNotificationPeriod()

 <?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>Notification Requirement. Notification_ Period. Period</ccts:DictionaryEntryName>
                      <ccts:Definition>A period during which a notification should be issued.</ccts:Definition>
                      <ccts:Cardinality>0..n</ccts:Cardinality>
                      <ccts:ObjectClass>Notification Requirement</ccts:ObjectClass>
                      <ccts:PropertyTermQualifier>Notification</ccts:PropertyTermQualifier>
                      <ccts:PropertyTerm>Period</ccts:PropertyTerm>
                      <ccts:AssociatedObjectClass>Period</ccts:AssociatedObjectClass>
                      <ccts:RepresentationTerm>Period</ccts:RepresentationTerm>
                   </ccts:Component>
 

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

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

    getNotificationPeriod().add(newItem);
 

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

getNotificationLocation

public List<LocationType> getNotificationLocation()

 <?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>Notification Requirement. Notification_ Location. Location</ccts:DictionaryEntryName>
                      <ccts:Definition>A location at which a notification should be issued.</ccts:Definition>
                      <ccts:Cardinality>0..n</ccts:Cardinality>
                      <ccts:ObjectClass>Notification Requirement</ccts:ObjectClass>
                      <ccts:PropertyTermQualifier>Notification</ccts:PropertyTermQualifier>
                      <ccts:PropertyTerm>Location</ccts:PropertyTerm>
                      <ccts:AssociatedObjectClass>Location</ccts:AssociatedObjectClass>
                      <ccts:RepresentationTerm>Location</ccts:RepresentationTerm>
                   </ccts:Component>
 

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

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

    getNotificationLocation().add(newItem);
 

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