|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface DynamicTask
Extends the Task interface by methods which allow task parameters to be queried based on a (at least partially) populated Environment. By default, Tasks report the Parameters they use so that the on-line help system can supply that information to users at runtime. However, for some tasks the parameters in use depend on the value of other parameters. This interface allows tasks to make that information available. The method implementations are considered to be on a best-efforts basis, it is not guaranteed that they will be able to report all the parameters. This information is only used for user help.
Method Summary | |
---|---|
Parameter[] |
getContextParameters(Environment env)
Returns the parameters for this task in the context of a given execution environment. |
Parameter |
getParameterByName(Environment env,
String paramName)
Attempts to find a parameter with a given name that might be used by this task in the content of the given environment. |
Method Detail |
---|
Parameter getParameterByName(Environment env, String paramName) throws TaskException
This ought not to result in additional prompts to the user.
env
- execution environmentparamName
- requested parameter name
TaskException
Parameter[] getContextParameters(Environment env) throws TaskException
Task.getParameters()
, but found
settings of parameters in the presented environment may lead to
parameters being added to or removed from the list.
This ought not to result in additional prompts to the user.
env
- execution environment
TaskException
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |