com.vmware.vcenter

Interface Folder

All Superinterfaces:

FolderTypes, Service

All Known Implementing Classes:

FolderStub

public interface Folder
extends Service, FolderTypes

The Folder interface provides methods for manipulating a vCenter Server folder.

Nested Class Summary

Nested classes/interfaces inherited from interface com.vmware.vcenter.FolderTypes

FolderTypes.FilterSpec, FolderTypes.Summary, FolderTypes.Type

Field Summary

Fields inherited from interface com.vmware.vcenter.FolderTypes

_VAPI_SERVICE_ID, RESOURCE_TYPE

Method Summary

Modifier and Type	Method and Description
java.util.List<FolderTypes.Summary>	list(FolderTypes.FilterSpec filter) Returns information about at most 1000 visible (subject to permission checks) folders in vCenter matching the FolderTypes.FilterSpec.
void	list(FolderTypes.FilterSpec filter, AsyncCallback<java.util.List<FolderTypes.Summary>> asyncCallback) Returns information about at most 1000 visible (subject to permission checks) folders in vCenter matching the FolderTypes.FilterSpec.
void	list(FolderTypes.FilterSpec filter, AsyncCallback<java.util.List<FolderTypes.Summary>> asyncCallback, InvocationConfig invocationConfig) Returns information about at most 1000 visible (subject to permission checks) folders in vCenter matching the FolderTypes.FilterSpec.
java.util.List<FolderTypes.Summary>	list(FolderTypes.FilterSpec filter, InvocationConfig invocationConfig) Returns information about at most 1000 visible (subject to permission checks) folders in vCenter matching the FolderTypes.FilterSpec.

Method Detail

list

java.util.List<FolderTypes.Summary> list(FolderTypes.FilterSpec filter)

Returns information about at most 1000 visible (subject to permission checks) folders in vCenter matching the FolderTypes.FilterSpec.

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

Parameters:

filter - Specification of matching folders for which information should be returned. If null, the behavior is equivalent to a FolderTypes.FilterSpec with all properties null which means all folders match the filter.

Returns:

Commonly used information about the folders matching the FolderTypes.FilterSpec.

Throws:

InvalidArgument - if the FolderTypes.FilterSpec.getType() property contains a value that is not supported by the server.

UnableToAllocateResource - if more than 1000 folders match the FolderTypes.FilterSpec.

ServiceUnavailable - if the system is unable to communicate with a service to complete the request.

Unauthenticated - if the user can not be authenticated.

Unauthorized - if the user doesn't have the required privileges.

list

java.util.List<FolderTypes.Summary> list(FolderTypes.FilterSpec filter,
                                         InvocationConfig invocationConfig)

Returns information about at most 1000 visible (subject to permission checks) folders in vCenter matching the FolderTypes.FilterSpec.

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:

filter - Specification of matching folders for which information should be returned. If null, the behavior is equivalent to a FolderTypes.FilterSpec with all properties null which means all folders match the filter.

invocationConfig - Configuration for the method invocation.

Returns:

Commonly used information about the folders matching the FolderTypes.FilterSpec.

Throws:

InvalidArgument - if the FolderTypes.FilterSpec.getType() property contains a value that is not supported by the server.

UnableToAllocateResource - if more than 1000 folders match the FolderTypes.FilterSpec.

ServiceUnavailable - if the system is unable to communicate with a service to complete the request.

Unauthenticated - if the user can not be authenticated.

Unauthorized - if the user doesn't have the required privileges.

list

void list(FolderTypes.FilterSpec filter,
          AsyncCallback<java.util.List<FolderTypes.Summary>> asyncCallback)

Returns information about at most 1000 visible (subject to permission checks) folders in vCenter matching the FolderTypes.FilterSpec.

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

Invocation Result:
Commonly used information about the folders matching the FolderTypes.FilterSpec.

Operation Errors:
InvalidArgument - if the FolderTypes.FilterSpec.getType() property contains a value that is not supported by the server.
UnableToAllocateResource - if more than 1000 folders match the FolderTypes.FilterSpec.
ServiceUnavailable - if the system is unable to communicate with a service to complete the request.
Unauthenticated - if the user can not be authenticated.
Unauthorized - if the user doesn't have the required privileges.

Parameters:

filter - Specification of matching folders for which information should be returned. If null, the behavior is equivalent to a FolderTypes.FilterSpec with all properties null which means all folders match the filter.

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

list

void list(FolderTypes.FilterSpec filter,
          AsyncCallback<java.util.List<FolderTypes.Summary>> asyncCallback,
          InvocationConfig invocationConfig)

Returns information about at most 1000 visible (subject to permission checks) folders in vCenter matching the FolderTypes.FilterSpec.

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:
Commonly used information about the folders matching the FolderTypes.FilterSpec.

Operation Errors:
InvalidArgument - if the FolderTypes.FilterSpec.getType() property contains a value that is not supported by the server.
UnableToAllocateResource - if more than 1000 folders match the FolderTypes.FilterSpec.
ServiceUnavailable - if the system is unable to communicate with a service to complete the request.
Unauthenticated - if the user can not be authenticated.
Unauthorized - if the user doesn't have the required privileges.

Parameters:

filter - Specification of matching folders for which information should be returned. If null, the behavior is equivalent to a FolderTypes.FilterSpec with all properties null which means all folders match the filter.

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

invocationConfig - Configuration for the method invocation.