com.sap.portal.obn.semanticlayer.operation

Interface IOperation

All Superinterfaces:
IOBNObject

public interface IOperation
extends IOBNObject

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

All operations are persisted in the PCD under its business object.

Use IBusinessObject to create and delete operations.


Method Summary
 IBusinessObject getBusinessObject()
          Gets the business object of this operation.
 List getExpressionParameterNames()
          Gets a list of parameter names that are used for Navigation by Attributes for this operation.
 List getExpressionVariableNames()
          Gets a list of variable names that represents the parameters that are used for Navigation by Attributes for this operation.
 int getMaxImplementationPriority()
          Gets highest priority so far of any operation implementation that refers to this operation.
 int getPriority()
          Gets the operation priority.
 void setExpressionParameterNames(List paramsNames)
          For internal use only.
 void setExpressionVariableNames(List variablesNames)
          For internal use only.
 void setMaxImplementationPriority(int priority)
          For internal use only.
 void setPriority(int priority)
          For internal use only.
 
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 priority.

Returns:
the operation priority

setPriority

void setPriority(int priority)
For internal use only.

Sets the operation priority.

Parameters:
priority - the new operation priority

getMaxImplementationPriority

int getMaxImplementationPriority()
Gets highest priority so far of any operation implementation that refers to this operation.

Returns:
the highest priority

setMaxImplementationPriority

void setMaxImplementationPriority(int priority)
For internal use only.

Sets the highest priority so far of any operation implementation that refers to this operation.

Parameters:
priority - The new highest priority

getExpressionParameterNames

List getExpressionParameterNames()
                                 throws OBNException
Gets a list of parameter names that are used for Navigation by Attributes for this operation.

Returns:
a List of parameters names, or an empty List if none exist
Throws:
OBNException - if an error occurs

setExpressionParameterNames

void setExpressionParameterNames(List paramsNames)
                                 throws OBNException
For internal use only.

Sets the parameters that are used for Navigation by Attributes for this operation.

Parameters:
paramsNames - a list of parameters names
Throws:
OBNException - if an error occurs

getExpressionVariableNames

List getExpressionVariableNames()
                                throws OBNException
Gets a list of variable names that represents the parameters that are used for Navigation by Attributes for this operation.

Returns:
a List of variable names, or an empty List if none exist
Throws:
OBNException - if an error occurs

setExpressionVariableNames

void setExpressionVariableNames(List variablesNames)
                                throws OBNException
For internal use only.

Sets the list of variables for this operation.

Parameters:
variablesNames - a list of variables names
Throws:
OBNException - if an error occurs

getBusinessObject

IBusinessObject getBusinessObject()
                                  throws OBNException
Gets the business object of this operation.

Returns:
the business object of this operation
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