com.vmware.vapi.metadata.metamodel

Interface Service

All Superinterfaces:

Service, ServiceTypes

public interface Service
extends Service, ServiceTypes

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

A service is a logical grouping of operations that operate on some entity. A service element describes a service. It contains operation elements that describe the operations grouped in the service. It also contains structure elements and enumeration elements corresponding to the structures and enumerations defined in the service.

Field Summary

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

_VAPI_SERVICE_ID, RESOURCE_TYPE

Method Summary

Modifier and Type	Method and Description
ServiceInfo	get(java.lang.String serviceId) Retrieves information about the service element corresponding to serviceId.
void	get(java.lang.String serviceId, AsyncCallback<ServiceInfo> asyncCallback) Retrieves information about the service element corresponding to serviceId.
void	get(java.lang.String serviceId, AsyncCallback<ServiceInfo> asyncCallback, InvocationConfig invocationConfig) Retrieves information about the service element corresponding to serviceId.
ServiceInfo	get(java.lang.String serviceId, InvocationConfig invocationConfig) Retrieves information about the service element corresponding to serviceId.
java.util.List<java.lang.String>	list() Returns the identifiers for the service elements that are currently registered with the infrastructure.
void	list(AsyncCallback<java.util.List<java.lang.String>> asyncCallback) Returns the identifiers for the service elements that are currently registered with the infrastructure.
void	list(AsyncCallback<java.util.List<java.lang.String>> asyncCallback, InvocationConfig invocationConfig) Returns the identifiers for the service elements that are currently registered with the infrastructure.
java.util.List<java.lang.String>	list(InvocationConfig invocationConfig) Returns the identifiers for the service elements that are currently registered with the infrastructure.

Method Detail

list

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

Returns the identifiers for the service elements that are currently registered with the infrastructure.

The list of service elements is an aggregate list of all the service elements contained in all the package elements.

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

Returns:

The list of identifiers for the service elements that are currently registered with the infrastructure. The return value will contain identifiers for the resource type: com.vmware.vapi.service.

list

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

Returns the identifiers for the service elements that are currently registered with the infrastructure.

The list of service elements is an aggregate list of all the service elements contained in all the package 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 service elements that are currently registered with the infrastructure. The return value will contain identifiers for the resource type: com.vmware.vapi.service.

list

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

Returns the identifiers for the service elements that are currently registered with the infrastructure.

The list of service elements is an aggregate list of all the service elements contained in all the package elements.

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

Invocation Result:
The list of identifiers for the service elements that are currently registered with the infrastructure. The return value will contain identifiers for the resource type: com.vmware.vapi.service.

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 service elements that are currently registered with the infrastructure.

The list of service elements is an aggregate list of all the service elements contained in all the package 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 service elements that are currently registered with the infrastructure. The return value will contain identifiers for the resource type: com.vmware.vapi.service.

Parameters:

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

invocationConfig - Configuration for the method invocation.

get

ServiceInfo get(java.lang.String serviceId)

Retrieves information about the service element corresponding to serviceId.

The ServiceInfo contains the metamodel information for the operation elements, structure elements and enumeration elements contained in the service element.

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

Parameters:

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

Returns:

The ServiceInfo instance that corresponds to serviceId

Throws:

NotFound - if the service element associated with serviceId is not registered with the infrastructure.

get

ServiceInfo get(java.lang.String serviceId,
                InvocationConfig invocationConfig)

Retrieves information about the service element corresponding to serviceId.

The ServiceInfo contains the metamodel information for the operation elements, structure elements and enumeration elements contained in the service 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:

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

invocationConfig - Configuration for the method invocation.

Returns:

The ServiceInfo instance that corresponds to serviceId

Throws:

NotFound - if the service element associated with serviceId is not registered with the infrastructure.

get

void get(java.lang.String serviceId,
         AsyncCallback<ServiceInfo> asyncCallback)

Retrieves information about the service element corresponding to serviceId.

The ServiceInfo contains the metamodel information for the operation elements, structure elements and enumeration elements contained in the service element.

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

Invocation Result:
The ServiceInfo instance that corresponds to serviceId

Operation Errors:
NotFound - if the service element associated with serviceId is not registered with the infrastructure.

Parameters:

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

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

get

void get(java.lang.String serviceId,
         AsyncCallback<ServiceInfo> asyncCallback,
         InvocationConfig invocationConfig)

Retrieves information about the service element corresponding to serviceId.

The ServiceInfo contains the metamodel information for the operation elements, structure elements and enumeration elements contained in the service 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 ServiceInfo instance that corresponds to serviceId

Operation Errors:
NotFound - if the service element associated with serviceId is not registered with the infrastructure.

Parameters:

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

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

invocationConfig - Configuration for the method invocation.