com.crystaldecisions.sdk.occa.report.data
Class SelectionOperation

java.lang.Object
  extended by com.crystaldecisions.sdk.occa.report.data.SelectionOperation

public final class SelectionOperation
extends java.lang.Object

This class defines a selection operation in a formula. Except where specified, these values are used in conjunction with the ConstantValue object. Values 3 to 6 can be inclusive operations while the rest can not.


Field Summary
static int _anyValue
           The selection can be any value.
static int _equal
           The selection must equal a certain value.
static int _formula
           When this is set for the primitive expression's Operation, you only have to supply a RangeValue.
static int _greaterThan
           The selection must be greater than a certain value.
static int _inPeriod
           The selection must be within a certain time period.
static int _inRange
           The selection must be in a certain range.
static int _isFalse
           The selection must be false.
static int _isNotNull
           For internal use only.
static int _isNull
           For internal use only.
static int _isTrue
           The selection must be true.
static int _lessThan
           The selection must be less than a certain value.
static int _like
           The selection must be like a certain value.
static int _likeOneOf
           The selection must be like one of a certain of predefined set values.
static int _notEqual
           The selection may not equal a certain value.
static int _notGreaterThan
           The selection must not be greater than a certain value.
static int _notInPeriod
           The selection must not be within a certain time period.
static int _notInRange
           The selection must not be within a certain range.
static int _notLessThan
           The selection must not be less than a certain value.
static int _notLike
           The selection must not be like a certain value.
static int _notLikeOneOf
           The selection must not be like one of a predefined set of values.
static int _notOneOf
           The selection must not be one of a predefined selection of values.
static int _notOneOfNRanges
           The selection must not be one of N predefined selections of values.
static int _notStartWith
           The selection must not start with a certain value.
static int _notStartWithOneOf
           The selection must not start with one of a predefined set of values.
static int _oneOf
           The selection must be one of a predefined selection of values.
static int _oneOfNRanges
           The selection must be one of N predefined selections of values.
static int _startWith
           The selection must start with a certain value.
static int _startWithOneOf
           The selection must start with one of a predefined set of values.
static SelectionOperation anyValue
           A SelectionOperation object that specifies the selection can be any value.
static SelectionOperation equal
           A SelectionOperation object that specifies the selection must equal a certain value.
static SelectionOperation formula
           A SelectionOperation object that specifies when this is set for the primitive expression's Operation, you only have to supply a RangeValue.
static SelectionOperation greaterThan
           A SelectionOperation object that specifies the selection must be greater than a certain value.
static SelectionOperation inPeriod
           A SelectionOperation object that specifies the selection must be within a certain time period.
static SelectionOperation inRange
           A SelectionOperation object that specifies the selection must be in a certain range.
static SelectionOperation isFalse
           A SelectionOperation object that specifies the selection must be false.
static SelectionOperation isNotNull
           For internal use only.
static SelectionOperation isNull
           For internal use only.
static SelectionOperation isTrue
           A SelectionOperation object that specifies the selection must be true.
static SelectionOperation lessThan
           A SelectionOperation object that specifies the selection must be less than a certain value.
static SelectionOperation like
           A SelectionOperation object that specifies the selection must be like a certain value.
static SelectionOperation likeOneOf
           A SelectionOperation object that specifies the selection must be like one of a certain of predefined set values.
static SelectionOperation notEqual
           A SelectionOperation object that specifies the selection may not equal a certain value.
static SelectionOperation notGreaterThan
           A SelectionOperation object that specifies the selection must not be greater than a certain value.
static SelectionOperation notInPeriod
           A SelectionOperation object that specifies the selection must not be within a certain time period.
static SelectionOperation notInRange
           A SelectionOperation object that specifies the selection must not be within a certain range.
static SelectionOperation notLessThan
           A SelectionOperation object that specifies the selection must not be less than a certain value.
static SelectionOperation notLike
           A SelectionOperation object that specifies the selection must not be like a certain value.
static SelectionOperation notLikeOneOf
           A SelectionOperation object that specifies the selection must not be like one of a predefined set of values.
static SelectionOperation notOneOf
           A SelectionOperation object that specifies the selection must not be one of a predefined selection of values.
static SelectionOperation notOneOfNRanges
           A SelectionOperation object that specifies the selection must not be one of N predefined selections of values.
static SelectionOperation notStartWith
           A SelectionOperation object that specifies the selection must not start with a certain value.
static SelectionOperation notStartWithOneOf
           A SelectionOperation object that specifies the selection must not start with one of a predefined set of values.
static SelectionOperation oneOf
           A SelectionOperation object that specifies the selection must be one of a predefined selection of values.
static SelectionOperation oneOfNRanges
           A SelectionOperation object that specifies the selection must be one of N predefined selections of values.
static SelectionOperation startWith
           A SelectionOperation object that specifies the selection must start with a certain value.
static SelectionOperation startWithOneOf
           A SelectionOperation object that specifies the selection must start with one of a predefined set of values.
 
Method Summary
static SelectionOperation from_int(int i)
           Returns the SelectionOperation object corresponding to the specified value.
static SelectionOperation from_string(java.lang.String sVal)
           Returns the SelectionOperation object corresponding to the specified type.
 java.lang.String toString()
           Returns the String value of this SelectionOperation object.
 int value()
           Returns the int value of this SelectionOperation object.
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

_anyValue

public static final int _anyValue

The selection can be any value. The operation does not have any value as an argument.

See Also:
Constant Field Values

_equal

public static final int _equal

The selection must equal a certain value. The operation has one value as an argument.

See Also:
Constant Field Values

_notEqual

public static final int _notEqual

The selection may not equal a certain value. The operation has one value as an argument.

See Also:
Constant Field Values

_lessThan

public static final int _lessThan

The selection must be less than a certain value. The operation has one value as an argument.

See Also:
Constant Field Values

_greaterThan

public static final int _greaterThan

The selection must be greater than a certain value. The operation has one value as an argument.

See Also:
Constant Field Values

_notGreaterThan

public static final int _notGreaterThan

The selection must not be greater than a certain value. The operation has one value as an argument.

See Also:
Constant Field Values

_notLessThan

public static final int _notLessThan

The selection must not be less than a certain value. The operation has one value as an argument.

See Also:
Constant Field Values

_inRange

public static final int _inRange

The selection must be in a certain range. The operation has two values as arguments.

See Also:
Constant Field Values

_notInRange

public static final int _notInRange

The selection must not be within a certain range. The operation has two values as arguments.

See Also:
Constant Field Values

_oneOf

public static final int _oneOf

The selection must be one of a predefined selection of values. The operation may have multiple values as arguments.

See Also:
Constant Field Values

_notOneOf

public static final int _notOneOf

The selection must not be one of a predefined selection of values. The operation may have multiple values as arguments.

See Also:
Constant Field Values

_oneOfNRanges

public static final int _oneOfNRanges

The selection must be one of N predefined selections of values. The operation may have multiple values as arguments.

See Also:
Constant Field Values

_notOneOfNRanges

public static final int _notOneOfNRanges

The selection must not be one of N predefined selections of values. The operation may have multiple values as arguments.

See Also:
Constant Field Values

_inPeriod

public static final int _inPeriod

The selection must be within a certain time period. This operation is performed on a Date/Time field.

See Also:
Constant Field Values

_notInPeriod

public static final int _notInPeriod

The selection must not be within a certain time period. This operation is performed on a Date/Time field.

See Also:
Constant Field Values

_isTrue

public static final int _isTrue

The selection must be true. The operation does not have any values as arguments. This is used for boolean fields only.

See Also:
Constant Field Values

_isFalse

public static final int _isFalse

The selection must be false. The operation does not have any values as arguments. This is used for boolean fields only.

See Also:
Constant Field Values

_like

public static final int _like

The selection must be like a certain value. The operation has one value as an argument. This operation is for string fields.

See Also:
Constant Field Values

_notLike

public static final int _notLike

The selection must not be like a certain value. The operation has one value as an argument. This operation is for string fields.

See Also:
Constant Field Values

_likeOneOf

public static final int _likeOneOf

The selection must be like one of a certain of predefined set values. The operation may have multiple values as arguments. This operation is for string fields.

See Also:
Constant Field Values

_notLikeOneOf

public static final int _notLikeOneOf

The selection must not be like one of a predefined set of values. The operation may have multiple values as arguments. This operation is for string fields.

See Also:
Constant Field Values

_startWith

public static final int _startWith

The selection must start with a certain value. The operation has one value as an argument. This operation is for string fields.

See Also:
Constant Field Values

_notStartWith

public static final int _notStartWith

The selection must not start with a certain value. The operation has one value as an argument. This operation is for string fields.

See Also:
Constant Field Values

_startWithOneOf

public static final int _startWithOneOf

The selection must start with one of a predefined set of values. The operation may have multiple values as arguments. This operation is for string fields.

See Also:
Constant Field Values

_notStartWithOneOf

public static final int _notStartWithOneOf

The selection must not start with one of a predefined set of values. The operation may have multiple values as arguments. This operation is for string fields.

See Also:
Constant Field Values

_formula

public static final int _formula

When this is set for the primitive expression's Operation, you only have to supply a RangeValue. This will act as the whole expression and was intended to work with ExpressionValue objects.

See Also:
Constant Field Values

_isNull

public static final int _isNull

For internal use only.

See Also:
Constant Field Values

_isNotNull

public static final int _isNotNull

For internal use only.

See Also:
Constant Field Values

anyValue

public static final SelectionOperation anyValue

A SelectionOperation object that specifies the selection can be any value.


equal

public static final SelectionOperation equal

A SelectionOperation object that specifies the selection must equal a certain value.


notEqual

public static final SelectionOperation notEqual

A SelectionOperation object that specifies the selection may not equal a certain value.


lessThan

public static final SelectionOperation lessThan

A SelectionOperation object that specifies the selection must be less than a certain value.


greaterThan

public static final SelectionOperation greaterThan

A SelectionOperation object that specifies the selection must be greater than a certain value.


notGreaterThan

public static final SelectionOperation notGreaterThan

A SelectionOperation object that specifies the selection must not be greater than a certain value.


notLessThan

public static final SelectionOperation notLessThan

A SelectionOperation object that specifies the selection must not be less than a certain value.


inRange

public static final SelectionOperation inRange

A SelectionOperation object that specifies the selection must be in a certain range.


notInRange

public static final SelectionOperation notInRange

A SelectionOperation object that specifies the selection must not be within a certain range.


oneOf

public static final SelectionOperation oneOf

A SelectionOperation object that specifies the selection must be one of a predefined selection of values.


notOneOf

public static final SelectionOperation notOneOf

A SelectionOperation object that specifies the selection must not be one of a predefined selection of values.


oneOfNRanges

public static final SelectionOperation oneOfNRanges

A SelectionOperation object that specifies the selection must be one of N predefined selections of values.


notOneOfNRanges

public static final SelectionOperation notOneOfNRanges

A SelectionOperation object that specifies the selection must not be one of N predefined selections of values.


inPeriod

public static final SelectionOperation inPeriod

A SelectionOperation object that specifies the selection must be within a certain time period.


notInPeriod

public static final SelectionOperation notInPeriod

A SelectionOperation object that specifies the selection must not be within a certain time period.


isTrue

public static final SelectionOperation isTrue

A SelectionOperation object that specifies the selection must be true.


isFalse

public static final SelectionOperation isFalse

A SelectionOperation object that specifies the selection must be false.


like

public static final SelectionOperation like

A SelectionOperation object that specifies the selection must be like a certain value.


notLike

public static final SelectionOperation notLike

A SelectionOperation object that specifies the selection must not be like a certain value.


likeOneOf

public static final SelectionOperation likeOneOf

A SelectionOperation object that specifies the selection must be like one of a certain of predefined set values.


notLikeOneOf

public static final SelectionOperation notLikeOneOf

A SelectionOperation object that specifies the selection must not be like one of a predefined set of values.


startWith

public static final SelectionOperation startWith

A SelectionOperation object that specifies the selection must start with a certain value.


notStartWith

public static final SelectionOperation notStartWith

A SelectionOperation object that specifies the selection must not start with a certain value.


startWithOneOf

public static final SelectionOperation startWithOneOf

A SelectionOperation object that specifies the selection must start with one of a predefined set of values.


notStartWithOneOf

public static final SelectionOperation notStartWithOneOf

A SelectionOperation object that specifies the selection must not start with one of a predefined set of values.


formula

public static final SelectionOperation formula

A SelectionOperation object that specifies when this is set for the primitive expression's Operation, you only have to supply a RangeValue.


isNull

public static final SelectionOperation isNull

For internal use only.


isNotNull

public static final SelectionOperation isNotNull

For internal use only.

Method Detail

from_int

public static final SelectionOperation from_int(int i)

Returns the SelectionOperation object corresponding to the specified value.

Parameters:
i - The int value of the desired SelectionOperation object.
Returns:
The SelectionOperation object corresponding to the specified value.

from_string

public static final SelectionOperation from_string(java.lang.String sVal)

Returns the SelectionOperation object corresponding to the specified type.

Parameters:
sVal - The String value of the desired SelectionOperation object.
Returns:
The SelectionOperation object corresponding to the specified type.

toString

public java.lang.String toString()

Returns the String value of this SelectionOperation object.

Overrides:
toString in class java.lang.Object
Returns:
The String value of this SelectionOperation object.
Throws:
java.lang.IndexOutOfBoundsException

value

public int value()

Returns the int value of this SelectionOperation object.

Returns:
The int value of this SelectionOperation object.