com.arsdigita.glossary
Class Glossary

java.lang.Object
  extended bycom.arsdigita.domain.DomainObject
      extended bycom.arsdigita.domain.ObservableDomainObject
          extended bycom.arsdigita.kernel.ACSObject
              extended bycom.arsdigita.kernel.Resource
                  extended bycom.arsdigita.web.Application
                      extended bycom.arsdigita.glossary.Glossary

public class Glossary
extends com.arsdigita.web.Application

Glossary Domain Object.

Since:
ACS 4.6.5
Version:
$Revision: #4 $ $Date: 2003/08/26 $
Author:
Gautam Chowdhary

Field Summary
static String BASE_DATA_OBJECT_TYPE
           
static String versionId
           
 
Fields inherited from class com.arsdigita.web.Application
PRIMARY_URL
 
Fields inherited from class com.arsdigita.kernel.Resource
CHILD_RESOURCE, DESCRIPTION, PARENT_RESOURCE, RESOURCE_TYPE, TIMESTAMP, TITLE
 
Fields inherited from class com.arsdigita.kernel.ACSObject
CONTAINER, DEFAULT_DOMAIN_CLASS, DISPLAY_NAME, ID, OBJECT_TYPE
 
Constructor Summary
Glossary(BigDecimal key)
          Constructor.
Glossary(com.arsdigita.persistence.DataObject dataObject)
           
Glossary(com.arsdigita.persistence.OID oid)
           
 
Method Summary
static Glossary create(String urlName, String title, com.arsdigita.web.Application parent)
           
 GlossaryWord createWord(String word, com.arsdigita.util.TypedText definition)
           
protected  String getBaseDataObjectType()
          Returns the appropriate object type for a Glossary so that proper type validation will occur when retrieving Glossary's by OID
 WordCollection getWordList()
          gets all the words in this glossary
 WordCollection getWordList(String start)
          gets all the words in this glossary which start with the specified string.
 void removeWord(GlossaryWord word)
           
 
Methods inherited from class com.arsdigita.web.Application
afterDelete, beforeSave, createApplication, createApplication, createRootApplication, getAncestorApplications, getApplicationType, getCanonicalURL, getChildApplications, getChildApplicationsForType, getContainingApplication, getContextPath, getCurrentApplication, getPackageType, getParentApplication, getPath, getPrimaryURL, getRelevantPrivileges, getServletPath, getSiteNode, getStylesheetPath, isInstalled, retrieveAllApplications, retrieveApplication, retrieveApplication, retrieveApplication, retrieveApplicationForPath, retrieveApplicationForSiteNode, setApplicationType, setParentApplication, setPath
 
Methods inherited from class com.arsdigita.kernel.Resource
afterSave, createResource, createResource, getChildResources, getContainer, getContainingResource, getDescription, getDisplayName, getParentResource, getResourceType, getTimestamp, getTitle, isContainerModified, retrieveAllResources, retrieveResource, retrieveResource, retrieveResource, setDescription, setParentResource, setResourceType, setTitle
 
Methods inherited from class com.arsdigita.kernel.ACSObject
assertPrivilege, checkPrivilege, doCreateCheck, doWriteCheck, getDefaultDomainClass, getID, getSpecificObjectType, getSpecificOID, gimmeContainer, initialize, setID, setID
 
Methods inherited from class com.arsdigita.domain.ObservableDomainObject
addObserver, getObservers
 
Methods inherited from class com.arsdigita.domain.DomainObject
add, add, addToAssociation, 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, toString
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
 

Field Detail

versionId

public static final String versionId
See Also:
Constant Field Values

BASE_DATA_OBJECT_TYPE

public static final String BASE_DATA_OBJECT_TYPE
See Also:
Constant Field Values
Constructor Detail

Glossary

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

Glossary

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

Glossary

public Glossary(BigDecimal key)
         throws com.arsdigita.domain.DataObjectNotFoundException
Constructor. Retrieves a Glossary 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
Method Detail

create

public static Glossary create(String urlName,
                              String title,
                              com.arsdigita.web.Application parent)

getBaseDataObjectType

protected String getBaseDataObjectType()
Returns the appropriate object type for a Glossary 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 Glossary object type.

createWord

public GlossaryWord createWord(String word,
                               com.arsdigita.util.TypedText definition)

removeWord

public void removeWord(GlossaryWord word)

getWordList

public WordCollection getWordList()
gets all the words in this glossary


getWordList

public WordCollection getWordList(String start)
gets all the words in this glossary which start with the specified string. If the string is null, then all words are retrieved.



Copyright (c) 2004 Red Hat, Inc. Corporation. All Rights Reserved. Generated at July 19 2004:2349 UTC