org.dcs.query_process.model.activity

Class Script_Auto

java.lang.Object

org.dcs.query_process.model.Script_Element

org.dcs.query_process.model.data.Script_Conditions

org.dcs.query_process.model.event.Script_Event

org.dcs.query_process.model.activity.Script_Auto

Direct Known Subclasses:

Script_AutoMethod

public abstract class Script_Auto
extends Script_Event

This is a base class for retrieving information from a stored list, such as from a message queue. The information can be defined by one of the field types, resulting in a different request to retrieve it.

Author:

Kieran Greer

Field Summary

Fields

Modifier and Type	Field and Description
protected long	timeStamp Time the information was lodged
protected boolean	useOpName True if use the operation name field to retrieve the information
protected boolean	useTimestamp True if use the timestamp field to retrieve the information

Fields inherited from class org.dcs.query_process.model.event.Script_Event

subEvents, varMap

Fields inherited from class org.dcs.query_process.model.data.Script_Conditions

filter, function, operation, source

Fields inherited from class org.dcs.query_process.model.Script_Element

id, internalID, keyLong, name, namespace, objType, parentElement, value

Constructor Summary

Constructors

Constructor and Description
Script_Auto(org.licas_xml.abs.Element autoXml) Create a new instance of Script_Auto and add the xml-based description of the element values.
Script_Auto(java.lang.String scriptType, java.lang.String elemID) Create a new instance of Script_Auto.

Method Summary

Modifier and Type	Method and Description
long	getTimestamp() Get the timestamp value.
org.licas_xml.abs.Element	toXml() Convert the contents of this Script_Auto into an XML-only format.
boolean	useOperationName() Return true if use the operation name with this element.
boolean	useTimestamp()

Methods inherited from class org.dcs.query_process.model.event.Script_Event

addEvent, addVariable, getEvents, getVariables, setForUse, usesSubEvents

Methods inherited from class org.dcs.query_process.model.data.Script_Conditions

getFilter, getFunction, getOperation, getSource, setFilter, setFunction, setOperation, setSource

Methods inherited from class org.dcs.query_process.model.Script_Element

getID, getInternalID, getName, getNamespace, getObjType, getParent, getScriptUuid, getValue, processThis, setNamespace, setObjType, setParent, setValue, setValue

Methods inherited from class java.lang.Object

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

Field Detail

useOpName

protected boolean useOpName

True if use the operation name field to retrieve the information

useTimestamp

protected boolean useTimestamp

True if use the timestamp field to retrieve the information

timeStamp

protected long timeStamp

Time the information was lodged

Constructor Detail

Script_Auto

public Script_Auto(java.lang.String scriptType,
                   java.lang.String elemID)

Create a new instance of Script_Auto.

Parameters:

scriptType - the script element type. This is also the element tag name and should not be null.

elemID - this is the external id used to identify this element specifically. The element is also stored under this value and so it cannot be null.

Script_Auto

public Script_Auto(org.licas_xml.abs.Element autoXml)
            throws java.lang.Exception

Create a new instance of Script_Auto and add the xml-based description of the element values.

Parameters:

autoXml - the xml-based description of values to add.

Throws:

java.lang.Exception - any error.

Method Detail

useOperationName

public boolean useOperationName()

Return true if use the operation name with this element.

Returns:

true if use operation name, false otherwise.

useTimestamp

public boolean useTimestamp()

getTimestamp

public long getTimestamp()

Get the timestamp value.

Returns:

the value of timeStamp.

toXml

public org.licas_xml.abs.Element toXml()
                                throws java.lang.Exception

Convert the contents of this Script_Auto into an XML-only format.

Overrides:

toXml in class Script_Event

Returns:

the contents as an XML-based description only.

Throws:

java.lang.Exception - any error.