com.monad.homerun.objmgt
Interface ObjectService

All Superinterfaces:

ManagedService

public interface ObjectService
extends ManagedService

ObjectService describes the object management services

Method Summary

boolean	addCircuit(Circuit circuit) Adds a circuit to runtime and the circuit store.
boolean	addControl(Control control)
boolean	addDomain(Domain domain)
boolean	addEmitter(Emitter emitter)
boolean	addFilter(Filter filter)
void	addListener(SystemListener listener)
boolean	addObject(Instance object)
void	addObjectObserver(java.lang.String domain, java.lang.String objectName, java.lang.String emitterName, java.util.Observer observer, boolean priority) Add an observer of the indicated object
boolean	addPanel(Panel panel)
boolean	addReflexSet(ReflexSet reflexSet) Adds a ReflexSet to runtime and the reflexSet store.
boolean	addType(Type type)
void	announceEvent(java.lang.String eventType, java.lang.Object object)
java.lang.String[]	applyFilter(Filter filter)
boolean	applyFilter(Filter filter, java.lang.String objectName)
java.lang.String[]	applyFilter(java.lang.String domainName, java.lang.String filterName, java.lang.String type) Returns list of filtered objects or their shared component names.
boolean	controlObject(java.lang.String domainName, java.lang.String objectName, java.lang.String controlName, java.lang.String command, java.util.Map modifiers, java.util.Map context)
boolean	domainExists(java.lang.String domainName)
java.lang.String[]	getBearersOfModel(java.lang.String domain, java.lang.String modelName)
Type[]	getCategoryTypes(java.lang.String domainName, java.lang.String category)
Circuit	getCircuit(java.lang.String circuitName) Returns the Circuit for given name.
java.lang.String[]	getCircuitNames() Returns a list of all the names of the defined circuits.
Control	getControl(java.lang.String controlName)
Control[]	getControlsForType(java.lang.String type)
Domain	getDomain(java.lang.String domain, int catFilter)
Domain[]	getDomains(int filter)
Emitter	getEmitter(java.lang.String emitterName)
java.lang.String[]	getEmittersForType(java.lang.String type)
Filter	getFilter(java.lang.String domainName, java.lang.String filterName)
java.lang.String[]	getFilterIComps(Filter filter)
java.lang.String[]	getFilterNames(java.lang.String domainName)
java.lang.String[]	getIconNames(java.lang.String category)
java.lang.String[]	getIndexKeys(java.lang.String domainName, java.lang.String indexName)
ModelStatus	getModelStatus(java.lang.String domain, java.lang.String objectName, java.lang.String modelName)
Instance	getObject(java.lang.String domainName, java.lang.String objectName)
java.lang.String[]	getObjectNames(java.lang.String domainName)
java.lang.String[]	getObjectNames(java.lang.String domainName, java.lang.String indexName, java.lang.String indexKey)
java.util.Properties	getObjectProperties(java.lang.String domainName, java.lang.String objectName)
Type	getObjectType(java.lang.String domainName, java.lang.String objectName)
Panel	getPanel(java.lang.String category, java.lang.String panelName)
java.lang.String[]	getPanelCategories()
java.lang.String[]	getPanelNames(java.lang.String category)
ReflexSet	getReflexSet(java.lang.String reflexSetName) Returns the ReflexSet for given name.
Type	getType(java.lang.String domainName, java.lang.String typeName)
java.lang.String[]	getTypeNames(java.lang.String domainName)
Type[]	getTypes(java.lang.String domainName)
boolean	objectExists(java.lang.String domainName, java.lang.String objectName)
void	recordActivity(java.lang.String domainName, java.lang.String objectName)
void	registerObject(java.lang.String domainName, java.lang.String objectName, boolean register)
boolean	removeCircuit(java.lang.String circuitName) Removes the circuit from runtime and the circuit store.
boolean	removeControl(Control control)
boolean	removeDomain(Domain domain)
boolean	removeEmitter(Emitter emitter)
boolean	removeFilter(Filter filter)
void	removeListener(SystemListener listener)
boolean	removeObject(Instance object)
void	removeObjectObserver(java.lang.String domain, java.lang.String objectName, java.lang.String emitterName, java.util.Observer observer) Remove an observer of the indicated object
boolean	removePanel(Panel panel)
boolean	removeReflexSet(java.lang.String reflexSetName) Removes the reflexSet from runtime and the reflexSet store.
boolean	removeType(Type type)
FilterTrace	traceFilter(Filter filter, java.lang.String objectName, java.lang.String mode)
boolean	updateCircuit(Circuit circuit) Saves changes in the passed circuit.
boolean	updateDomain(Domain domain)
boolean	updateFilter(Filter filter)
boolean	updateObject(Instance object)
boolean	updatePanel(Panel panel)
boolean	updateReflexSet(ReflexSet reflexSet) Saves changes in the passed reflexSet.
boolean	validateFilter(Filter filter)
boolean	validateObject(java.lang.String domainName, java.lang.String objectName)

Methods inherited from interface com.monad.homerun.core.ManagedService

init, shutdown

Method Detail

getDomains

Domain[] getDomains(int filter)

getDomain

Domain getDomain(java.lang.String domain,
                 int catFilter)

domainExists

boolean domainExists(java.lang.String domainName)

addDomain

boolean addDomain(Domain domain)

updateDomain

boolean updateDomain(Domain domain)

removeDomain

boolean removeDomain(Domain domain)

getTypeNames

java.lang.String[] getTypeNames(java.lang.String domainName)

getTypes

Type[] getTypes(java.lang.String domainName)

getCategoryTypes

Type[] getCategoryTypes(java.lang.String domainName,
                        java.lang.String category)

getObjectType

Type getObjectType(java.lang.String domainName,
                   java.lang.String objectName)

getType

Type getType(java.lang.String domainName,
             java.lang.String typeName)

addType

boolean addType(Type type)

removeType

boolean removeType(Type type)

getControlsForType

Control[] getControlsForType(java.lang.String type)

getControl

Control getControl(java.lang.String controlName)

addControl

boolean addControl(Control control)

removeControl

boolean removeControl(Control control)

getEmittersForType

java.lang.String[] getEmittersForType(java.lang.String type)

getEmitter

Emitter getEmitter(java.lang.String emitterName)

addEmitter

boolean addEmitter(Emitter emitter)

removeEmitter

boolean removeEmitter(Emitter emitter)

objectExists

boolean objectExists(java.lang.String domainName,
                     java.lang.String objectName)

getIndexKeys

java.lang.String[] getIndexKeys(java.lang.String domainName,
                                java.lang.String indexName)

getObjectNames

java.lang.String[] getObjectNames(java.lang.String domainName)

getObjectNames

java.lang.String[] getObjectNames(java.lang.String domainName,
                                  java.lang.String indexName,
                                  java.lang.String indexKey)

getObjectProperties

java.util.Properties getObjectProperties(java.lang.String domainName,
                                         java.lang.String objectName)

getBearersOfModel

java.lang.String[] getBearersOfModel(java.lang.String domain,
                                     java.lang.String modelName)

getIconNames

java.lang.String[] getIconNames(java.lang.String category)

getObject

Instance getObject(java.lang.String domainName,
                   java.lang.String objectName)

validateObject

boolean validateObject(java.lang.String domainName,
                       java.lang.String objectName)

addObject

boolean addObject(Instance object)

updateObject

boolean updateObject(Instance object)

removeObject

boolean removeObject(Instance object)

recordActivity

void recordActivity(java.lang.String domainName,
                    java.lang.String objectName)

controlObject

boolean controlObject(java.lang.String domainName,
                      java.lang.String objectName,
                      java.lang.String controlName,
                      java.lang.String command,
                      java.util.Map modifiers,
                      java.util.Map context)

registerObject

void registerObject(java.lang.String domainName,
                    java.lang.String objectName,
                    boolean register)

addObjectObserver

void addObjectObserver(java.lang.String domain,
                       java.lang.String objectName,
                       java.lang.String emitterName,
                       java.util.Observer observer,
                       boolean priority)

Add an observer of the indicated object

Parameters:

observer - - an observer of the object

