edu.northwestern.at.wordhoard.model.userdata
Interface UserDataObject

All Known Implementing Classes:

AuthoredTextAnnotation, PhraseSet, UserGroup, UserGroupPermission, WHQuery, WordSet, WorkSet

public interface UserDataObject

A WordHoard user data object.

Method Summary

boolean	addToDOMDocument(org.w3c.dom.Document document) Add to DOM document.
java.util.Date	getCreationTime() Gets the creation date/time.
java.lang.String	getDescription() Gets the description.
java.lang.Long	getId() Get the ID.
boolean	getIsActive() Gets the "is active" flag.
boolean	getIsPublic() Gets the "is public" flag.
java.util.Date	getModificationTime() Gets the modification date/time.
java.lang.String	getOwner() Gets the owner.
java.lang.String	getQuery() Gets the generating query.
java.lang.String	getTitle() Gets the title.
java.lang.String	getWebPageURL() Gets the web page URL.
void	setCreationTime(java.util.Date creationTime) Sets the creation date/time.
void	setDescription(java.lang.String description) Sets the description.
boolean	setFromDOMDocumentNode(org.w3c.dom.Node domNode) Set values from DOM document node.
void	setModificationTime(java.util.Date modificationTime) Sets the modification date/time.
void	setTitle(java.lang.String title) Sets the title.
void	setWebPageURL(java.lang.String webPageURL) Sets the web page URL.

Method Detail

getId

java.lang.Long getId()

Get the ID.

Returns:

The unique object ID.

getTitle

java.lang.String getTitle()

Gets the title.

Returns:

The title.

setTitle

void setTitle(java.lang.String title)

Sets the title.

Parameters:

title - The title.

getDescription

java.lang.String getDescription()

Gets the description.

Returns:

The description.

setDescription

void setDescription(java.lang.String description)

Sets the description.

Parameters:

description - The description.

getWebPageURL

java.lang.String getWebPageURL()

Gets the web page URL.

Returns:

The web page URL.

setWebPageURL

void setWebPageURL(java.lang.String webPageURL)

Sets the web page URL.

Parameters:

webPageURL - The web page URL.

getCreationTime

java.util.Date getCreationTime()

Gets the creation date/time.

Returns:

The creation date/time.

setCreationTime

void setCreationTime(java.util.Date creationTime)

Sets the creation date/time.

Parameters:

creationTime - The creation date/time.

getModificationTime

java.util.Date getModificationTime()

Gets the modification date/time.

Returns:

The modification date/time.

setModificationTime

void setModificationTime(java.util.Date modificationTime)

Sets the modification date/time.

Parameters:

modificationTime - The modification date/time.

getOwner

java.lang.String getOwner()

Gets the owner.

Returns:

The owner.

getIsPublic

boolean getIsPublic()

Gets the "is public" flag.

Returns:

True if the word set is public, false if private.

getIsActive

boolean getIsActive()

Gets the "is active" flag.

Returns:

True if the word set is available for use.

The "is active" flag is false until a user object is fully created and not in the process of being deleted.

getQuery

java.lang.String getQuery()

Gets the generating query.

Returns:

The query for generating this object.

addToDOMDocument

boolean addToDOMDocument(org.w3c.dom.Document document)

Add to DOM document.

Parameters:

document - DOM document to which to add this object. Must not be null. In most cases, this document should have a "wordhoard" node as the root element.

Returns:

true if DOM addition successful, false otherwise.

setFromDOMDocumentNode

boolean setFromDOMDocumentNode(org.w3c.dom.Node domNode)

Set values from DOM document node.

Parameters:

domNode - DOM document node from which to initialize query.

Returns:

true if settings retrieved.