com.filenet.api.constants
Class GroupAction
- java.lang.Object
-
- com.filenet.api.constants.GroupAction
-
- All Implemented Interfaces:
- java.io.Serializable
public class GroupAction extends java.lang.Object implements java.io.Serializable
Specifies the type of group action to apply to a set of content terms in a Stored Search query.- See Also:
- Serialized Form
-
-
Field Summary
Fields Modifier and Type Field and Description static GroupAction
ALL
Specifies that the group action is an AND condition.static GroupAction
ANY
Specifies that the group action is an OR condition.static GroupAction
IN
Specifies a group action based on the in context.static GroupAction
NEAR
Specifies that the group action is based on proximity, the NEAR condition.static GroupAction
NONE
Specifies no group action.static GroupAction
PARAGRAPH
Specifies a group action based on the paragraph context.static GroupAction
PHRASE
Specifies a group action based on the phrase context.static GroupAction
SENTENCE
Specifies a group action based on the sentence context.static GroupAction
UNIT
Specifies a group action based on the unit context.static GroupAction
VQL
Specifies the use of the native text query language.
-
Method Summary
Methods Modifier and Type Method and Description static GroupAction
getInstanceFromInt(int value)
Gets an instance of this class using its associated integer value (the*_AS_INT
fields).int
getValue()
Returns an integer value associated with a specific instance of this class.java.lang.String
toString()
Returns aString
representation of this instance.
-
-
-
Field Detail
-
NONE
public static final GroupAction NONE
Specifies no group action.
-
ANY
public static final GroupAction ANY
Specifies that the group action is an OR condition. If any of the grouped terms are found in the text the condition is satisfied.
-
ALL
public static final GroupAction ALL
Specifies that the group action is an AND condition. Only when all of the grouped terms are found in the text is the condition satisfied.
-
IN
public static final GroupAction IN
Specifies a group action based on the in context.
-
PARAGRAPH
public static final GroupAction PARAGRAPH
Specifies a group action based on the paragraph context.
-
SENTENCE
public static final GroupAction SENTENCE
Specifies a group action based on the sentence context.
-
NEAR
public static final GroupAction NEAR
Specifies that the group action is based on proximity, the NEAR condition.
-
PHRASE
public static final GroupAction PHRASE
Specifies a group action based on the phrase context.
-
UNIT
public static final GroupAction UNIT
Specifies a group action based on the unit context.
-
VQL
public static final GroupAction VQL
Specifies the use of the native text query language.
-
-
Method Detail
-
getValue
public int getValue()
Returns an integer value associated with a specific instance of this class.- Returns:
- An integer representing a specific instance of this class.
-
getInstanceFromInt
public static GroupAction getInstanceFromInt(int value)
Gets an instance of this class using its associated integer value (the*_AS_INT
fields).- Parameters:
value
- An integer representing a particular static instance of this class.- Returns:
- The referenced
RefreshMode
instance. - Throws:
EngineRuntimeException
- Thrown when thevalue
parameter isnull
or invalid.
-
toString
public java.lang.String toString()
Returns aString
representation of this instance.- Overrides:
toString
in classjava.lang.Object
- Returns:
- A
String
representing the instance.
-
-