|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.tivoli.twg.engine.TWGObject
com.tivoli.twg.engine.TWGPersistentObject
com.tivoli.twg.engine.TWGTask
This class is an abstract base class for tasks. It is primarily a container to hold all the information about a specific task, like the Java class to invoke for its GUI, its icon, the labels used for various places on the console, and which Java class or native program to run for the server portion of the task.
Field Summary | |
---|---|
static java.lang.String |
CLASSNAME
Our classname |
protected TWGClientTaskList |
clientTasks
|
protected int |
dataStoreVersion
|
protected StringValueSet |
privileges
|
protected java.lang.String |
propertiesFileName
|
protected java.util.Properties |
props
|
static int |
SUBTASK_ACT_COMPLETE
|
static int |
SUBTASK_ACT_FAILED
|
static int |
SUBTASK_ACT_PENDING
|
protected java.util.Hashtable |
subtasks
|
static int |
TASK_BIND_INSTANCE
|
static int |
TASK_DELETED
|
static int |
TASK_SERVER_AUTOLOAD
|
static int |
TASK_SERVER_ENABLE_JIT
|
static int |
TASK_SERVER_NO_RUN_THREAD
|
static int |
TASK_SERVER_SAME_JVM
|
static int |
TASK_SERVER_SAME_JVM_CONFIGURABLE
|
static int |
TASK_SERVER_SYNCHRONOUS
|
static int |
TASK_SERVER_TYPE_JAVA
|
static int |
TASK_SERVER_TYPE_NATIVE
|
static int |
TASK_SERVER_TYPE_NONE
|
static int |
TASK_STATE_FAILED
|
static int |
TASK_STATE_STARTED
|
static int |
TASK_STATE_STARTING
|
static int |
TASK_STATE_STOPPED
|
static int |
TASK_STATE_STOPPING
|
protected static java.util.Hashtable |
tasks
|
protected static LongKeyTable |
tasksByToid
|
Fields inherited from class com.tivoli.twg.engine.TWGPersistentObject |
---|
CLASS_NAME, SIZEOF_BYTE, SIZEOF_CHAR, SIZEOF_DOUBLE, SIZEOF_FLOAT, SIZEOF_INT, SIZEOF_LONG, SIZEOF_SHORT |
Constructor Summary | |
---|---|
TWGTask()
Default constructor to allow for persistant object restore |
Method Summary | |
---|---|
boolean |
addClient(java.lang.String clientClass,
java.lang.String clientTaskList)
Adds a client and the client tasks used by this task to its client list. |
boolean |
addClient(java.lang.String clientClass,
java.lang.String clientTaskList,
boolean single)
Adds a client and the client tasks used by this task to its client list. |
void |
addSubtask(java.lang.String subtaskID,
java.lang.String menu,
java.lang.String menuLocation,
java.lang.String contextList,
java.lang.String actionsList)
Add a subtask to this task's list. |
void |
addSubtask(java.lang.String subtaskID,
java.lang.String menu,
java.lang.String menuLocation,
java.lang.String contextList,
java.lang.String actionsList,
java.lang.String privilegeList)
Add a subtask to this task's list. |
static void |
attachAllAllowedTasks(TWGActiveConsole con)
Attach all allowed tasks to console |
void |
AttachObjectToConsole(TWGActiveConsole act_con)
Associate the object with the given TWGActiveConsole instance. |
protected void |
checkPersistentStoreLevel()
Check to see if persistent store needs to be updated for any reason |
boolean |
checkPrivileges(StringValueSet checkSet)
Check to see if the specified set of privileges is adequate for using this TWGTask. |
void |
clientServiceAdded(java.lang.String svcname,
TWGManagedObject mo)
Service add notification : indicates that the given client service has been added to the given managed object |
void |
clientServiceRemoved(java.lang.String svcname,
TWGManagedObject mo)
Service remove notification : indicates that the given client service has been remove from the given managed object |
void |
Delete()
Override of TWGObject's Delete to do some necessary cleanup when a task is deleted. |
static int |
deleteTask(java.lang.String taskID)
Delete the specified task. |
static int |
deleteTask(TWGTask task)
Delete the specified task. |
void |
Destroy()
Destroy method : used to process cleanup for object destroy |
void |
destroyActivation(TWGTaskActivation act,
int status)
|
static void |
detachAllDisallowedTasks(TWGActiveConsole con)
Detach all disallowed tasks from console |
void |
DetachObjectFromAllConsoles()
Disassociate the object from all TWGActiveConsoles. |
void |
DetachObjectFromConsole(TWGActiveConsole act_con)
Disassociate the object from the given TWGActiveConsole instance. |
protected void |
dumpProperties()
|
java.util.Enumeration |
getAllSubtasks()
Get an enumeration of all the subtasks contain in this task. |
static long[] |
getAllTaskIdentifiers()
Get all task identifiers |
java.lang.String[] |
getAttributeIDList()
Attribute ID enumeration : this method is expected to return a list of strings containing the String names of the attributes supported for a given object. |
int |
getAttributeType(java.lang.String id)
Get type of attribute value for given attribute |
DataValue |
getAttributeValue(java.lang.String id,
java.util.Locale loc)
Get value of attribute with given ID |
int |
getClientTaskCount(TWGManagedObject mo)
Get the number of client tasks that would be started for a specific TWGManagedObject based on its MOF. |
TWGClientTaskList |
getClientTasks()
|
java.lang.String |
GetConShadowClass()
Get the name of the console class that shadow's task. |
java.lang.String |
getExtensionClassName()
Get the name of the extension class that defined this task. |
java.lang.String |
getGuiClass()
Get the name of the GUI class for this task. |
java.lang.String |
getGuiParms()
Get the parameters for the GUI class for this task. |
java.lang.String |
getHelpTopicsMapping()
Get the help topics mapping file name. |
java.lang.String |
getID()
Get the this task's ID |
long |
getImageSet()
Get the image set id for this task. |
TWGTask |
getParent()
Get this task's parent. |
long |
getParentID()
Get this task's parent OID. |
java.lang.String[] |
getPrivileges()
Get the list of privileges required for a user to be able to use this task. |
java.lang.String |
getPropertiesFileName()
Get the name of the properties file used to create this task. |
java.lang.String |
getProperty(java.lang.String key)
Get a property from the task's properties file. |
java.lang.String |
getProperty(java.lang.String key,
java.lang.String defaultValue)
Get a property from the task's properties file. |
java.lang.String |
getResourceBundle()
Get the name of the resource bundle for this task's labels. |
java.lang.String |
getServerMaxHeapParm()
Get the server's maximum heap size parameter. |
java.lang.String |
getServerMinHeapParm()
Get the server's minimum heap size parameter. |
java.lang.String |
getServerName()
Get the name of the server Java class or native executable for this task. |
java.lang.String |
getServerParms()
Get the parameters for the server class/native executable. |
int |
getServerType()
Get the type of the server portion of this task. |
java.lang.String |
getServiceNode()
Get the name of the Service Node for this task. |
byte[] |
GetShadowRecord(java.util.Locale locale)
Get the data to shadow this task. |
long |
GetShadowVersion()
Get the shadow version of this task. |
int |
getState()
|
TWGSubtask |
getSubtask(java.lang.String subtaskID)
Get a subtask based on the task ID string. |
int |
getSubtaskCount()
Get the number of subtasks defined for this task |
static TWGTask |
getTask(long toid)
Get a task based on its object identifier. |
static TWGTask |
getTask(java.lang.String taskID)
Get a task based on its task ID. |
byte[] |
getTaskData()
Get the data for this task. |
java.lang.String |
getTitle(java.util.Locale loc)
Get the title for the task |
java.lang.String |
getTitleKey()
Get the key used to retrieve the icon title from the resource file. |
boolean |
hasServerRunThread()
Determine if this Java server task in engine JVM is to have run method called |
boolean |
hasSubtask(java.lang.String subtaskID)
Determine if a subtask is defined for this task. |
static void |
initialize()
Activate any tasks that are flagged to be started during server initialization |
boolean |
isBoundInstance()
See if this task is bound to managed object on an instance basis. |
boolean |
isDisabled()
Test to see if task is disabled |
boolean |
isDisabledSubtask(java.lang.String subid)
Test to see if subtask is disabled |
boolean |
isLiteralTitle()
Indicate if this task's title is a literal or a resource bundle key. |
static boolean |
isSchedulerReady()
Check if the scheduler has been initialized. |
boolean |
isServerAutoLoad()
Indicate if this task's server portion will be loaded during initialization |
boolean |
isServerJIT()
Indicate if this task's Java server task runs with the JIT enabled. |
boolean |
isServerSameJVM()
Determine if this task's Java server task will be run in the server's JVM. |
boolean |
isServerSameJVMConfigurable()
Determine if this task's Java server task will be run in or out of the engine's JVM based on the engine's configuration. |
boolean |
isServerSynchronous()
Indicate if this task's server portion will be loaded during initialization and will cause the server engine's initialization to wait for this task's server to indicate that it is ready. |
boolean |
isTaskDeleted()
|
boolean |
isTaskIconHidden()
Indicate if this task's icon will be displayed in the console's task pane. |
static boolean |
isTaskID(java.lang.String taskID)
Determine if a task has already been defined based on its task ID. |
boolean |
isUnrestricted()
See if this task is unrestricted with respect to user permissions. |
static void |
putTask(TWGTask task)
Add a task to the hash table. |
boolean |
removeSubtask(java.lang.String subtaskID)
|
protected void |
restoreData(TWGPersistentObjectDictionary dictionary,
boolean resolveObjectReferences)
Method for restoring persistent object data. |
protected void |
saveData(TWGPersistentObjectDictionary dictionary)
Method for saving persistent object data. |
abstract boolean |
serverActivate()
This abstract method is called by the server when it is activating the this task in preparation for activating a subtask. |
void |
serverActivationFailed()
This method is called by the server task if it has experienced some sort of error that is causing it to terminate. |
abstract boolean |
serverDeactivate()
This method is called by the server when it needs to deactivate a task. |
void |
serverDeactivationComplete()
This method is called by the server task to indicate that server task deactivation is complete after previously returning false to the serverDeactivate() call. |
abstract boolean |
serverTaskThread()
This method is called by the server to offer the server task a chance to own the thread that is being used to invoke serverActivate(). |
boolean |
setAttributeValue(java.lang.String id,
DataValue val)
Set value of attribute with given ID |
void |
setBoundInstance(boolean flag)
Specify that this task is to be bound to managed objects on an instance basis. |
void |
setExtensionClassName(java.lang.String extensionClassName)
Set the name of the extension class that defined this task. |
void |
setGuiClass(java.lang.String guiClass)
Set the name of the GUI class for this task. |
void |
setGuiParms(java.lang.String guiParms)
Set the name of the GUI class for this task. |
void |
setHelpTopicsMapping(java.lang.String helpTopicsMapping)
Set the name of the help topics mapping file. |
protected void |
setID(java.lang.String taskID)
Set the this task's ID |
void |
setImageSet(long imageSetID)
Set the image set for this task. |
void |
setImageSet(java.lang.String[] iconNames)
Set the image set for this task. |
void |
setLiteralTitle(boolean flag)
Set whether or not the task's title is a literal or a resource bundle key. |
void |
SetObjectID(long oid)
Set object ID. |
void |
setParent(TWGTask parent)
Set this task's parent. |
void |
setPrivileges(java.lang.String[] privNames,
boolean reset)
Set the list of privilege token names required to be able to use this subtask. |
void |
setPropertiesFileName(java.lang.String propertiesFileName)
Set the name of the properties file used to create this task. |
void |
setResourceBundle(java.lang.String resourceBundle)
Set the resource bundle for the task's labels. |
void |
setServerAutoLoad(boolean flag)
|
protected void |
setServerJIT(boolean flag)
Set this task's Java server to run with the JIT enabled. |
void |
setServerMaxHeapParm(java.lang.String val)
Set the maximum heap size parm for the Java server for this task. |
void |
setServerMinHeapParm(java.lang.String val)
Set the minimum heap size parm for the Java server for this task. |
void |
setServerName(java.lang.String serverName)
Set the name of the server Java class or native executable for this task. |
void |
setServerParms(java.lang.String serverParms)
Set the parameter string for the server class/native executable. |
void |
setServerRunThread(boolean flag)
Set whether this Java server task in engine JVM is to have run method called |
void |
setServerSameJVM(boolean flag)
Set this task's server portion to run in the same or different JVM |
void |
setServerSameJVMConfigurable(boolean flag)
Set this task's server portion to run in the same or different JVM based on the engine's configuration. |
void |
setServerSynchronous(boolean flag)
Set this task's server portion so that it will be loaded during initialization and will cause the server engine's initialization to wait for this task's server to indicate that it is ready. |
void |
setServerType(int serverType)
Set the type of the server portion of this task. |
void |
setServiceNode(java.lang.String serviceNode)
Set the name of the Service Node for this task. |
void |
setTaskData(byte[] taskData)
Set the data for this task. |
void |
setTaskIconHidden(boolean flag)
Set whether or not the task's icon will be displayed in the console's task pane. |
void |
setTempDisabled(boolean do_disable)
Set task disabled temporarily (non-persistently) |
void |
setTitleKey(java.lang.String titleKey)
Set the key used to retrieve the icon title from the resource file. |
void |
setUnrestricted(boolean flag)
Specify that this task is unrestricted with respect to user permissions. |
abstract int |
subtaskActivate(TWGTaskActivation act)
This method is called by the server when it receives a console command to activate a subtask. |
void |
subtaskActivationComplete(TWGTaskActivation act,
boolean success)
This method is called by the server task when subtask activation has completed after previously returning SUBTASK_ACT_PENDING from the subtaskActivate() call. |
abstract void |
subtaskDeactivate(TWGTaskActivation act)
This method is called by the server when it receives a console command to deactivate a subtask or if the active console that has started the subtask goes away. |
static void |
terminate()
Deactivate all active tasks |
java.lang.String |
toString()
Obtain a string representation of this TWGTask. |
void |
unsetParent()
Unset this task's parent |
void |
UpdateShadowVersion()
Update the shadow version of this task. |
Methods inherited from class com.tivoli.twg.engine.TWGPersistentObject |
---|
enableAsyncWrites, fromPersistID, isNewPersistentStore, isSaveRequired, PersistID, restore, restoreAll, save, save, setSaveRequired, toPersistID |
Methods inherited from class com.tivoli.twg.engine.TWGObject |
---|
AllObjects, AllObjects, DumpTWGObjects, FindObject, isDeleted, isNewObject, isPersistent, isPersistent, isValid, isValid, ObjectID, setDistinctObjectID |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Field Detail |
public static final java.lang.String CLASSNAME
public static final int TASK_STATE_STOPPED
public static final int TASK_STATE_STARTING
public static final int TASK_STATE_STARTED
public static final int TASK_STATE_STOPPING
public static final int TASK_STATE_FAILED
public static final int SUBTASK_ACT_COMPLETE
public static final int SUBTASK_ACT_FAILED
public static final int SUBTASK_ACT_PENDING
public static final int TASK_SERVER_AUTOLOAD
public static final int TASK_SERVER_SYNCHRONOUS
public static final int TASK_SERVER_SAME_JVM
public static final int TASK_DELETED
public static final int TASK_BIND_INSTANCE
public static final int TASK_SERVER_NO_RUN_THREAD
public static final int TASK_SERVER_SAME_JVM_CONFIGURABLE
public static final int TASK_SERVER_ENABLE_JIT
public static final int TASK_SERVER_TYPE_NONE
public static final int TASK_SERVER_TYPE_JAVA
public static final int TASK_SERVER_TYPE_NATIVE
protected static java.util.Hashtable tasks
protected static LongKeyTable tasksByToid
protected int dataStoreVersion
protected TWGClientTaskList clientTasks
protected java.util.Hashtable subtasks
protected StringValueSet privileges
protected java.lang.String propertiesFileName
protected java.util.Properties props
Constructor Detail |
public TWGTask()
Method Detail |
public static boolean isTaskID(java.lang.String taskID)
taskID
- string containing the task ID to check for.
public static void putTask(TWGTask task) throws TWGTaskException
TWGTaskException
- Thrown if the task's taskID is already in the table.public static int deleteTask(java.lang.String taskID)
taskID
- a string containing the ID of the task to destroy
public static int deleteTask(TWGTask task)
task
- the task to destroy.
public void Delete()
Delete
in class TWGObject
public void Destroy() throws TWGObjectDestroyException
Destroy
in class TWGPersistentObject
TWGObjectDestroyException
- if error during destroypublic static TWGTask getTask(java.lang.String taskID)
taskID
- string containing the ID of the task to retrieve.
public static TWGTask getTask(long toid)
toid
- object identifier the ID of the task to retrieve.
public static boolean isSchedulerReady()
public static long[] getAllTaskIdentifiers()
protected void checkPersistentStoreLevel()
public static void initialize()
public static void terminate()
public void destroyActivation(TWGTaskActivation act, int status)
public abstract boolean serverActivate()
public final void serverActivationFailed()
public abstract boolean serverDeactivate()
public final void serverDeactivationComplete()
public abstract boolean serverTaskThread()
public abstract int subtaskActivate(TWGTaskActivation act)
act
- the TWGTaskActivation object for this subtask activation.
public final void subtaskActivationComplete(TWGTaskActivation act, boolean success)
act
- the TWGTaskActivation object for this subtask activation.success
- true if activation successful, false if failedpublic abstract void subtaskDeactivate(TWGTaskActivation act)
public void UpdateShadowVersion()
UpdateShadowVersion
in interface TWGBaseShadowedObject
TWGShadowedObject
public long GetShadowVersion()
GetShadowVersion
in interface TWGBaseShadowedObject
TWGShadowedObject
public java.lang.String GetConShadowClass()
GetConShadowClass
in interface TWGBaseShadowedObject
TWGShadowedObject
public byte[] GetShadowRecord(java.util.Locale locale)
GetShadowRecord
in interface TWGBaseShadowedObject
locale
- - Locale to use for locale-specific data
TWGShadowedObject
public final int getState()
public final java.lang.String getID()
protected final void setID(java.lang.String taskID)
taskID
- the string ID of this taskpublic final TWGTask getParent()
public final long getParentID()
public final void setParent(TWGTask parent)
parent
- TWGTask to be set as the parent of this task.public final void unsetParent()
public final java.lang.String getTitleKey()
public final java.lang.String getTitle(java.util.Locale loc)
loc
- - locale for request
public final void setTitleKey(java.lang.String titleKey)
public final java.lang.String getPropertiesFileName()
public final void setPropertiesFileName(java.lang.String propertiesFileName) throws TWGTaskException
propertiesFileName
- the name of this task's property file.
TWGTaskException
public final java.lang.String getExtensionClassName()
public final void setExtensionClassName(java.lang.String extensionClassName)
public final java.lang.String getProperty(java.lang.String key)
key
- the property key
public final java.lang.String getProperty(java.lang.String key, java.lang.String defaultValue)
key
- the property keydefaultValue
- a default value
public final java.lang.String getServiceNode()
public final void setServiceNode(java.lang.String serviceNode)
serviceNode
- service node namepublic final java.lang.String getResourceBundle()
public final void setResourceBundle(java.lang.String resourceBundle) throws java.util.MissingResourceException
resourceBundle
- name of the resource bundle for the task
ResourceNotFound
- If the specified resource bundle is not found.
java.util.MissingResourceException
public final byte[] getTaskData()
public final void setTaskData(byte[] taskData)
NOTE: save() must be called in order for the task's data to actually be placed into persistent storage.
taskData
- a byte array to save as this task's datapublic final java.lang.String getServerName()
public final void setServerName(java.lang.String serverName)
serverName
- the name of the server Java class or native executable for this task.public final java.lang.String getServerMinHeapParm()
public final void setServerMinHeapParm(java.lang.String val)
val
- the minimum heap size parm (e.g., "4M" (megabytes) or "4096" (kilobytes))public final java.lang.String getServerMaxHeapParm()
public final void setServerMaxHeapParm(java.lang.String val)
val
- the maximum heap size parm (e.g., "128M" (megabytes) or "131072" (kilobytes))public final boolean isServerJIT()
protected final void setServerJIT(boolean flag)
flag
- true to enable the JIT for this Java task,
false to disable the JIT for this Java taskpublic final java.lang.String getServerParms()
public final void setServerParms(java.lang.String serverParms)
serverParms
- the parameter string for the server class/native executable.public final int getServerType()
public final void setServerType(int serverType)
serverType
- the type of the server portion of this task.public final java.lang.String getGuiClass()
public final void setGuiClass(java.lang.String guiClass)
guiClass
- the name of the GUI class for this task.public final java.lang.String getGuiParms()
public final void setGuiParms(java.lang.String guiParms)
guiParms
- the name of the GUI class for this task.public final java.lang.String getHelpTopicsMapping()
public final void setHelpTopicsMapping(java.lang.String helpTopicsMapping)
helpTopicsMapping
- the name of the help topics mapping filepublic final long getImageSet()
public final void setImageSet(java.lang.String[] iconNames) throws TWGTaskException
iconNames
- an array of strings that are the names of the icons
for this task.
TWGTaskException
public final void setImageSet(long imageSetID)
imageSetID
- image set id for this task.public final boolean addClient(java.lang.String clientClass, java.lang.String clientTaskList)
clientClass
- The name of the client task class being added to the
list of clients supported by this task.
public final boolean addClient(java.lang.String clientClass, java.lang.String clientTaskList, boolean single)
clientClass
- The name of the client task class being added to the
list of clients supported by this task.single
- true, if clientTasks is actually a single client task
instead of a list concatenated with the '|' character
public TWGClientTaskList getClientTasks()
public int getClientTaskCount(TWGManagedObject mo)
mo
- the TWGManagedObject to report
public final void addSubtask(java.lang.String subtaskID, java.lang.String menu, java.lang.String menuLocation, java.lang.String contextList, java.lang.String actionsList) throws com.tivoli.twg.engine.TWGTaskCreationException
subtaskID
- String containing the subtask's ID.menu
- String containing the TWGTaskMenuList elements
defining this subtask's label for menus.menuLocation
- String specifying the console locations where this
subtasks menu should be displayed.contextList
- String specifying the tasks context attributes
(i.e. interactive, client, server, targeted).
TWGTaskCreationException
- When syntax errors are discovered
in the String parameters or if a subtask with the
specified subtaskID already exists for this task.public final void addSubtask(java.lang.String subtaskID, java.lang.String menu, java.lang.String menuLocation, java.lang.String contextList, java.lang.String actionsList, java.lang.String privilegeList) throws com.tivoli.twg.engine.TWGTaskCreationException
subtaskID
- String containing the subtask's ID.menu
- String containing the TWGTaskMenuList elements
defining this subtask's label for menus.menuLocation
- String specifying the console locations where this
subtasks menu should be displayed.contextList
- String specifying the tasks context attributes
(i.e. interactive, client, server, targeted).privilegeList
- list of privileges required for user to be able
to use this subtask
TWGTaskCreationException
- When syntax errors are discovered
in the String parameters or if a subtask with the
specified subtaskID already exists for this task.public final boolean removeSubtask(java.lang.String subtaskID)
public final int getSubtaskCount()
public final TWGSubtask getSubtask(java.lang.String subtaskID)
subtaskID
- Subtaks ID string.
public java.util.Enumeration getAllSubtasks()
public final boolean hasSubtask(java.lang.String subtaskID)
public final boolean isTaskDeleted()
public final boolean isBoundInstance()
public final void setBoundInstance(boolean flag)
flag
- a booleanpublic final boolean isUnrestricted()
public final void setUnrestricted(boolean flag)
flag
- a booleanpublic final boolean isTaskIconHidden()
public final void setTaskIconHidden(boolean flag)
flag
- true to make hidden, false to make visiblepublic final boolean isLiteralTitle()
public final void setLiteralTitle(boolean flag)
flag
- true if title is a literal, false if title is a keypublic final boolean isServerAutoLoad()
public final void setServerAutoLoad(boolean flag)
public final boolean isServerSynchronous()
public final void setServerSynchronous(boolean flag)
public final boolean isServerSameJVM()
public final void setServerSameJVM(boolean flag)
flag
- true to load this Java task in the same JVM as the server,
false to create a new JVM for this Java taskpublic final boolean isServerSameJVMConfigurable()
public final void setServerSameJVMConfigurable(boolean flag)
flag
- true to base this task on the engine's configuration
false to base this task on the value returned by isServerSameJVM()public final boolean hasServerRunThread()
public final void setServerRunThread(boolean flag)
flag
- true for Java server task in engine JVM to have its run method calledpublic java.lang.String toString()
protected void saveData(TWGPersistentObjectDictionary dictionary) throws TWGPersistentObjectSaveException
saveData
in class TWGPersistentObject
TWGPersistentObjectSaveException
- thrown to abort save procedure.protected void restoreData(TWGPersistentObjectDictionary dictionary, boolean resolveObjectReferences) throws TWGPersistentObjectRestoreException
restoreData
in class TWGPersistentObject
resolveObjectReferences
- used to indicate if object references should be resolved during restore.
TWGPersistentObjectRestoreException
- thrown to abort restore procedure.public java.lang.String[] getAttributeIDList()
getAttributeIDList
in interface TWGGetSetInterface
public DataValue getAttributeValue(java.lang.String id, java.util.Locale loc)
getAttributeValue
in interface TWGGetSetInterface
id
- - attribute ID requestedloc
- - locale to use for value, if applicable
public boolean setAttributeValue(java.lang.String id, DataValue val)
setAttributeValue
in interface TWGGetSetInterface
id
- - attribute ID to be setval
- - attribute value to be set
public int getAttributeType(java.lang.String id)
getAttributeType
in interface TWGGetSetInterface
id
- - attribute ID
public void SetObjectID(long oid) throws DuplicateObjectIDException
SetObjectID
in class TWGObject
oid
- - new object ID, or INVALID_OBJECT_ID if none
DuplicateObjectIDException
- if ID is duplicatepublic void AttachObjectToConsole(TWGActiveConsole act_con)
AttachObjectToConsole
in interface TWGConsoleSpecShadowedObject
act_con
- - Active console instance to be associated withpublic void DetachObjectFromConsole(TWGActiveConsole act_con)
DetachObjectFromConsole
in interface TWGConsoleSpecShadowedObject
act_con
- - Active console instance to be disassociated frompublic void DetachObjectFromAllConsoles()
DetachObjectFromAllConsoles
in interface TWGConsoleSpecShadowedObject
public static void attachAllAllowedTasks(TWGActiveConsole con)
con
- - console instancepublic static void detachAllDisallowedTasks(TWGActiveConsole con)
con
- - console instancepublic void clientServiceAdded(java.lang.String svcname, TWGManagedObject mo)
clientServiceAdded
in interface TWGClientServiceListener
svcname
- - client service namemo
- - managed objectpublic void clientServiceRemoved(java.lang.String svcname, TWGManagedObject mo)
clientServiceRemoved
in interface TWGClientServiceListener
svcname
- - client service namemo
- - managed objectprotected void dumpProperties()
public final boolean isDisabled()
public void setTempDisabled(boolean do_disable)
do_disable
- - true if disable, false if enablepublic final boolean isDisabledSubtask(java.lang.String subid)
subid
- - subtask IDpublic void setPrivileges(java.lang.String[] privNames, boolean reset)
reset
- true if existing list should be reset before adding
false if new list should simple be added to existing listpublic java.lang.String[] getPrivileges()
public boolean checkPrivileges(StringValueSet checkSet)
|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |