com.vmware.vapi.metadata.metamodel

Interface Package

All Superinterfaces:

PackageTypes, Service

All Known Implementing Classes:

PackageStub

public interface Package
extends Service, PackageTypes

The Package interface provides methods to retrieve metamodel information about a package element in the interface definition language.

A package is a logical grouping of services, structures and enumerations. A package element describes the package. It contains the service elements, structure elements and enumeration elements that are grouped together.

Field Summary

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

_VAPI_SERVICE_ID, RESOURCE_TYPE

Method Summary

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

Method Detail

list

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

Returns the identifiers for the packages elements that are contained in all the registered component elements.

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

Returns:

The list of identifiers for the package elements that are contained in all the registered component elements. The return value will contain identifiers for the resource type: com.vmware.vapi.package.

list

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

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

list

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

Returns the identifiers for the packages elements that are contained in all the registered component elements.

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

Invocation Result:
The list of identifiers for the package elements that are contained in all the registered component elements. The return value will contain identifiers for the resource type: com.vmware.vapi.package.

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

Parameters:

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

invocationConfig - Configuration for the method invocation.

get

PackageInfo get(java.lang.String packageId)

Retrieves information about the package element corresponding to packageId.

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

Parameters:

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

Returns:

The PackageInfo instance that corresponds to packageId.

Throws:

NotFound - if the package element associated with packageId does not exist.

get

PackageInfo get(java.lang.String packageId,
                InvocationConfig invocationConfig)

Retrieves information about the package element corresponding to packageId.

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:

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

invocationConfig - Configuration for the method invocation.

Returns:

The PackageInfo instance that corresponds to packageId.

Throws:

NotFound - if the package element associated with packageId does not exist.

get

void get(java.lang.String packageId,
         AsyncCallback<PackageInfo> asyncCallback)

Retrieves information about the package element corresponding to packageId.

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

Invocation Result:
The PackageInfo instance that corresponds to packageId.

Operation Errors:
NotFound - if the package element associated with packageId does not exist.

Parameters:

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

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

get

void get(java.lang.String packageId,
         AsyncCallback<PackageInfo> asyncCallback,
         InvocationConfig invocationConfig)

Retrieves information about the package element corresponding to packageId.

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 PackageInfo instance that corresponds to packageId.

Operation Errors:
NotFound - if the package element associated with packageId does not exist.

Parameters:

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

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

invocationConfig - Configuration for the method invocation.