Skip navigation links

Oracle Fusion Middleware Java API Reference for Oracle Team Productivity Center
12c (12.1.2)
E23194-01


oracle.alm.connector.data
Class Criterion

java.lang.Object
  extended by oracle.alm.connector.data.Criterion


public class Criterion
extends java.lang.Object

The Criterion represents a single query criterion in a connector query.

This query object is passed to the connector by OTPC connector framework as the result of a search action on the OTPC client. Connector writer can use this Query Object to configure and implement the query against the backend repository and return the query result for the OTPC client.

Since:
11.1.1.1.0
See Also:
WorkItemQuery\, Operator\

Field Summary
static Criterion EMPTY_CRITERION
           
static java.lang.String OPERATOR_EQUAL
           
static java.lang.String OPERATOR_GREATTHAN
           
static java.lang.String OPERATOR_GREATTHANOREQUAL
           
static java.lang.String OPERATOR_LESSTHANOREQUAL
           
static java.lang.String OPERATOR_LESSTTHAN
           
static java.lang.String OPERATOR_LIKE
           
static java.lang.String OPERATOR_NOTEQUAL
           
static java.lang.String QUERY_NULL_VALUE
           

 

Constructor Summary
Criterion()
           
Criterion(java.lang.String attribute, Operator operator, java.lang.Object value)
          Constructs a criterion with specified work item field name, operator, and value.
Criterion(java.lang.String attribute, java.lang.String description, Operator operator, java.lang.Object value)
          Constructs a criterion with specified work item field name, description, operator, and value.

 

Method Summary
 java.lang.String getAttribute()
          Retrieves the work item field name from the criterion object.
 java.lang.String getDescription()
          Retrieves the description of the criterion.
 Operator getOperator()
          Retrieves the operator object for the criterion.
 java.lang.Object getValue()
          Retrieves the criterion value object.
 boolean isRequired()
          Deprecated. Use required attribute on WorkItemFieldDef instead.
 void setAttribute(java.lang.String attribute)
          Sets a new work item field name for the criterion.
 void setDescription(java.lang.String description)
          Sets the description of the criterion.
 void setOperator(Operator operator)
          Sets the operator object for the criterion.
 void setRequired(boolean required)
          Deprecated. Use required attribute on WorkItemFieldDef instead.
 void setValue(java.lang.Object value)
          Sets criterion value object.

 

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

 

Field Detail

EMPTY_CRITERION

public static final Criterion EMPTY_CRITERION

OPERATOR_EQUAL

public static final java.lang.String OPERATOR_EQUAL
See Also:
Constant Field Values

OPERATOR_NOTEQUAL

public static final java.lang.String OPERATOR_NOTEQUAL
See Also:
Constant Field Values

OPERATOR_LIKE

public static final java.lang.String OPERATOR_LIKE
See Also:
Constant Field Values

OPERATOR_GREATTHAN

public static final java.lang.String OPERATOR_GREATTHAN
See Also:
Constant Field Values

OPERATOR_LESSTTHAN

public static final java.lang.String OPERATOR_LESSTTHAN
See Also:
Constant Field Values

OPERATOR_GREATTHANOREQUAL

public static final java.lang.String OPERATOR_GREATTHANOREQUAL
See Also:
Constant Field Values

OPERATOR_LESSTHANOREQUAL

public static final java.lang.String OPERATOR_LESSTHANOREQUAL
See Also:
Constant Field Values

QUERY_NULL_VALUE

public static final java.lang.String QUERY_NULL_VALUE
See Also:
Constant Field Values

Constructor Detail

Criterion

public Criterion()

Criterion

public Criterion(java.lang.String attribute,
                 Operator operator,
                 java.lang.Object value)
Constructs a criterion with specified work item field name, operator, and value.
Parameters:
attribute - name of a work item field
operator - operator object
value - value object

Criterion

public Criterion(java.lang.String attribute,
                 java.lang.String description,
                 Operator operator,
                 java.lang.Object value)
Constructs a criterion with specified work item field name, description, operator, and value.
Parameters:
attribute - name of a work item field
description - description of the criterion
operator - operator object
value - value object

Method Detail

getAttribute

public java.lang.String getAttribute()
Retrieves the work item field name from the criterion object.
Returns:
the name of the work item field

setAttribute

public void setAttribute(java.lang.String attribute)
Sets a new work item field name for the criterion. If the passing attribute is null, then the criterion's field name is unchanged.
Parameters:
attribute - field of a work item

getDescription

public java.lang.String getDescription()
Retrieves the description of the criterion. By default if description is not set, the work item field name will be served as the description of the criterion.
Returns:
the description of the criterion

setDescription

public void setDescription(java.lang.String description)
Sets the description of the criterion. If the passing description is null, then the criterion's description is unchanged.
Parameters:
description - of the criterion

getOperator

public Operator getOperator()
Retrieves the operator object for the criterion.
Returns:
the operator object for the criterion.

setOperator

public void setOperator(Operator operator)
Sets the operator object for the criterion.
Parameters:
operator - operator object

getValue

public java.lang.Object getValue()
Retrieves the criterion value object.
Returns:
criterion value for the field

setValue

public void setValue(java.lang.Object value)
Sets criterion value object.
Parameters:
value - the value object

isRequired

public boolean isRequired()
Deprecated. Use required attribute on WorkItemFieldDef instead.
Returns:
the required value for the criterion object

setRequired

public void setRequired(boolean required)
Deprecated. Use required attribute on WorkItemFieldDef instead.
Parameters:
required -

Skip navigation links

Oracle Fusion Middleware Java API Reference for Oracle Team Productivity Center
12c (12.1.2)
E23194-01


Copyright © 2009,2013, Oracle. All rights reserved.