com.vmware.cis.tagging

Class CategoryStub

java.lang.Object

com.vmware.vapi.internal.bindings.Stub

com.vmware.cis.tagging.CategoryStub

All Implemented Interfaces:

Category, CategoryTypes, Service

public class CategoryStub
extends com.vmware.vapi.internal.bindings.Stub
implements Category

Remote stub implementation of the Category API service.

WARNING: Internal class, subject to change in future versions.

Nested Class Summary

Nested classes/interfaces inherited from interface com.vmware.cis.tagging.CategoryTypes

CategoryTypes.CreateSpec, CategoryTypes.UpdateSpec

Field Summary

Fields inherited from class com.vmware.vapi.internal.bindings.Stub

apiProvider, converter, ifaceId, securityContext

Constructor Summary

Constructors

Constructor and Description
CategoryStub(ApiProvider apiProvider, StubConfigurationBase config)
CategoryStub(ApiProvider apiProvider, com.vmware.vapi.internal.bindings.TypeConverter typeConverter, StubConfigurationBase config)

Method Summary

Methods

Modifier and Type	Method and Description
void	addToUsedBy(java.lang.String categoryId, java.lang.String usedByEntity) Adds the usedByEntity to the CategoryModel.getUsedBy() subscribers Set for the specified category.
void	addToUsedBy(java.lang.String categoryId, java.lang.String usedByEntity, AsyncCallback<java.lang.Void> asyncCallback) Adds the usedByEntity to the CategoryModel.getUsedBy() subscribers Set for the specified category.
void	addToUsedBy(java.lang.String categoryId, java.lang.String usedByEntity, AsyncCallback<java.lang.Void> asyncCallback, InvocationConfig invocationConfig) Adds the usedByEntity to the CategoryModel.getUsedBy() subscribers Set for the specified category.
void	addToUsedBy(java.lang.String categoryId, java.lang.String usedByEntity, InvocationConfig invocationConfig) Adds the usedByEntity to the CategoryModel.getUsedBy() subscribers Set for the specified category.
java.lang.String	create(CategoryTypes.CreateSpec createSpec) Creates a category.
void	create(CategoryTypes.CreateSpec createSpec, AsyncCallback<java.lang.String> asyncCallback) Creates a category.
void	create(CategoryTypes.CreateSpec createSpec, AsyncCallback<java.lang.String> asyncCallback, InvocationConfig invocationConfig) Creates a category.
java.lang.String	create(CategoryTypes.CreateSpec createSpec, InvocationConfig invocationConfig) Creates a category.
void	delete(java.lang.String categoryId) Deletes an existing category.
void	delete(java.lang.String categoryId, AsyncCallback<java.lang.Void> asyncCallback) Deletes an existing category.
void	delete(java.lang.String categoryId, AsyncCallback<java.lang.Void> asyncCallback, InvocationConfig invocationConfig) Deletes an existing category.
void	delete(java.lang.String categoryId, InvocationConfig invocationConfig) Deletes an existing category.
CategoryModel	get(java.lang.String categoryId) Fetches the category information for the given category identifier.
void	get(java.lang.String categoryId, AsyncCallback<CategoryModel> asyncCallback) Fetches the category information for the given category identifier.
void	get(java.lang.String categoryId, AsyncCallback<CategoryModel> asyncCallback, InvocationConfig invocationConfig) Fetches the category information for the given category identifier.
CategoryModel	get(java.lang.String categoryId, InvocationConfig invocationConfig) Fetches the category information for the given category identifier.
java.util.List<java.lang.String>	list() Enumerates the categories in the system.
void	list(AsyncCallback<java.util.List<java.lang.String>> asyncCallback) Enumerates the categories in the system.
void	list(AsyncCallback<java.util.List<java.lang.String>> asyncCallback, InvocationConfig invocationConfig) Enumerates the categories in the system.
java.util.List<java.lang.String>	list(InvocationConfig invocationConfig) Enumerates the categories in the system.
java.util.List<java.lang.String>	listUsedCategories(java.lang.String usedByEntity) Enumerates all categories for which the usedByEntity is part of the CategoryModel.getUsedBy() subscribers Set.
void	listUsedCategories(java.lang.String usedByEntity, AsyncCallback<java.util.List<java.lang.String>> asyncCallback) Enumerates all categories for which the usedByEntity is part of the CategoryModel.getUsedBy() subscribers Set.
void	listUsedCategories(java.lang.String usedByEntity, AsyncCallback<java.util.List<java.lang.String>> asyncCallback, InvocationConfig invocationConfig) Enumerates all categories for which the usedByEntity is part of the CategoryModel.getUsedBy() subscribers Set.
java.util.List<java.lang.String>	listUsedCategories(java.lang.String usedByEntity, InvocationConfig invocationConfig) Enumerates all categories for which the usedByEntity is part of the CategoryModel.getUsedBy() subscribers Set.
void	removeFromUsedBy(java.lang.String categoryId, java.lang.String usedByEntity) Removes the usedByEntity from the CategoryModel.getUsedBy() subscribers Set.
void	removeFromUsedBy(java.lang.String categoryId, java.lang.String usedByEntity, AsyncCallback<java.lang.Void> asyncCallback) Removes the usedByEntity from the CategoryModel.getUsedBy() subscribers Set.
void	removeFromUsedBy(java.lang.String categoryId, java.lang.String usedByEntity, AsyncCallback<java.lang.Void> asyncCallback, InvocationConfig invocationConfig) Removes the usedByEntity from the CategoryModel.getUsedBy() subscribers Set.
void	removeFromUsedBy(java.lang.String categoryId, java.lang.String usedByEntity, InvocationConfig invocationConfig) Removes the usedByEntity from the CategoryModel.getUsedBy() subscribers Set.
void	revokePropagatingPermissions(java.lang.String categoryId) Revokes all propagating permissions on the given category.
void	revokePropagatingPermissions(java.lang.String categoryId, AsyncCallback<java.lang.Void> asyncCallback) Revokes all propagating permissions on the given category.
void	revokePropagatingPermissions(java.lang.String categoryId, AsyncCallback<java.lang.Void> asyncCallback, InvocationConfig invocationConfig) Revokes all propagating permissions on the given category.
void	revokePropagatingPermissions(java.lang.String categoryId, InvocationConfig invocationConfig) Revokes all propagating permissions on the given category.
void	update(java.lang.String categoryId, CategoryTypes.UpdateSpec updateSpec) Updates an existing category.
void	update(java.lang.String categoryId, CategoryTypes.UpdateSpec updateSpec, AsyncCallback<java.lang.Void> asyncCallback) Updates an existing category.
void	update(java.lang.String categoryId, CategoryTypes.UpdateSpec updateSpec, AsyncCallback<java.lang.Void> asyncCallback, InvocationConfig invocationConfig) Updates an existing category.
void	update(java.lang.String categoryId, CategoryTypes.UpdateSpec updateSpec, InvocationConfig invocationConfig) Updates an existing category.

Methods inherited from class com.vmware.vapi.internal.bindings.Stub

invokeMethod, invokeMethodAsync, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

CategoryStub

public CategoryStub(ApiProvider apiProvider,
            com.vmware.vapi.internal.bindings.TypeConverter typeConverter,
            StubConfigurationBase config)

CategoryStub

public CategoryStub(ApiProvider apiProvider,
            StubConfigurationBase config)

Method Detail

create

public java.lang.String create(CategoryTypes.CreateSpec createSpec)

Description copied from interface: Category

Creates a category. To invoke this method, you need the create category privilege.

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

Specified by:

create in interface Category

Parameters:

createSpec - Specification for the new category to be created.

Returns:

The identifier of the created category. The return value will be an identifier for the resource type: com.vmware.cis.tagging.Category.

create

public java.lang.String create(CategoryTypes.CreateSpec createSpec,
                      InvocationConfig invocationConfig)

Description copied from interface: Category

Creates a category. To invoke this method, you need the create category privilege.

Synchronous method overload. Result of the invocation will be reported as a method return value. Use invocationConfig to specify configuration for this particular invocation.

Specified by:

create in interface Category

Parameters:

createSpec - Specification for the new category to be created.

invocationConfig - Configuration for the method invocation.

Returns:

The identifier of the created category. The return value will be an identifier for the resource type: com.vmware.cis.tagging.Category.

create

public void create(CategoryTypes.CreateSpec createSpec,
          AsyncCallback<java.lang.String> asyncCallback)

Description copied from interface: Category

Creates a category. To invoke this method, you need the create category privilege.

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

Operation Result:
The identifier of the created category. The return value will be an identifier for the resource type: com.vmware.cis.tagging.Category.

