oracle.alm.connector.data

Class WorkItemQueryDef

java.lang.Object

oracle.alm.connector.data.RowDef

oracle.alm.connector.data.WorkItemDef

oracle.alm.connector.data.WorkItemQueryDef

public class WorkItemQueryDef
extends WorkItemDef

WorkItemQueryDef is the data structure that holds the definition of a work item query.

Since:

11.1.1.1.0

See Also:

WorkItemQuery, Criterion

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	WorkItemQueryDef.Conjunction Query Conjunction definition

Field Summary

Fields

Modifier and Type	Field and Description
protected java.util.Map<java.lang.String,WorkItemFieldDef>	displayItemDefs

Fields inherited from class oracle.alm.connector.data.WorkItemDef

DEFAULT_TYPE_NAME, webReference

Fields inherited from class oracle.alm.connector.data.RowDef

DEFAULT_FETCH_SIZE

Constructor Summary

Constructors

Constructor and Description
WorkItemQueryDef()

Method Summary

Methods

Modifier and Type	Method and Description
void	addConjunctionSet(WorkItemQueryDef.Conjunction conj) Utility method to add a conjunction progmatically in the query conjunction set.
void	addDisplayFieldDef(java.lang.String name, WorkItemFieldDef wiFldDef) Adds a work item field as display field shown in the query result
java.lang.String	convertToDatabaseField(java.lang.String input) Reserved for internal use only
java.lang.String	convertToDatabaseField(java.lang.String input, java.lang.String separator) Reserved for internal use only
java.lang.String	convertToDisplayLabel(java.lang.String input) Reserved for internal use only
java.lang.String	convertToDisplayLabel(java.lang.String input, java.lang.String separator) Reserved for internal use only
java.util.Set	getConjunctionSet() get the query conjucntion set
WorkItemQuery	getDefaultCriteria()
java.lang.String	getDefaultOperator(WorkItemConnector connector, java.lang.String name, java.lang.Object value) Retrieves the default operator to use in the query form for the specified field It is the one shown in the drop down of the operator combo box.
java.util.Map<java.lang.String,WorkItemFieldDef>	getDisplayFieldDefs() Retrieves the definitions of fields used as columns in the query result table.
java.util.Map<java.lang.String,WorkItemFieldDef>	getDisplyFieldDefs() Deprecated. use getDisplayFieldDefs() instead.
WorkItemQueryDefModel	getModel()
java.lang.String	getOperatorHandlerClass() get the operator handling class for work item fields having customzied operator set.
java.util.Map<java.lang.String,java.lang.String>	getOperators(WorkItemConnector connector, java.lang.String name) Retrieves the operators to show in the query form for the specified field
java.util.Map<java.lang.String,WorkItemFieldDef>	getQueryFieldDefs()
java.lang.String	getSelectList() Retrieves the query select statement
WorkItemQueryDef	getWorkItemDef(java.lang.String sourceName) Deprecated. since 11.1.2.0, please use getWorkItemDef(WorkItemConnector connector, String sourceName, Object value)
WorkItemQueryDef	getWorkItemDef(WorkItemConnector connector, java.lang.String sourceName, java.lang.Object value) Retrieves the work item query definition for a specific LOV list field
void	setDefaultCriteria(WorkItemQuery defCriteria)
void	setDisplayFieldDefs(java.util.Map<java.lang.String,WorkItemFieldDef> displayItemDefs) Sets the display fields for the query result
void	setDisplyFieldDefs(java.util.Map<java.lang.String,WorkItemFieldDef> displayItemDefs) Deprecated. use setDisplayFieldDefs(Map<String, WorkItemFieldDef> displayItemDefs) instead.
void	setModel(WorkItemQueryDefModel model)
void	setOperatorHandlerClass(java.lang.String operatorHandler) Set the operator handling class for work item fields having customzied operator set.
void	setSelectList(java.lang.String selectStatement) Sets the query select statement

Methods inherited from class oracle.alm.connector.data.WorkItemDef

addWebReferenceEntry, createNew, getCommentDef, getDataSourceDefs, getFeatureHandlerClass, getIdDef, getIDLabel, getLabelDef, getName, getRepositoryDef, getSubjectDef, getType, getTypeLabel, getUrlHandlerClass, getWebReferences, isSupportSearchById, isSupportWorkItemCreation, setCommentDef, setFeatureHandlerClass, setIdDef, setIDLabel, setLabelDef, setName, setRepositoryDef, setSubjectDef, setSupportSearchById, setSupportWorkItemCreation, setType, setTypeLabel, setUrlHandlerClass

