it.eng.spagobi.behaviouralmodel.lov.bo
Class ScriptDetail

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

public class ScriptDetail
extends java.lang.Object
implements it.eng.spagobi.behaviouralmodel.lov.bo.ILovDetail

Defines the ScriptDetail objects. This object is used to store Script Wizard detail information.

See Also:
Serialized Form

Constructor Summary
ScriptDetail()
          constructor.
ScriptDetail(java.lang.String dataDefinition)
          constructor.
 
Method Summary
 boolean checkSintax(java.lang.String result)
          checks if the result is formatted in the right xml structure
 java.lang.String convertResult(java.lang.String result)
          In case the result of the string is not structured as expected wrap the result into the right xml envelope
static ScriptDetail fromXML(java.lang.String dataDefinition)
          Splits an XML string by using some SourceBean object methods in order to obtain the source ScriptDetail objects whom XML has been built.
 java.lang.String getDescriptionColumnName()
           
 java.util.List getInvisibleColumnNames()
           
 java.lang.String getLanguageScript()
           
 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 getScript()
          Get the string of the script.
 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 descriptionColumnName)
           
 void setInvisibleColumnNames(java.util.List invisibleColumnNames)
           
 void setLanguageScript(java.lang.String languageScript)
           
 void setScript(java.lang.String script)
          Set the string of the script.
 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
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

ScriptDetail

public ScriptDetail()
constructor.


ScriptDetail

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

Parameters:
dataDefinition - xml representation of the script lov
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.

Specified by:
loadFromXML in interface it.eng.spagobi.behaviouralmodel.lov.bo.ILovDetail
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.

Specified by:
toXML in interface it.eng.spagobi.behaviouralmodel.lov.bo.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 it.eng.spagobi.behaviouralmodel.lov.bo.ILovDetail
Parameters:
profile - the profile of the user
Returns:
the string result of the lov
Throws:
java.lang.Exception - the exception

checkSintax

public boolean checkSintax(java.lang.String result)
checks if the result is formatted in the right xml structure

Parameters:
result - the result of the lov
Returns:
true if the result is formatted correctly false otherwise

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 it.eng.spagobi.behaviouralmodel.lov.bo.ILovDetail
Returns:
list of profile attribute names
Throws:
java.lang.Exception - the exception

requireProfileAttributes

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

Specified by:
requireProfileAttributes in interface it.eng.spagobi.behaviouralmodel.lov.bo.ILovDetail
Returns:
true if the lov require one or more profile attributes, false otherwise
Throws:
java.lang.Exception - the exception

convertResult

public java.lang.String convertResult(java.lang.String result)
In case the result of the string is not structured as expected wrap the result into the right xml envelope

Parameters:
result - the result of the script
Returns:

getScript

public java.lang.String getScript()
Get the string of the script.

Returns:
The string of the script

setScript

public void setScript(java.lang.String script)
Set the string of the script.

Parameters:
script - the string of the script

fromXML

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

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

getDescriptionColumnName

public java.lang.String getDescriptionColumnName()
Specified by:
getDescriptionColumnName in interface it.eng.spagobi.behaviouralmodel.lov.bo.ILovDetail

setDescriptionColumnName

public void setDescriptionColumnName(java.lang.String descriptionColumnName)
Specified by:
setDescriptionColumnName in interface it.eng.spagobi.behaviouralmodel.lov.bo.ILovDetail

getInvisibleColumnNames

public java.util.List getInvisibleColumnNames()
Specified by:
getInvisibleColumnNames in interface it.eng.spagobi.behaviouralmodel.lov.bo.ILovDetail

setInvisibleColumnNames

public void setInvisibleColumnNames(java.util.List invisibleColumnNames)
Specified by:
setInvisibleColumnNames in interface it.eng.spagobi.behaviouralmodel.lov.bo.ILovDetail

getValueColumnName

public java.lang.String getValueColumnName()
Specified by:
getValueColumnName in interface it.eng.spagobi.behaviouralmodel.lov.bo.ILovDetail

setValueColumnName

public void setValueColumnName(java.lang.String valueColumnName)
Specified by:
setValueColumnName in interface it.eng.spagobi.behaviouralmodel.lov.bo.ILovDetail

getVisibleColumnNames

public java.util.List getVisibleColumnNames()
Specified by:
getVisibleColumnNames in interface it.eng.spagobi.behaviouralmodel.lov.bo.ILovDetail

setVisibleColumnNames

public void setVisibleColumnNames(java.util.List visibleColumnNames)
Specified by:
setVisibleColumnNames in interface it.eng.spagobi.behaviouralmodel.lov.bo.ILovDetail

getLanguageScript

public java.lang.String getLanguageScript()

setLanguageScript

public void setLanguageScript(java.lang.String languageScript)