com.vmware.vapi.metadata.metamodel.resource

Interface Model

All Superinterfaces:

ModelTypes, Service

All Known Implementing Classes:

ModelStub

public interface Model
extends Service, ModelTypes

The Model interface provides methods to retrieve information about models.

A structure is used as a model if it is used for persisting data about an entity. Some of the fields in the model structure are also used for creating indexes for querying.

One or more services can operate on the same resource type. One or more services can provide the model structure for an entity of this resource type. Using Model interface you can retrieve the list of all the structure elements that are model structures for a given resource type.

Field Summary

Fields inherited from interface com.vmware.vapi.metadata.metamodel.resource.ModelTypes

_VAPI_SERVICE_ID

Method Summary

Modifier and Type	Method and Description
java.util.Set<java.lang.String>	list(java.lang.String resourceId) Returns the set of identifiers for the structure elements that are models for the resource type corresponding to resourceId.
void	list(java.lang.String resourceId, AsyncCallback<java.util.Set<java.lang.String>> asyncCallback) Returns the set of identifiers for the structure elements that are models for the resource type corresponding to resourceId.
void	list(java.lang.String resourceId, AsyncCallback<java.util.Set<java.lang.String>> asyncCallback, InvocationConfig invocationConfig) Returns the set of identifiers for the structure elements that are models for the resource type corresponding to resourceId.
java.util.Set<java.lang.String>	list(java.lang.String resourceId, InvocationConfig invocationConfig) Returns the set of identifiers for the structure elements that are models for the resource type corresponding to resourceId.

Method Detail

list

java.util.Set<java.lang.String> list(java.lang.String resourceId)

Returns the set of identifiers for the structure elements that are models for the resource type corresponding to resourceId.

The Structure interface provides methods to retrieve more details about the structure elements corresponding to the identifiers returned by this method.

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

Parameters:

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

Returns:

The set of identifiers for the models that are associated with the resource type in resourceId. The return value will contain identifiers for the resource type: com.vmware.vapi.structure.

Throws:

NotFound - if the resource type associated with resourceId does not exist.

list

java.util.Set<java.lang.String> list(java.lang.String resourceId,
                                     InvocationConfig invocationConfig)

Returns the set of identifiers for the structure elements that are models for the resource type corresponding to resourceId.

The Structure interface provides methods to retrieve more details about the structure elements corresponding to the identifiers returned by this method.

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:

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

invocationConfig - Configuration for the method invocation.

Returns:

The set of identifiers for the models that are associated with the resource type in resourceId. The return value will contain identifiers for the resource type: com.vmware.vapi.structure.

Throws:

NotFound - if the resource type associated with resourceId does not exist.

list

void list(java.lang.String resourceId,
          AsyncCallback<java.util.Set<java.lang.String>> asyncCallback)

Returns the set of identifiers for the structure elements that are models for the resource type corresponding to resourceId.

The Structure interface provides methods to retrieve more details about the structure elements corresponding to the identifiers returned by this method.

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

Invocation Result:
The set of identifiers for the models that are associated with the resource type in resourceId. The return value will contain identifiers for the resource type: com.vmware.vapi.structure.

Operation Errors:
NotFound - if the resource type associated with resourceId does not exist.

Parameters:

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

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

list

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

Returns the set of identifiers for the structure elements that are models for the resource type corresponding to resourceId.

The Structure interface provides methods to retrieve more details about the structure elements corresponding to the identifiers returned by this method.

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 set of identifiers for the models that are associated with the resource type in resourceId. The return value will contain identifiers for the resource type: com.vmware.vapi.structure.

Operation Errors:
NotFound - if the resource type associated with resourceId does not exist.

Parameters:

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

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

invocationConfig - Configuration for the method invocation.