pt.digitalis.dif.dem.objects.parameters
Interface IParameters

All Known Implementing Classes:
ParametersImpl

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.

Author:
Pedro Viegas pviegas@digitalis.pt
Created on:
Nov 22, 2007

Method Summary
<T extends IParameter<?>>
T
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

addStageParameter

<T extends IParameter<?>> T addStageParameter(Class<T> parameterClass,
                                              String parameterID,
                                              ParameterScope parameterScope,
                                              String defaultValue,
                                              String constraintDefinition)
                                          throws ParameterException
Adds a new parameter to the current stage

Type Parameters:
T - the parameter class type
Parameters:
parameterClass - the new parameter class
parameterID - the new parameter ID
parameterScope - the parameter scope
defaultValue - the default parameter
constraintDefinition -
Returns:
the newly created parameter (already added to the stage)
Throws:
ParameterException

getAllAvailableParameters

ParameterList getAllAvailableParameters()
                                        throws ParameterException
Retrieves all parameters. Gathers parameters for the stage, service, application and stage in a unique Map.

Returns:
the parameter list
Throws:
ParameterException - if there was an error refreshing the parameter values

getApplicationParameters

ParameterList getApplicationParameters()
                                       throws ParameterException
Retrieves all application parameters. Without hierachical inheritance.

Returns:
the parameter list
Throws:
ParameterException - if there was an error refreshing the parameter values

getProviderParameters

ParameterList getProviderParameters()
                                    throws ParameterException
Retrieves all provider parameters. Without hierachical inheritance.

Returns:
the parameter list
Throws:
ParameterException - if there was an error refreshing the parameter values

getServiceParameters

ParameterList getServiceParameters()
                                   throws ParameterException
Retrieves all service parameters. Without hierarchical inheritance.

Returns:
the parameter list
Throws:
ParameterException - if there was an error refreshing the parameter values

getStageParameters

ParameterList getStageParameters()
                                 throws ParameterException
Retrieves all stage parameters. Without hierachical inheritance.

Returns:
the parameter list
Throws:
ParameterException - if there was an error refreshing the parameter values

initialize

void initialize(IStageInstance stage)
Initialize the parameter object, reading all parameter values from all scopes and sources

Parameters:
stage - the stage


Copyright © 2014 Digitalis Informática Lda. All Rights Reserved.