com.ibm.portal.cp.tagging.controller
Interface TagCreationContext<R>

All Superinterfaces:

CreationContext

All Known Subinterfaces:

UserTagCreationContext<R>

public interface TagCreationContext<R>
extends CreationContext

CreationContext that exposes information common to all types of tagging creation context interfaces.

Since:

7.0.0

Method Summary

java.util.Set<java.lang.String>	getCategories() Returns a set of categories the resource the tag is being associated to belongs to.
java.util.Locale	getLocale() Returns the locale of the tag
ObjectID	getOwnerID() Returns the ObjectID of the owner of this tag.
R	getResource() Returns the resource this tag is associated to.
java.lang.String	getTagName() Returns the name of this tag.
boolean	preserveCategories() If a TagCreationContext was created without specifying categories it is possible to preserve all categories that have been assigned to the tagged resource.

Method Detail

getTagName

java.lang.String getTagName()

Returns the name of this tag.

Returns:

The name of this tag.

getLocale

java.util.Locale getLocale()

Returns the locale of the tag

Returns:

the locale of the tag or null if this creation context must not consider a locale.

getOwnerID

ObjectID getOwnerID()

Returns the ObjectID of the owner of this tag.

Returns:

The code>ObjectID of the owner of this tag.

getResource

R getResource()

Returns the resource this tag is associated to.

Returns:

The resource this tag is associated to.

getCategories

java.util.Set<java.lang.String> getCategories()

Returns a set of categories the resource the tag is being associated to belongs to. May be null.

Returns:

The set of categories the resource the tag is being associated to belongs to.

preserveCategories

boolean preserveCategories()

If a TagCreationContext was created without specifying categories it is possible to preserve all categories that have been assigned to the tagged resource.

Returns:

true if the categories already associated with the resource to tag should be preserved.