livespace.services.entities
Class DocumentLibraryEntity

java.lang.Object
  dsto.dfc.databeans.AbstractDataObject
      dsto.dfc.databeans.SimpleDataObject
          dsto.dfc.databeans.FancyDataObject
              livespace.services.Entity
                  livespace.services.entities.DocumentLibraryEntity

All Implemented Interfaces:

IDataObject, IDataObjectChildListener, Cloneable

public class DocumentLibraryEntity
extends Entity

Represents a document library within an information repository. A document library is an area on the repository (like a folder) where documents and other document libraries are stored. The id of the document library corresponds to the url where the document is located.

Author:

Steven Johnson Created on 13/01/2005

To do:

add reference to parent

Field Summary

EntityRegistry	documents A registry of the documents this document library contains
static String	ENTITY_TYPE
String	url

Fields inherited from class livespace.services.Entity

container, id, lastTouched, name, unconfirmedUpdates

Fields inherited from class dsto.dfc.databeans.AbstractDataObject

listeners

Fields inherited from interface dsto.dfc.databeans.IDataObject

OVERRIDE, PERSISTENT, PERSISTENT_OVERRIDE, TRANSIENT, TRANSIENT_OVERRIDE

Constructor Summary

DocumentLibraryEntity()

DocumentLibraryEntity(String id, String url)
Creates a document library entity with the specified name and url.The id of this document will be set the url value passed in to this constructor.

DocumentLibraryEntity(String id, String url, String name)
Creates a document library entity with the specified name and url(id).

Method Summary

String

getType() The type of the object (eg "room", "light", "volume", etc).

Methods inherited from class livespace.services.Entity

create, createId, getElvin, getType, getTypeInfo, mutex, sameEntity, shallowClone, waitForProperty, waitForProperty, waitForProperty, waitForProperty

Methods inherited from class dsto.dfc.databeans.FancyDataObject

childPropertyChanged, getValue, isTransient, propertyIterator, setValue

Methods inherited from class dsto.dfc.databeans.SimpleDataObject

getFieldNames, setValue

Methods inherited from class dsto.dfc.databeans.AbstractDataObject

addFirstPropertyListener, addPropertyListener, firePropertyChangedEvent, firePropertyChangedEvent, firePropertyChangedEvent, firePropertyChangedEvent, firePropertyChangedEvent, firePropertyChangedEvent, getBeanValue, getBooleanValue, getBooleanValue, getCharValue, getCharValue, getDoubleValue, getDoubleValue, getFloatValue, getFloatValue, getIntValue, getIntValue, getLongValue, getLongValue, getObjectValue, getPropertyListeners, getShortValue, getStringValue, registerValue, removePropertyListener, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, toString, unregisterValue

Methods inherited from class java.lang.Object

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

Field Detail

ENTITY_TYPE

public static final String ENTITY_TYPE

See Also:

Constant Field Values

documents

public EntityRegistry documents

A registry of the documents this document library contains

url

public String url

Constructor Detail

DocumentLibraryEntity

public DocumentLibraryEntity()

DocumentLibraryEntity

public DocumentLibraryEntity(String id,
                             String url)

Creates a document library entity with the specified name and url.The id of this document will be set the url value passed in to this constructor.

Parameters:

url -

DocumentLibraryEntity

public DocumentLibraryEntity(String id,
                             String url,
                             String name)

Creates a document library entity with the specified name and url(id).

Parameters:

url -

Method Detail

getType

public String getType()

Description copied from class: Entity

The type of the object (eg "room", "light", "volume", etc). This must be unique to the entity class.

NOTE: it is also a good practice to provide a static field that defines the entity type on the class: eg

 public static final String ENTITY_TYPE = "room";
 

Specified by:

getType in class Entity