com.sap.ip.me.api.pios.configuration
Class Configuration

java.lang.Object
  com.sap.ip.me.api.pios.configuration.Configuration

public class Configuration

extends java.lang.Object

The Configuration class represents a set of parameters and its values for a configuration type.

Since:

MI 2.5

Author:

Abaco

Constructor Summary

Configuration(java.lang.String name, java.lang.String type, ConfigurationManager confManager)
Internal use only.

Method Summary

java.lang.String	getName() Returns the name of the configuration.
java.lang.String[]	getParameters() Returns the parameters for this configuration.
java.lang.String	getParameterValue(java.lang.String parameter) Returns the parameter value.
java.lang.String[]	getPossibleValues(java.lang.String parameter) Returns all possible values for an specific parameter.
void	setParameterValue(java.lang.String parameter, java.lang.String value) Sets the parameter value.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Configuration

public Configuration(java.lang.String name,
                     java.lang.String type,
                     ConfigurationManager confManager)

Internal use only. Constructs a new Configuration instance using the specified configurationManager, name and type.

Parameters:

name - the name for the configuration.

type - the type for the configuration.

confManager - the instance of the configuration manager for this configuration.

Method Detail

getName

public java.lang.String getName()

Returns the name of the configuration.

Returns:

A string with the name of the configuration.

getParameters

public java.lang.String[] getParameters()

Returns the parameters for this configuration. If there are no parameters it will return a string array with 0 elements.

Returns:

A string array with the parameters.

getPossibleValues

public java.lang.String[] getPossibleValues(java.lang.String parameter)
                                     throws ConfigurationException

Returns all possible values for an specific parameter. If there are no possible values it will return a string array with 0 elements.

Parameters:

parameter - the parameter name

Returns:

A string array with the possible values for the parameter.

Throws:

ConfigurationException - thrown if the parameter is not valid.

getParameterValue

public java.lang.String getParameterValue(java.lang.String parameter)
                                   throws ConfigurationException

Returns the parameter value.

Parameters:

parameter - the parameter name.

Returns:

The value for this parameter.

Throws:

ConfigurationException - thrown if the parameter does not exist.

setParameterValue

public void setParameterValue(java.lang.String parameter,
                              java.lang.String value)
                       throws ConfigurationException

Sets the parameter value. The value is not validated against the possible values or any other source.

Parameters:

parameter - the parameter name

value - the value for this parameter

Throws:

ConfigurationException - thrown if the parameter does not exist