oracle.alm.connector.data
Class WorkItemQuery

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

public class WorkItemQuery
extends java.lang.Object

WorkItemQuery is a runtime data structure that holds all data for a single work item query.

Since:

11.1.1.1.0

See Also:

WorkItemQueryDef, Criterion

Nested Class Summary

static class

WorkItemQuery.QueryType

Field Summary

static java.lang.String	WHERE_FOR_UPDATE
static java.lang.String	WHERE_GROUP_BY
static java.lang.String	WHERE_HAVING
static java.lang.String	WHERE_ORDER_BY

Constructor Summary

WorkItemQuery()

Method Summary

java.lang.String	getColwidthinfo() Reserved for internal use only
WorkItemQueryDef.Conjunction	getConjunction() Retrieves the conjunction used
java.util.List<Criterion>	getCriteria() Retrieves criteria used for the query
java.util.List<java.lang.String>	getCustomSelectList() Retrieves the column names used for query selection list.
java.util.List<java.lang.String>	getDisplayList() Retrieve column names that can be used as query result table
java.util.Map<java.lang.String,ListItem>	getListData() Retrieves the ListItems used by the query
java.lang.String	getName() Retrives the query name
java.lang.String	getRowKey() Retrives the row key
java.lang.String	getSortinfo() Reserved for internal use only
WorkItemQuery.QueryType	getType() Retrieves the query type
java.util.Map<java.lang.String,java.lang.Boolean>	getValueBindings() Retrieves value binding set for all fields
java.lang.String	getWhereOptions() Retrieves the where options for the query
boolean	isDirty() Indicates if this query is modified
boolean	isDisclosed() Determines if the query form is hidden
boolean	isNew() Indicates if this query is a newly created
void	release() Release cached definitions
void	setColwidthinfo(java.lang.String val) Reserved for internal use only
void	setConjunction(WorkItemQueryDef.Conjunction conjunction) Sets the conjunction for the current query
void	setDirty(boolean dirty) Sets the flag to dirty for a modified query.
void	setDisclosed(boolean disclosed) Sets the "disclosed" state for the query.
void	setName(java.lang.String name) Sets the query name
void	setNew(boolean isNew) Sets to true for a new query.
void	setRowKey(java.lang.String rowKey) Sets the row key for the row data.
void	setSortinfo(java.lang.String val) Reserved for internal use only
void	setType(WorkItemQuery.QueryType type) Sets the query type
void	setValueBinding(java.lang.String name, java.lang.Boolean vb) Indicates if a query criterion has value binding instead of a direct value.
void	setWhereOptions(java.lang.String name) Sets the where options for the query

Methods inherited from class java.lang.Object

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

Field Detail

WHERE_GROUP_BY

public static final java.lang.String WHERE_GROUP_BY

See Also:

Constant Field Values

WHERE_HAVING

public static final java.lang.String WHERE_HAVING

See Also:

Constant Field Values

WHERE_ORDER_BY

public static final java.lang.String WHERE_ORDER_BY

See Also:

Constant Field Values

WHERE_FOR_UPDATE

public static final java.lang.String WHERE_FOR_UPDATE

See Also:

Constant Field Values

Constructor Detail

WorkItemQuery

public WorkItemQuery()

Method Detail

getName

public java.lang.String getName()

Retrives the query name

Returns:

the query name

setName

public void setName(java.lang.String name)

Sets the query name

Parameters:

name - query name

setRowKey

public void setRowKey(java.lang.String rowKey)

Sets the row key for the row data.

Parameters:

rowKey - rowkKey is unqiue per data row.

getRowKey

public java.lang.String getRowKey()

Retrives the row key

Returns:

the rowKey of the row data.

setNew

public void setNew(boolean isNew)

Sets to true for a new query.

Parameters:

isNew -

isNew

public boolean isNew()

Indicates if this query is a newly created

Returns:

true if the query is new, false otherwise

setDirty

public void setDirty(boolean dirty)

Sets the flag to dirty for a modified query.

Parameters:

dirty -

isDirty

public boolean isDirty()

Indicates if this query is modified

Returns:

true if the query is dirty, otherwise false

getCriteria

public java.util.List<Criterion> getCriteria()

Retrieves criteria used for the query

Returns:

all query criteria

getListData

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

Retrieves the ListItems used by the query

Returns:

listItems for all attributes in the row that are to be rendered in UI as choice (pickList), radioGroup, list, etc

setValueBinding

public void setValueBinding(java.lang.String name,
                            java.lang.Boolean vb)

Indicates if a query criterion has value binding instead of a direct value. For example, a value for aquery criterion could come from another field.

Parameters:

name - field name in a query criterion

vb - true if this field has valueBinding, false otherwise

getValueBindings

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

Retrieves value binding set for all fields

Returns:

all fields having valuebinding set

getConjunction

public WorkItemQueryDef.Conjunction getConjunction()

Retrieves the conjunction used

Returns:

the conjunction for the current query. The default conjunction for the query is AND

setConjunction

public void setConjunction(WorkItemQueryDef.Conjunction conjunction)

Sets the conjunction for the current query

Parameters:

conjunction -

setWhereOptions

public void setWhereOptions(java.lang.String name)

Sets the where options for the query

Parameters:

name - the string representing a where options

getWhereOptions

public java.lang.String getWhereOptions()

Retrieves the where options for the query

Returns:

return the WhereOptions String

getCustomSelectList

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

Retrieves the column names used for query selection list.

Returns:

the customized select list by customers during ALM Runtime, the customized Select List is persistent when saving a query.

getDisplayList

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

Retrieve column names that can be used as query result table

Returns:

the customized select list, this list is for UI purpose, it is usually a subset of CustomSelectList.

setType

public void setType(WorkItemQuery.QueryType type)

Sets the query type

Parameters:

type - the query team

getType

public WorkItemQuery.QueryType getType()

Retrieves the query type

Returns:

the query type

getSortinfo

public java.lang.String getSortinfo()

Reserved for internal use only

setSortinfo

public void setSortinfo(java.lang.String val)

Reserved for internal use only

getColwidthinfo

public java.lang.String getColwidthinfo()

Reserved for internal use only

setColwidthinfo

public void setColwidthinfo(java.lang.String val)

Reserved for internal use only

setDisclosed

public void setDisclosed(boolean disclosed)

Sets the "disclosed" state for the query. true if the query form is displayed, false if it is hidden.

Parameters:

disclosed -

isDisclosed

public boolean isDisclosed()

Determines if the query form is hidden

Returns:

The disclosed state of the query.

release

public void release()

Release cached definitions