Operation Errors:
AlreadyExists - if the CategoryTypes.CreateSpec.getName() provided in the createSpec is the name of an already existing category.
InvalidArgument - if any of the information in the createSpec is invalid.
Unauthorized - if you do not have the privilege to create a category.

Specified by:

create in interface Category

Parameters:

createSpec - Specification for the new category to be created.

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

create

public void create(CategoryTypes.CreateSpec createSpec,
          AsyncCallback<java.lang.String> asyncCallback,
          InvocationConfig invocationConfig)

Description copied from interface: Category

Creates a category. To invoke this method, you need the create category privilege.

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 identifier of the created category. The return value will be an identifier for the resource type: com.vmware.cis.tagging.Category.

Operation Errors:
AlreadyExists - if the CategoryTypes.CreateSpec.getName() provided in the createSpec is the name of an already existing category.
InvalidArgument - if any of the information in the createSpec is invalid.
Unauthorized - if you do not have the privilege to create a category.

Specified by:

create in interface Category

Parameters:

createSpec - Specification for the new category to be created.

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

invocationConfig - Configuration for the method invocation.

get

public CategoryModel get(java.lang.String categoryId)

Description copied from interface: Category

Fetches the category information for the given category identifier. In order to view the category information, you need the read privilege on the category.

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

Specified by:

get in interface Category

Parameters:

categoryId - The identifier of the input category. The parameter must be an identifier for the resource type: com.vmware.cis.tagging.Category.

Returns:

The CategoryModel that corresponds to categoryId.

get

public CategoryModel get(java.lang.String categoryId,
                InvocationConfig invocationConfig)

Description copied from interface: Category

Fetches the category information for the given category identifier. In order to view the category information, you need the read privilege on the category.

Synchronous method overload. Result of the invocation will be reported as a method return value. Use invocationConfig to specify configuration for this particular invocation.

Specified by:

get in interface Category

Parameters:

categoryId - The identifier of the input category. The parameter must be an identifier for the resource type: com.vmware.cis.tagging.Category.

invocationConfig - Configuration for the method invocation.

Returns:

The CategoryModel that corresponds to categoryId.

get

public void get(java.lang.String categoryId,
       AsyncCallback<CategoryModel> asyncCallback)

Description copied from interface: Category

Fetches the category information for the given category identifier. In order to view the category information, you need the read privilege on the category.

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

Operation Result:
The CategoryModel that corresponds to categoryId.

Operation Errors:
NotFound - if the category for the given categoryId does not exist in the system.
Unauthorized - if you do not have the privilege to read the category.

Specified by:

get in interface Category

Parameters:

categoryId - The identifier of the input category. The parameter must be an identifier for the resource type: com.vmware.cis.tagging.Category.

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

get

public void get(java.lang.String categoryId,
       AsyncCallback<CategoryModel> asyncCallback,
       InvocationConfig invocationConfig)

Description copied from interface: Category

Fetches the category information for the given category identifier. In order to view the category information, you need the read privilege on the category.

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 CategoryModel that corresponds to categoryId.

Operation Errors:
NotFound - if the category for the given categoryId does not exist in the system.
Unauthorized - if you do not have the privilege to read the category.

Specified by:

get in interface Category

Parameters:

categoryId - The identifier of the input category. The parameter must be an identifier for the resource type: com.vmware.cis.tagging.Category.

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

invocationConfig - Configuration for the method invocation.

update

public void update(java.lang.String categoryId,
          CategoryTypes.UpdateSpec updateSpec)

Description copied from interface: Category

Updates an existing category. To invoke this method, you need the edit privilege on the category.

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

Specified by:

update in interface Category

Parameters:

categoryId - The identifier of the category to be updated. The parameter must be an identifier for the resource type: com.vmware.cis.tagging.Category.

updateSpec - Specification to update the category.

update

public void update(java.lang.String categoryId,
          CategoryTypes.UpdateSpec updateSpec,
          InvocationConfig invocationConfig)

Description copied from interface: Category

Updates an existing category. To invoke this method, you need the edit privilege on the category.

Synchronous method overload. Result of the invocation will be reported as a method return value. Use invocationConfig to specify configuration for this particular invocation.

Specified by:

update in interface Category

Parameters:

categoryId - The identifier of the category to be updated. The parameter must be an identifier for the resource type: com.vmware.cis.tagging.Category.

updateSpec - Specification to update the category.

invocationConfig - Configuration for the method invocation.

update

