com.vmware.vapi.metadata.metamodel

Interface Structure

All Superinterfaces:

Service, StructureTypes

All Known Implementing Classes:

StructureStub

public interface Structure
extends Service, StructureTypes

The Structure interface providers methods to retrieve metamodel information about a structure element in the interface definition language.

Field Summary

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

RESOURCE_TYPE

Method Summary

Methods

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

Method Detail

list

List<String> list()

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

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

Returns:

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

list

List<String> list(InvocationConfig invocationConfig)

Returns the identifiers for the structure elements that are contained in all the package elements and service 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 structure elements. The return value will contain identifiers for the resource type: com.vmware.vapi.structure.

list

void list(AsyncCallback<List<String>> asyncCallback)

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

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

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

Parameters:

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

list

void list(AsyncCallback<List<String>> asyncCallback,
        InvocationConfig invocationConfig)

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

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

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

Parameters:

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

invocationConfig - Configuration for the method invocation.

get

StructureInfo get(String structureId)

Retrieves information about the structure element corresponding to structureId.

The StructureInfo contains the metamodel information about the structure element. It contains information about all the field elements and enumeration elements contained in this structure element.

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

Parameters:

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

Returns:

The StructureInfo instance that corresponds to structureId.

Throws:

NotFound - if the structure element associated with structureId is not contained in any of the package elements or service elements.

get

StructureInfo get(String structureId,
                InvocationConfig invocationConfig)

Retrieves information about the structure element corresponding to structureId.

The StructureInfo contains the metamodel information about the structure element. It contains information about all the field elements and enumeration elements contained in this structure 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:

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

invocationConfig - Configuration for the method invocation.

Returns:

The StructureInfo instance that corresponds to structureId.

Throws:

NotFound - if the structure element associated with structureId is not contained in any of the package elements or service elements.

get

void get(String structureId,
       AsyncCallback<StructureInfo> asyncCallback)

Retrieves information about the structure element corresponding to structureId.

The StructureInfo contains the metamodel information about the structure element. It contains information about all the field elements and enumeration elements contained in this structure element.

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

Operation Result:
The StructureInfo instance that corresponds to structureId.

Operation Errors:
NotFound - if the structure element associated with structureId is not contained in any of the package elements or service elements.

Parameters:

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

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

get

void get(String structureId,
       AsyncCallback<StructureInfo> asyncCallback,
       InvocationConfig invocationConfig)

Retrieves information about the structure element corresponding to structureId.

The StructureInfo contains the metamodel information about the structure element. It contains information about all the field elements and enumeration elements contained in this structure element.

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

Operation Result:
The StructureInfo instance that corresponds to structureId.

Operation Errors:
NotFound - if the structure element associated with structureId is not contained in any of the package elements or service elements.

Parameters:

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

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

invocationConfig - Configuration for the method invocation.