livespace.services.entities.sessions
Class Sessions

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

All Implemented Interfaces:

IDataObject, IDataObjectChildListener, Cloneable

public class Sessions
extends Entity

This entity stores information about the sessions within the room. It stores a stack of the session configurations that have been invoked. The configuration at the top of the stack represents the current configuration of the room and those below represent previous sessions (or configurations) with the newest at the top and the oldest at the bottom.

Author:

Steven Johnson Created on 23/02/2005

Field Summary

int	currentHistoryPosition Maintains a position of where within the session history the room currently is.
static String	ENTITY_TYPE
EntityRegistry	playQueue A registry of SessionEntity's that are to be played.
EntityStack	sessionHistory Maintains a list of the session history for the room.

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

Sessions()

Sessions(String id)

Sessions(String id, String name)

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

sessionHistory

public EntityStack sessionHistory

Maintains a list of the session history for the room. Each entry is a SessionEntity.

playQueue

public EntityRegistry playQueue

A registry of SessionEntity's that are to be played. As the service plays the meta-apps they will be added to the session history (just before being played) and removed from this registry (when finished).

currentHistoryPosition

public int currentHistoryPosition

Maintains a position of where within the session history the room currently is. This can be used for 'back' and 'forward' actions for moving between previous sessions (similar to a web browser).

Constructor Detail

Sessions

public Sessions()

Sessions

public Sessions(String id)

Sessions

public Sessions(String id,
                String name)

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