com.ibm.commerce.oagis9.datatypes

Interface BODType

public interface BODType

A representation of the model object 'BOD Type'. The outcome of processing a specific BOD. Describes overall/summary outcome, plus the outcome of processing each noun of the BOD. Includes noun-specific error and/or warning messaages encountered during processing. May include summary and/or roll-up messages at the BOD level.

The following features are supported:

• Original Application Area
• Description
• Note
• BOD Failure Message
• BOD Success Message
• Partial BOD Failure Message
• User Area

See Also:

Oagis9Package.getBODType()

Method Summary

Modifier and Type	Method and Description
BODFailureMessageType	getBODFailureMessage() Returns the value of the 'BOD Failure Message' containment reference.
SuccessMessageType	getBODSuccessMessage() Returns the value of the 'BOD Success Message' containment reference.
java.util.List	getDescription() Returns the value of the 'Description' containment reference list.
java.util.List	getNote() Returns the value of the 'Note' containment reference list.
ApplicationAreaType	getOriginalApplicationArea() Returns the value of the 'Original Application Area' containment reference.
BODFailureMessageType	getPartialBODFailureMessage() Returns the value of the 'Partial BOD Failure Message' containment reference.
com.ibm.commerce.oagis9.datatypes.UserAreaType	getUserArea() Returns the value of the 'User Area' containment reference.
void	setBODFailureMessage(BODFailureMessageType value) Sets the value of the 'BOD Failure Message' containment reference.
void	setBODSuccessMessage(SuccessMessageType value) Sets the value of the 'BOD Success Message' containment reference.
void	setOriginalApplicationArea(ApplicationAreaType value) Sets the value of the 'Original Application Area' containment reference.
void	setPartialBODFailureMessage(BODFailureMessageType value) Sets the value of the 'Partial BOD Failure Message' containment reference.
void	setUserArea(com.ibm.commerce.oagis9.datatypes.UserAreaType value) Sets the value of the 'User Area' containment reference.

Method Detail

getOriginalApplicationArea

ApplicationAreaType getOriginalApplicationArea()

Returns the value of the 'Original Application Area' containment reference. A copy of the ApplicationArea for the original BOD that was processed. Present either as additional reference information, or for use in identifying the BOD in situations where a BODReference is not known. A copy of the ApplicationArea for the original BOD that was processed. Present either as additional reference information, or for use in identifying the BOD in situations where a BODReference is not known.

Returns:

the value of the 'Original Application Area' containment reference.

See Also:

setOriginalApplicationArea(ApplicationAreaType), Oagis9Package.getBODType_OriginalApplicationArea()

setOriginalApplicationArea

void setOriginalApplicationArea(ApplicationAreaType value)

Sets the value of the 'Original Application Area' containment reference.

Parameters:

value - the new value of the 'Original Application Area' containment reference.

See Also:

getOriginalApplicationArea()

getDescription

java.util.List getDescription()

Returns the value of the 'Description' containment reference list. The list contents are of type DescriptionType.

If the meaning of the 'Description' containment reference list isn't clear, there really should be more of a description here...

Returns:

the value of the 'Description' containment reference list.

See Also:

Oagis9Package.getBODType_Description()

getNote

java.util.List getNote()

Returns the value of the 'Note' containment reference list. The list contents are of type NoteType.

If the meaning of the 'Note' containment reference list isn't clear, there really should be more of a description here...

Returns:

the value of the 'Note' containment reference list.

See Also:

Oagis9Package.getBODType_Note()

getBODFailureMessage

BODFailureMessageType getBODFailureMessage()

Returns the value of the 'BOD Failure Message' containment reference. The processing of the BOD has failed. Provides a list of error and warning messages that explain the failure. Specific outcomes of processing each noun are reported in each of the NounOutcome elements.

Returns:

the value of the 'BOD Failure Message' containment reference.

See Also:

setBODFailureMessage(BODFailureMessageType), Oagis9Package.getBODType_BODFailureMessage()

setBODFailureMessage

void setBODFailureMessage(BODFailureMessageType value)

Sets the value of the 'BOD Failure Message' containment reference.

Parameters:

value - the new value of the 'BOD Failure Message' containment reference.

See Also:

getBODFailureMessage()

getBODSuccessMessage

SuccessMessageType getBODSuccessMessage()

Returns the value of the 'BOD Success Message' containment reference. The processing of the BOD was a success. Possible, non-fatal warning messages may appear here. Specific outcomes of processing each noun are reported in each of the NounOutcome elements.

Returns:

the value of the 'BOD Success Message' containment reference.

See Also:

setBODSuccessMessage(SuccessMessageType), Oagis9Package.getBODType_BODSuccessMessage()

setBODSuccessMessage

void setBODSuccessMessage(SuccessMessageType value)

Sets the value of the 'BOD Success Message' containment reference.

Parameters:

value - the new value of the 'BOD Success Message' containment reference.

See Also:

getBODSuccessMessage()

getPartialBODFailureMessage

BODFailureMessageType getPartialBODFailureMessage()

Returns the value of the 'Partial BOD Failure Message' containment reference. The processing of at least one noun in the BOD has failed. Error and warning messages may explain the failure. Specific outcomes of processing each noun are reported in each of the NounOutcome elements.

Returns:

the value of the 'Partial BOD Failure Message' containment reference.

See Also:

setPartialBODFailureMessage(BODFailureMessageType), Oagis9Package.getBODType_PartialBODFailureMessage()

setPartialBODFailureMessage

void setPartialBODFailureMessage(BODFailureMessageType value)

Sets the value of the 'Partial BOD Failure Message' containment reference.

Parameters:

value - the new value of the 'Partial BOD Failure Message' containment reference.

See Also:

getPartialBODFailureMessage()

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.getBODType_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()