public void update(java.lang.String categoryId,
          CategoryTypes.UpdateSpec updateSpec,
          AsyncCallback<java.lang.Void> asyncCallback)

Description copied from interface: Category

Updates an existing category. To invoke this method, you need the edit privilege on the category.

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

Operation Errors:
AlreadyExists - if the CategoryTypes.UpdateSpec.getName() provided in the updateSpec is the name of an already existing category.
InvalidArgument - if any of the information in the updateSpec is invalid.
NotFound - if the category for the given categoryId does not exist in the system.
Unauthorized - if you do not have the privilege to update the category.

Specified by:

update in interface Category

Parameters:

categoryId - The identifier of the category to be updated. The parameter must be an identifier for the resource type: com.vmware.cis.tagging.Category.

updateSpec - Specification to update the category.

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

update

public void update(java.lang.String categoryId,
          CategoryTypes.UpdateSpec updateSpec,
          AsyncCallback<java.lang.Void> asyncCallback,
          InvocationConfig invocationConfig)

Description copied from interface: Category

Updates an existing category. To invoke this method, you need the edit privilege on the category.

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:
AlreadyExists - if the CategoryTypes.UpdateSpec.getName() provided in the updateSpec is the name of an already existing category.
InvalidArgument - if any of the information in the updateSpec is invalid.
NotFound - if the category for the given categoryId does not exist in the system.
Unauthorized - if you do not have the privilege to update the category.

Specified by:

update in interface Category

Parameters:

categoryId - The identifier of the category to be updated. The parameter must be an identifier for the resource type: com.vmware.cis.tagging.Category.

updateSpec - Specification to update the category.

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

invocationConfig - Configuration for the method invocation.

delete

public void delete(java.lang.String categoryId)

Description copied from interface: Category

Deletes an existing category. To invoke this method, you need the delete privilege on the category.

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

Specified by:

delete in interface Category

Parameters:

categoryId - The identifier of category to be deleted. The parameter must be an identifier for the resource type: com.vmware.cis.tagging.Category.

delete

public void delete(java.lang.String categoryId,
          InvocationConfig invocationConfig)

Description copied from interface: Category

Deletes an existing category. To invoke this method, you need the delete privilege on the category.

Synchronous method overload. Result of the invocation will be reported as a method return value. Use invocationConfig to specify configuration for this particular invocation.

Specified by:

delete in interface Category

Parameters:

categoryId - The identifier of category to be deleted. The parameter must be an identifier for the resource type: com.vmware.cis.tagging.Category.

invocationConfig - Configuration for the method invocation.

delete

public void delete(java.lang.String categoryId,
          AsyncCallback<java.lang.Void> asyncCallback)

Description copied from interface: Category

Deletes an existing category. To invoke this method, you need the delete privilege on the category.

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

Operation Errors:
NotFound - if the category for the given categoryId does not exist in the system.
Unauthorized - if you do not have the privilege to delete the category.

Specified by:

delete in interface Category

Parameters:

categoryId - The identifier of category to be deleted. The parameter must be an identifier for the resource type: com.vmware.cis.tagging.Category.

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

delete

public void delete(java.lang.String categoryId,
          AsyncCallback<java.lang.Void> asyncCallback,
          InvocationConfig invocationConfig)

Description copied from interface: Category

Deletes an existing category. To invoke this method, you need the delete privilege on the category.

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 category for the given categoryId does not exist in the system.
Unauthorized - if you do not have the privilege to delete the category.

Specified by:

delete in interface Category

Parameters:

categoryId - The identifier of category to be deleted. The parameter must be an identifier for the resource type: com.vmware.cis.tagging.Category.

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

invocationConfig - Configuration for the method invocation.

list

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

Description copied from interface: Category

Enumerates the categories in the system. To invoke this method, you need the read privilege on the individual categories. The List will only contain those categories for which you have read privileges.

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

Specified by:

list in interface Category

Returns:

The List of resource identifiers for the categories in the system. The return value will contain identifiers for the resource type: com.vmware.cis.tagging.Category.

list

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

Description copied from interface: Category

Enumerates the categories in the system. To invoke this method, you need the read privilege on the individual categories. The List will only contain those categories for which you have read privileges.

Synchronous method overload. Result of the invocation will be reported as a method return value. Use invocationConfig to specify configuration for this particular invocation.

Specified by:

list in interface Category

Parameters:

invocationConfig - Configuration for the method invocation.

