it.eng.spagobi.behaviouralmodel.lov.bo
Interface ILovDetail

All Superinterfaces:
java.io.Serializable
All Known Implementing Classes:
DatasetDetail, FixedListDetail, JavaClassDetail, QueryDetail, ScriptDetail

public interface ILovDetail
extends java.io.Serializable

Defines methods to manage a lov


Method Summary
 java.lang.String getDescriptionColumnName()
          Gets the description column name.
 java.util.List getInvisibleColumnNames()
          Gets the invisible column names.
 java.lang.String getLovResult(it.eng.spago.security.IEngUserProfile profile, java.util.List<ObjParuse> dependencies, ExecutionInstance executionInstance)
          Returns the result of the lov for a given user and for a particular execution instance with the given dependencies (optional).
 java.lang.String getLovType()
          Gets the type of the lov.
 java.util.List getProfileAttributeNames()
          Gets the list of names of the profile attributes required.
 java.util.List getTreeLevelsColumns()
          Gets the levels names of the tree lov
 java.lang.String getValueColumnName()
          Gets the value column name.
 java.util.List getVisibleColumnNames()
          Gets the visible column names.
 void loadFromXML(java.lang.String dataDefinition)
          loads the lov from an xml string.
 boolean requireProfileAttributes()
          Checks if the lov requires one or more profile attributes.
 void setDescriptionColumnName(java.lang.String name)
          Sets the description column name.
 void setInvisibleColumnNames(java.util.List invisCols)
          Sets the invisible column names.
 void setLovType(java.lang.String name)
          Sets the type of the lov.
 void setTreeLevelsColumns(java.util.List treeLevelColumns)
          Sets the levels names of the tree lov
 void setValueColumnName(java.lang.String name)
          Sets the value column name.
 void setVisibleColumnNames(java.util.List visCols)
          Sets the visible column names.
 java.lang.String toXML()
          serialize the lov to an xml string.
 

Method Detail

toXML

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

Returns:
the serialized xml string

loadFromXML

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

getLovResult

java.lang.String getLovResult(it.eng.spago.security.IEngUserProfile profile,
                              java.util.List<ObjParuse> dependencies,
                              ExecutionInstance executionInstance)
                              throws java.lang.Exception
Returns the result of the lov for a given user and for a particular execution instance with the given dependencies (optional).

Parameters:
profile - the profile of the user
dependencies - the dependencies to be considered for the lov. It may be null, since when testing a lov, there is no correlation.
executionInstance - the execution instance object, that contains the BIObject being executed. It may be null, since when testing a lov, there is no execution instance.
Returns:
the string result of the lov
Throws:
java.lang.Exception - the exception

requireProfileAttributes

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

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

getProfileAttributeNames

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

getVisibleColumnNames

java.util.List getVisibleColumnNames()
                                     throws java.lang.Exception
Gets the visible column names.

Returns:
the visible column names
Throws:
java.lang.Exception - the exception

getInvisibleColumnNames

java.util.List getInvisibleColumnNames()
                                       throws java.lang.Exception
Gets the invisible column names.

Returns:
the invisible column names
Throws:
java.lang.Exception - the exception

getValueColumnName

java.lang.String getValueColumnName()
                                    throws java.lang.Exception
Gets the value column name.

Returns:
the value column name
Throws:
java.lang.Exception - the exception

getDescriptionColumnName

java.lang.String getDescriptionColumnName()
                                          throws java.lang.Exception
Gets the description column name.

Returns:
the description column name
Throws:
java.lang.Exception - the exception

getLovType

java.lang.String getLovType()
Gets the type of the lov. Now the available types are: simple, tree

Returns:
name the type of the lov
Throws:
java.lang.Exception - the exception

getTreeLevelsColumns

java.util.List getTreeLevelsColumns()
                                    throws java.lang.Exception
Gets the levels names of the tree lov

Returns:
treeLevelColumns levels names of the tree lov
Throws:
java.lang.Exception - the exception

setVisibleColumnNames

void setVisibleColumnNames(java.util.List visCols)
                           throws java.lang.Exception
Sets the visible column names.

Parameters:
visCols - the new visible column names
Throws:
java.lang.Exception - the exception

setInvisibleColumnNames

void setInvisibleColumnNames(java.util.List invisCols)
                             throws java.lang.Exception
Sets the invisible column names.

Parameters:
invisCols - the new invisible column names
Throws:
java.lang.Exception - the exception

setValueColumnName

void setValueColumnName(java.lang.String name)
                        throws java.lang.Exception
Sets the value column name.

Parameters:
name - the new value column name
Throws:
java.lang.Exception - the exception

setDescriptionColumnName

void setDescriptionColumnName(java.lang.String name)
                              throws java.lang.Exception
Sets the description column name.

Parameters:
name - the new description column name
Throws:
java.lang.Exception - the exception

setLovType

void setLovType(java.lang.String name)
                throws java.lang.Exception
Sets the type of the lov. Now the available types are: simple, tree

Parameters:
name - the type of the lov
Throws:
java.lang.Exception - the exception

setTreeLevelsColumns

void setTreeLevelsColumns(java.util.List treeLevelColumns)
                          throws java.lang.Exception
Sets the levels names of the tree lov

Parameters:
treeLevelColumns - levels names of the tree lov
Throws:
java.lang.Exception - the exception