it.eng.spagobi.tools.dataset.bo
Class DataSetParametersList

java.lang.Object
  extended by it.eng.spagobi.tools.dataset.bo.DataSetParametersList

public class DataSetParametersList
extends java.lang.Object

Defines method to manage dataset parametes


Constructor Summary
DataSetParametersList()
          constructor.
DataSetParametersList(java.lang.String dataDefinition)
          constructor.
 
Method Summary
 void add(java.lang.String name, java.lang.String type)
          Adds a dataset to the dataset Detail List.
static DataSetParametersList fromXML(java.lang.String dataDefinition)
          Splits an XML string by using some SourceBean object methods in order to obtain the source LovDetail objects whom XML has been built.
 java.lang.String getDataSetResult(it.eng.spago.security.IEngUserProfile profile)
          Returns the result of the Dataset using a user profile to fill the Datase profile attribute.
 java.util.List getItems()
          Gets item of the fixed list.
 java.util.List getProfileAttributeNames()
          Gets the list of names of the profile attributes required.
 void loadFromXML(java.lang.String dataDefinition)
          loads the lov from an xml string.
 void remove(java.lang.String name, java.lang.String type)
          Deletes a dataset from the dataset Detail List.
 boolean requireProfileAttributes()
          Checks if the dataset requires one or more profile attributes.
 void setPars(java.util.List items)
          Sets items of the fixed list.
 java.lang.String toXML()
          serialize the lov to an xml string.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

DataSetParametersList

public DataSetParametersList()
constructor.


DataSetParametersList

public DataSetParametersList(java.lang.String dataDefinition)
                      throws it.eng.spago.base.SourceBeanException
constructor.

Parameters:
dataDefinition - the data definition
Throws:
it.eng.spago.base.SourceBeanException - the source bean exception
Method Detail

loadFromXML

public void loadFromXML(java.lang.String dataDefinition)
                 throws it.eng.spago.base.SourceBeanException
loads the lov from an xml string.

Parameters:
dataDefinition - the xml definition of the lov
Throws:
it.eng.spago.base.SourceBeanException - the source bean exception

toXML

public java.lang.String toXML()
serialize the lov to an xml string.

Returns:
the serialized xml string

getDataSetResult

public java.lang.String getDataSetResult(it.eng.spago.security.IEngUserProfile profile)
                                  throws java.lang.Exception
Returns the result of the Dataset using a user profile to fill the Datase profile attribute.

Parameters:
profile - the profile of the user
Returns:
the string result of the lov
Throws:
java.lang.Exception - the exception

getProfileAttributeNames

public java.util.List getProfileAttributeNames()
                                        throws java.lang.Exception
Gets the list of names of the profile attributes required.

Returns:
list of profile attribute names
Throws:
java.lang.Exception - the exception

requireProfileAttributes

public boolean requireProfileAttributes()
                                 throws java.lang.Exception
Checks if the dataset requires one or more profile attributes.

Returns:
true if the dataset require one or more profile attributes, false otherwise
Throws:
java.lang.Exception - the exception

add

public void add(java.lang.String name,
                java.lang.String type)
Adds a dataset to the dataset Detail List.

Parameters:
name - The dataset lov name
type - the type

remove

public void remove(java.lang.String name,
                   java.lang.String type)
Deletes a dataset from the dataset Detail List.

Parameters:
name - the name
type - the type

fromXML

public static DataSetParametersList fromXML(java.lang.String dataDefinition)
                                     throws it.eng.spago.base.SourceBeanException
Splits an XML string by using some SourceBean object methods in order to obtain the source LovDetail objects whom XML has been built.

Parameters:
dataDefinition - The XML input String
Returns:
The corrispondent DatasetParameterList object
Throws:
it.eng.spago.base.SourceBeanException - If a SourceBean Exception occurred

getItems

public java.util.List getItems()
Gets item of the fixed list.

Returns:
items of the fixed list

setPars

public void setPars(java.util.List items)
Sets items of the fixed list.

Parameters:
items - the items to set