Returns:

The List of resource identifiers for the categories in the system. The return value will contain identifiers for the resource type: com.vmware.cis.tagging.Category.

list

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

Description copied from interface: Category

Enumerates the categories in the system. To invoke this method, you need the read privilege on the individual categories. The List will only contain those categories for which you have read privileges.

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

Operation Result:
The List of resource identifiers for the categories in the system. The return value will contain identifiers for the resource type: com.vmware.cis.tagging.Category.

Specified by:

list in interface Category

Parameters:

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

list

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

Description copied from interface: Category

Enumerates the categories in the system. To invoke this method, you need the read privilege on the individual categories. The List will only contain those categories for which you have read privileges.

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 resource identifiers for the categories in the system. The return value will contain identifiers for the resource type: com.vmware.cis.tagging.Category.

Specified by:

list in interface Category

Parameters:

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

invocationConfig - Configuration for the method invocation.

listUsedCategories

public java.util.List<java.lang.String> listUsedCategories(java.lang.String usedByEntity)

Description copied from interface: Category

Enumerates all categories for which the usedByEntity is part of the CategoryModel.getUsedBy() subscribers Set. To invoke this method, you need the read privilege on the individual categories.

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

Specified by:

listUsedCategories in interface Category

Parameters:

usedByEntity - The field on which the results will be filtered.

Returns:

The List of resource identifiers for the categories in the system that are used by usedByEntity. The return value will contain identifiers for the resource type: com.vmware.cis.tagging.Category.

listUsedCategories

public java.util.List<java.lang.String> listUsedCategories(java.lang.String usedByEntity,
                                                  InvocationConfig invocationConfig)

Description copied from interface: Category

Enumerates all categories for which the usedByEntity is part of the CategoryModel.getUsedBy() subscribers Set. To invoke this method, you need the read privilege on the individual categories.

Synchronous method overload. Result of the invocation will be reported as a method return value. Use invocationConfig to specify configuration for this particular invocation.

Specified by:

listUsedCategories in interface Category

Parameters:

usedByEntity - The field on which the results will be filtered.

invocationConfig - Configuration for the method invocation.

Returns:

The List of resource identifiers for the categories in the system that are used by usedByEntity. The return value will contain identifiers for the resource type: com.vmware.cis.tagging.Category.

listUsedCategories

public void listUsedCategories(java.lang.String usedByEntity,
                      AsyncCallback<java.util.List<java.lang.String>> asyncCallback)

Description copied from interface: Category

Enumerates all categories for which the usedByEntity is part of the CategoryModel.getUsedBy() subscribers Set. To invoke this method, you need the read privilege on the individual categories.

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

Operation Result:
The List of resource identifiers for the categories in the system that are used by usedByEntity. The return value will contain identifiers for the resource type: com.vmware.cis.tagging.Category.

Specified by:

listUsedCategories in interface Category

Parameters:

usedByEntity - The field on which the results will be filtered.

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

listUsedCategories

public void listUsedCategories(java.lang.String usedByEntity,
                      AsyncCallback<java.util.List<java.lang.String>> asyncCallback,
                      InvocationConfig invocationConfig)

Description copied from interface: Category

Enumerates all categories for which the usedByEntity is part of the CategoryModel.getUsedBy() subscribers Set. To invoke this method, you need the read privilege on the individual categories.

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 resource identifiers for the categories in the system that are used by usedByEntity. The return value will contain identifiers for the resource type: com.vmware.cis.tagging.Category.

Specified by:

listUsedCategories in interface Category

Parameters:

usedByEntity - The field on which the results will be filtered.

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

invocationConfig - Configuration for the method invocation.

addToUsedBy

public void addToUsedBy(java.lang.String categoryId,
               java.lang.String usedByEntity)

Description copied from interface: Category

Adds the usedByEntity to the CategoryModel.getUsedBy() subscribers Set for the specified category. If the usedByEntity is already in the Set, then this becomes an idempotent no-op. To invoke this method, you need the modify CategoryModel.getUsedBy() privilege on the category.

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

Specified by:

addToUsedBy in interface Category

Parameters:

categoryId - The identifier of the input category. The parameter must be an identifier for the resource type: com.vmware.cis.tagging.Category.

usedByEntity - The name of the user to be added to the CategoryModel.getUsedBy() Set.

addToUsedBy

