livespace.services.entities.vtc
Class VirtualMonitorEntity

java.lang.Object
  extended by dsto.dfc.databeans.AbstractDataObject
      extended by dsto.dfc.databeans.SimpleDataObject
          extended by dsto.dfc.databeans.FancyDataObject
              extended by livespace.services.Entity
                  extended by livespace.services.entities.vtc.VirtualMonitorEntity
All Implemented Interfaces:
IDataObject, IDataObjectChildListener, Cloneable

public class VirtualMonitorEntity
extends Entity

Author:
Steven Johnson Created on 19/09/2005

Field Summary
 String call
          The id of the CallEntity this virtual monitor is to display.
static String ENTITY_TYPE
           
 int index
          The index of the virtual monitor on the vtc device
 String picture
          The id of the PictureEntity this virtual monitor is to display.
 
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
VirtualMonitorEntity()
           
VirtualMonitorEntity(String id)
           
VirtualMonitorEntity(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

index

public transient int index
The index of the virtual monitor on the vtc device


picture

public String picture
The id of the PictureEntity this virtual monitor is to display. This may also be an id of a PictureProgramEntity which is a composite of multiple PictureEntity's. If you wish the vtc system to take control of the virtual monitor and decide what to display on the virtual monitor (i.e. its layout etc) then set this to null.


call

public String call
The id of the CallEntity this virtual monitor is to display. This is only meaningful if a remote picture (i.e. remote main or remote secondary) is being shown.

Constructor Detail

VirtualMonitorEntity

public VirtualMonitorEntity()

VirtualMonitorEntity

public VirtualMonitorEntity(String id)

VirtualMonitorEntity

public VirtualMonitorEntity(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


Copyright © 2008 Commonwealth of Australia