|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.tivoli.twg.engine.TWGSubtask
This class is a container to hold information about a task's subtasks. It holds information like the subtask's label and which GUI actions are to activate a subtask (i.e. double-clicking, drag/drop, etc.). The primary way that TWGSubtask instances are created is by TWGDefaultTask while it is processing a properties file.
Method Summary | |
---|---|
boolean |
checkPrivileges(StringValueSet checkSet)
Check to see if the specified set of privileges is adequate for using this TWGTask. |
TWGConTask |
getConTask()
Get the task that owns this subtask. |
java.lang.String |
getID()
Get the ID of this subtask, |
long |
getJobID()
Get the ID of the job if this subtask is supposed to be activated via the scheduler. |
TWGTaskMenuList |
getMenu()
Get the menu object for this subtask. |
java.lang.String |
getName()
Get the name of this subtask. |
java.lang.String[] |
getPrivileges()
Get the list of privilege token names required to be able to use this subtask. |
byte[] |
getSubtaskData()
Get the data for this subtask. |
TWGTask |
getTask()
Get the task that owns this subtask. |
int |
getToolbarWeight()
Get the sorting weight factor for the toolbar icon. |
boolean |
hasServer()
Determine if this subtask has a server portion. |
boolean |
isCheckClients()
Determine if this subtask wants the clients checked for tasks. |
boolean |
isClientRequired()
Determin if this subtask requires a client service in order to bind the task to a managed object |
boolean |
isDisabled()
Is this subtask disabled, either directly or through inheritence from its parent? |
boolean |
isDoubleClick()
Determine if this subtask is the double click action for this task. |
boolean |
isDragDrop()
Determine if this subtask is the drag/drop (multi or single) action for this task. |
boolean |
isDragDropMulti()
Determine if this subtask is the multi-target drag/drop action for this task. |
boolean |
isDragDropSingle()
Determine if this subtask is the single-target drag/drop action for this task. |
boolean |
isFilterIconMenu()
Determine if this subtask's menu should be displayed on a filter's context menu. |
boolean |
isFilterPaneMenu()
Determine if this subtask's menu should be be displayed on the filter pane's context menu. |
boolean |
isGroupCategoryIconMenu()
Determine if this subtask's menu should be displayed on a group category's context menu. |
boolean |
isInteractive()
Determine if this subtask is interactive. |
boolean |
isMainMenu()
Determine if this subtask's menu should be displayed on the console's main menu. |
boolean |
isManagedObjectSupported(TWGConManagedObject cmo)
Determine if the specified managed object can be a target for this subtask. |
boolean |
isManagedObjectSupported(TWGManagedObject mo)
Determine if the specified managed object can be a target for this subtask. |
boolean |
isMultiTargeted()
Determine if this subtask is multi-targeted. |
boolean |
isNewCategoryTask()
Determine if this subtask is the request for a new category |
boolean |
isObjectIconMenu()
Determine if this subtask's menu should be displayed on an object's context menu. |
boolean |
isObjectPaneMenu()
Determine if this subtask's menu should be displayed on the object pane's context menu. |
boolean |
isScheduled()
Determine if this subtask is supposed to be activated via the scheduler. |
boolean |
isSingleTargeted()
Determine if this subtask is single targeted. |
boolean |
isStartClients()
Determine if this subtask wants the client tasks automatically started. |
boolean |
isTargeted()
Determine if this subtask is single or multi-targeted. |
boolean |
isTaskCategoryIconMenu()
Determine if this subtask's menu should be displayed on a task category's context menu. |
boolean |
isTaskIconMenu()
Determine if this subtask's menu should be displayed on the task icon's context menu. |
boolean |
isTaskPaneMenu()
Determine if this subtask's menu to should displayed on the task pane's context menu. |
boolean |
isToolbar()
Determine if this subtask is the toolbar action for this task. |
boolean |
isToolbarMenu()
Determine if this subtask's menu to should displayed on the console's toolbar |
void |
setCheckClients(boolean flag)
Set this subtask to check for client tasks. |
void |
setClientRequired(boolean flag)
Set this subtask to require a client in order to bind to a task |
void |
setDoubleClick(boolean flag)
Set the double click flag for this subtask. |
void |
setDragDrop(boolean flag)
Set the drag/drop flag for this subtask. |
void |
setDragDropMulti(boolean flag)
Set the drag/drop multi flag for this subtask. |
void |
setFilterIconMenu(boolean flag)
Set this subtask's menu to be displayed on a filter's context menu. |
void |
setFilterPaneMenu(boolean flag)
Set this subtask's menu to be displayed on the filter pane's context menu. |
void |
setGroupCategoryIconMenu(boolean flag)
Set this subtask's menu to be displayed on a group category's context menu. |
void |
setIgnoreClients()
Clear this subtask's client flags so that it neither checks nor starts client subtasks. |
void |
setInteractive(boolean flag)
Set this subtask's interactive flag. |
void |
setMainMenu(boolean flag)
Set this subtask's menu to be displayed on the console's main menu. |
void |
setMultiTargeted(boolean flag)
Set this subtask to be multi-targeted. |
void |
setNewCategoryTask(boolean flag)
Set flag indicating this subtask is the new category request subtask. |
void |
setObjectIconMenu(boolean flag)
Set this subtask's menu to be displayed on an object's context menu. |
void |
setObjectPaneMenu(boolean flag)
Set this subtask's menu to be displayed on the object pane's context menu. |
void |
setPrivileges(java.lang.String[] privNames,
boolean reset)
Set the list of privilege token names required to be able to use this subtask. |
void |
setScheduled(boolean flag)
Set this subtask's scheduled flag. |
void |
setServer(boolean flag)
Set this subtask's server flag. |
void |
setSingleTargeted(boolean flag)
Set this subtask to be single-targeted. |
void |
setStartClients(boolean flag)
Set this subtask to start the client tasks. |
void |
setSubtaskData(byte[] subtaskData)
Set the data for this task. |
void |
setTaskCategoryIconMenu(boolean flag)
Set this subtask's menu to be displayed on a task category's context menu. |
void |
setTaskIconMenu(boolean flag)
Set this subtask's menu to be displayed on the task icon's context menu. |
void |
setTaskPaneMenu(boolean flag)
Set this subtask's menu to be displayed on the task pane's context menu. |
void |
setToolbarMenu(boolean flag)
Set this subtask's menu to be displayed on the console's toolbar |
void |
setToolbarWeight(int weight)
Set the toolbar flag for this subtask. |
java.lang.String |
toString()
Get a string representation of this subtask. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Method Detail |
public java.lang.String toString()
public final TWGTask getTask()
public final TWGConTask getConTask()
public final boolean isDisabled()
public final java.lang.String getID()
public final long getJobID()
public final byte[] getSubtaskData()
public final void setSubtaskData(byte[] subtaskData)
NOTE: save() must be called in order for the task's data to actually be placed into persistent storage.
ALSO NOTE: this method only affects persistent storage this TWGSubtask is instantiated in the engine. If this TWGSubtask is in the console and you want to affect persistent storage then you must use a TWGSetAttributeCommand.
public final TWGTaskMenuList getMenu()
public final void setSingleTargeted(boolean flag)
public final void setMultiTargeted(boolean flag)
public final void setInteractive(boolean flag)
public final void setServer(boolean flag)
public final void setScheduled(boolean flag)
public final void setNewCategoryTask(boolean flag)
public final void setIgnoreClients()
public final void setCheckClients(boolean flag)
public final void setStartClients(boolean flag)
public final void setClientRequired(boolean flag)
public final void setDoubleClick(boolean flag)
public final void setToolbarWeight(int weight)
public final void setDragDrop(boolean flag)
public final void setDragDropMulti(boolean flag)
public final void setMainMenu(boolean flag)
public final void setToolbarMenu(boolean flag)
public final void setTaskIconMenu(boolean flag)
public final void setTaskPaneMenu(boolean flag)
public final void setObjectIconMenu(boolean flag)
public final void setObjectPaneMenu(boolean flag)
public final void setFilterIconMenu(boolean flag)
public final void setFilterPaneMenu(boolean flag)
public final void setGroupCategoryIconMenu(boolean flag)
public final void setTaskCategoryIconMenu(boolean flag)
public final boolean isSingleTargeted()
public final boolean isMultiTargeted()
public final boolean isTargeted()
public final boolean isInteractive()
public final boolean hasServer()
public final boolean isScheduled()
public final boolean isNewCategoryTask()
public final boolean isCheckClients()
public final boolean isStartClients()
public final boolean isClientRequired()
public final boolean isDoubleClick()
public final boolean isToolbar()
public final int getToolbarWeight()
public final boolean isDragDrop()
public final boolean isDragDropSingle()
public final boolean isDragDropMulti()
public final boolean isMainMenu()
public final boolean isToolbarMenu()
public final boolean isTaskIconMenu()
public final boolean isTaskPaneMenu()
public final boolean isObjectIconMenu()
public final boolean isObjectPaneMenu()
public final boolean isFilterIconMenu()
public final boolean isFilterPaneMenu()
public final boolean isGroupCategoryIconMenu()
public final boolean isTaskCategoryIconMenu()
public 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 final java.lang.String[] getPrivileges()
public boolean checkPrivileges(StringValueSet checkSet)
public final java.lang.String getName()
public final boolean isManagedObjectSupported(TWGConManagedObject cmo)
cmo
- the TWGConManagedObject to check against this subtask
public final boolean isManagedObjectSupported(TWGManagedObject mo)
|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |