com.sap.portal.obn.service

Interface IOBNResolvingContainer

public interface IOBNResolvingContainer

The interface that allows you to get OBN information for a specific set of OBN metadata.

The OBN resolving container caches information. Therefore, it is recommended to use only one instance for each metadata.

The OBN results are sorted using OBNSortMethod. After sorting, the first result is called the default result.

To get an OBN resolving container, use IOBNService.

Method Summary

List	getAllDefaultImplementations() Returns the default implementation for each operation defined by the OBN metadata of this OBN resolving container.
IOBNImplementationMD	getDefaultImplementation() Returns the default implementation of the default operation for the OBN metadata of this OBN resolving container.
List	getImplementations(IOBNOperationMD operation) Returns a list of implementations for the specified operation.
IOBNMetadata	getOBNMetadata() Returns the OBN metadata of this OBN resolving container.
OBNSortMethod	getOBNSortMethod() Returns the OBN sort method used by this OBN resolving container for sorting of business objects operations and their implementations.
List	getOperations(boolean implementedOnly) Returns a list of all operations defined by the OBN metadata of this OBN resolving container.
boolean	hasImplementations() Indicates whether the OBN metadata of this OBN resolving container has at least one implementation for at least one of its operations.
boolean	isOperationImplemented(IOBNOperationMD operation) Indicates whether the specified operation has at least one implementation.

Method Detail

getOBNSortMethod

OBNSortMethod getOBNSortMethod()

Returns the OBN sort method used by this OBN resolving container for sorting of business objects operations and their implementations.

The sort method determines the default operation and default implementation for the OBN metadata.

Returns:

the OBN sort method

getOBNMetadata

IOBNMetadata getOBNMetadata()

Returns the OBN metadata of this OBN resolving container.

Returns:

the OBN metadata of this OBN resolving container

getOperations

List getOperations(boolean implementedOnly)
                   throws OBNException

Returns a list of all operations defined by the OBN metadata of this OBN resolving container.

This method can also return a list of the operations that have at least one implementation, which takes longer to process.

The returned operations are sorted using the OBNSortMethod.

Parameters:

implementedOnly - determines whether the returned list includes all operations or only implemented operations

Returns:

a list of IOBNOperationMD objects, each of which represents an operation of the business object

Throws:

OBNException - if an error occurs

getImplementations

List getImplementations(IOBNOperationMD operation)
                        throws OBNException

Returns a list of implementations for the specified operation.

The operation can be retrieved using getOperations(boolean).

The returned implementations are sorted using the OBNSortMethod.

Parameters:

operation - the operation whose implementations are to be returned

Returns:

a list of IOBNImplementationMD objects, each of which represents an operation implementation

Throws:

OBNException - if an error occurs

isOperationImplemented

boolean isOperationImplemented(IOBNOperationMD operation)
                               throws OBNException

Indicates whether the specified operation has at least one implementation.

Parameters:

operation - the operation to check

Returns:

true if the specified operation has implementations

Throws:

OBNException - if an error occurs

hasImplementations

boolean hasImplementations()
                           throws OBNException

Indicates whether the OBN metadata of this OBN resolving container has at least one implementation for at least one of its operations.

Returns:

true if at least one implementation exists for the OBN metadata of this OBN resolving container

Throws:

OBNException - if an error occurs

getDefaultImplementation

IOBNImplementationMD getDefaultImplementation()
                                              throws OBNException

Returns the default implementation of the default operation for the OBN metadata of this OBN resolving container.

The default implementation is determined using the OBNSortMethod.

Returns:

the default implementation of the default operation

Throws:

OBNException - if an error occurs

getAllDefaultImplementations

List getAllDefaultImplementations()
                                  throws OBNException

Returns the default implementation for each operation defined by the OBN metadata of this OBN resolving container.

The returned implementations are sorted by the priority of their operations, or in other words, in the same order that the operations are returned by getOperations(boolean).

When the OBN metadata of this OBN resolving container describes a single operation, the returned list contains the same element returned by the getDefaultImplementation() method.

Returns:

list of IOBNImplementationMD where each member is a default implementation of a specific operation

Throws:

OBNException - if an error occurs during the resolving process

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