com.sap.portal.obn.semanticlayer.businessobject

Interface IBusinessObject

All Superinterfaces:

IOBNObject

public interface IBusinessObject
extends IOBNObject

A semantic object that represents a business object in the PCD. IBusinessObject exposes APIs for handling the business object data including the maintenance of its operations.
All business objects are persisted in the PCD under Business_Objects folder.
A business object can be either of BusinessObjectType.BUSINESS_OBJECT_TYPE_SYSTEM type or BusinessObjectType.BUSINESS_OBJECT_TYPE_CONTEXT type.
For more information see BusinessObjectType.

Method Summary

String	getAuxiliaryKey(int index) Returns the key of the auxiliary variable that corresponds to the given index
String	getAuxiliaryValue(int index) Returns the value of the auxiliary variable that corresponds to the given index
List	getAuxiliaryValuesByKey(String key) Returns the values of the all the auxiliary variables that have the given key
String	getNamespace() Returns the namespace of the business object.
IOperation	getOperationObject(String operationName, com.sap.security.api.IPrincipal user) Returns an operation object by its ID
IOperation	getOperationObject(String operationName, com.sap.security.api.IPrincipal user, boolean isEditable) Returns an operation object by its ID
Set	getOperationsNames() Returns IDs list of operations that are bound under (i.e. belong to) this business object
String	getOriginalNamespace() Returns the original Namespace of the business object in case it was encoded to be PCD compliant.
String	getOriginalObjectName() Returns the original ID of the business object in case it was encoded to be PCD compliant.
String	getSystemAlias() Returns the system alias of the business object.
BusinessObjectType	getTypeOfBusinessObject() Returns the type of the business object.
void	removeOperationObject(String operationName, com.sap.security.api.IPrincipal user) Remove operation object that belongs to this business object.
void	setAuxiliary(int index, String key, String value) Set auxiliary variable with jey and value
void	setOperationsNames(Set operationsNames) Sets the IDs list of operation that belong to this business object

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

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

Method Detail

getTypeOfBusinessObject

BusinessObjectType getTypeOfBusinessObject()

Returns the type of the business object.

Returns:

The business object type

getSystemAlias

String getSystemAlias()

Returns the system alias of the business object.
The system alias usually refers to the source system from which the business object was imported.
This is relevant only to system business object

Returns:

The SystemAlias

getNamespace

String getNamespace()

Returns the namespace of the business object.
Namespace is also the prefix of the Object's Id in the PCD.
This can be relevant for business objects of both types: BUSINESS_OBJECT_TYPE_SYSTEM and BUSINESS_OBJECT_TYPE_CONTEXT.
The Namespace might be encoded for persistency binding reasons, and it will be returned that way.
To obtain the original Namespace call getOriginalNamespace()

Returns:

The Namespace

getOriginalNamespace

String getOriginalNamespace()

Returns the original Namespace of the business object in case it was encoded to be PCD compliant.

Returns:

The original business object Namespace

getOriginalObjectName

String getOriginalObjectName()

Returns the original ID of the business object in case it was encoded to be PCD compliant.

Returns:

The original business object ID

getOperationsNames

Set getOperationsNames()

Returns IDs list of operations that are bound under (i.e. belong to) this business object

Returns:

The set of operations IDs

setOperationsNames

void setOperationsNames(Set operationsNames)

Sets the IDs list of operation that belong to this business object

Parameters:

operationsNames - The list of operations IDs

getOperationObject

IOperation getOperationObject(String operationName,
                              com.sap.security.api.IPrincipal user)
                              throws OBNException

Returns an operation object by its ID

Parameters:

operationName - The operation ID

user - The user object, for permission reasons

Returns:

The requested operation object

Throws:

OBNException

getOperationObject

IOperation getOperationObject(String operationName,
                              com.sap.security.api.IPrincipal user,
                              boolean isEditable)
                              throws OBNException

Returns an operation object by its ID

Parameters:

operationName - The operation ID

user - The user object, for permission reasons

isEditable - If the context is DesingTime

Returns:

The requested operation object

Throws:

OBNException

removeOperationObject

void removeOperationObject(String operationName,
                           com.sap.security.api.IPrincipal user)
                           throws OBNException

Remove operation object that belongs to this business object.

Parameters:

operationName - - The ID of the operation to remove

user -

Throws:

OBNException

setAuxiliary

void setAuxiliary(int index,
                  String key,
                  String value)
                  throws OBNException

Set auxiliary variable with jey and value

Parameters:

index - The Id of the auxiliary variable

key - The key of the variable

value - The value of the variable

Throws:

OBNException

getAuxiliaryKey

String getAuxiliaryKey(int index)
                       throws OBNException

Returns the key of the auxiliary variable that corresponds to the given index

Parameters:

index - The index of the auxiliary variable

Returns:

The key of the auxiliary variable

Throws:

OBNException - In case no auxiliary variable corresponds to the given index

getAuxiliaryValue

String getAuxiliaryValue(int index)
                         throws OBNException

Returns the value of the auxiliary variable that corresponds to the given index

Parameters:

index - The index of the auxiliary variable

Returns:

The value of the auxiliary variable

Throws:

OBNException - In case no auxiliary variable corresponds to the given index

getAuxiliaryValuesByKey

List getAuxiliaryValuesByKey(String key)
                             throws OBNException

Returns the values of the all the auxiliary variables that have the given key

Parameters:

key - The key of the needed auxiliary variable

Returns:

The List of values, or empty List in case no values were found

Throws:

OBNException

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