it.eng.spagobi.bo.lov
Interface ILovDetail

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

public interface ILovDetail
extends java.io.Serializable

Defines methods to manage a lov


Method Summary
 java.lang.String getDescriptionColumnName()
           
 java.util.List getInvisibleColumnNames()
           
 java.lang.String getLovResult(it.eng.spago.security.IEngUserProfile profile)
          Returns the result of the lov using a user profile to fill the lov profile attribute
 java.util.List getProfileAttributeNames()
          Gets the list of names of the profile attributes required
 java.lang.String getValueColumnName()
           
 java.util.List getVisibleColumnNames()
           
 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)
           
 void setInvisibleColumnNames(java.util.List invisCols)
           
 void setValueColumnName(java.lang.String name)
           
 void setVisibleColumnNames(java.util.List visCols)
           
 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

getLovResult

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

Parameters:
profile - the profile of the user
Returns:
the string result of the lov
Throws:
java.lang.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

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

getVisibleColumnNames

java.util.List getVisibleColumnNames()
                                     throws java.lang.Exception
Throws:
java.lang.Exception

getInvisibleColumnNames

java.util.List getInvisibleColumnNames()
                                       throws java.lang.Exception
Throws:
java.lang.Exception

getValueColumnName

java.lang.String getValueColumnName()
                                    throws java.lang.Exception
Throws:
java.lang.Exception

getDescriptionColumnName

java.lang.String getDescriptionColumnName()
                                          throws java.lang.Exception
Throws:
java.lang.Exception

setVisibleColumnNames

void setVisibleColumnNames(java.util.List visCols)
                           throws java.lang.Exception
Throws:
java.lang.Exception

setInvisibleColumnNames

void setInvisibleColumnNames(java.util.List invisCols)
                             throws java.lang.Exception
Throws:
java.lang.Exception

setValueColumnName

void setValueColumnName(java.lang.String name)
                        throws java.lang.Exception
Throws:
java.lang.Exception

setDescriptionColumnName

void setDescriptionColumnName(java.lang.String name)
                              throws java.lang.Exception
Throws:
java.lang.Exception