com.ibm.commerce.oagis9.datatypes

Interface ApplicationAreaType

All Known Subinterfaces:

ApplicationAreaType

public interface ApplicationAreaType

A representation of the model object 'Application Area Type'.

The following features are supported:

• Sender
• Creation Date Time
• Signature
• BODID
• User Area

See Also:

Oagis9Package.getApplicationAreaType()

Method Summary

Modifier and Type	Method and Description
IdentifierType	getBODID() Returns the value of the 'BODID' containment reference.
java.lang.Object	getCreationDateTime() Returns the value of the 'Creation Date Time' attribute.
com.ibm.commerce.oagis9.datatypes.SenderType	getSender() Returns the value of the 'Sender' containment reference.
com.ibm.commerce.oagis9.datatypes.SignatureType	getSignature() Returns the value of the 'Signature' containment reference.
com.ibm.commerce.oagis9.datatypes.UserAreaType	getUserArea() Returns the value of the 'User Area' containment reference.
void	setBODID(IdentifierType value) Sets the value of the 'BODID' containment reference.
void	setCreationDateTime(java.lang.Object value) Sets the value of the 'Creation Date Time' attribute.
void	setSender(com.ibm.commerce.oagis9.datatypes.SenderType value) Sets the value of the 'Sender' containment reference.
void	setSignature(com.ibm.commerce.oagis9.datatypes.SignatureType value) Sets the value of the 'Signature' containment reference.
void	setUserArea(com.ibm.commerce.oagis9.datatypes.UserAreaType value) Sets the value of the 'User Area' containment reference.

Method Detail

getSender

com.ibm.commerce.oagis9.datatypes.SenderType getSender()

Returns the value of the 'Sender' containment reference. Identifies characteristics and control identifiers that relate to the application that created the Business Object Document. The sender area can indicate the logical location of the application and/or database server, the application, and the task that was processing to create the BOD.

Returns:

the value of the 'Sender' containment reference.

See Also:

setSender(SenderType), Oagis9Package.getApplicationAreaType_Sender()

setSender

void setSender(com.ibm.commerce.oagis9.datatypes.SenderType value)

Sets the value of the 'Sender' containment reference.

Parameters:

value - the new value of the 'Sender' containment reference.

See Also:

getSender()

getCreationDateTime

java.lang.Object getCreationDateTime()

Returns the value of the 'Creation Date Time' attribute. is the date time stamp that the given instance of the Business Object Document was created. This date must not be modified during the life of the Business Object Document.

Returns:

the value of the 'Creation Date Time' attribute.

See Also:

setCreationDateTime(Object), Oagis9Package.getApplicationAreaType_CreationDateTime()

setCreationDateTime

void setCreationDateTime(java.lang.Object value)

Sets the value of the 'Creation Date Time' attribute.

Parameters:

value - the new value of the 'Creation Date Time' attribute.

See Also:

getCreationDateTime()

getSignature

com.ibm.commerce.oagis9.datatypes.SignatureType getSignature()

Returns the value of the 'Signature' containment reference. If the BOD is to be signed the signature element is included, otherwise it is not. Signature supports any digital signature that maybe used by an implementation of OAGIS. The qualifyingAgency identifies the agency that provided the format for the signature. This element supports any digital signature specification that is available today and in the future. This is accomplished by not actually defining the content but by allowing the implementation to specify the digital signature to be used via an external XML Schema namespace declaration. The Signature element is defined to have any content from any other namespace. This allows the user to carry a digital signature in the xml instance of a BOD. The choice of which digital signature to use is left up to the user and their integration needs.

Returns:

the value of the 'Signature' containment reference.

See Also:

setSignature(SignatureType), Oagis9Package.getApplicationAreaType_Signature()

setSignature

void setSignature(com.ibm.commerce.oagis9.datatypes.SignatureType value)

Sets the value of the 'Signature' containment reference.

Parameters:

value - the new value of the 'Signature' containment reference.

See Also:

getSignature()

getBODID

IdentifierType getBODID()

Returns the value of the 'BODID' containment reference. The BODId provides a place to carry a Globally Unique Identifier (GUID) that will make each Business Object Document instance uniquely identifiable. This is a critical success factor to enable software developers to use the Globally Unique Identifier (GUID) to build the following services or capabilities: 1. Legally binding transactions, 2. Transaction logging, 3. Exception handling, 4. Re-sending, 5. Reporting, 6. Confirmations, 7. Security.

Returns:

the value of the 'BODID' containment reference.

See Also:

setBODID(IdentifierType), Oagis9Package.getApplicationAreaType_BODID()

setBODID

void setBODID(IdentifierType value)

Sets the value of the 'BODID' containment reference.

Parameters:

value - the new value of the 'BODID' containment reference.

See Also:

getBODID()

getUserArea

com.ibm.commerce.oagis9.datatypes.UserAreaType getUserArea()

Returns the value of the 'User Area' containment reference. Allows the user of OAGIS to extend the specification in order to provide additional information that is not captured in OAGIS.

Returns:

the value of the 'User Area' containment reference.

See Also:

setUserArea(UserAreaType), Oagis9Package.getApplicationAreaType_UserArea()

setUserArea

void setUserArea(com.ibm.commerce.oagis9.datatypes.UserAreaType value)

Sets the value of the 'User Area' containment reference.

Parameters:

value - the new value of the 'User Area' containment reference.

See Also:

getUserArea()