com.arsdigita.glossary
Class GlossaryWord

java.lang.Object
  com.arsdigita.domain.DomainObject
      com.arsdigita.domain.ObservableDomainObject
          com.arsdigita.kernel.ACSObject
              com.arsdigita.glossary.GlossaryWord

public class GlossaryWord

extends com.arsdigita.kernel.ACSObject

GlossaryWord represent the word / definition pairs in a Glossary

Since:

ACS 4.6.5

Version:

$Revision: #3 $ $Date: 2003/08/15 $

Author:

Kevin Scaldeferri (kevin@arsdigita.com)

Field Summary

Fields inherited from class com.arsdigita.kernel.ACSObject

CONTAINER, DEFAULT_DOMAIN_CLASS, DISPLAY_NAME, ID, OBJECT_TYPE, versionId

Constructor Summary

GlossaryWord(BigDecimal key)
Constructor.

GlossaryWord(com.arsdigita.persistence.DataObject dataObject)

GlossaryWord(com.arsdigita.persistence.OID oid)
Constructor.

GlossaryWord(String typeName)
Constructor.

Method Summary

protected String	getBaseDataObjectType() Returns the appropriate object type for a GlossaryWord so that proper type validation will occur when retrieving Glossary's by OID
com.arsdigita.util.TypedText	getDefinition()
Glossary	getGlossary()
String	getWord()
void	setDefinition(com.arsdigita.util.TypedText definition)
void	setWord(String word)
String	toString() returns the word.

Methods inherited from class com.arsdigita.kernel.ACSObject

assertPrivilege, beforeSave, checkPrivilege, doCreateCheck, doWriteCheck, getContainer, getDefaultDomainClass, getDisplayName, getID, getSpecificObjectType, getSpecificOID, gimmeContainer, initialize, isContainerModified, setID, setID

Methods inherited from class com.arsdigita.domain.ObservableDomainObject

addObserver, getObservers

Methods inherited from class com.arsdigita.domain.DomainObject

add, add, addToAssociation, afterDelete, afterSave, beforeDelete, clear, delete, disconnect, equals, get, getObjectType, getOID, getSession, hashCode, isDeleted, isDisconnected, isModified, isNew, isPropertyModified, isValid, remove, remove, remove, removeFromAssociation, save, set, setAssociation, setAssociation, specializeDataObject, specializeDataObject

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

GlossaryWord

public GlossaryWord(String typeName)

Constructor. The contained DataObject is initialized with a new DataObject with an ObjectType specified by the string typeName.

Parameters:

typeName - The name of the ObjectType of the contained DataObject.

See Also:

DataObject, ObjectType

GlossaryWord

public GlossaryWord(com.arsdigita.persistence.OID oid)
             throws com.arsdigita.domain.DataObjectNotFoundException

Constructor. Retrieves a glossary instance, retrieving an existing glossary from the database with OID oid. Throws an exception if an object with OID oid does not exist or the object is not of type Glossary

Parameters:

oid - The OID for the retrieved DataObject.

Throws:

com.arsdigita.domain.DataObjectNotFoundException - Thrown if we cannot retrieve a data object for the specified OID

See Also:

DataObject, OID

GlossaryWord

public GlossaryWord(BigDecimal key)
             throws com.arsdigita.domain.DataObjectNotFoundException

Constructor. Retrieves a GlossaryWord instance, retrieving an existing glossary from the database with an ID responding to key.

Parameters:

key - The ID for the object to be retrieved. object.

Throws:

com.arsdigita.domain.DataObjectNotFoundException - Thrown if we cannot retrieve a data object for the specified OID

GlossaryWord

public GlossaryWord(com.arsdigita.persistence.DataObject dataObject)

Method Detail

getBaseDataObjectType

protected String getBaseDataObjectType()

Returns the appropriate object type for a GlossaryWord so that proper type validation will occur when retrieving Glossary's by OID

Returns:

The fully qualitifed name of of the base data object type for the GlossaryWord object type.

getGlossary

public Glossary getGlossary()

getWord

public String getWord()

setWord

public void setWord(String word)

getDefinition

public com.arsdigita.util.TypedText getDefinition()

setDefinition

public void setDefinition(com.arsdigita.util.TypedText definition)

toString

public String toString()

returns the word. Wrapper to getWord().