|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface IParameters
Defines an utility for parameter access for stages. It facilitates the access to all parameters of the stage and all hierachical entities above it. Allows reading and writing of parameter values.
Method Summary | ||
---|---|---|
|
addStageParameter(Class<T> parameterClass,
String parameterID,
ParameterScope parameterScope,
String defaultValue,
String constraintDefinition)
Adds a new parameter to the current stage |
|
ParameterList |
getAllAvailableParameters()
Retrieves all parameters. |
|
ParameterList |
getApplicationParameters()
Retrieves all application parameters. |
|
ParameterList |
getProviderParameters()
Retrieves all provider parameters. |
|
ParameterList |
getServiceParameters()
Retrieves all service parameters. |
|
ParameterList |
getStageParameters()
Retrieves all stage parameters. |
|
void |
initialize(IStageInstance stage)
Initialize the parameter object, reading all parameter values from all scopes and sources |
Method Detail |
---|
<T extends IParameter<?>> T addStageParameter(Class<T> parameterClass, String parameterID, ParameterScope parameterScope, String defaultValue, String constraintDefinition) throws ParameterException
T
- the parameter class typeparameterClass
- the new parameter classparameterID
- the new parameter IDparameterScope
- the parameter scopedefaultValue
- the default parameterconstraintDefinition
-
ParameterException
ParameterList getAllAvailableParameters() throws ParameterException
ParameterException
- if there was an error refreshing the parameter valuesParameterList getApplicationParameters() throws ParameterException
ParameterException
- if there was an error refreshing the parameter valuesParameterList getProviderParameters() throws ParameterException
ParameterException
- if there was an error refreshing the parameter valuesParameterList getServiceParameters() throws ParameterException
ParameterException
- if there was an error refreshing the parameter valuesParameterList getStageParameters() throws ParameterException
ParameterException
- if there was an error refreshing the parameter valuesvoid initialize(IStageInstance stage)
stage
- the stage
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |