com.vmware.vapi.metadata.metamodel

Interface Enumeration

All Superinterfaces:

EnumerationTypes, Service

All Known Implementing Classes:

EnumerationStub

public interface Enumeration
extends Service, EnumerationTypes

The Enumeration interface provides methods to retrieve metamodel information about an enumeration element in the interface definition language.

The Enumeration has a list of enumeration value elements.

Field Summary

Fields inherited from interface com.vmware.vapi.metadata.metamodel.EnumerationTypes

_VAPI_SERVICE_ID, RESOURCE_TYPE

Method Summary

Modifier and Type	Method and Description
EnumerationInfo	get(java.lang.String enumerationId) Retrieves information about the enumeration element corresponding to enumerationId.
void	get(java.lang.String enumerationId, AsyncCallback<EnumerationInfo> asyncCallback) Retrieves information about the enumeration element corresponding to enumerationId.
void	get(java.lang.String enumerationId, AsyncCallback<EnumerationInfo> asyncCallback, InvocationConfig invocationConfig) Retrieves information about the enumeration element corresponding to enumerationId.
EnumerationInfo	get(java.lang.String enumerationId, InvocationConfig invocationConfig) Retrieves information about the enumeration element corresponding to enumerationId.
java.util.List<java.lang.String>	list() Returns the identifiers for the enumeration elements that are contained in all the package elements, service elements and structure elements.
void	list(AsyncCallback<java.util.List<java.lang.String>> asyncCallback) Returns the identifiers for the enumeration elements that are contained in all the package elements, service elements and structure elements.
void	list(AsyncCallback<java.util.List<java.lang.String>> asyncCallback, InvocationConfig invocationConfig) Returns the identifiers for the enumeration elements that are contained in all the package elements, service elements and structure elements.
java.util.List<java.lang.String>	list(InvocationConfig invocationConfig) Returns the identifiers for the enumeration elements that are contained in all the package elements, service elements and structure elements.

Method Detail

list

java.util.List<java.lang.String> list()

Returns the identifiers for the enumeration elements that are contained in all the package elements, service elements and structure elements.

Synchronous method overload. Result of the invocation will be reported as a method return value.

Returns:

The list of identifiers for the enumeration elements. The return value will contain identifiers for the resource type: com.vmware.vapi.enumeration.

list

java.util.List<java.lang.String> list(InvocationConfig invocationConfig)

Returns the identifiers for the enumeration elements that are contained in all the package elements, service elements and structure elements.

Synchronous method overload. Result of the invocation will be reported as a method return value. Use invocationConfig to specify configuration for this particular invocation.

Parameters:

invocationConfig - Configuration for the method invocation.

Returns:

The list of identifiers for the enumeration elements. The return value will contain identifiers for the resource type: com.vmware.vapi.enumeration.

list

void list(AsyncCallback<java.util.List<java.lang.String>> asyncCallback)

Returns the identifiers for the enumeration elements that are contained in all the package elements, service elements and structure elements.

Asynchronous method overload. Result of the invocation will be reported via the specified asyncCallback.

Invocation Result:
The list of identifiers for the enumeration elements. The return value will contain identifiers for the resource type: com.vmware.vapi.enumeration.

Parameters:

asyncCallback - Receives the status (progress, result or error) of the operation invocation.

list

void list(AsyncCallback<java.util.List<java.lang.String>> asyncCallback,
          InvocationConfig invocationConfig)

Returns the identifiers for the enumeration elements that are contained in all the package elements, service elements and structure elements.

Asynchronous method overload. Result of the invocation will be reported via the specified asyncCallback. Use invocationConfig to specify configuration for this particular invocation.

Invocation Result:
The list of identifiers for the enumeration elements. The return value will contain identifiers for the resource type: com.vmware.vapi.enumeration.

Parameters:

asyncCallback - Receives the status (progress, result or error) of the operation invocation.

invocationConfig - Configuration for the method invocation.

get

EnumerationInfo get(java.lang.String enumerationId)

Retrieves information about the enumeration element corresponding to enumerationId.

The EnumerationInfo contains the metamodel information about the enumeration value element contained in the enumeration element.

Synchronous method overload. Result of the invocation will be reported as a method return value.

Parameters:

enumerationId - Identifier of the enumeration element. The parameter must be an identifier for the resource type: com.vmware.vapi.enumeration.

Returns:

The EnumerationInfo instance that corresponds to enumerationId

Throws:

NotFound - if the enumeration element associated with enumerationId is not contained in any of the package elements, service elements and structure elements.

get

EnumerationInfo get(java.lang.String enumerationId,
                    InvocationConfig invocationConfig)

Retrieves information about the enumeration element corresponding to enumerationId.

The EnumerationInfo contains the metamodel information about the enumeration value element contained in the enumeration element.

Synchronous method overload. Result of the invocation will be reported as a method return value. Use invocationConfig to specify configuration for this particular invocation.

Parameters:

enumerationId - Identifier of the enumeration element. The parameter must be an identifier for the resource type: com.vmware.vapi.enumeration.

invocationConfig - Configuration for the method invocation.

Returns:

The EnumerationInfo instance that corresponds to enumerationId

Throws:

NotFound - if the enumeration element associated with enumerationId is not contained in any of the package elements, service elements and structure elements.

get

void get(java.lang.String enumerationId,
         AsyncCallback<EnumerationInfo> asyncCallback)

Retrieves information about the enumeration element corresponding to enumerationId.

The EnumerationInfo contains the metamodel information about the enumeration value element contained in the enumeration element.

Asynchronous method overload. Result of the invocation will be reported via the specified asyncCallback.

Invocation Result:
The EnumerationInfo instance that corresponds to enumerationId

Operation Errors:
NotFound - if the enumeration element associated with enumerationId is not contained in any of the package elements, service elements and structure elements.

Parameters:

enumerationId - Identifier of the enumeration element. The parameter must be an identifier for the resource type: com.vmware.vapi.enumeration.

asyncCallback - Receives the status (progress, result or error) of the operation invocation.

get

void get(java.lang.String enumerationId,
         AsyncCallback<EnumerationInfo> asyncCallback,
         InvocationConfig invocationConfig)

Retrieves information about the enumeration element corresponding to enumerationId.

The EnumerationInfo contains the metamodel information about the enumeration value element contained in the enumeration element.

Asynchronous method overload. Result of the invocation will be reported via the specified asyncCallback. Use invocationConfig to specify configuration for this particular invocation.

Invocation Result:
The EnumerationInfo instance that corresponds to enumerationId

Operation Errors:
NotFound - if the enumeration element associated with enumerationId is not contained in any of the package elements, service elements and structure elements.

Parameters:

enumerationId - Identifier of the enumeration element. The parameter must be an identifier for the resource type: com.vmware.vapi.enumeration.

asyncCallback - Receives the status (progress, result or error) of the operation invocation.

invocationConfig - Configuration for the method invocation.