com.vmware.content

Interface Library

All Superinterfaces:

LibraryTypes, Service

All Known Implementing Classes:

LibraryStub

public interface Library
extends Service, LibraryTypes

The Library interface provides methods to manage and find LibraryModel entities.

The Library interface provides support for generic functionality which can be applied equally to all types of libraries. The functionality provided by this interface will not affect the properties specific to the type of library. See also LocalLibrary and SubscribedLibrary.

Nested Class Summary

Nested classes/interfaces inherited from interface com.vmware.content.LibraryTypes

LibraryTypes.FindSpec

Field Summary

Fields inherited from interface com.vmware.content.LibraryTypes

RESOURCE_TYPE

Method Summary

Methods

Modifier and Type	Method and Description
List<String>	find(LibraryTypes.FindSpec spec) Returns a list of all the visible (as determined by authorization policy) libraries matching the requested LibraryTypes.FindSpec.
void	find(LibraryTypes.FindSpec spec, AsyncCallback<List<String>> asyncCallback) Returns a list of all the visible (as determined by authorization policy) libraries matching the requested LibraryTypes.FindSpec.
void	find(LibraryTypes.FindSpec spec, AsyncCallback<List<String>> asyncCallback, InvocationConfig invocationConfig) Returns a list of all the visible (as determined by authorization policy) libraries matching the requested LibraryTypes.FindSpec.
List<String>	find(LibraryTypes.FindSpec spec, InvocationConfig invocationConfig) Returns a list of all the visible (as determined by authorization policy) libraries matching the requested LibraryTypes.FindSpec.
LibraryModel	get(String libraryId) Returns a given LibraryModel.
void	get(String libraryId, AsyncCallback<LibraryModel> asyncCallback) Returns a given LibraryModel.
void	get(String libraryId, AsyncCallback<LibraryModel> asyncCallback, InvocationConfig invocationConfig) Returns a given LibraryModel.
LibraryModel	get(String libraryId, InvocationConfig invocationConfig) Returns a given LibraryModel.
List<String>	list() Returns the identifiers of all libraries of any type in the Content Library.
void	list(AsyncCallback<List<String>> asyncCallback) Returns the identifiers of all libraries of any type in the Content Library.
void	list(AsyncCallback<List<String>> asyncCallback, InvocationConfig invocationConfig) Returns the identifiers of all libraries of any type in the Content Library.
List<String>	list(InvocationConfig invocationConfig) Returns the identifiers of all libraries of any type in the Content Library.
void	update(String libraryId, LibraryModel updateSpec) Updates the properties of a library.
void	update(String libraryId, LibraryModel updateSpec, AsyncCallback<Void> asyncCallback) Updates the properties of a library.
void	update(String libraryId, LibraryModel updateSpec, AsyncCallback<Void> asyncCallback, InvocationConfig invocationConfig) Updates the properties of a library.
void	update(String libraryId, LibraryModel updateSpec, InvocationConfig invocationConfig) Updates the properties of a library.

Method Detail

get

LibraryModel get(String libraryId)

Returns a given LibraryModel.

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

Parameters:

libraryId - Identifier of the library to return. The parameter must be an identifier for the resource type: com.vmware.content.Library.

Returns:

The LibraryModel instance with the specified libraryId.

Throws:

NotFound - if the specified library does not exist.

Unauthorized - if you do not have all of the privileges described as follows:

• The resource com.vmware.content.Library referenced by the parameter libraryId requires System.Read.

get

LibraryModel get(String libraryId,
               InvocationConfig invocationConfig)

Returns a given LibraryModel.

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:

libraryId - Identifier of the library to return. The parameter must be an identifier for the resource type: com.vmware.content.Library.

invocationConfig - Configuration for the method invocation.

Returns:

The LibraryModel instance with the specified libraryId.

Throws:

NotFound - if the specified library does not exist.

Unauthorized - if you do not have all of the privileges described as follows:

• The resource com.vmware.content.Library referenced by the parameter libraryId requires System.Read.

get

void get(String libraryId,
       AsyncCallback<LibraryModel> asyncCallback)

Returns a given LibraryModel.

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

Operation Result:
The LibraryModel instance with the specified libraryId.

Operation Errors:
NotFound - if the specified library does not exist.
Unauthorized - if you do not have all of the privileges described as follows:

• The resource com.vmware.content.Library referenced by the parameter libraryId requires System.Read.

Parameters:

libraryId - Identifier of the library to return. The parameter must be an identifier for the resource type: com.vmware.content.Library.

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

get

void get(String libraryId,
       AsyncCallback<LibraryModel> asyncCallback,
       InvocationConfig invocationConfig)

Returns a given LibraryModel.

Asynchronous method overload. Result of the invocation will be reported via the specified asyncCallback. Use invocationConfig to specify configuration for this particular invocation.

