com.sapportals.connector.metadata.relations

Interface IRelation

All Superinterfaces:

IConnectorObject, IGenericElement, ISOAPSerializable

All Known Subinterfaces:

IBlackBoxRelation, IDefaultRelation

public interface IRelation
extends ISOAPSerializable, IGenericElement

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

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).

Fields inherited from interface com.sapportals.connector.metadata.objects.IGenericElement

ATTRIBUTE, BUSINESS_OBJECT, BUSINESS_OBJECT_GROUP, FUNCTION, RELATION

Method Summary

String	getCardinality()
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
int	retrieveTypeCode() Deprecated.

Methods inherited from interface com.sapportals.connector.metadata.objects.IGenericElement

getDescription, getElementType, getMetaType, getName, getNamespace, getUniqueName, retrieveTerm

Methods inherited from interface com.sapportals.connector.IConnectorObject

retrieveConnection

Field Detail

BLACKBOX_RELATION

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

See Also:

Constant Field Values

DEFAULT_RELATION

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

See Also:

Constant Field Values

Method Detail

getSourceObject

IBusinessObject getSourceObject()
                                throws ConnectorException

Returns the source business object of the relation.

Returns:

IBusinessObject interface

Throws:

ConnectorException

See Also:

IBusinessObject

getSourceKey

IKey getSourceKey()
                  throws ConnectorException

Returns the source key of the relation

Returns:

IKey the source key of the relation

Throws:

ConnectorException

See Also:

IKey

getTargetObject

IBusinessObject getTargetObject()
                                throws ConnectorException

Returns the target business object of the relation.

Returns:

IBusinessObject interface

Throws:

ConnectorException

See Also:

IBusinessObject

getTargetKey

IKey getTargetKey()
                  throws ConnectorException

Returns the target key of the relation

Returns:

IKey the target key of the relation

Throws:

ConnectorException

See Also:

IKey

retrieveTypeCode

int retrieveTypeCode()

Deprecated.

returns the type of the relation

Returns:

int typeCode of relation

isBlackBox

boolean isBlackBox()

Returns whether the relation is a black box

Returns:

whether the relation is a black box

getCardinality

String getCardinality()

Access Rights

This class can be accessed from:

SC	DC	Public Part	ACH
[sap.com] FRAMEWORK-EXT	[sap.com] tc/conn/connectorframeworkdeprecated	default	EP-CON-CF
[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