com.sap.portal.obn.service

Interface IOBNOperationMD

All Superinterfaces:
IOBNMetadata

public interface IOBNOperationMD
extends IOBNMetadata

The interface that represents metadata for an OBN operation.

The interface provides access to the operation's underlying semantic object, as well as information about attributes for Navigation by Attributes.

This interface can be obtained from IOBNResolvingContainer.getOperations(boolean) method of IOBNResolvingContainer.


Nested Class Summary
static interface IOBNOperationMD.Comparators
          Deprecated. as of 710 SP9. OBN service will not provide default implementation of comparators in future releases.
 
Field Summary
 
Fields inherited from interface com.sap.portal.obn.service.IOBNMetadata
NAVIGATION_PARAM_EVALUATE_EXPRESSION
 
Method Summary
 IOperation getAttributesObject()
          Returns a semantic object for this operation metadata.
 List getExpressionParameterNames()
          Returns the names of the parameters used as attributes for Navigation by Attributes.
 List getExpressionVariableNames()
          Returns the names of the internal variables that represent each attribute parameter in the semantic objects.
 boolean isExpressionDataEmpty()
          Indicates whether this operation metadata can be used for Navigation by Attributes.
 boolean isExpressionTrue(List parameterVals, List variableVals)
          Indicates whether the specified variable values and parameter values match the Navigation by Attributes parameters defined for this operation.
 
Methods inherited from interface com.sap.portal.obn.service.IOBNMetadata
getBOAttributesObject, getBusinessObject, getOBNUrl, getOBNUrlParametersString, getOperation, getOperationAttributesObject, getParameter, getParametersNames, getSystemAlias, getUser, isExpressionToEvaluate, setParameter
 

Method Detail

getAttributesObject

IOperation getAttributesObject()
                               throws OBNException
Returns a semantic object for this operation metadata.

The returned instance can be used to get additional properties of the operation.

Returns:
the semantic object representing the operation defined by this operation metadata
Throws:
OBNException - if an error occurs

isExpressionDataEmpty

boolean isExpressionDataEmpty()
                              throws OBNException
Indicates whether this operation metadata can be used for Navigation by Attributes.

Returns:
true if no attributes are defined for this operation, meaning it cannot be used for Navigation by Attributes
Throws:
OBNException - if an error occurs

getExpressionParameterNames

List getExpressionParameterNames()
                                 throws OBNException
Returns the names of the parameters used as attributes for Navigation by Attributes.

Returns:
a list of strings, each of which is the name of a parameter used as an attribute
Throws:
OBNException - if an error occurs

getExpressionVariableNames

List getExpressionVariableNames()
                                throws OBNException
Returns the names of the internal variables that represent each attribute parameter in the semantic objects. This method should only be used as input for isExpressionTrue(List,List) as the second list.

Returns:
a list of strings that should be used only as input for
Throws:
OBNException - if an error occurred during the process

isExpressionTrue

boolean isExpressionTrue(List parameterVals,
                         List variableVals)
                         throws OBNException
Indicates whether the specified variable values and parameter values match the Navigation by Attributes parameters defined for this operation.

Parameters:
parameterVals - a list of strings, each a value for one attribute parameter. Values in the list should be organized in the same order as the parameter names in the list returned by the method getExpressionParameterNames.
variableVals - a list of strings, each a value for one attribute variable. Values in the list should be organized in the same order as the variables names in the list returned by the method getExpressionVariableNames.
Returns:
result of the operation expression evaluation
Throws:
OBNException - if an error occurs
Access Rights

This class can be accessed from:


SC DC Public Part ACH
[sap.com] EP-RUNTIME [sap.com] tc/ep/navigation/api api EP-PIN


Copyright 2011 SAP AG Complete Copyright Notice