org.asam.ods

Interface ApplicationRelationOperations

All Known Subinterfaces:

ApplicationRelation

All Known Implementing Classes:

_ApplicationRelationStub, ApplicationRelation, ApplicationRelation, ApplicationRelationPOA

public interface ApplicationRelationOperations

The ASAM ODS application relation interface. A relation is the connection between two ASAM ODS elements; it may be navigated in both directions. The get- and set- methods are defined from the first element, the getInverse- and setInverse- methods work from the second element.

Method Summary

Methods

Modifier and Type	Method and Description
BaseRelation	getBaseRelation() (6001) Get the base relation of the application relation.
ApplicationElement	getElem1() (6002) Get the first application element of the application relation.
ApplicationElement	getElem2() (6003) Get the second application element of the application relation.
java.lang.String	getInverseRelationName() (6017) Get the inverse name of the application relation.
RelationRange	getInverseRelationRange() (6004) Get the inverse relation range of the application relation.
Relationship	getInverseRelationship() (6005) Get the inverse relationship of the application relation.
java.lang.String	getRelationName() (6006) Get the name of the application relation.
RelationRange	getRelationRange() (6007) Get the relation range of the application relation.
Relationship	getRelationship() (6008) Get the relationship of the application relation.
RelationType	getRelationType() (6009) Get the relation type of the application relation.
void	setBaseRelation(BaseRelation baseRel) (6010) Set the base relation of the application relation.
void	setElem1(ApplicationElement applElem) (6011) Set the first application element of the application relation.
void	setElem2(ApplicationElement applElem) (6012) Set the second application element of the application relation.
void	setInverseRelationName(java.lang.String arInvName) (6018) Set the inverse name of the application relation.
void	setInverseRelationRange(RelationRange arRelationRange) (6013) Set the inverse relation range of an application relation.
void	setRelationName(java.lang.String arName) (6014) Set the name of an application relation.
void	setRelationRange(RelationRange arRelationRange) (6015) Set the relation range of the application relation.
void	setRelationType(RelationType arRelationType) (6016) Set the relation type of the application relation.

Method Detail

getBaseRelation

BaseRelation getBaseRelation()
                             throws AoException

(6001) Get the base relation of the application relation.

Returns:

The base relation of the application relation. A 'null' is returned if the application relation has no 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

getElem1

ApplicationElement getElem1()
                            throws AoException

(6002) Get the first application element of the application relation.

Returns:

The first application element of the application 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

ApplicationElement getElem2()
                            throws AoException

(6003) Get the second application element of the application relation.

Returns:

The second application element of the application 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

(6004) Get the inverse relation range of the application relation. The range value describes the allowed number of the relations from one element to the other element of the relation. The relation range is defined by a min and a max value.

Returns:

The inverse relation range of the application 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

(6005) Get the inverse relationship of the application relation.

Returns:

The inverse relationship of the application 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

(6006) Get the name of the application relation.

Returns:

The name of the application 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

(6007) Get the relation range of the application relation. The range value describes the allowed number of relations from one element to the other element of the relation. The relation range is defined by a min and a max value.

Returns:

The relation range of the application 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

(6008) Get the relationship of the application relation.

Returns:

The relationship of the application 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

(6009) Get the relation type of the application relation.

Returns:

The relation type of the application 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

setBaseRelation

void setBaseRelation(BaseRelation baseRel)
                     throws AoException

(6010) Set the base relation of the application relation. It is allowed to modify the application relation outside a transaction but it is recommended to activate a transaction. The relation type and relation range is copied from the base relation. The previous values will be lost.

Parameters:

baseRel - The base relation.

Throws:

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

setElem1

void setElem1(ApplicationElement applElem)
              throws AoException

(6011) Set the first application element of the application relation. It is allowed to modify the application relation outside a transaction but it is recommended to activate a transaction.

Parameters:

applElem - The application element.

Throws:

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

setElem2

void setElem2(ApplicationElement applElem)
              throws AoException

(6012) Set the second application element of the application relation. It is allowed to modify the application relation outside a transaction but it is recommended to activate a transaction.

Parameters:

applElem - The application element.

Throws:

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

setInverseRelationRange

void setInverseRelationRange(RelationRange arRelationRange)
                             throws AoException

