|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.ibm.jsdt.facade.DynamicSolutionConfiguration
com.ibm.jsdt.facade.TaskConfiguration
public class TaskConfiguration
Provides a facade of apis to modify attributes of TaskGroup and Task objects. It can be used to perform the functions listed below. See method descriptions for more information.
NOTE: For any method that fails, an exception will be thrown. The exception object will contain the error message pertaining to the failure as well as additional information that may be pertinent. See the Java doc for each exception object for more information.
Field Summary | |
---|---|
static java.lang.String |
AIX
Constant used to set AIX as the target operating system. |
static java.lang.String |
HPUX_ITANIUM
Constant used to set HP-UX 64BIT as the target operating system. |
static java.lang.String |
HPUX_RISC
Constant used to set HP-UX as the target operating system. |
static java.lang.String |
LINUX
Deprecated. Use LINUX_X86_32 or LINUX_X86_64 instead |
static java.lang.String |
LINUX_ON_POWER
Constant used to set Linux on POWER as the target operating system. |
static java.lang.String |
LINUX_X86_32
Constant used to set 32-bit x86-based Linux as the target operating system. |
static java.lang.String |
LINUX_X86_64
Constant used to set 64-bit x86-based Linux as the target operating system. |
static java.lang.String |
OS400
Constant used to set i5 as the target operating system. |
static java.lang.String |
SUNOS_X86_32
Constant used to set SUN OS x86 32 bit as the target operating system. |
static java.lang.String |
SUNOS_X86_64
Constant used to set SUN OS x86 64 BIT as the target operating system. |
static java.lang.String |
WINDOWS
Constant used to set Windows as the target operating system. |
Constructor Summary | |
---|---|
TaskConfiguration()
Instantiates a TaskConfiguration option that is used to modify task and task group options. |
Method Summary | |
---|---|
void |
addTargetInfoForTask(java.lang.String taskID,
java.lang.String hostname,
java.lang.String userId,
java.lang.String password,
java.lang.String operatingSystem,
boolean storeCredentials)
Adds a target to a specified task. |
void |
removeTargetFromTask(java.lang.String taskID,
java.lang.String hostname)
Removes a target from a specified task. |
void |
setAllTasksOptional(boolean isOptional,
boolean setParentTaskGroup)
Sets all tasks isOptional attribute based upon the boolean passed in. |
void |
setAllTasksSelectedByDefault(boolean selected,
boolean setParentTaskGroup)
Sets the selection of all tasks based upon the boolean passed in. |
void |
setAllTasksSelectedByDefault(boolean selected,
boolean setParentTaskGroup,
boolean override)
Sets the selection of all the tasks depending on the value of the override boolean that is passed in which indicates whether or not to override tasks selection changes made by the user. |
void |
setTaskGroupOptional(java.lang.String id,
boolean isOptional,
boolean setAllChildTasks)
Sets a task group's isOptional attribute based upon the boolean passed in. |
void |
setTaskGroupSelectedByDefault(java.lang.String id,
boolean selectedByDefault,
boolean setAllChildTasks)
Sets the selection of a task group based upon the boolean passed in. |
void |
setTaskGroupSelectedByDefault(java.lang.String id,
boolean selectedByDefault,
boolean setAllChildTasks,
boolean override)
Sets the selection of the specified task group depending on the value of the override boolean that is passed in which indicates whether or not to override the task group selection change made by the user. |
void |
setTaskOptional(java.lang.String taskID,
boolean isOptional,
boolean setParentTaskGroup)
Sets a task's isOptional attribute based upon the boolean passed in. |
void |
setTaskSelectedByDefault(java.lang.String taskID,
boolean selectedByDefault,
boolean setParentTaskGroup)
Sets the selection of a task based upon the boolean passed in. |
void |
setTaskSelectedByDefault(java.lang.String taskID,
boolean selectedByDefault,
boolean setParentTaskGroup,
boolean override)
Sets the selection of the specified task depending on the value of the override boolean that is passed in which indicates whether or not to override the task selection change made by the user. |
void |
setVisibilityOnAllUnselectedTasksObjects(boolean visible)
Sets a boolean indicating whether or not the deployment wizard should hide any task group and task that is not already selected when the Deployment Wizard is launched. |
void |
skipAllTargetPanels(boolean skip)
Sets a boolean indicating whether or not the Deployment Wizard should skip all target panels. |
void |
skipAllTaskSelectionPanels(boolean skip)
Sets a boolean indicating whether or not the Deployment Wizard should skip all task group and task selection panels. |
void |
skipTargetPanel(java.lang.String taskID,
boolean skip)
Skips the target panel for the specified task id based on the boolean passed in. |
Methods inherited from class com.ibm.jsdt.facade.DynamicSolutionConfiguration |
---|
getApplicationIDList, getDeployables, getMainManager, getSharedVariableIDList, getSharedVariables, getSuite, getTaskGroupIDList, getTaskGroups, getTaskIDList, getTaskIDList, getTopLevelDeployables, getVariableIDList, isDeploymentWizardRunning, setDeployables, setMainManager, setSuite, setTopLevelDeployables, validateSolution |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
public static java.lang.String WINDOWS
public static java.lang.String LINUX
public static java.lang.String LINUX_X86_32
public static java.lang.String LINUX_X86_64
public static java.lang.String AIX
public static java.lang.String SUNOS_X86_32
public static java.lang.String SUNOS_X86_64
public static java.lang.String HPUX_RISC
public static java.lang.String HPUX_ITANIUM
public static java.lang.String OS400
public static java.lang.String LINUX_ON_POWER
Constructor Detail |
---|
public TaskConfiguration() throws DeployerNotRunningException
DeployerNotRunningException
- if this object is instantiated and the Deployment Wizard is not running
interactively or via a task file deployment. An example of improper usage would be attempting to
instantiating this class within a user program(i.e PreDeployment Checker, Main , Entry or Exit)Method Detail |
---|
public void setTaskSelectedByDefault(java.lang.String taskID, boolean selectedByDefault, boolean setParentTaskGroup) throws TaskObjectNotFoundException, InvalidTaskOptionException
For example: If the selected and setParentTaskGroup booleans are set to true for taskId "myTask", then task "myTask" will be selected as well it's parent task group. If setParentTaskGroup is false, then only task "myTask" will be selected.
NOTE: Selecting a task when the parent task group is not selected has no effect. RESTRICTIONS:
taskID
- - The task id for the task that is being modified.selectedByDefault
- - Indicates whether or not to select the tasksetParentTaskGroup
- - Indicates whether or not to select the task's parent task group
TaskObjectNotFoundException
- if the specified task could not be found in the solution.
InvalidTaskOptionException
- if one of the above mentioned restrictions are violatedpublic void setTaskSelectedByDefault(java.lang.String taskID, boolean selectedByDefault, boolean setParentTaskGroup, boolean override) throws TaskObjectNotFoundException, InvalidTaskOptionException
taskID
- - The task id for the task that is being modified.selectedByDefault
- - Indicates whether or not to select the tasksetParentTaskGroup
- - Indicates whether or not to select the task's parent task groupoverride
- - Indicates whether or not to override the task selection change made by the user
TaskObjectNotFoundException
- if the specified task could not be found in the solution.
InvalidTaskOptionException
- if one of the above mentioned restrictions are violatedpublic void setAllTasksSelectedByDefault(boolean selected, boolean setParentTaskGroup) throws InvalidTaskOptionException
For example: If the selected and setParentTaskGroup booleans are set to true all taskss will be selected as well their parent task group. If setParentTaskGroup is false, then only the individual tasks will be selected.
NOTE: Selecting a task when the parent task group is not selected has no effect. RESTRICTIONS:
selected
- - Indicates whether or not to select the tasksetParentTaskGroup
- - Indicates whether or not to select the task's parent task group
InvalidTaskOptionException
- if any of the restrictions are violatedpublic void setAllTasksSelectedByDefault(boolean selected, boolean setParentTaskGroup, boolean override) throws InvalidTaskOptionException
selected
- - Indicates whether or not to select the tasksetParentTaskGroup
- - Indicates whether or not to select the task's parent task groupoverride
- - Indicates whether or not to override tasks selection changes made by the user
InvalidTaskOptionException
- if any of the restrictions are violatedpublic void addTargetInfoForTask(java.lang.String taskID, java.lang.String hostname, java.lang.String userId, java.lang.String password, java.lang.String operatingSystem, boolean storeCredentials) throws TaskObjectNotFoundException, InvalidHostnameException
taskID
- hostname
- - Hostname, IP or fullyqualified hostname of the machine this task will be deployed touserId
- - Valid user name on this machinepassword
- - Valid passwordoperatingSystem
- - Operating System of this machine. Use the predefined operating system constants in this class.ostoreCredentials
- - Indicates whether or not to save the user id and pwd for subsequent sessions of the Deployment Wizard
TaskObjectNotFoundException
- if the specified task can not be found in the solution.
InvalidHostnameException
- if the hostname specified is not a properly formatted ip address, hostname or fullyqualified hostnamepublic void removeTargetFromTask(java.lang.String taskID, java.lang.String hostname) throws TaskObjectNotFoundException
taskID
- - ID of the task that the specified hostname is being removed from.hostname
- - Hostname, IP or fullyqualified hostname that is being removed.
TaskObjectNotFoundException
public void setTaskGroupSelectedByDefault(java.lang.String id, boolean selectedByDefault, boolean setAllChildTasks) throws InvalidTaskOptionException, TaskObjectNotFoundException
Setting a task group as selected by default has no effect on the child tasks. If you desire the child tasks to be selected based on whether the parent task group is selected then ensure the setAllChildTasks parameter is true. RESTRICTIONS:
id
- - The id for the task group that is being modified.selectedByDefault
- - Indicates whether or not to select the task groupsetAllChildTasks
- - Indicates whether or not to set the selection state of all the children to the same state as the parent task group
TaskObjectNotFoundException
- if the specified task could not be found in the solution.
InvalidTaskOptionException
- if one of the above mentioned restrictions are violatedpublic void setTaskGroupSelectedByDefault(java.lang.String id, boolean selectedByDefault, boolean setAllChildTasks, boolean override) throws InvalidTaskOptionException, TaskObjectNotFoundException
id
- - The id for the task group that is being modified.selectedByDefault
- - Indicates whether or not to select the task groupsetAllChildTasks
- - Indicates whether or not to set the selection state of all the children to the same state as the parent task groupoverride
- - Indicates whether or not to override the task group selection change made by the user
TaskObjectNotFoundException
- if the specified task could not be found in the solution.
InvalidTaskOptionException
- if one of the above mentioned restrictions are violatedpublic void skipAllTaskSelectionPanels(boolean skip)
skip
- public void skipTargetPanel(java.lang.String taskID, boolean skip) throws TaskObjectNotFoundException
Once all task selections have been made the validate method should be called to ensure that the solution is valid based on all changes that have been made. For example, the validate method will not allow a target panel to be skipped if at least one target has not been defined for each task. If this method is not called validation will be ran when the solution is loaded and the skip flag will be set to false if the specified task does not have a target defined. NOTE: This attribute is only valid during the current deployment wizard session.
taskID
- is the id of the task whose target panels will be skipped based on the boolean specifiedskip
- indicates whether or not to skip the target panel for the specified task
TaskObjectNotFoundException
- if the specified task can not be found in the solutionpublic void skipAllTargetPanels(boolean skip)
Once all task selections have been made the validateSolution() method should be called to ensure that the solution is valid based on all changes that have been made. For example, the validate method will not allow all target panels to be skipped if at least one target has not been defined for each task. As a safety precaution the Deployment Wizard will validate the solution when it is loaded and the skip flag will be set to false if each task does not have a target defined. NOTE: This attribute is only valid during the current deployment wizard session.
skip
- indicates whether or not to skip the target panel for the specified task
TaskObjectNotFoundException
- if the specified task can not be found in the solutionpublic void setVisibilityOnAllUnselectedTasksObjects(boolean visible)
NOTE: This method should not be called unless at least one task group has been pre-selected. This preselection could have been through settings in the Developer IDE or apis called that modify task selection. This is necessary to avoid launching the Deployment Wizard with no task groups or tasks visible because nothing was preselected.
visible
- public void setTaskOptional(java.lang.String taskID, boolean isOptional, boolean setParentTaskGroup) throws TaskObjectNotFoundException, InvalidTaskOptionException
Setting a task as required or optional has no effect on the it's parent task group. If you desire the parent task group to be required or optional based on whether the task is required or optional then ensure the setParentTaskGroup paramater is true. RESTRICTIONS:
id
- - The task id for the task that is being modified.isOptional
- - Indicates whether or not to the task is optional or required.setParentTaskGroup
- - Indicates whether or not to change the parent task group value based on the task value
TaskObjectNotFoundException
- if the specified task could not be found in the solution.
InvalidTaskOptionException
- if one of the above mentioned restrictions are violatedpublic void setAllTasksOptional(boolean isOptional, boolean setParentTaskGroup) throws InvalidTaskOptionException
Setting a task as required or optional has no effect on the it's parent task group. If you desire the parent task group to be required or optional based on whether the task is required or optional then ensure the setParentTaskGroup paramater is true. RESTRICTIONS:
isOptional
- setParentTaskGroup
-
InvalidTaskOptionException
- if one of the above mentioned restrictions are violatedpublic void setTaskGroupOptional(java.lang.String id, boolean isOptional, boolean setAllChildTasks) throws TaskObjectNotFoundException, InvalidTaskOptionException
Setting a task group as required or optional has no effect on the child tasks. If you desire the child tasks to be required or optional based on whether the parent task group is required or optional then ensure the setAllChildTasks paramater is true. RESTRICTIONS:
id
- - The task id for the task that is being modified.isOptional
- - Indicates whether or not the task group is optional or required.setAllChildTasks
- - Indicates whether or not to change the child tasks value based on the parent task group value
TaskObjectNotFoundException
- if the specified task could not be found in the solution.
InvalidTaskOptionException
- if one of the above mentioned restrictions are violated
|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |