|
IBM WebSphere Application ServerTM Release 7 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface CommandStep
Represents a step in a TaskCommand.
CommandStep extends from AdminCommand, thus it has most functionalities AdminCommand
offer. Besides it has couple of unique characteristics of its own.
A command step can not exist outside TaskCommand. In another word, you can not
create a command step from CommandMgr through createCommand
.
The only way you can get a command step is through a TaskCommand instance.
For the same reason, you can not execute command step directly.
A command step may be enabled or disabled. user can not access the step if
a command step is disabled. Disabled steps are skipped when the user navigates
through steps.
The parameter data of a command step can be a table. Each column represents
the values for one specific parameter and each row represents one set of parameter values
in the table. The row index starts from 0. User can read or modify any element
in the table by parameter name and row index in the table. User can also add
rows or delete rows through row index.
Method Summary | |
---|---|
void |
addRow(javax.management.AttributeList rowData,
int rowIndex)
Add a row to the table at the specified position. |
void |
deleteRow(int rowIndex)
Remove a row at the specified position from the table. |
java.lang.Object[] |
getChoices(java.lang.String paramName,
int rowIndex)
Returns valid values for the specified parameter. |
int |
getNumberOfRows()
Gets the number of rows in the table. |
java.lang.Object |
getParameter(java.lang.String parameterName,
int rowIndex)
Gets the parameter value for a specified parameter and row index. |
boolean |
isEnabled()
Tests if this command step is enabled or not. |
boolean |
isRequired()
Check if step has required data missing |
boolean |
isRequired(int rowIndex)
Check if row at the specified position has required data missing |
java.util.Collection |
listSetParams(int rowIndex)
Lists all the parameters are set. |
void |
setParameter(java.lang.String paramName,
java.lang.Object value,
int rowIndex)
Sets a parameter value. |
Methods inherited from interface com.ibm.websphere.management.cmdframework.AdminCommand |
---|
createParameterMetadata, execute, generateScript, getChoices, getCommandMetadata, getCommandResult, getConfigSession, getLocale, getName, getOrigParameterValue, getParameter, getTargetObject, getTargetObjectChoices, isAsyncCommand, isDynamicStepCommand, isPrivateParameter, listAllParameterName, listParameterName, listSetParams, save, setCmdHandler, setConfigSession, setLocale, setOrigParameterValue, setParameter, setTargetObject, validate |
Methods inherited from interface org.eclipse.emf.common.command.Command |
---|
canExecute, canUndo, chain, dispose, execute, getAffectedObjects, getDescription, getLabel, getResult, redo, undo |
Method Detail |
---|
boolean isEnabled()
java.util.Collection listSetParams(int rowIndex) throws java.lang.IndexOutOfBoundsException
rowIndex
- the row index in the table. Ignored if the command step parameter data is not a table.
java.lang.IndexOutOfBoundsException
java.lang.Object getParameter(java.lang.String parameterName, int rowIndex) throws InvalidParameterNameException, java.lang.IndexOutOfBoundsException
parameterName
- the name of a paramterrowIndex
- the row index in the table. Ignored if the command step parameter data is not a table.
InvalidParameterNameException
java.lang.IndexOutOfBoundsException
void setParameter(java.lang.String paramName, java.lang.Object value, int rowIndex) throws InvalidParameterValueException, InvalidParameterNameException, java.lang.IndexOutOfBoundsException
paramName
- the name of a parameter.value
- the value of a parameter.rowIndex
- the row index in the table. Ignored if the command step parameter data is not a table.
InvalidParameterValueException
InvalidParameterNameException
java.lang.IndexOutOfBoundsException
int getNumberOfRows()
void addRow(javax.management.AttributeList rowData, int rowIndex) throws InvalidParameterValueException, java.lang.IndexOutOfBoundsException, java.lang.UnsupportedOperationException
rowData
- the parameter data in a row. The attribute name is a
parameter name and the attribute value is the value for the parameter.rowIndex
- the row index in the table. Ignored if the command step parameter data is not a table.
java.lang.UnsupportedOperationException
- if the command step parameter data is not a table.
InvalidParameterValueException
java.lang.IndexOutOfBoundsException
void deleteRow(int rowIndex) throws java.lang.IndexOutOfBoundsException, java.lang.UnsupportedOperationException
rowIndex
- the row index in the table.
java.lang.UnsupportedOperationException
- if the command step parameter data is not a table.
java.lang.IndexOutOfBoundsException
boolean isRequired()
boolean isRequired(int rowIndex)
rowIndex
- the row index in the table.
java.lang.Object[] getChoices(java.lang.String paramName, int rowIndex)
paramName
- the parameter name.rowIndex
- the row index in the table.
|
IBM WebSphere Application ServerTM Release 7 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |