com.sapportals.connector.metadata.relations

Interface IRelationsMetaData

public interface IRelationsMetaData

This interface exposes metadata for EIS relations. Use this interface in order to get the EIS relations list, get a specific relation metadata, or get a list of relations

Method Summary

IRelation	getRelation(String token) Returns a relation by its identifying token
Set<IRelation>	getRelations() Deprecated. Use getRelationsEx()
Set<IRelation>	getRelations(IBusinessObject sourceObject, IBusinessObject targetObject) Deprecated. Use getRelationsEx(IBusinessObject,IBusinessObject)
List<IRelation>	getRelationsEx() Returns the EIS relations between all EIS business objects.
List<IRelation>	getRelationsEx(IBusinessObject sourceObject, IBusinessObject targetObject) Returns the EIS relations the current user can execute between two given objects.

Method Detail

getRelations

Set<IRelation> getRelations()
                            throws ConnectorException

Deprecated. Use getRelationsEx()

Returns the EIS relations the current user can execute.

Returns:

a Set of IRelations

Throws:

ConnectorException

See Also:

IRelation

getRelationsEx

List<IRelation> getRelationsEx()
                               throws ConnectorException

Returns the EIS relations between all EIS business objects.

Returns:

a List of IRelations

Throws:

ConnectorException

See Also:

IRelation

getRelations

Set<IRelation> getRelations(IBusinessObject sourceObject,
                            IBusinessObject targetObject)
                            throws ConnectorException

Deprecated. Use getRelationsEx(IBusinessObject,IBusinessObject)

Returns the EIS relations the current user can execute between two given objects.

Parameters:

sourceObject - the source object of the relation

targetObject - the target object of the relation

Returns:

a Set of IRelations

Throws:

ConnectorException

See Also:

IRelation

getRelationsEx

List<IRelation> getRelationsEx(IBusinessObject sourceObject,
                               IBusinessObject targetObject)
                               throws ConnectorException

Returns the EIS relations the current user can execute between two given objects.

Parameters:

sourceObject - the source object of the relation

targetObject - the target object of the relation

Returns:

a List of IRelations

Throws:

ConnectorException

See Also:

IRelation

getRelation

IRelation getRelation(String token)
                      throws RelationNotFoundException,
                             ConnectorException

Returns a relation by its identifying token

Parameters:

token - The relation identifier

Returns:

IRelations

Throws:

RelationNotFoundException

ConnectorException

See Also:

IRelation

Access Rights

This class can be accessed from:

SC	DC	Public Part	ACH
[sap.com] FRAMEWORK-EXT	[sap.com] tc/conn/connectorframeworkdeprecated	-	EP-CON-CF
[sap.com] EP-BASIS-API	[sap.com] tc/epbc/connectivityfw/api	api	EP-PIN
[sap.com] FRAMEWORK-EXT	[sap.com] tc/conn/connectorframeworkdeprecated	default	EP-CON-CF