com.sapportals.connector.metadata.relations
Interface IRelation

All Superinterfaces:

ISOAPSerializable

All Known Subinterfaces:

IBlackBoxRelation, IDefaultRelation

public interface IRelation

extends ISOAPSerializable

This interface exposes metadata for a relation between 2 EIS Business Objects

Version:

1.0

Field Summary

static int	BLACKBOX_RELATION Constant indicating this relation is a blackbox relation.
static int	DEFAULT_RELATION Constant indicating this is a regular relation (not a blackbox relation).

Method Summary

java.lang.String	getDescription() returns the description of this relation
java.lang.String	getName() Deprecated.
IKey	getSourceKey() Returns the source key of the relation
IBusinessObject	getSourceObject() Returns the source business object of the relation.
IKey	getTargetKey() Returns the target key of the relation
IBusinessObject	getTargetObject() Returns the target business object of the relation.
boolean	isBlackBox() Returns whether the relation is a black box
java.lang.String	retrieveTerm() Returns the term describing the parameter, for example "Relation"
int	retrieveTypeCode() Deprecated.

Field Detail

BLACKBOX_RELATION

public static final int BLACKBOX_RELATION

Constant indicating this relation is a blackbox relation. For a blackbox relation, it's logic is only known to the connector

DEFAULT_RELATION

public static final int DEFAULT_RELATION

Constant indicating this is a regular relation (not a blackbox relation). A simple attribute to attribute comparison relation of the type A.x1 = B.y1 and ... A.xn = B.yn

Method Detail

getName

public java.lang.String getName()

Deprecated.

Returns the name of the relation

Returns:

String the name

getSourceObject

public IBusinessObject getSourceObject()
                                throws ConnectorException

Returns the source business object of the relation.

Returns:

IBusinessObject interface

See Also:

IBusinessObject

getSourceKey

public IKey getSourceKey()
                  throws ConnectorException

Returns the source key of the relation

Returns:

IKey the source key of the relation

See Also:

IKey

getTargetObject

public IBusinessObject getTargetObject()
                                throws ConnectorException

Returns the target business object of the relation.

Returns:

IBusinessObject interface

See Also:

IBusinessObject

getTargetKey

public IKey getTargetKey()
                  throws ConnectorException

Returns the target key of the relation

Returns:

IKey the target key of the relation

See Also:

IKey

retrieveTypeCode

public int retrieveTypeCode()

Deprecated.

returns the type of the relation

Returns:

int typeCode of relation

getDescription

public java.lang.String getDescription()

returns the description of this relation

Returns:

String the description of this relation

retrieveTerm

public java.lang.String retrieveTerm()

Returns the term describing the parameter, for example "Relation"

Returns:

The parameter term

isBlackBox

public boolean isBlackBox()

Returns whether the relation is a black box

Returns:

whether the relation is a black box