removeObjectObserver

void removeObjectObserver(java.lang.String domain,
                          java.lang.String objectName,
                          java.lang.String emitterName,
                          java.util.Observer observer)

Remove an observer of the indicated object

Parameters:

observer - an observer of the object

getFilterNames

java.lang.String[] getFilterNames(java.lang.String domainName)

getFilter

Filter getFilter(java.lang.String domainName,
                 java.lang.String filterName)

applyFilter

java.lang.String[] applyFilter(Filter filter)

applyFilter

java.lang.String[] applyFilter(java.lang.String domainName,
                               java.lang.String filterName,
                               java.lang.String type)

Returns list of filtered objects or their shared component names.

Parameters:

domainName - filter domain

filterName - filter name

type - component type 'object', 'control', 'model' or 'emitter'

Returns:

list of object or component names

applyFilter

boolean applyFilter(Filter filter,
                    java.lang.String objectName)

validateFilter

boolean validateFilter(Filter filter)

getFilterIComps

java.lang.String[] getFilterIComps(Filter filter)

traceFilter

FilterTrace traceFilter(Filter filter,
                        java.lang.String objectName,
                        java.lang.String mode)

addFilter

boolean addFilter(Filter filter)

updateFilter

boolean updateFilter(Filter filter)

removeFilter

boolean removeFilter(Filter filter)

getPanelCategories

java.lang.String[] getPanelCategories()

getPanelNames

java.lang.String[] getPanelNames(java.lang.String category)

getPanel

Panel getPanel(java.lang.String category,
               java.lang.String panelName)

addPanel

boolean addPanel(Panel panel)

updatePanel

boolean updatePanel(Panel panel)

removePanel

boolean removePanel(Panel panel)

getCircuitNames

java.lang.String[] getCircuitNames()

Returns a list of all the names of the defined circuits.

Returns:

names the circuit names - which are concatenated descriptions of the circuit links.

getCircuit

Circuit getCircuit(java.lang.String circuitName)

Returns the Circuit for given name.

Parameters:

circuitName - the descriptive name of the circuit

Returns:

circuit the circuit

addCircuit

boolean addCircuit(Circuit circuit)

Adds a circuit to runtime and the circuit store.

Parameters:

circuit - the circuit to add

Returns:

status true if the circuit was added, otherwise false.

updateCircuit

boolean updateCircuit(Circuit circuit)

Saves changes in the passed circuit.

Parameters:

circuit - the updated circuit to commit

Returns:

status true if the circuit was updated, otherwise false.

removeCircuit

boolean removeCircuit(java.lang.String circuitName)

Removes the circuit from runtime and the circuit store.

Parameters:

circuitName - the name of the circuit to remove

Returns:

status true if the circuit was removed, otherwise false.

getReflexSet

ReflexSet getReflexSet(java.lang.String reflexSetName)

Returns the ReflexSet for given name.

Parameters:

reflexSetName - the descriptive name of the reflexSet - usually 'domain:object'

Returns:

reflexSet the reflexSet

addReflexSet

boolean addReflexSet(ReflexSet reflexSet)

Adds a ReflexSet to runtime and the reflexSet store.

Parameters:

reflexSet - the reflexSet to add

Returns:

status true if the reflexSet was added, otherwise false.

updateReflexSet

boolean updateReflexSet(ReflexSet reflexSet)

Saves changes in the passed reflexSet.

Parameters:

reflexSet - the updated reflexSet to commit

Returns:

status true if the reflexSet was updated, otherwise false.

removeReflexSet

boolean removeReflexSet(java.lang.String reflexSetName)

Removes the reflexSet from runtime and the reflexSet store.

Parameters:

reflexSetName - the name of the reflexSet to remove

Returns:

status true if the reflexSet was removed, otherwise false.

getModelStatus

ModelStatus getModelStatus(java.lang.String domain,
                           java.lang.String objectName,
                           java.lang.String modelName)

addListener

void addListener(SystemListener listener)

removeListener

void removeListener(SystemListener listener)

announceEvent

void announceEvent(java.lang.String eventType,
                   java.lang.Object object)