Tree PREV CLASS NEXT CLASS SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD com.ibm.portal.cp.rating.controller
Interface RatingCreationContext<R>
- All Superinterfaces:
- CreationContext
public interface RatingCreationContext<R>- extends CreationContext
CreationContext that exposes information common to all types of rating creation context interfaces.
- Since:
- 7.0.0
Method Summary java.util.Set<java.lang.String> getCategories()
Return a set of categories the resource the rating is being associated to belongs to.ObjectID getOwnerID()
Return the ObjectID of the owner of this tag.int getRating()
Return the rating value of this rating.R getResource()
Return the resource this rating is associated to.boolean isPrivate()
Returns true if the rating should be considered private, i.boolean preserveCategories()
If a RatingCreationContext was created without specifying categories it is possible to preserve all categories that have been assigned to the rated resource.
Method Detail getRating
int getRating()
- Returns the rating value of this rating.
- Returns:
- The rating value of this rating.
getOwnerID
ObjectID getOwnerID()
- Returns the ObjectID of the owner of this tag.
- Returns:
- The code>ObjectID of the owner of this tag.
isPrivate
boolean isPrivate()
- Returns true if the rating should be considered private, i. e. only the current user will be able to see it.
- Returns:
- true if the rating should be considered private, i. e. only the current user will be able to see it.
getResource
R getResource()
- Returns the resource this rating is associated to.
- Returns:
- The resource this rating is associated to.
getCategories
java.util.Set<java.lang.String> getCategories()
- Returns a set of categories the resource the rating is being associated to belongs to. May be null.
- Returns:
- The set of categories the resource the rating is being associated to belongs to.
preserveCategories
boolean preserveCategories()
- If a RatingCreationContext was created without specifying categories it is possible to preserve all categories that have been assigned to the rated resource.
- Returns:
- true if the categories already associated with the resource to rate should be preserved.
Tree PREV CLASS NEXT CLASS SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD