org.asam.ods

Class _EnumerationDefinitionStub

java.lang.Object

org.omg.CORBA.portable.ObjectImpl

org.asam.ods._EnumerationDefinitionStub

All Implemented Interfaces:

java.io.Serializable, EnumerationDefinition, EnumerationDefinitionOperations, org.omg.CORBA.Object, org.omg.CORBA.portable.IDLEntity

public class _EnumerationDefinitionStub
extends org.omg.CORBA.portable.ObjectImpl
implements EnumerationDefinition

The ASAM ODS enumeration interface.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
_EnumerationDefinitionStub()

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.String[]	_ids()
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.

Methods inherited from class org.omg.CORBA.portable.ObjectImpl

_create_request, _create_request, _duplicate, _get_delegate, _get_domain_managers, _get_interface_def, _get_policy, _hash, _invoke, _is_a, _is_equivalent, _is_local, _non_existent, _orb, _release, _releaseReply, _request, _request, _servant_postinvoke, _servant_preinvoke, _set_delegate, _set_policy_override, equals, hashCode, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.omg.CORBA.Object

_create_request, _create_request, _duplicate, _get_domain_managers, _get_interface_def, _get_policy, _hash, _is_a, _is_equivalent, _non_existent, _release, _request, _set_policy_override

Constructor Detail

_EnumerationDefinitionStub

public _EnumerationDefinitionStub()

Method Detail

listItemNames

public 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.

Specified by:

listItemNames in interface EnumerationDefinitionOperations

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

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

(28001) Get the value of an item.

Specified by:

getItem in interface EnumerationDefinitionOperations

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

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

(28002) Get the name of an item.

Specified by:

getItemName in interface EnumerationDefinitionOperations

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

public 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.

Specified by:

addItem in interface EnumerationDefinitionOperations

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

public 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.

Specified by:

renameItem in interface EnumerationDefinitionOperations

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

public java.lang.String getName()
                         throws AoException

(28005) Get the name of the enumeration.

Specified by:

getName in interface EnumerationDefinitionOperations

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

public 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.

Specified by:

setName in interface EnumerationDefinitionOperations

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

public int getIndex()
             throws AoException

(28007) Get the index of the enumeration definition.

Specified by:

getIndex in interface EnumerationDefinitionOperations

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

_ids

public java.lang.String[] _ids()

Specified by:

_ids in class org.omg.CORBA.portable.ObjectImpl