com.ibm.commerce.oagis9.datatypes

Interface ActionExpressionType

public interface ActionExpressionType

A representation of the model object 'Action Expression Type'. ReturnCriteria identifies the content that is to be returned, given query success. In essence, the expression here has the effect of filtering the part(s) of the found element(s) that are to be returned. ReturnCriteria plays no role in the query itself. That is handled as a match against the request BOD's noun exemplar. ReturnCriteria allows the sender of the BOD to indicate which information (down to the field level) is requested to be returned, given that the query has been successful in matching the exemplar to existing nouns. That is, in a GetListPurchaseOrder, if one or more PurchaseOrders with a TotalPrice = $1M were found, ReturnCriteria tells the BOD recipient which parts of the PurchaseOrder should be populated with content when the response (ShowPurchaseOrder) is formulated. The expressionLanguage indicates the expression language being used. In order for the ReturnCriteria expression to be evaluable by the BOD recipient, the recipient must be capable of processing and interpreting the specified expression language. XPath is the default, due to its ubiquity among XML processing technologies.

The following features are supported:

• Value
• Action Code
• Expression Language

See Also:

Oagis9Package.getActionExpressionType()

Method Summary

Modifier and Type	Method and Description
java.lang.Object	getActionCode() Returns the value of the 'Action Code' attribute.
java.lang.String	getExpressionLanguage() Returns the value of the 'Expression Language' attribute.
java.lang.String	getValue() Returns the value of the 'Value' attribute.
void	setActionCode(java.lang.Object value) Sets the value of the 'Action Code' attribute.
void	setExpressionLanguage(java.lang.String value) Sets the value of the 'Expression Language' attribute.
void	setValue(java.lang.String value) Sets the value of the 'Value' attribute.

Method Detail

getValue

java.lang.String getValue()

Returns the value of the 'Value' attribute.

If the meaning of the 'Value' attribute isn't clear, there really should be more of a description here...

Returns:

the value of the 'Value' attribute.

See Also:

setValue(String), Oagis9Package.getActionExpressionType_Value()

setValue

void setValue(java.lang.String value)

Sets the value of the 'Value' attribute.

Parameters:

value - the new value of the 'Value' attribute.

See Also:

getValue()

getActionCode

java.lang.Object getActionCode()

Returns the value of the 'Action Code' attribute.

If the meaning of the 'Action Code' attribute isn't clear, there really should be more of a description here...

Returns:

the value of the 'Action Code' attribute.

See Also:

setActionCode(Object), Oagis9Package.getActionExpressionType_ActionCode()

setActionCode

void setActionCode(java.lang.Object value)

Sets the value of the 'Action Code' attribute.

Parameters:

value - the new value of the 'Action Code' attribute.

See Also:

getActionCode()

getExpressionLanguage

java.lang.String getExpressionLanguage()

Returns the value of the 'Expression Language' attribute.

If the meaning of the 'Expression Language' attribute isn't clear, there really should be more of a description here...

Returns:

the value of the 'Expression Language' attribute.

See Also:

setExpressionLanguage(String), Oagis9Package.getActionExpressionType_ExpressionLanguage()

setExpressionLanguage

void setExpressionLanguage(java.lang.String value)

Sets the value of the 'Expression Language' attribute.

Parameters:

value - the new value of the 'Expression Language' attribute.

See Also:

getExpressionLanguage()