Methods inherited from class oracle.alm.connector.data.RowDef

getDataSource, getFieldDefs, getLovDefs, setDataSource

Methods inherited from class java.lang.Object

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

Field Detail

displayItemDefs

protected java.util.Map<java.lang.String,WorkItemFieldDef> displayItemDefs

Constructor Detail

WorkItemQueryDef

public WorkItemQueryDef()

Method Detail

getConjunctionSet

public java.util.Set getConjunctionSet()

get the query conjucntion set

getQueryFieldDefs

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

getModel

public WorkItemQueryDefModel getModel()

setModel

public void setModel(WorkItemQueryDefModel model)

addConjunctionSet

public void addConjunctionSet(WorkItemQueryDef.Conjunction conj)

Utility method to add a conjunction progmatically in the query conjunction set.

Parameters:

conj -

setSelectList

public void setSelectList(java.lang.String selectStatement)

Sets the query select statement

Parameters:

selectStatement -

setOperatorHandlerClass

public void setOperatorHandlerClass(java.lang.String operatorHandler)

Set the operator handling class for work item fields having customzied operator set.

Parameters:

operatorHandler -

getOperatorHandlerClass

public java.lang.String getOperatorHandlerClass()

get the operator handling class for work item fields having customzied operator set.

getSelectList

public java.lang.String getSelectList()

Retrieves the query select statement

Returns:

the query select statement

setDisplyFieldDefs

public void setDisplyFieldDefs(java.util.Map<java.lang.String,WorkItemFieldDef> displayItemDefs)

Deprecated. use setDisplayFieldDefs(Map<String, WorkItemFieldDef> displayItemDefs) instead.

Sets the display fields for the query result

Parameters:

displayItemDefs -

setDisplayFieldDefs

public void setDisplayFieldDefs(java.util.Map<java.lang.String,WorkItemFieldDef> displayItemDefs)

Sets the display fields for the query result

Parameters:

displayItemDefs -

addDisplayFieldDef

public void addDisplayFieldDef(java.lang.String name,
                      WorkItemFieldDef wiFldDef)

Adds a work item field as display field shown in the query result

Parameters:

name - work item attribute name

wiFldDef - work item field definition

setDefaultCriteria

public void setDefaultCriteria(WorkItemQuery defCriteria)

getDefaultCriteria

public WorkItemQuery getDefaultCriteria()

getWorkItemDef

public WorkItemQueryDef getWorkItemDef(java.lang.String sourceName)

Deprecated. since 11.1.2.0, please use getWorkItemDef(WorkItemConnector connector, String sourceName, Object value)

Parameters:

sourceName - the source field name

Returns:

the WorkItemQueryDef object

getWorkItemDef

public WorkItemQueryDef getWorkItemDef(WorkItemConnector connector,
                              java.lang.String sourceName,
                              java.lang.Object value)

Retrieves the work item query definition for a specific LOV list field

Parameters:

connector - the current connector object

sourceName - the current LOV list field name.

value - the submitted value for current LOV list field

Returns:

the WorkItemQueryDef for current LOV list field.

getDisplyFieldDefs

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

Deprecated. use getDisplayFieldDefs() instead.

Retrieves the definitions of fields used as columns in the query result table.

Returns:

field names that are used as display columns in the query result table.

getDisplayFieldDefs

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

Retrieves the definitions of fields used as columns in the query result table.

Returns:

field names that are used as display columns in the query result table.

getOperators

public java.util.Map<java.lang.String,java.lang.String> getOperators(WorkItemConnector connector,
                                                            java.lang.String name)

Retrieves the operators to show in the query form for the specified field

Returns:

the operators to show in the query form for the specified field

getDefaultOperator

public java.lang.String getDefaultOperator(WorkItemConnector connector,
                                  java.lang.String name,
                                  java.lang.Object value)

Retrieves the default operator to use in the query form for the specified field It is the one shown in the drop down of the operator combo box.

Returns:

the operator to show

convertToDatabaseField

public java.lang.String convertToDatabaseField(java.lang.String input)

Reserved for internal use only

convertToDatabaseField

public java.lang.String convertToDatabaseField(java.lang.String input,
                                      java.lang.String separator)

Reserved for internal use only

convertToDisplayLabel

public java.lang.String convertToDisplayLabel(java.lang.String input)

Reserved for internal use only

convertToDisplayLabel

public java.lang.String convertToDisplayLabel(java.lang.String input,
                                     java.lang.String separator)

Reserved for internal use only