com.ibm.portal.cp.resources
Interface ModifiableCustomResource

All Superinterfaces:

CustomResource, Identifiable, Localized, Modifiable, ModifiableResource, Resource, TimeStamped

public interface ModifiableCustomResource
extends ModifiableResource, CustomResource

ModifiableCustomResource: the interface for a modifiable CustomResource, which can be updated.

Since:

7.0.0

Method Summary

boolean	addCategories(java.util.Set<java.lang.String> categories) Adds categories to the already existing categories.
boolean	addCategory(java.lang.String category) Adds a category to the already existing categories.
boolean	confirmAddCategories(java.util.Set<java.lang.String> aCategoriesSet) Indicates if the specified categories may be set.
boolean	confirmAddCategory(java.lang.String aCategory) Indicates if the specified category may be set.
boolean	confirmRemoveCategories() Indicates if all categories may be removed.
boolean	confirmRemoveCategory(java.lang.String aCategory) Indicates if the specified categories may be removed.
boolean	removeCategories() Clears all Categories.
boolean	removeCategory(java.lang.String aCategory) Removes a category.

Methods inherited from interface com.ibm.portal.cp.resources.CustomResource

getCategories

Methods inherited from interface com.ibm.portal.cp.resources.Resource

getCreated, getLastModified, getObjectID, getSchemeSpecificPart, getTypeSchema, getURI

Methods inherited from interface com.ibm.portal.Localized

getDescription, getLocales, getTitle

Method Detail

addCategory

boolean addCategory(java.lang.String category)
                    throws CannotModifyPropertyException

Adds a category to the already existing categories. Duplicate values will be ignored.

Parameters:

category - The category to add, must not be null.

Returns:

true if the category was added

Throws:

CannotModifyPropertyException - in case the category cannot be added

addCategories

boolean addCategories(java.util.Set<java.lang.String> categories)
                      throws CannotModifyPropertyException

Adds categories to the already existing categories. Duplicate values will be ignored.

Parameters:

categories - The categories to add, must not be null.

Returns:

true if the categories of this resource were changed as a result of this call

Throws:

CannotModifyPropertyException - in case a category cannot be added; in this case the categories are added only partially

removeCategory

boolean removeCategory(java.lang.String aCategory)
                       throws CannotModifyPropertyException

Removes a category.

Parameters:

aCategory - category to remove; must not be null

Returns:

true if this CustomResource was changed as a result of this call

Throws:

CannotModifyPropertyException - in case the category cannot be removed

removeCategories

boolean removeCategories()
                         throws CannotModifyPropertyException

Clears all Categories.

Returns:

true if this ModifiableCustomResource was changed as a result of this call

Throws:

CannotModifyPropertyException - in case a category cannot be removed; in this case the categories are removed only partially

confirmAddCategory

boolean confirmAddCategory(java.lang.String aCategory)

Indicates if the specified category may be set.

Parameters:

aCategory - category for which to indicate if it may be set; must not be null

Returns:

true if the specified category may be set, false otherwise

confirmAddCategories

boolean confirmAddCategories(java.util.Set<java.lang.String> aCategoriesSet)

Indicates if the specified categories may be set.

Parameters:

aCategoriesSet - set of categories for which to indicate if they may be set; must not be null

Returns:

true if the specified categories may be set, false otherwise

confirmRemoveCategory

boolean confirmRemoveCategory(java.lang.String aCategory)

Indicates if the specified categories may be removed.

Parameters:

aCategory - category for which to indicate if it may be removed; must not be null

Returns:

true if the category may be removed, false otherwise

confirmRemoveCategories

boolean confirmRemoveCategories()

Indicates if all categories may be removed.

Returns:

true if all categories may be removed, false otherwise