(6013) Set the inverse relation range of an application relation. The range value describes the allowed number of relations from one element to the other element of the relation. The relation range is defined by a min and a max value. It is allowed to modify the application relation outside a transaction but it is recommended to activate a transaction. It is only allowed to set the relation type if no base relation is defined.

Parameters:

arRelationRange - The inverse relation range.

Throws:

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

setRelationName

void setRelationName(java.lang.String arName)
                     throws AoException

(6014) Set the name of an application relation. It is allowed to modify the application relation outside a transaction but it is recommended to activate a transaction. The name of an application attribute must not exceed the maximum name length of the underlying physical storage. Current server typically implementations restrict it to 30 characters.

Parameters:

arName - The application relation name.

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

setRelationRange

void setRelationRange(RelationRange arRelationRange)
                      throws AoException

(6015) Set the relation range of the application relation. The range value describes the allowed number of relations from one element to the other element of the relation. The relation range is defined by a min and a max value. It is allowed to modify the application relation outside a transaction but it is recommended to activate a transaction. It is only allowed to set the relation type if no base relation is defined.

Parameters:

arRelationRange - The relation range.

Throws:

AoException - with the following possible error codes: AO_BAD_PARAMETER AO_CONNECTION_LOST AO_HAS_BASE_RELATION AO_IMPLEMENTATION_PROBLEM AO_INVALID_RELATION_RANGE AO_IS_BASE_RELATION AO_NOT_IMPLEMENTED AO_NO_MEMORY AO_SESSION_NOT_ACTIVE AO_TRANSACTION_NOT_ACTIVE

setRelationType

void setRelationType(RelationType arRelationType)
                     throws AoException

(6016) Set the relation type of the application relation. It is allowed to modify the application relation outside a transaction but it is recommended to activate a transaction. The relationship is automatically set when the relation type is set. It is only allowed to set the relation type if no base relation is defined. It is only allowed to modify a relation type when no base relation is given, otherwise the exception AO_HAS_BASE_RELATION is thrown. It is not allowed to set the relation type FATHER_CHILD. This relation type is reserved for the base model. The two relation types which can be set are INFO or INHERITANCE. The relationship is set automatically when the relation type is set, the maximum of the relation range determines the relationship between the elements of the relation, as is described in the following table: R.Type | max R.Range | max inv. R.Range | Relationship ------------+-------------+------------------+------------- INFO | 1 | 1 | exception, AO_INVALID_RELATION_TYPE ------------+-------------+------------------+------------- INFO | 1 | MANY | INFO_TO ------------+-------------+------------------+------------- INFO | MANY | 1 | INFO_FROM ------------+-------------+------------------+------------- INFO | MANY | MANY | INFO ------------+-------------+------------------+------------- INHERITANCE | 1 | 1 | exception, AO_INVALID_RELATION_TYPE ------------+-------------+------------------+------------- INHERITANCE | 1 | MANY | SUPERTYPE ------------+-------------+------------------+------------- INHERITANCE | MANY | 1 | SUBTYPE ------------+-------------+------------------+------------- INHERITANCE | MANY | MANY | exception, AO_INVALID_RELATION_TYPE

Parameters:

arRelationType - The relation type.

Throws:

AoException - with the following possible error codes: AO_BAD_PARAMETER AO_CONNECTION_LOST AO_HAS_BASE_RELATION AO_IMPLEMENTATION_PROBLEM AO_INVALID_RELATION_TYPE AO_IS_BASE_RELATION AO_NOT_IMPLEMENTED AO_NO_MEMORY AO_SESSION_NOT_ACTIVE AO_TRANSACTION_NOT_ACTIVE

getInverseRelationName

java.lang.String getInverseRelationName()
                                        throws AoException

(6017) Get the inverse name of the application relation. The inverse name of an application relation is the name of the relation seen from the other application element.

Returns:

The inverse name of the application 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

setInverseRelationName

void setInverseRelationName(java.lang.String arInvName)
                            throws AoException

(6018) Set the inverse name of the application relation. It is allowed to modify the application relation outside a transaction but it is recommended to activate a transaction.

Parameters:

arInvName - The inverse application relation name.

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 AO_TRANSACTION_NOT_ACTIVE