org.asam.ods

Interface EnumerationDefinitionOperations

All Known Subinterfaces:

EnumerationDefinition

All Known Implementing Classes:

_EnumerationDefinitionStub, EnumerationDefinition, EnumerationDefinition, EnumerationDefinitionPOA

public interface EnumerationDefinitionOperations

The ASAM ODS enumeration interface.

Method Summary

Methods

Modifier and Type	Method and Description
void	addItem(java.lang.String itemName) (28003) Append a new item to the enumeration.
int	getIndex() (28007) Get the index of the enumeration definition.
int	getItem(java.lang.String itemName) (28001) Get the value of an item.
java.lang.String	getItemName(int item) (28002) Get the name of an item.
java.lang.String	getName() (28005) Get the name of the enumeration.
java.lang.String[]	listItemNames() (28000) List the possible names of the enumeration.
void	renameItem(java.lang.String oldItemName, java.lang.String newItemName) (28004) Rename the item of the enumeration.
void	setName(java.lang.String enumName) (28006) Set the name of the enumeration.

Method Detail

listItemNames

java.lang.String[] listItemNames()
                                 throws AoException

(28000) List the possible names of the enumeration. The sort order of the list is the value of the item. The first item has the value zero.

Returns:

List with all possible names of the enumeration items.

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

getItem

int getItem(java.lang.String itemName)
            throws AoException

(28001) Get the value of an item.

Parameters:

itemName - The name of the item.

Returns:

The number of the item.

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_NOT_FOUND

getItemName

java.lang.String getItemName(int item)
                             throws AoException

(28002) Get the name of an item.

Parameters:

item - The value of the item.

Returns:

The name of the item.

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_NOT_FOUND

addItem

void addItem(java.lang.String itemName)
             throws AoException

(28003) Append a new item to the enumeration. This method modifies the application model and is only allowed for the super user. The name of an item must not exceed the maximum name length of the underlying physical storage. Current server implementations restrict it to 128 characters.

Parameters:

itemName - The name of the new item.

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 AO_ACCESS_DENIED AO_DUPLICATE_NAME AO_DUPLICATE_VALUE

renameItem

void renameItem(java.lang.String oldItemName,
              java.lang.String newItemName)
                throws AoException

(28004) Rename the item of the enumeration. This method modifies the application model and is only allowed for the super user.

Parameters:

oldItemName - The existing name of the item.

newItemName - the new name of the item.

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 AO_NOT_FOUND

getName

java.lang.String getName()
                         throws AoException

(28005) Get the name of the enumeration.

Returns:

Name of the enumeration.

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

setName

void setName(java.lang.String enumName)
             throws AoException

(28006) Set the name of the enumeration. This method modifies the application model and is only allowed for the super user. The name of an enumeration definition must not exceed the maximum name length of the underlying physical storage. Current server implementations restrict it to 30 characters.

Parameters:

enumName - Name of the enumeration.

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 AO_ACCESS_DENIED

getIndex

int getIndex()
             throws AoException

(28007) Get the index of the enumeration definition.

Returns:

The index of the enumeration.

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