public void addToUsedBy(java.lang.String categoryId,
               java.lang.String usedByEntity,
               InvocationConfig invocationConfig)

Description copied from interface: Category

Adds the usedByEntity to the CategoryModel.getUsedBy() subscribers Set for the specified category. If the usedByEntity is already in the Set, then this becomes an idempotent no-op. To invoke this method, you need the modify CategoryModel.getUsedBy() privilege on the category.

Synchronous method overload. Result of the invocation will be reported as a method return value. Use invocationConfig to specify configuration for this particular invocation.

Specified by:

addToUsedBy in interface Category

Parameters:

categoryId - The identifier of the input category. The parameter must be an identifier for the resource type: com.vmware.cis.tagging.Category.

usedByEntity - The name of the user to be added to the CategoryModel.getUsedBy() Set.

invocationConfig - Configuration for the method invocation.

addToUsedBy

public void addToUsedBy(java.lang.String categoryId,
               java.lang.String usedByEntity,
               AsyncCallback<java.lang.Void> asyncCallback)

Description copied from interface: Category

Adds the usedByEntity to the CategoryModel.getUsedBy() subscribers Set for the specified category. If the usedByEntity is already in the Set, then this becomes an idempotent no-op. To invoke this method, you need the modify CategoryModel.getUsedBy() privilege on the category.

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

Operation Errors:
NotFound - if the category for the given categoryId does not exist in the system.
Unauthorized - if you do not have the privilege to add an entity to the CategoryModel.getUsedBy() field.

Specified by:

addToUsedBy in interface Category

Parameters:

categoryId - The identifier of the input category. The parameter must be an identifier for the resource type: com.vmware.cis.tagging.Category.

usedByEntity - The name of the user to be added to the CategoryModel.getUsedBy() Set.

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

addToUsedBy

public void addToUsedBy(java.lang.String categoryId,
               java.lang.String usedByEntity,
               AsyncCallback<java.lang.Void> asyncCallback,
               InvocationConfig invocationConfig)

Description copied from interface: Category

Adds the usedByEntity to the CategoryModel.getUsedBy() subscribers Set for the specified category. If the usedByEntity is already in the Set, then this becomes an idempotent no-op. To invoke this method, you need the modify CategoryModel.getUsedBy() privilege on the category.

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 category for the given categoryId does not exist in the system.
Unauthorized - if you do not have the privilege to add an entity to the CategoryModel.getUsedBy() field.

Specified by:

addToUsedBy in interface Category

Parameters:

categoryId - The identifier of the input category. The parameter must be an identifier for the resource type: com.vmware.cis.tagging.Category.

usedByEntity - The name of the user to be added to the CategoryModel.getUsedBy() Set.

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

invocationConfig - Configuration for the method invocation.

removeFromUsedBy

public void removeFromUsedBy(java.lang.String categoryId,
                    java.lang.String usedByEntity)

Description copied from interface: Category

Removes the usedByEntity from the CategoryModel.getUsedBy() subscribers Set. If the usedByEntity is not using this category, then this becomes a no-op. To invoke this method, you need the modify CategoryModel.getUsedBy() privilege on the category.

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

Specified by:

removeFromUsedBy in interface Category

Parameters:

categoryId - The identifier of the input category. The parameter must be an identifier for the resource type: com.vmware.cis.tagging.Category.

usedByEntity - The name of the user to be removed from the CategoryModel.getUsedBy() Set.

removeFromUsedBy

public void removeFromUsedBy(java.lang.String categoryId,
                    java.lang.String usedByEntity,
                    InvocationConfig invocationConfig)

Description copied from interface: Category

Removes the usedByEntity from the CategoryModel.getUsedBy() subscribers Set. If the usedByEntity is not using this category, then this becomes a no-op. To invoke this method, you need the modify CategoryModel.getUsedBy() privilege on the category.

Synchronous method overload. Result of the invocation will be reported as a method return value. Use invocationConfig to specify configuration for this particular invocation.

Specified by:

removeFromUsedBy in interface Category

Parameters:

categoryId - The identifier of the input category. The parameter must be an identifier for the resource type: com.vmware.cis.tagging.Category.

usedByEntity - The name of the user to be removed from the CategoryModel.getUsedBy() Set.

invocationConfig - Configuration for the method invocation.

removeFromUsedBy

public void removeFromUsedBy(java.lang.String categoryId,
                    java.lang.String usedByEntity,
                    AsyncCallback<java.lang.Void> asyncCallback)

Description copied from interface: Category

Removes the usedByEntity from the CategoryModel.getUsedBy() subscribers Set. If the usedByEntity is not using this category, then this becomes a no-op. To invoke this method, you need the modify CategoryModel.getUsedBy() privilege on the category.

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

Operation Errors:
NotFound - if the category for the given categoryId does not exist in the system.
Unauthorized - if you do not have the privilege to remove an entity from the CategoryModel.getUsedBy() field.

Specified by:

removeFromUsedBy in interface Category

Parameters:

categoryId - The identifier of the input category. The parameter must be an identifier for the resource type: com.vmware.cis.tagging.Category.

usedByEntity - The name of the user to be removed from the CategoryModel.getUsedBy() Set.

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

removeFromUsedBy

public void removeFromUsedBy(java.lang.String categoryId,
                    java.lang.String usedByEntity,
                    AsyncCallback<java.lang.Void> asyncCallback,
                    InvocationConfig invocationConfig)

Description copied from interface: Category

Removes the usedByEntity from the CategoryModel.getUsedBy() subscribers Set. If the usedByEntity is not using this category, then this becomes a no-op. To invoke this method, you need the modify CategoryModel.getUsedBy() privilege on the category.

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 category for the given categoryId does not exist in the system.
Unauthorized - if you do not have the privilege to remove an entity from the CategoryModel.getUsedBy() field.

Specified by:

removeFromUsedBy in interface Category

Parameters:

categoryId - The identifier of the input category. The parameter must be an identifier for the resource type: com.vmware.cis.tagging.Category.

usedByEntity - The name of the user to be removed from the CategoryModel.getUsedBy() Set.

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

invocationConfig - Configuration for the method invocation.

revokePropagatingPermissions

public void revokePropagatingPermissions(java.lang.String categoryId)

Description copied from interface: Category

Revokes all propagating permissions on the given category. You should then attach a direct permission with tagging privileges on the given category. To invoke this method, you need category related privileges (direct or propagating) on the concerned category.

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

Specified by:

revokePropagatingPermissions in interface Category

Parameters:

categoryId - The identifier of the input category. The parameter must be an identifier for the resource type: com.vmware.cis.tagging.Category.

revokePropagatingPermissions

public void revokePropagatingPermissions(java.lang.String categoryId,
                                InvocationConfig invocationConfig)

Description copied from interface: Category

Revokes all propagating permissions on the given category. You should then attach a direct permission with tagging privileges on the given category. To invoke this method, you need category related privileges (direct or propagating) on the concerned category.

Synchronous method overload. Result of the invocation will be reported as a method return value. Use invocationConfig to specify configuration for this particular invocation.

Specified by:

revokePropagatingPermissions in interface Category

Parameters:

categoryId - The identifier of the input category. The parameter must be an identifier for the resource type: com.vmware.cis.tagging.Category.

invocationConfig - Configuration for the method invocation.

revokePropagatingPermissions

public void revokePropagatingPermissions(java.lang.String categoryId,
                                AsyncCallback<java.lang.Void> asyncCallback)

Description copied from interface: Category

Revokes all propagating permissions on the given category. You should then attach a direct permission with tagging privileges on the given category. To invoke this method, you need category related privileges (direct or propagating) on the concerned category.

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

Operation Errors:
NotFound - if the category for the given categoryId does not exist in the system.
Unauthorized - if you do not have the privilege to revoke propagating permissions on the category.

Specified by:

revokePropagatingPermissions in interface Category

Parameters:

categoryId - The identifier of the input category. The parameter must be an identifier for the resource type: com.vmware.cis.tagging.Category.

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

revokePropagatingPermissions

public void revokePropagatingPermissions(java.lang.String categoryId,
                                AsyncCallback<java.lang.Void> asyncCallback,
                                InvocationConfig invocationConfig)

Description copied from interface: Category

Revokes all propagating permissions on the given category. You should then attach a direct permission with tagging privileges on the given category. To invoke this method, you need category related privileges (direct or propagating) on the concerned category.

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 category for the given categoryId does not exist in the system.
Unauthorized - if you do not have the privilege to revoke propagating permissions on the category.

Specified by:

revokePropagatingPermissions in interface Category

Parameters:

categoryId - The identifier of the input category. The parameter must be an identifier for the resource type: com.vmware.cis.tagging.Category.

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

invocationConfig - Configuration for the method invocation.