|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectit.eng.spagobi.behaviouralmodel.lov.bo.DatasetDetail
public class DatasetDetail
Constructor Summary | |
---|---|
DatasetDetail()
|
|
DatasetDetail(java.lang.String dataDefinition)
constructor. |
Method Summary | |
---|---|
static DatasetDetail |
fromXML(java.lang.String dataDefinition)
Splits an XML string by using some SourceBean object methods
in order to obtain the source DatasetDetail objects whom XML has been
built. |
java.lang.String |
getDatasetId()
|
java.lang.String |
getDatasetLabel()
|
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 |
setDatasetId(java.lang.String datasetId)
|
void |
setDatasetLabel(java.lang.String datasetLabel)
|
void |
setDescriptionColumnName(java.lang.String descriptionColumnName)
Sets the description column name. |
void |
setInvisibleColumnNames(java.util.List invisibleColumnNames)
Sets the invisible column names. |
void |
setLovType(java.lang.String lovType)
Sets the type of the lov. |
void |
setTreeLevelsColumns(java.util.List treeLevelsColumns)
Sets the levels names of the tree lov |
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 java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public DatasetDetail()
public DatasetDetail(java.lang.String dataDefinition) throws it.eng.spago.base.SourceBeanException
dataDefinition
- xml representation of the script lov
it.eng.spago.base.SourceBeanException
- the source bean exceptionMethod Detail |
---|
public java.lang.String getDatasetId()
public void setDatasetId(java.lang.String datasetId)
datasetId
- the datasetId to setpublic java.lang.String getDatasetLabel()
public void setDatasetLabel(java.lang.String datasetLabel)
datasetLabel
- the datasetLabel to setpublic java.lang.String toXML()
ILovDetail
toXML
in interface ILovDetail
public void loadFromXML(java.lang.String dataDefinition) throws it.eng.spago.base.SourceBeanException
loadFromXML
in interface ILovDetail
dataDefinition
- the xml definition of the lov
it.eng.spago.base.SourceBeanException
- the source bean exceptionpublic java.lang.String getLovResult(it.eng.spago.security.IEngUserProfile profile, java.util.List<ObjParuse> dependencies, ExecutionInstance executionInstance) throws java.lang.Exception
ILovDetail
getLovResult
in interface ILovDetail
profile
- the profile of the userdependencies
- 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.
java.lang.Exception
- the exceptionpublic boolean requireProfileAttributes() throws java.lang.Exception
ILovDetail
requireProfileAttributes
in interface ILovDetail
java.lang.Exception
- the exceptionpublic java.util.List getProfileAttributeNames() throws java.lang.Exception
ILovDetail
getProfileAttributeNames
in interface ILovDetail
java.lang.Exception
- the exceptionpublic java.util.List getVisibleColumnNames()
ILovDetail
getVisibleColumnNames
in interface ILovDetail
public java.util.List getInvisibleColumnNames()
ILovDetail
getInvisibleColumnNames
in interface ILovDetail
public java.lang.String getDescriptionColumnName()
ILovDetail
getDescriptionColumnName
in interface ILovDetail
public void setVisibleColumnNames(java.util.List visibleColumnNames)
ILovDetail
setVisibleColumnNames
in interface ILovDetail
visibleColumnNames
- the new visible column namespublic void setInvisibleColumnNames(java.util.List invisibleColumnNames)
ILovDetail
setInvisibleColumnNames
in interface ILovDetail
invisibleColumnNames
- the new invisible column namespublic void setDescriptionColumnName(java.lang.String descriptionColumnName)
ILovDetail
setDescriptionColumnName
in interface ILovDetail
descriptionColumnName
- the new description column namepublic java.lang.String getValueColumnName()
ILovDetail
getValueColumnName
in interface ILovDetail
public void setValueColumnName(java.lang.String valueColumnName)
ILovDetail
setValueColumnName
in interface ILovDetail
valueColumnName
- the new value column namepublic static DatasetDetail fromXML(java.lang.String dataDefinition) throws it.eng.spago.base.SourceBeanException
SourceBean
object methods
in order to obtain the source DatasetDetail
objects whom XML has been
built.
dataDefinition
- The XML input String
DatasetDetail
object
it.eng.spago.base.SourceBeanException
- If a SourceBean Exception occurredpublic java.lang.String getLovType()
ILovDetail
getLovType
in interface ILovDetail
public void setLovType(java.lang.String lovType)
ILovDetail
setLovType
in interface ILovDetail
lovType
- the type of the lovpublic java.util.List getTreeLevelsColumns()
ILovDetail
getTreeLevelsColumns
in interface ILovDetail
public void setTreeLevelsColumns(java.util.List treeLevelsColumns)
ILovDetail
setTreeLevelsColumns
in interface ILovDetail
treeLevelsColumns
- levels names of the tree lov
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |