Skip navigation links

oracle.webcenter.tagging.model
Interface Bookmark

public interface Bookmark

A bookmark is a conceptual entity that encapsulates the actions of a user tagging a resource. It captures the ID of the resource being tagged as well as the service providing that resource. It contains a name that is the custom name given to the bookmark and some notes about the bookmark. It also gives indication of whether this is a shared bookmark, as well as own a list of tag Strings used in the bookmark.

Since:

11.1.1.0.0

Method Summary

java.util.Date	getCreateDate() Gets this bookmark's creation date
java.util.Date	getModifyDate() Gets this bookmark's modify date
java.lang.String	getName() Returns the bookmark's name
Resource	getResource() Gets the resource being bookmarked / tagged.
java.util.List<Tag>	getTags(boolean isAscending) Return a list of Tags in this bookmark
java.lang.String	getTagWords() Gets the tag words as they are presented in any UI, in the form of one single string containing tag words that are space separated.
boolean	isShared() Return whether this boomark is shared
void	setName(java.lang.String name) Set this bookmark's name
void	setShared(boolean shared) Set whether the bookmark is shared or not
void	setTagWords(java.lang.String tagWords) Sets the tag words as they are presented in any UI, in the form of one single string containing tag words that are space separated.

Method Detail

getTagWords

java.lang.String getTagWords()

Gets the tag words as they are presented in any UI, in the form of one single string containing tag words that are space separated.

Returns:

returns a single String representing a list of tag words used in this bookmark

getTags

java.util.List<Tag> getTags(boolean isAscending)

Return a list of Tags in this bookmark

Parameters:

isAscending - whether the returned Tags is in ascending/descending order of Tag's name

Returns:

a list of Tags

setTagWords

void setTagWords(java.lang.String tagWords)

Sets the tag words as they are presented in any UI, in the form of one single string containing tag words that are space separated.

Parameters:

tagWords - a single String representing a list of tag words used in this bookmark

getResource

Resource getResource()

Gets the resource being bookmarked / tagged.

Returns:

the resource being bookmarked / tagged

getCreateDate

java.util.Date getCreateDate()

Gets this bookmark's creation date

Returns:

this bookmark's creation date

getModifyDate

java.util.Date getModifyDate()

Gets this bookmark's modify date

Returns:

this bookmark's modify date

setName

void setName(java.lang.String name)

Set this bookmark's name

Parameters:

name - the name used to set this bookmark's name with

getName

java.lang.String getName()

Returns the bookmark's name

Returns:

the bookmark's name

isShared

boolean isShared()

Return whether this boomark is shared

Returns:

true if the bookmark is shared, or false otherwise

setShared

void setShared(boolean shared)

Set whether the bookmark is shared or not

Parameters:

shared - the boolean whether the bookmark is shared or not.

Skip navigation links