it.eng.spagobi.bo.lov
Class QueryDetail

java.lang.Object
  extended by it.eng.spagobi.bo.lov.QueryDetail
All Implemented Interfaces:
ILovDetail, java.io.Serializable

public class QueryDetail
extends java.lang.Object
implements ILovDetail

Defines the QueryDetail objects. This object is used to store Query Wizard detail information.

See Also:
Serialized Form

Constructor Summary
QueryDetail()
          constructor
QueryDetail(java.lang.String dataDefinition)
          constructor
 
Method Summary
static QueryDetail fromXML(java.lang.String dataDefinition)
          Splits an XML string by using some SourceBean object methods in order to obtain the source QueryDetail objects whom XML has been built.
 java.lang.String getConnectionName()
           
 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 getQueryDefinition()
           
 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 setConnectionName(java.lang.String connectionName)
           
 void setDescriptionColumnName(java.lang.String descriptionColumnName)
           
 void setInvisibleColumnNames(java.util.List invisibleColumnNames)
           
 void setQueryDefinition(java.lang.String queryDefinition)
           
 void setValueColumnName(java.lang.String valueColumnName)
           
 void setVisibleColumnNames(java.util.List visibleColumnNames)
           
 java.lang.String toXML()
          serialize the lov to an xml string
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

QueryDetail

public QueryDetail()
constructor


QueryDetail

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

Parameters:
dataDefinition - the xml representation of the lov
Throws:
it.eng.spago.base.SourceBeanException
Method Detail

loadFromXML

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

Specified by:
loadFromXML in interface ILovDetail
Parameters:
dataDefinition - the xml definition of the lov
Throws:
it.eng.spago.base.SourceBeanException

toXML

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

Specified by:
toXML in interface ILovDetail
Returns:
the serialized xml string

getLovResult

public 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

Specified by:
getLovResult in interface ILovDetail
Parameters:
profile - the profile of the user
Returns:
the string result of the lov
Throws:
java.lang.Exception

getProfileAttributeNames

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

Specified by:
getProfileAttributeNames in interface ILovDetail
Returns:
list of profile attribute names
Throws:
java.lang.Exception

requireProfileAttributes

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

Specified by:
requireProfileAttributes in interface ILovDetail
Returns:
true if the lov require one or more profile attributes, false otherwise
Throws:
java.lang.Exception

fromXML

public static QueryDetail 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 QueryDetail objects whom XML has been built.

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

getConnectionName

public java.lang.String getConnectionName()

setConnectionName

public void setConnectionName(java.lang.String connectionName)

getQueryDefinition

public java.lang.String getQueryDefinition()

setQueryDefinition

public void setQueryDefinition(java.lang.String queryDefinition)

getDescriptionColumnName

public java.lang.String getDescriptionColumnName()
Specified by:
getDescriptionColumnName in interface ILovDetail

setDescriptionColumnName

public void setDescriptionColumnName(java.lang.String descriptionColumnName)
Specified by:
setDescriptionColumnName in interface ILovDetail

getInvisibleColumnNames

public java.util.List getInvisibleColumnNames()
Specified by:
getInvisibleColumnNames in interface ILovDetail

setInvisibleColumnNames

public void setInvisibleColumnNames(java.util.List invisibleColumnNames)
Specified by:
setInvisibleColumnNames in interface ILovDetail

getValueColumnName

public java.lang.String getValueColumnName()
Specified by:
getValueColumnName in interface ILovDetail

setValueColumnName

public void setValueColumnName(java.lang.String valueColumnName)
Specified by:
setValueColumnName in interface ILovDetail

getVisibleColumnNames

public java.util.List getVisibleColumnNames()
Specified by:
getVisibleColumnNames in interface ILovDetail

setVisibleColumnNames

public void setVisibleColumnNames(java.util.List visibleColumnNames)
Specified by:
setVisibleColumnNames in interface ILovDetail