org.asam.ods

Interface BaseRelationOperations

All Known Subinterfaces:

BaseRelation

All Known Implementing Classes:

_BaseRelationStub, BaseRelation, BaseRelation, BaseRelationPOA

public interface BaseRelationOperations

The ASAM ODS base relation interface.

Method Summary

Methods

Modifier and Type	Method and Description
BaseElement	getElem1() (10001) Get the first base element of the base relation.
BaseElement	getElem2() (10002) Get the second base element of the base relation.
java.lang.String	getInverseRelationName() (10009) Return the inverse name of the base relation.
RelationRange	getInverseRelationRange() (10003) Get the inverse relation range of the base relation.
Relationship	getInverseRelationship() (10004) Get the inverse relationship of the base relation.
java.lang.String	getRelationName() (10005) Get the relation name of the base relation.
RelationRange	getRelationRange() (10006) Get the relation range of the base relation.
Relationship	getRelationship() (10007) Get the relationship of the base relation.
RelationType	getRelationType() (10008) Get the relation type of the base relation.

Method Detail

getElem1

BaseElement getElem1()
                     throws AoException

(10001) Get the first base element of the base relation.

Returns:

The first base element of the base relation.

Throws:

AoException - with the following possible error codes: AO_CONNECTION_LOST AO_IMPLEMENTATION_PROBLEM AO_NOT_IMPLEMENTED AO_NO_MEMORY AO_SESSION_NOT_ACTIVE

getElem2

BaseElement getElem2()
                     throws AoException

(10002) Get the second base element of the base relation.

Returns:

The second base element of the base relation.

Throws:

AoException - with the following possible error codes: AO_CONNECTION_LOST AO_IMPLEMENTATION_PROBLEM AO_NOT_IMPLEMENTED AO_NO_MEMORY AO_SESSION_NOT_ACTIVE

getInverseRelationRange

RelationRange getInverseRelationRange()
                                      throws AoException

(10003) Get the inverse relation range of the base relation.

Returns:

The inverse relation range of the base relation.

Throws:

AoException - with the following possible error codes: AO_CONNECTION_LOST AO_IMPLEMENTATION_PROBLEM AO_NOT_IMPLEMENTED AO_NO_MEMORY AO_SESSION_NOT_ACTIVE

getInverseRelationship

Relationship getInverseRelationship()
                                    throws AoException

(10004) Get the inverse relationship of the base relation.

Returns:

The inverse relationship of the base relation.

Throws:

AoException - with the following possible error codes: AO_CONNECTION_LOST AO_IMPLEMENTATION_PROBLEM AO_NOT_IMPLEMENTED AO_NO_MEMORY AO_SESSION_NOT_ACTIVE

getRelationName

java.lang.String getRelationName()
                                 throws AoException

(10005) Get the relation name of the base relation.

Returns:

The relation name of the base relation.

Throws:

AoException - with the following possible error codes: AO_CONNECTION_LOST AO_IMPLEMENTATION_PROBLEM AO_NOT_IMPLEMENTED AO_NO_MEMORY AO_SESSION_NOT_ACTIVE

getRelationRange

RelationRange getRelationRange()
                               throws AoException

(10006) Get the relation range of the base relation.

Returns:

The relation range of the base relation.

Throws:

AoException - with the following possible error codes: AO_CONNECTION_LOST AO_IMPLEMENTATION_PROBLEM AO_NOT_IMPLEMENTED AO_NO_MEMORY AO_SESSION_NOT_ACTIVE

getRelationship

Relationship getRelationship()
                             throws AoException

(10007) Get the relationship of the base relation.

Returns:

The relationship of the base relation.

Throws:

AoException - with the following possible error codes: AO_CONNECTION_LOST AO_IMPLEMENTATION_PROBLEM AO_NOT_IMPLEMENTED AO_NO_MEMORY AO_SESSION_NOT_ACTIVE

getRelationType

RelationType getRelationType()
                             throws AoException

(10008) Get the relation type of the base relation.

Returns:

The relation type of the base relation.

Throws:

AoException - with the following possible error codes: AO_CONNECTION_LOST AO_IMPLEMENTATION_PROBLEM AO_NOT_IMPLEMENTED AO_NO_MEMORY AO_SESSION_NOT_ACTIVE

getInverseRelationName

java.lang.String getInverseRelationName()
                                        throws AoException

(10009) Return the inverse name of the base relation.

Returns:

The name of the inverse relation.

Throws:

AoException - with the following possible error codes: AO_BAD_PARAMETER AO_CONNECTION_LOST AO_IMPLEMENTATION_PROBLEM AO_NOT_IMPLEMENTED AO_NO_MEMORY AO_SESSION_NOT_ACTIVE