|
|||||||||||
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.TWGTaskActivation
This class maintains all the pertinent information within the server for a task activation. It is also the focal point for controlling the task activation.
Constructor Summary | |
---|---|
TWGTaskActivation(TWGTask task,
TWGSubtask subtask)
Constructor accepting only the task/subtask to activate. |
|
TWGTaskActivation(TWGTask task,
TWGSubtask subtask,
Command cmd)
Constructor accepting only the task/subtask to activate. |
|
TWGTaskActivation(TWGTask task,
TWGSubtask subtask,
LongValueSet moid,
LongValueSet foid,
java.lang.String logName,
TWGTaskActivationListener listener,
byte[] taskActData)
Full blown constructor |
Method Summary | |
---|---|
void |
activeConsoleChanged(TWGActiveConsole console,
int conState)
Notification of an active console state change. |
void |
deactivateClient(long id,
int status)
Deactivate a client's tasks if it is in this activation's list |
void |
deactivateClients(boolean force)
Deactivate clients. |
void |
Destroy()
Destroy this activation. |
TWGLocalTaskClients |
getClients()
Get the collection of TWGLocalManagedObjects that represent the clients that are the targets of this activation. |
Command |
getCommand()
Get the task activation command that caused this activation to be created. |
long |
getConsoleActID()
Get the activation ID assigned by the console for this activation. |
LongValueSet |
getFoid()
Get the filter(s) that were resolved to obtain the target set. |
TWGLog |
getLog()
Get the TWGLog object to use to log status messages for this activation. |
java.lang.String |
getLogName()
Get log name |
LongValueSet |
getMoid()
Get the set of managed objects that are the target(s) for this activation |
long |
getServerActID()
Get the activation ID for this activation. |
int |
getStatus()
Get the status of this task activation. |
TWGSubtask |
getSubtask()
Get the TWGSubtask object being activated |
TWGTask |
getTask()
Get the TWGTask object being activated |
byte[] |
getTaskActData()
Get the taskActData from this activation |
java.lang.String |
getTitle()
|
TWGUser |
getUser()
Get user associated with activation |
void |
logMessage(java.lang.String message,
int level)
Log a non-translatable message to the log associeated with this activation. |
void |
logMessage(java.lang.String message,
int level,
int correlator)
Log a non-translatable message to the log associeated with this activation. |
void |
logMessage(java.lang.String message,
int level,
TWGManagedObject mo)
Log a non-translatable message to the log associeated with this activation. |
void |
logMessage(java.lang.String bundleName,
java.lang.String messageKey,
int level)
Log a message to the log associated with this activation. |
void |
logMessage(java.lang.String bundleName,
java.lang.String messageKey,
int level,
int correlator)
Log a message to the log associated with this activation. |
void |
logMessage(java.lang.String bundleName,
java.lang.String messageKey,
int level,
TWGManagedObject mo)
Log a message to the log associated with this activation. |
void |
setClientTaskStatus(long id,
int status)
Set the client task status for the specified client. |
void |
setLogName(java.lang.String logname)
Set log name |
void |
setStatus(int status)
Set the status of this task activation. |
void |
setTaskActData(byte[] taskActData)
Set the taskActData for this activation |
Methods inherited from class com.tivoli.twg.engine.TWGObject |
---|
AllObjects, AllObjects, Delete, DumpTWGObjects, FindObject, isDeleted, isNewObject, isPersistent, isPersistent, isValid, isValid, ObjectID, setDistinctObjectID, SetObjectID |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
public TWGTaskActivation(TWGTask task, TWGSubtask subtask)
task
- TWGTask to activate.subtask
- TWGSubtask to activate.public TWGTaskActivation(TWGTask task, TWGSubtask subtask, LongValueSet moid, LongValueSet foid, java.lang.String logName, TWGTaskActivationListener listener, byte[] taskActData)
task
- TWGTask to activate.subtask
- TWGSubtask to activate.moid
- LongValueSet containing the clients to activatefoid
- LongValueSet containing the filters that were resolvedlogName
- name of the log to write status messages tolistener
- TWGTaskActivationListener to notify with status changespublic TWGTaskActivation(TWGTask task, TWGSubtask subtask, Command cmd)
task
- TWGTask to activate.subtask
- TWGSubtask to activate.cmd
- task activation Command received that caused this activation to happenMethod Detail |
public java.lang.String getTitle()
public Command getCommand()
public TWGTask getTask()
public TWGSubtask getSubtask()
public LongValueSet getMoid()
public LongValueSet getFoid()
public TWGLocalTaskClients getClients()
public byte[] getTaskActData()
public void setTaskActData(byte[] taskActData)
taskActData
- byte[] for new taskActData valuepublic long getServerActID()
public long getConsoleActID()
public TWGUser getUser()
public TWGLog getLog()
public int getStatus()
public void setStatus(int status)
status
- the new status of this activation.public void Destroy() throws TWGObjectDestroyException
Destroy
in class TWGObject
TWGObjectDestroyException
- if error during destroypublic void activeConsoleChanged(TWGActiveConsole console, int conState)
activeConsoleChanged
in interface TWGActiveConsoleListener
console
- TWGActiveConsole object that changed.conState
- new state of the consolepublic void deactivateClients(boolean force)
force
- true if clients' statuses should be force to a final state
false if clients' statuses should be left in pending or activepublic void deactivateClient(long id, int status)
public void setClientTaskStatus(long id, int status)
id
- the managed object id of the client to setstatus
- the status of the client task. See TWGTaskConstants for
constants starting with CLIENT_TASK_public void logMessage(java.lang.String bundleName, java.lang.String messageKey, int level, int correlator)
bundleName
- the fully qualified name of the bundle to retrieve the
locale specific version of the message text.messageKey
- the key to use to retrieve the message from the bundle
Note: If your message has string substitutions (i.e.
{0}, {1}, etc. that you need to use with MessageFormat,
then the substitution values should be appended to the
message key using the vertical bar ("|") as a delimiter.level
- the level of detail of the message for selective
display; currently, 0-99=low, 100-199=medium, >200=highcorrelator
- If the message being logged pertains to a specific
managed object, then this value should be the object's
ID (moid) cast to an int; otherwise, this value should be 0.public void logMessage(java.lang.String bundleName, java.lang.String messageKey, int level, TWGManagedObject mo)
bundleName
- the fully qualified name of the bundle to retrieve the
locale specific version of the message text.messageKey
- the key to use to retrieve the message from the bundle
Note: If your message has string substitutions (i.e.
{0}, {1}, etc. that you need to use with MessageFormat,
then the substitution values should be appended to the
message key using the vertical bar ("|") as a delimiter.level
- the level of detail of the message for selective
display; currently, 0-99=low, 100-199=medium, >200=highmo
- The managed object to which this message pertainspublic void logMessage(java.lang.String bundleName, java.lang.String messageKey, int level)
bundleName
- the fully qualified name of the bundle to retrieve the
locale specific version of the message text.messageKey
- the key to use to retrieve the message from the bundle
Note: If your message has string substitutions (i.e.
{0}, {1}, etc. that you need to use with MessageFormat,
then the substitution values should be appended to the
message key using the vertical bar ("|") as a delimiter.level
- the level of detail of the message for selective
display; currently, 0-99=low, 100-199=medium, >200=highpublic void logMessage(java.lang.String message, int level)
message
- the non-translatable message text to loglevel
- the level of detail of the message for selective
display; currently, 0-99=low, 100-199=medium, >200=highpublic void logMessage(java.lang.String message, int level, TWGManagedObject mo)
message
- the non-translatable message text to loglevel
- the level of detail of the message for selective
display; currently, 0-99=low, 100-199=medium, >200=highmo
- The managed object to which this message pertainspublic void logMessage(java.lang.String message, int level, int correlator)
message
- the non-translatable message text to loglevel
- the level of detail of the message for selective
display; currently, 0-99=low, 100-199=medium, >200=highcorrelator
- If the message being logged pertains to a specific
managed object, then this value should be the object's
ID (moid) cast to an int; otherwise, this value should be 0.public void setLogName(java.lang.String logname)
public java.lang.String getLogName()
|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |