com.sap.portal.obn.semanticlayer.operationimplementation

Interface IOperationImplementation

All Superinterfaces:

IOBNObject

public interface IOperationImplementation
extends IOBNObject

The interface that represents an operation implementation semantic object in the PCD.

All operation implementations are persisted in the PCD under its implementing iView.

Method Summary

Modifier and Type	Method and Description
Map	getExpressionInstancesMap() Gets the expression data as a map of attributes.
IOperation	getOperation() Gets the operation of this operation implementation.
int	getPriority() Gets the operation implementation priority.
String	getSystemAlias() Gets the system alias.
boolean	isExpressionNegativeForm() Indicates whether this operation implementation is set to be evaluated for Navigation by Attributes using the not equal sign.
boolean	isRegisteredForNoExpression() Indicates whether this implementation can be retrieved in Navigation by Attributes, as well as in OBN regular navigation (meaning: navigation without using attributes).
void	setExpressionInstancesMap(Map expressionDataMap) Sets the expression data as a map of attributes.
void	setExpressionNegativeForm(boolean isExpNegativeForm) Sets whether this operation implementation is evaluated for Navigation by Attributes using the not-equal sign.
void	setIsRegisteredForNoExpression(boolean isRegisteredForNoExpression) Sets whether this implementation can be retrieved in Navigation by Attributes, as well as in OBN regular navigation (meaning: navigation without using attributes).
void	setPriority(int priority) Sets the operation implementation priority.
void	setSystemAlias(String systemAlias) Sets the system alias.

Methods inherited from interface com.sap.portal.obn.semanticlayer.IOBNObject

getDescription, getObjectUrl, getPathName, getTechnicalName, getTitle, remove, save, setDescription, setTitle

Method Detail

getPriority

int getPriority()

Gets the operation implementation priority.

Returns:

the operation implementation priority

setPriority

void setPriority(int priority)

Sets the operation implementation priority.

Parameters:

priority - the new operation implementation priority

setSystemAlias

void setSystemAlias(String systemAlias)

Sets the system alias.

Parameters:

systemAlias - the new system alias

getSystemAlias

String getSystemAlias()

Gets the system alias.

Returns:

the new system alias

isRegisteredForNoExpression

boolean isRegisteredForNoExpression()
                             throws OBNException

Indicates whether this implementation can be retrieved in Navigation by Attributes, as well as in OBN regular navigation (meaning: navigation without using attributes).

Returns:

true if this implementation can also be retrieved by OBN navigation without attributes, false if it can be retrieved only when using Navigation by Attributes

Throws:

OBNException - if an error occurs

setIsRegisteredForNoExpression

void setIsRegisteredForNoExpression(boolean isRegisteredForNoExpression)

Sets whether this implementation can be retrieved in Navigation by Attributes, as well as in OBN regular navigation (meaning: navigation without using attributes).

Parameters:

isRegisteredForNoExpression - true if this implementation can also be retrieved by OBN navigation without attributes, false if it can be retrieved only when using Navigation by Attributes

getExpressionInstancesMap

Map getExpressionInstancesMap()
                       throws OBNException

Gets the expression data as a map of attributes. Each key is the variable name of the implementation attribute, and the value is a List of strings that are the values of the implementation attribute.

Returns:

Map the attributes to get

Throws:

OBNException - if an error occurs

setExpressionInstancesMap

void setExpressionInstancesMap(Map expressionDataMap)
                        throws OBNException

Sets the expression data as a map of attributes. Each key is the variable name of the implementation attribute, and the value is a List of strings that are the values of the implementation attribute.

The old expression data is removed.

For internal use only.

Parameters:

expressionDataMap - Map the attributes to set

Throws:

OBNException - if an error occurs

isExpressionNegativeForm

boolean isExpressionNegativeForm()
                          throws OBNException

Indicates whether this operation implementation is set to be evaluated for Navigation by Attributes using the not equal sign. When true, the comparison of the attributes of this operation implementation to the attributes of the metadata is done using the not-equal sign instead of the equal sign.

For example, suppose your metadata defines "Gold" customers and this operation implementation defines "Silver" customers. If this method returns true, it means that this operation implementation can match all the customers that are not defined as "Silver". Therefore, this implementation can be considered a match for this metadata.

Returns:

true if this operation implementation is set to be evaluated for Navigation by Attributes using the not-equal sign.

Throws:

OBNException - if an error occurs

setExpressionNegativeForm

void setExpressionNegativeForm(boolean isExpNegativeForm)
                        throws OBNException

Sets whether this operation implementation is evaluated for Navigation by Attributes using the not-equal sign.

For example, suppose your metadata defines "Gold" customers and this operation implementation defines "Silver" customers. If this method returns true, it means that this operation implementation can match all the customers that are not defined as "Silver". Therefore, this implementation can be considered a match for this metadata.

Parameters:

isExpNegativeForm - when true, the comparison of the attributes of this operation implementation to the attributes of the metadata is done using the not-equal sign instead of the equal sign

Throws:

OBNException - if an error occurs

getOperation

IOperation getOperation()
                 throws OBNException

Gets the operation of this operation implementation.

Returns:

the operation of this operation implementation

Throws:

OBNException - if an error occurs