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

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

public class ScriptDetail
extends DependenciesPostProcessingLov
implements 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()
          Gets the description column name.
 java.util.List getInvisibleColumnNames()
          Gets the invisible column names.
 java.lang.String getLanguageScript()
           
 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.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()
          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 descriptionColumnName)
          Sets the description column name.
 void setInvisibleColumnNames(java.util.List invisibleColumnNames)
          Sets the invisible column names.
 void setLanguageScript(java.lang.String languageScript)
           
 void setScript(java.lang.String script)
          Set the string of the script.
 void setValueColumnName(java.lang.String valueColumnName)
          Sets the value column name.
 void setVisibleColumnNames(java.util.List visibleColumnNames)
          Sets the visible column names.
 java.lang.String toXML()
          serialize the lov to an xml string.
 
Methods inherited from class it.eng.spagobi.behaviouralmodel.lov.bo.DependenciesPostProcessingLov
intersectLists, processDependencies
 
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 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 ILovDetail
Returns:
the serialized xml string

getLovResult

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

Specified by:
getLovResult in interface ILovDetail
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
See Also:
throws 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 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 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()
Description copied from interface: ILovDetail
Gets the description column name.

Specified by:
getDescriptionColumnName in interface ILovDetail
Returns:
the description column name

setDescriptionColumnName

public void setDescriptionColumnName(java.lang.String descriptionColumnName)
Description copied from interface: ILovDetail
Sets the description column name.

Specified by:
setDescriptionColumnName in interface ILovDetail
Parameters:
descriptionColumnName - the new description column name

getInvisibleColumnNames

public java.util.List getInvisibleColumnNames()
Description copied from interface: ILovDetail
Gets the invisible column names.

Specified by:
getInvisibleColumnNames in interface ILovDetail
Returns:
the invisible column names

setInvisibleColumnNames

public void setInvisibleColumnNames(java.util.List invisibleColumnNames)
Description copied from interface: ILovDetail
Sets the invisible column names.

Specified by:
setInvisibleColumnNames in interface ILovDetail
Parameters:
invisibleColumnNames - the new invisible column names

getValueColumnName

public java.lang.String getValueColumnName()
Description copied from interface: ILovDetail
Gets the value column name.

Specified by:
getValueColumnName in interface ILovDetail
Returns:
the value column name

setValueColumnName

public void setValueColumnName(java.lang.String valueColumnName)
Description copied from interface: ILovDetail
Sets the value column name.

Specified by:
setValueColumnName in interface ILovDetail
Parameters:
valueColumnName - the new value column name

getVisibleColumnNames

public java.util.List getVisibleColumnNames()
Description copied from interface: ILovDetail
Gets the visible column names.

Specified by:
getVisibleColumnNames in interface ILovDetail
Returns:
the visible column names

setVisibleColumnNames

public void setVisibleColumnNames(java.util.List visibleColumnNames)
Description copied from interface: ILovDetail
Sets the visible column names.

Specified by:
setVisibleColumnNames in interface ILovDetail
Parameters:
visibleColumnNames - the new visible column names

getLanguageScript

public java.lang.String getLanguageScript()

setLanguageScript

public void setLanguageScript(java.lang.String languageScript)