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

Version:

1.0

Method Summary

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

Method Detail

getRelations

public java.util.Set getRelations()
                           throws ConnectorException

Deprecated. Use getRelationsEx()

Returns the EIS relations the current user can execute.

Returns:

A Set of IRelations

See Also:

IRelation

getRelationsEx

public java.util.List getRelationsEx()
                              throws ConnectorException

Returns the EIS relations between all EIS business objects.

Returns:

A List of IRelations

See Also:

IRelation

getRelations

public java.util.Set 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

See Also:

IRelation

getRelationsEx

public java.util.List 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

See Also:

IRelation

getRelation

public IRelation getRelation(java.lang.String token)
                      throws RelationNotFoundException,
                             ConnectorException

Returns a relation by its identifying token

Parameters:

token - The relation identifier

Returns:

IRelations

See Also:

IRelation