com.sap.portal.obn.service

Interface IOBNImplementationMD

All Superinterfaces:

IOBNMetadata

public interface IOBNImplementationMD
extends IOBNMetadata

The interface that represents metadata for an OBN operation implementation.

This object is created via OBN resolving container.

Nested Class Summary

static interface

IOBNImplementationMD.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

IOperationImplementation	getAttributesObject() Returns a semantic object for this operation implementation metadata.
String	getDomainValue() Returns the value of the OBN domain attribute of the implementing iView.
List	getExpressionInstances() Returns a list of values for each Navigation by Attributes parameter for this operation implementation.
String	getiViewUrl() Returns the PCD address (URL) of the implementing iView.
String	getSearchContextNameInNamespace() Returns the PCD context in which the iView was found.
boolean	isExpressionNegativeForm() Indicates whether this operation implementation is set to be evaluated for Navigation by Attributes using the not-equal sign.
boolean	isExpressionTrue() Indicates whether the metadata's attributes define this operation implementation.
boolean	isRegisteredForNoExpression() Indicates whether this implementation can be retrieved with Navigation by Attributes, as well as with OBN regular navigation (that is, navigation without using attributes).

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

IOperationImplementation getAttributesObject()
                                             throws OBNException

Returns a semantic object for this operation implementation metadata.

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

Returns:

semantic object representing the operation implementation

Throws:

OBNException - if an error occurs

getDomainValue

String getDomainValue()

Returns the value of the OBN domain attribute of the implementing iView.

The OBN domain is a representation of OBN tagging on an iView.

Returns:

the value of the OBN domain attribute of the implementing iView

getiViewUrl

String getiViewUrl()

Returns the PCD address (URL) of the implementing iView.

Returns:

the PCD address (URL) of the implementing iView

getSearchContextNameInNamespace

String getSearchContextNameInNamespace()
                                       throws OBNException

Returns the PCD context in which the iView was found.

Usually, when OBN resolving is performed on all user-assigned roles (the user roles are the search contexts in this case), the name of the role containing the implementing iView is returned.
When OBN resolving is performed using com.sap.portal.obn.service.IOBNSrvice#getOBNResolvingContainer(List, IOBNMetadata), the name of the PCD context (such as folder, workset or role) containing the implementing iView is returned.

Returns:

PCD context name in which the implementing iView is located

Throws:

OBNException - if an error occurs

isRegisteredForNoExpression

boolean isRegisteredForNoExpression()
                                    throws OBNException

Indicates whether this implementation can be retrieved with Navigation by Attributes, as well as with OBN regular navigation (that is, navigation without using attributes).

Returns:

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

Throws:

OBNException - if the semantic object of this implementation does not exist in the PCD

getExpressionInstances

List getExpressionInstances()
                            throws OBNException

Returns a list of values for each Navigation by Attributes parameter for this operation implementation.

Each member in the returned list is a list that represents the values of one attribute.

Each attribute is represented by a list, and each member in that list is a String holding a value for the appropriate variable in the variable names list returned by the IOBNOperationMD.getExpressionVariableNames() method of IOBNOperationMD.

Returns:

a list of values for each attribute registered for Navigation by Attributes of this operation implementation

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

isExpressionTrue

boolean isExpressionTrue()
                         throws OBNException

Indicates whether the metadata's attributes define this operation implementation.

Returns:

true if this operation implementation matches the metadata

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