Operation Result:
The LibraryModel instance with the specified libraryId.

Operation Errors:
NotFound - if the specified library does not exist.
Unauthorized - if you do not have all of the privileges described as follows:

• The resource com.vmware.content.Library referenced by the parameter libraryId requires System.Read.

Parameters:

libraryId - Identifier of the library to return. The parameter must be an identifier for the resource type: com.vmware.content.Library.

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

invocationConfig - Configuration for the method invocation.

list

List<String> list()

Returns the identifiers of all libraries of any type in the Content Library.

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

Returns:

The List of all identifiers of all libraries in the Content Library. The return value will contain identifiers for the resource type: com.vmware.content.Library.

Throws:

Unauthorized - if you do not have all of the privileges described as follows:

• Method execution requires System.Read.

list

List<String> list(InvocationConfig invocationConfig)

Returns the identifiers of all libraries of any type in the Content Library.

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 all identifiers of all libraries in the Content Library. The return value will contain identifiers for the resource type: com.vmware.content.Library.

Throws:

Unauthorized - if you do not have all of the privileges described as follows:

• Method execution requires System.Read.

list

void list(AsyncCallback<List<String>> asyncCallback)

Returns the identifiers of all libraries of any type in the Content Library.

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

Operation Result:
The List of all identifiers of all libraries in the Content Library. The return value will contain identifiers for the resource type: com.vmware.content.Library.

Operation Errors:
Unauthorized - if you do not have all of the privileges described as follows:

• Method execution requires System.Read.

Parameters:

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

list

void list(AsyncCallback<List<String>> asyncCallback,
        InvocationConfig invocationConfig)

Returns the identifiers of all libraries of any type in the Content Library.

Asynchronous method overload. Result of the invocation will be reported via the specified asyncCallback. Use invocationConfig to specify configuration for this particular invocation.

Operation Result:
The List of all identifiers of all libraries in the Content Library. The return value will contain identifiers for the resource type: com.vmware.content.Library.

Operation Errors:
Unauthorized - if you do not have all of the privileges described as follows:

• Method execution requires System.Read.

Parameters:

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

invocationConfig - Configuration for the method invocation.

find

List<String> find(LibraryTypes.FindSpec spec)

Returns a list of all the visible (as determined by authorization policy) libraries matching the requested LibraryTypes.FindSpec.

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

Parameters:

spec - Specification describing what properties to filter on.

Returns:

The List of identifiers of all the visible libraries matching the given spec. The return value will contain identifiers for the resource type: com.vmware.content.Library.

Throws:

InvalidArgument - if no properties are specified in the spec.

Unauthorized - if you do not have all of the privileges described as follows:

• Method execution requires System.Read.

find

List<String> find(LibraryTypes.FindSpec spec,
                InvocationConfig invocationConfig)

Returns a list of all the visible (as determined by authorization policy) libraries matching the requested LibraryTypes.FindSpec.

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:

spec - Specification describing what properties to filter on.

invocationConfig - Configuration for the method invocation.

Returns:

The List of identifiers of all the visible libraries matching the given spec. The return value will contain identifiers for the resource type: com.vmware.content.Library.

Throws:

InvalidArgument - if no properties are specified in the spec.

Unauthorized - if you do not have all of the privileges described as follows:

• Method execution requires System.Read.

find

void find(LibraryTypes.FindSpec spec,
        AsyncCallback<List<String>> asyncCallback)

Returns a list of all the visible (as determined by authorization policy) libraries matching the requested LibraryTypes.FindSpec.

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

Operation Result:
The List of identifiers of all the visible libraries matching the given spec. The return value will contain identifiers for the resource type: com.vmware.content.Library.

Operation Errors:
InvalidArgument - if no properties are specified in the spec.
Unauthorized - if you do not have all of the privileges described as follows:

• Method execution requires System.Read.

Parameters:

spec - Specification describing what properties to filter on.

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

find

void find(LibraryTypes.FindSpec spec,
        AsyncCallback<List<String>> asyncCallback,
        InvocationConfig invocationConfig)

Returns a list of all the visible (as determined by authorization policy) libraries matching the requested LibraryTypes.FindSpec.

Asynchronous method overload. Result of the invocation will be reported via the specified asyncCallback. Use invocationConfig to specify configuration for this particular invocation.

Operation Result:
The List of identifiers of all the visible libraries matching the given spec. The return value will contain identifiers for the resource type: com.vmware.content.Library.

Operation Errors:
InvalidArgument - if no properties are specified in the spec.
Unauthorized - if you do not have all of the privileges described as follows:

• Method execution requires System.Read.

Parameters:

spec - Specification describing what properties to filter on.

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

invocationConfig - Configuration for the method invocation.

update

void update(String libraryId,
          LibraryModel updateSpec)

Updates the properties of a library.

