oracle.alm.connector.data
Class LovDef

java.lang.Object
  oracle.alm.connector.data.LovDef

public class LovDef
extends java.lang.Object

The LovDef defines the list of values used for a work item field. It is the run time data structure for the lovDef tag used in the connector model meta data XML file.

Since:

11.1.1.1.0

See Also:

RowDef, WorkItemQueryDef

Constructor Summary

LovDef(java.lang.String name, java.lang.String listDataSource)
Constructs an LovDef by the given name and the data source.

Method Summary

void	addCriteriaMapEntry(java.lang.String attrName, java.lang.String listAttrName) Adds an LOV criteria map reationship between a list field and a source field.
void	addCriteriaMapEntry(java.lang.String attrName, java.lang.String listAttrName, boolean isDependency) Adds an LOV criterion relationship between a list field and a source field.
void	addDisplayAttrEntry(java.lang.String listAttrName) Adds an display Attribute.
void	addMapEntry(java.lang.String listAttrName, java.lang.String attr) Adds an LOV map reationship between a list field and a source field.
java.util.Map<java.lang.String,java.lang.String>	getCriteriaMap() Retrieves the LOV criteria map.
java.util.Map<java.lang.String,java.lang.Boolean>	getDependencies() Retrieves the list of fields that the LOV depends on for its search.
java.util.List<java.lang.String>	getDisplayList() Returns the display field list.
java.lang.String	getListCriteriaDef() Retrieves the query criteria used to get the LOV query results.
java.lang.String	getListDataSource() Retrieves the data source name
java.util.Map<java.lang.String,java.lang.String>	getLovMap() Retrieves the LOV field map.
java.lang.String	getName() Retrieves the LOV name.
boolean	isDependentAttr(java.lang.String attrName) Decides if the work item source field is serving as a dependency for other fields for the LOV searching.
void	setListCriteriaRef(java.lang.String criteriaName) Sets the query criteria that is used to get the LOV query results.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

LovDef

public LovDef(java.lang.String name,
              java.lang.String listDataSource)

Constructs an LovDef by the given name and the data source.

Parameters:

name - name of the LOV definition

listDataSource - list data source name

Method Detail

getName

public java.lang.String getName()

Retrieves the LOV name.

Returns:

the name of the LOV definition

getListDataSource

public java.lang.String getListDataSource()

Retrieves the data source name

Returns:

the list data source name.

setListCriteriaRef

public void setListCriteriaRef(java.lang.String criteriaName)

Sets the query criteria that is used to get the LOV query results.

Parameters:

criteriaName -

getListCriteriaDef

public java.lang.String getListCriteriaDef()

Retrieves the query criteria used to get the LOV query results.

Returns:

the list criteria name.

addMapEntry

public void addMapEntry(java.lang.String listAttrName,
                        java.lang.String attr)

Adds an LOV map reationship between a list field and a source field. This map builds the relationship of how destination data should return to the source.

Parameters:

listAttrName - the list field name

attr - the source field name

addCriteriaMapEntry

public void addCriteriaMapEntry(java.lang.String attrName,
                                java.lang.String listAttrName)

Adds an LOV criteria map reationship between a list field and a source field. This map builds the relationship of how source data can serve as criteria for filtering LOV list data source.

Parameters:

attrName - the source field name

listAttrName - the LOV list field name

addCriteriaMapEntry

public void addCriteriaMapEntry(java.lang.String attrName,
                                java.lang.String listAttrName,
                                boolean isDependency)

Adds an LOV criterion relationship between a list field and a source field. The list field will get the corresponding submitted data for the source field from UI to form a criterion for filtering data from LOV list data source. The "isDependency" attribute is used to indicate whether this criterion is required for fetching data from the LOV list data source or not.

Parameters:

attrName - the source field name

listAttrName - the LOV list field name

isDependency - true if other base fileds are dependent on this LOV field

getLovMap

public java.util.Map<java.lang.String,java.lang.String> getLovMap()

Retrieves the LOV field map.

Returns:

the LOV Map. The map is a map of <listAttrName, fieldName>

getDependencies

public java.util.Map<java.lang.String,java.lang.Boolean> getDependencies()

Retrieves the list of fields that the LOV depends on for its search.

Returns:

A list of fields that the LOV depends on for its search

isDependentAttr

public boolean isDependentAttr(java.lang.String attrName)

Decides if the work item source field is serving as a dependency for other fields for the LOV searching.

Parameters:

attrName - the attribute name

Returns:

true if there is a dependency based on the field, otherwise false

getCriteriaMap

public java.util.Map<java.lang.String,java.lang.String> getCriteriaMap()

Retrieves the LOV criteria map.

Returns:

return the LOV criteriaMap. Criteria Map is a <sourceAttr, listAttr> Map

addDisplayAttrEntry

public void addDisplayAttrEntry(java.lang.String listAttrName)

Adds an display Attribute.

Parameters:

listAttrName -

getDisplayList

public java.util.List<java.lang.String> getDisplayList()

Returns the display field list.

Returns:

List of column names to show in the result list in the LOV dialog