org.asam.ods

Interface BaseAttributeOperations

All Known Subinterfaces:

BaseAttribute

All Known Implementing Classes:

_BaseAttributeStub, BaseAttribute, BaseAttribute, BaseAttributePOA

public interface BaseAttributeOperations

The ASAM ODS base attribute interface.

Method Summary

Methods

Modifier and Type	Method and Description
BaseElement	getBaseElement() (8005) Return the base element to which the attribute belongs..
DataType	getDataType() (8001) Get the data type of the base attribute.
EnumerationDefinition	getEnumerationDefinition() (8006) Get the definition of the enumeration of the base attribute.
java.lang.String	getName() (8002) Get the name of the base attribute.
boolean	isObligatory() (8003) Get the obligatory flag of the base attribute.
boolean	isUnique() (8004) Get the unique flag of the base attribute.

Method Detail

getDataType

DataType getDataType()
                     throws AoException

(8001) Get the data type of the base attribute.

Returns:

The data type of the base attribute.

Throws:

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

getName

java.lang.String getName()
                         throws AoException

(8002) Get the name of the base attribute.

Returns:

The name of the base attribute.

Throws:

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

isObligatory

boolean isObligatory()
                     throws AoException

(8003) Get the obligatory flag of the base attribute.

Returns:

The obligatory flag of the base attribute.

Throws:

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

isUnique

boolean isUnique()
                 throws AoException

(8004) Get the unique flag of the base attribute. All instances with this base attribute must have unique attribute values if the unique flag is TRUE.

Returns:

The unique flag of the base attribute.

Throws:

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

getBaseElement

BaseElement getBaseElement()
                           throws AoException

(8005) Return the base element to which the attribute belongs..

Returns:

The base element of the attribute.

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

getEnumerationDefinition

EnumerationDefinition getEnumerationDefinition()
                                               throws AoException

(8006) Get the definition of the enumeration of the base attribute.

Returns:

The ASAM ODS enumeration.

Throws:

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