This is an incremental update to the library. Any property in the LibraryModel class that is null will not be modified.

This method will only update the common properties for all library types. This will not, for example, update the LibraryModel.getPublishInfo() of a local library, nor the LibraryModel.getSubscriptionInfo() of a subscribed library. Specific properties are updated in LocalLibrary.update(java.lang.String, com.vmware.content.LibraryModel) and SubscribedLibrary.update(java.lang.String, com.vmware.content.LibraryModel).

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

Parameters:

libraryId - Identifier of the library to update. The parameter must be an identifier for the resource type: com.vmware.content.Library.

updateSpec - Specification of the new property values to set on the library.

Throws:

NotFound - if the library associated with libraryId does not exist.

InvalidArgument - if the updateSpec is not valid.

InvalidArgument - if the LibraryModel.getVersion() of updateSpec is not equal to the current version of the library.

Unauthorized - if you do not have all of the privileges described as follows:

• The resource com.vmware.content.Library referenced by the parameter libraryId requires ContentLibrary.UpdateLibrary.

update

void update(String libraryId,
          LibraryModel updateSpec,
          InvocationConfig invocationConfig)

Updates the properties of a library.

This is an incremental update to the library. Any property in the LibraryModel class that is null will not be modified.

This method will only update the common properties for all library types. This will not, for example, update the LibraryModel.getPublishInfo() of a local library, nor the LibraryModel.getSubscriptionInfo() of a subscribed library. Specific properties are updated in LocalLibrary.update(java.lang.String, com.vmware.content.LibraryModel) and SubscribedLibrary.update(java.lang.String, com.vmware.content.LibraryModel).

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:

libraryId - Identifier of the library to update. The parameter must be an identifier for the resource type: com.vmware.content.Library.

updateSpec - Specification of the new property values to set on the library.

invocationConfig - Configuration for the method invocation.

Throws:

NotFound - if the library associated with libraryId does not exist.

InvalidArgument - if the updateSpec is not valid.

InvalidArgument - if the LibraryModel.getVersion() of updateSpec is not equal to the current version of the library.

Unauthorized - if you do not have all of the privileges described as follows:

• The resource com.vmware.content.Library referenced by the parameter libraryId requires ContentLibrary.UpdateLibrary.

update

void update(String libraryId,
          LibraryModel updateSpec,
          AsyncCallback<Void> asyncCallback)

Updates the properties of a library.

This is an incremental update to the library. Any property in the LibraryModel class that is null will not be modified.

This method will only update the common properties for all library types. This will not, for example, update the LibraryModel.getPublishInfo() of a local library, nor the LibraryModel.getSubscriptionInfo() of a subscribed library. Specific properties are updated in LocalLibrary.update(java.lang.String, com.vmware.content.LibraryModel) and SubscribedLibrary.update(java.lang.String, com.vmware.content.LibraryModel).

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

Operation Errors:
NotFound - if the library associated with libraryId does not exist.
InvalidArgument - if the updateSpec is not valid.
InvalidArgument - if the LibraryModel.getVersion() of updateSpec is not equal to the current version of the library.
Unauthorized - if you do not have all of the privileges described as follows:

• The resource com.vmware.content.Library referenced by the parameter libraryId requires ContentLibrary.UpdateLibrary.

Parameters:

libraryId - Identifier of the library to update. The parameter must be an identifier for the resource type: com.vmware.content.Library.

updateSpec - Specification of the new property values to set on the library.

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

update

void update(String libraryId,
          LibraryModel updateSpec,
          AsyncCallback<Void> asyncCallback,
          InvocationConfig invocationConfig)

Updates the properties of a library.

This is an incremental update to the library. Any property in the LibraryModel class that is null will not be modified.

This method will only update the common properties for all library types. This will not, for example, update the LibraryModel.getPublishInfo() of a local library, nor the LibraryModel.getSubscriptionInfo() of a subscribed library. Specific properties are updated in LocalLibrary.update(java.lang.String, com.vmware.content.LibraryModel) and SubscribedLibrary.update(java.lang.String, com.vmware.content.LibraryModel).

Asynchronous method overload. Result of the invocation will be reported via the specified asyncCallback. Use invocationConfig to specify configuration for this particular invocation.

Operation Errors:
NotFound - if the library associated with libraryId does not exist.
InvalidArgument - if the updateSpec is not valid.
InvalidArgument - if the LibraryModel.getVersion() of updateSpec is not equal to the current version of the library.
Unauthorized - if you do not have all of the privileges described as follows:

• The resource com.vmware.content.Library referenced by the parameter libraryId requires ContentLibrary.UpdateLibrary.

Parameters:

libraryId - Identifier of the library to update. The parameter must be an identifier for the resource type: com.vmware.content.Library.

updateSpec - Specification of the new property values to set on the library.

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

invocationConfig - Configuration for the method invocation.