org.asam.ods

Interface BaseElementOperations

All Known Subinterfaces:

BaseElement

All Known Implementing Classes:

_BaseElementStub, BaseElement, BaseElement, BaseElementPOA

public interface BaseElementOperations

The ASAM ODS base element interface.

Method Summary

Methods

Modifier and Type	Method and Description
BaseRelation[]	getAllRelations() (9001) Get all known relations of the base element.
BaseAttribute[]	getAttributes(java.lang.String baPattern) (9002) Get attributes of the base element matching with the given pattern.
BaseElement[]	getRelatedElementsByRelationship(Relationship brRelationship) (9003) Get the related elements of a base element defined by the relationship.
BaseRelation[]	getRelationsByType(RelationType brRelationType) (9004) Get the base element's relations of the requested relation type.
java.lang.String	getType() (9005) Get the type of the base element.
boolean	isTopLevel() (9006) Get whether or not the base element is a top level element.
java.lang.String[]	listAttributes(java.lang.String baPattern) (9007) Get all attribute names of the base element matching with the given atrribute name pattern.
java.lang.String[]	listRelatedElementsByRelationship(Relationship brRelationship) (9008) Get the related element names of the base element defined by the relationship.

Method Detail

getAllRelations

BaseRelation[] getAllRelations()
                               throws AoException

(9001) Get all known relations of the base element.

Returns:

All known relations of the base element.

Throws:

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

getAttributes

BaseAttribute[] getAttributes(java.lang.String baPattern)
                              throws AoException

(9002) Get attributes of the base element matching with the given pattern.

Parameters:

baPattern - The name or the search pattern for the requested base attributes.

Returns:

The requested attributes of the base element.

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

getRelatedElementsByRelationship

BaseElement[] getRelatedElementsByRelationship(Relationship brRelationship)
                                               throws AoException

(9003) Get the related elements of a base element defined by the relationship.

Parameters:

brRelationship - The requested relationship.

Returns:

The related elements of a base element.

Throws:

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

getRelationsByType

BaseRelation[] getRelationsByType(RelationType brRelationType)
                                  throws AoException

(9004) Get the base element's relations of the requested relation type.

Parameters:

brRelationType - The requested relation type.

Returns:

The base element's relations of the requested type.

Throws:

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

getType

java.lang.String getType()
                         throws AoException

(9005) Get the type of the base element. The type of the base element is identical with the name of the base element, e.g. AoTest, AoMeasurement, ..etc. . The data type of BaseType is a string.

Returns:

The type of the base element.

Throws:

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

isTopLevel

boolean isTopLevel()
                   throws AoException

(9006) Get whether or not the base element is a top level element. Top level elements are elements without a father.

Returns:

Boolean whether or not the base element is a top level element.

Throws:

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

listAttributes

java.lang.String[] listAttributes(java.lang.String baPattern)
                                  throws AoException

(9007) Get all attribute names of the base element matching with the given atrribute name pattern.

Parameters:

baPattern - The name or the search pattern for the requested base attribute names.

Returns:

The requested attribute names of the base element.

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

listRelatedElementsByRelationship

java.lang.String[] listRelatedElementsByRelationship(Relationship brRelationship)
                                                     throws AoException

(9008) Get the related element names of the base element defined by the relationship.

Parameters:

brRelationship - The requested relationship.

Returns:

The related element names of the base element.

Throws:

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