com.ibm.rational.rpe.api.docspec
Class ConfigurationLayer

java.lang.Object
  extended by com.ibm.rational.rpe.api.docspec.ConfigurationLayer

public class ConfigurationLayer
extends java.lang.Object

The ConfigurationLayer class provides the functionality for resolving the configuration metadata defined in template data sources and variables. This class is not meant to be used directly, but through extension so that a user interface is provided to the user for choosing the appropriate options.
The configuration layer is a customized set of metadata that can be used when configuring data sources and variables for a report. This metadata is determined by the document designer and stored in the template to be used during document generation.
The configuration layer has this name because it is a layer of metadata that exists between the design and document generation stages. The metadata itself does not configure a data source or variable, but is used as a method of labeling and storing values for quick identification from the user interface of Rational® Publishing Engine or from a data source that incorporates Rational Reporting for Document Generation.
Configuration metadata is a mechanism for applying labels to sets of information to a set of data from your data source, whether it is a static list you create as a value set in the Central Management component or it is a dynamic value like a URL.


Nested Class Summary
static class ConfigurationLayer.ConfigurationValue
          This represents a Configuration Layer entry as returned by the readValueSet and readDataSet methods.
 
Constructor Summary
ConfigurationLayer()
           
 
Method Summary
static void readConfigurationData(com.ibm.rational.rpe.common.template.model.ConfigurationMetadata cfgMetadata, Credential credential, java.util.List<ConfigurationLayer.ConfigurationValue> data)
          Deprecated. 
 void readConfigurationData(com.ibm.rational.rpe.common.template.model.ConfigurationMetadata cfgMetadata, java.lang.String entityName, java.util.List<ConfigurationLayer.ConfigurationValue> data, Credential credential)
          Deprecated. 
static void readConfigurationOptions(com.ibm.rational.rpe.common.template.model.ConfigurationMetadata cfgMetadata, Credential credential, java.util.List<ConfigurationLayer.ConfigurationValue> data)
          Deprecated. 
 void readConfigurationOptions(com.ibm.rational.rpe.common.template.model.ConfigurationMetadata cfgMetadata, java.lang.String entityName, java.util.List<ConfigurationLayer.ConfigurationValue> data, Credential credential)
          Resolves the configuration metadata, if not empty.
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

ConfigurationLayer

public ConfigurationLayer()
Method Detail

readConfigurationOptions

public void readConfigurationOptions(com.ibm.rational.rpe.common.template.model.ConfigurationMetadata cfgMetadata,
                                     java.lang.String entityName,
                                     java.util.List<ConfigurationLayer.ConfigurationValue> data,
                                     Credential credential)
                              throws java.io.IOException,
                                     RPEException
Resolves the configuration metadata, if not empty. Depending on the metadata type, it will read the values from the Central Management component, such as from a value set or from a live stream.

Parameters:
cfgMetadata -
entityName -
data -
credential -
Throws:
AuthenticationException
java.io.IOException
RPEOtherException
RPEException

readConfigurationOptions

@Deprecated
public static void readConfigurationOptions(com.ibm.rational.rpe.common.template.model.ConfigurationMetadata cfgMetadata,
                                                       Credential credential,
                                                       java.util.List<ConfigurationLayer.ConfigurationValue> data)
                                     throws java.io.IOException,
                                            RPEException
Deprecated. 

Returns a collection of name-value pairs based on the configuration metadata. Only live streams are used. This method is deprecated and will be removed in a future release. Use the non-static method.

Throws:
java.io.IOException
RPEException

readConfigurationData

@Deprecated
public static void readConfigurationData(com.ibm.rational.rpe.common.template.model.ConfigurationMetadata cfgMetadata,
                                                    Credential credential,
                                                    java.util.List<ConfigurationLayer.ConfigurationValue> data)
                                  throws AuthenticationException,
                                         java.io.IOException,
                                         com.ibm.rational.rpe.common.utils.RPEOtherException
Deprecated. 

Returns a collection of name-value pairs based on the configuration metadata This method is deprecated. Use readConfigurationOptions Deprecated in 1.2.1

Throws:
AuthenticationException
java.io.IOException
com.ibm.rational.rpe.common.utils.RPEOtherException

readConfigurationData

@Deprecated
public void readConfigurationData(com.ibm.rational.rpe.common.template.model.ConfigurationMetadata cfgMetadata,
                                             java.lang.String entityName,
                                             java.util.List<ConfigurationLayer.ConfigurationValue> data,
                                             Credential credential)
                           throws AuthenticationException,
                                  java.io.IOException,
                                  com.ibm.rational.rpe.common.utils.RPEOtherException
Deprecated. 

Resolves the configuration metadata, if not empty. This method is deprecated. Use readConfigurationOptions Deprecated in 1.2.1

Throws:
AuthenticationException
java.io.IOException
com.ibm.rational.rpe.common.utils.RPEOtherException