com.vmware.cis.tagging

Interface Category

All Superinterfaces:

CategoryTypes, Service

All Known Implementing Classes:

CategoryStub

public interface Category
extends Service, CategoryTypes

The Category interface provides methods to create, read, update, delete, and enumerate categories.

Nested Class Summary

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

CategoryTypes.CreateSpec, CategoryTypes.UpdateSpec

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.

Method Detail

create

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

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.

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.

Throws:

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.

create

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

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.

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.

Throws:

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.

create

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

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.

Parameters:

createSpec - Specification for the new category to be created.

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

create

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

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.

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

CategoryModel get(java.lang.String categoryId)

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.

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.

Throws:

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.

get

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

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.

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.

Throws:

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.

get

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

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.

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

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

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.

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

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

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.

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.

Throws:

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.

update

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

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.

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.

Throws:

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.

update

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

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.

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

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

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.

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

void delete(java.lang.String categoryId)

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.

Parameters:

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

Throws:

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.

delete

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

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.

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.

Throws:

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.

delete

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

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.

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

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

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.

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

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

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.

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

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

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.

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

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

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.

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)

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.

Parameters:

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

invocationConfig - Configuration for the method invocation.

listUsedCategories

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. 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.

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

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. 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.

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

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. 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.

Parameters:

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

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

listUsedCategories

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. 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.

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

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

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.

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.

Throws:

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.

addToUsedBy

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. 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.

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.

Throws:

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.

addToUsedBy

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. 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.

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

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. 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.

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

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

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.

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.

Throws:

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.

removeFromUsedBy

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

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.

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.

Throws:

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.

removeFromUsedBy

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

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.

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

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. 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.

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

void revokePropagatingPermissions(java.lang.String categoryId)

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.

Parameters:

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

Throws:

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.

revokePropagatingPermissions

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

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.

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.

Throws:

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.

revokePropagatingPermissions

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

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.

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

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

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.

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.