com.vmware.vapi.metadata.metamodel

Class StructureStub

java.lang.Object

com.vmware.vapi.internal.bindings.Stub

com.vmware.vapi.metadata.metamodel.StructureStub

All Implemented Interfaces:

Service, Structure, StructureTypes

public class StructureStub
extends com.vmware.vapi.internal.bindings.Stub
implements Structure

Remote stub implementation of the Structure API service.

WARNING: Internal class, subject to change in future versions.

Field Summary

Fields inherited from class com.vmware.vapi.internal.bindings.Stub

apiProvider, converter, ifaceId, securityContext

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

_VAPI_SERVICE_ID, RESOURCE_TYPE

Constructor Summary

Constructors

Constructor and Description
StructureStub(ApiProvider apiProvider, StubConfigurationBase config)
StructureStub(ApiProvider apiProvider, com.vmware.vapi.internal.bindings.TypeConverter typeConverter, StubConfigurationBase config)

Method Summary

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

Methods inherited from class com.vmware.vapi.internal.bindings.Stub

invokeMethod, invokeMethodAsync, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

StructureStub

public StructureStub(ApiProvider apiProvider,
                     com.vmware.vapi.internal.bindings.TypeConverter typeConverter,
                     StubConfigurationBase config)

StructureStub

public StructureStub(ApiProvider apiProvider,
                     StubConfigurationBase config)

Method Detail

list

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

Description copied from interface: Structure

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.

Specified by:

list in interface Structure

Returns:

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

list

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

Description copied from interface: Structure

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.

Specified by:

list in interface Structure

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

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

Description copied from interface: Structure

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.

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

Specified by:

list in interface Structure

Parameters:

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

list

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

Description copied from interface: Structure

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.

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

Specified by:

list in interface Structure

Parameters:

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

invocationConfig - Configuration for the method invocation.

get

public StructureInfo get(java.lang.String structureId)

Description copied from interface: Structure

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.

Specified by:

get in interface Structure

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.

get

public StructureInfo get(java.lang.String structureId,
                         InvocationConfig invocationConfig)

Description copied from interface: Structure

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.

Specified by:

get in interface Structure

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.

get

public void get(java.lang.String structureId,
                AsyncCallback<StructureInfo> asyncCallback)

Description copied from interface: Structure

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.

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

Specified by:

get in interface Structure

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

public void get(java.lang.String structureId,
                AsyncCallback<StructureInfo> asyncCallback,
                InvocationConfig invocationConfig)

Description copied from interface: Structure

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.

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

Specified by:

get in interface Structure

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.