blackboard.cms.bookmark
Class Bookmark

java.lang.Object
  blackboard.data.BbObject
      blackboard.cms.bookmark.Bookmark

All Implemented Interfaces:

blackboard.data.IBbObject, blackboard.data.Identifiable, java.lang.Cloneable

public class Bookmark
extends blackboard.data.BbObject

The Bookmark class provides a representation of a Bookmark within the Blackboard application. Bookmarks are links to existing files or folder in the Content System. Bookmarks can be organized into a folder heirarchy (by using setFolderInd()).

Example: Create new Bookmark:

Bookmark bm = new Bookmark();
bm.setFolderInd(false);
bm.setTitle(strbookmarkName);
bm.setUserId(userId);
bm.setParentId(parentId);
bm.setFileEntryPath(p_entry.getName());
BookmarkManager bmManager = new BookmarkManager();
bmManager.save(bm);

Since:

Bb CS 1.0

Version:

$Revision: #1 $

Field Summary

static blackboard.persist.DataType

DATA_TYPE Object data type constant used in brokering loaders and persisters

Fields inherited from class blackboard.data.BbObject

_bbAttributes

Constructor Summary

Bookmark()
Creates an instance of Bookmark with default property values.

Method Summary

blackboard.persist.DataType	getDataType() Returns the DataType identifier for this object.
java.lang.String	getFileEntryPath() Returns the file path for item for the Bookmark
boolean	getFolderInd() Returns the folder indicator flag for the Bookmark.
blackboard.persist.Id	getParentId() Returns the parent Id for the Bookmark .
java.lang.String	getTitle() Returns the title for the Bookmark.
blackboard.persist.Id	getUserId() Returns the user Id for the Bookmark.
void	setFileEntryPath(java.lang.String path) Sets the file path for item for the Bookmark
void	setFolderInd(boolean val) Sets the folder indicator flag for this Bookmark.
void	setParentId(blackboard.persist.Id id) Sets the parent Id for the Bookmark.
void	setTitle(java.lang.String str) Sets the title for the Bookmark.
void	setUserId(blackboard.persist.Id id) Sets the user Id for the Bookmark.

Methods inherited from class blackboard.data.BbObject

clone, getBbAttributes, getCreatedDate, getId, getModifiedDate, persist, setCreatedDate, setId, setModifiedDate, toString, validate

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

DATA_TYPE

public static final blackboard.persist.DataType DATA_TYPE

Object data type constant used in brokering loaders and persisters

Constructor Detail

Bookmark

public Bookmark()

Creates an instance of Bookmark with default property values.

Method Detail

getFileEntryPath

public java.lang.String getFileEntryPath()

Returns the file path for item for the Bookmark

Returns:

a String representing the file path for the Bookmark.

setFileEntryPath

public void setFileEntryPath(java.lang.String path)

Sets the file path for item for the Bookmark

Parameters:

path - a String representing the file path for the Bookmark.

getTitle

public java.lang.String getTitle()

Returns the title for the Bookmark.

Returns:

a String representing the title for the Bookmark.

setTitle

public void setTitle(java.lang.String str)

Sets the title for the Bookmark.

Parameters:

str - a String representing the title for the Bookmark.

getFolderInd

public boolean getFolderInd()

Returns the folder indicator flag for the Bookmark. This flag determines whether or not the Bookmark is a folder.

Returns:

a boolean denoting whether the Bookmark

setFolderInd

public void setFolderInd(boolean val)

Sets the folder indicator flag for this Bookmark. This flag determines whether or not the Bookmark is a folder.

Parameters:

val - true if this Bookmark is a folder (to hold other Bookmarks), false otherwise.

getParentId

public blackboard.persist.Id getParentId()

Returns the parent Id for the Bookmark .

Returns:

the parent Id for the Bookmark.

setParentId

public void setParentId(blackboard.persist.Id id)

Sets the parent Id for the Bookmark.

Parameters:

id - a parent Id for the Bookmark.

getUserId

public blackboard.persist.Id getUserId()

Returns the user Id for the Bookmark. This user Id represents the owner of the Bookmark.

Returns:

the user Id for the Bookmark.

setUserId

public void setUserId(blackboard.persist.Id id)

Sets the user Id for the Bookmark. This user Id represents the owner of the Bookmark.

Parameters:

id - the user Id for the Bookmark.

getDataType

public blackboard.persist.DataType getDataType()

Returns the DataType identifier for this object. Can be used to uniquely identify the "type" of this data object.

Specified by:

getDataType in interface blackboard.data.IBbObject

Specified by:

getDataType in interface blackboard.data.Identifiable

Specified by:

getDataType in class blackboard.data.BbObject

Returns:

the DataType for this object