com.filenet.api.constants
Class CBRQueryRankOverride
- java.lang.Object
-
- com.filenet.api.constants.CBRQueryRankOverride
-
- All Implemented Interfaces:
- java.io.Serializable
public final class CBRQueryRankOverride extends java.lang.Object implements java.io.Serializable
Provides a set of constants for specifying rank ordering behavior for CBR (content-based retrieval) queries that request rank order. The constants are set on the CBRQueryRankOverride property.- See Also:
- Serialized Form
-
-
Field Summary
Fields Modifier and Type Field and Description static CBRQueryRankOverride
DISABLED
Forces CBR-first only searches for queries that combine a CBR search and a relational search on a database (DB).static int
DISABLED_AS_INT
Anint
value associated with the DISABLED instance of this class.static CBRQueryRankOverride
ENABLED
Allows the Content Engine to operate in dynamic switching mode for queries that combine a CBR search and a database (DB) search.static int
ENABLED_AS_INT
Anint
value associated with the ENABLED instance of this class.static CBRQueryRankOverride
REQUIRED
Suppresses a request for rank order for all CBR searches, with or without dynamic switching enabled, including CBR-first searches.static int
REQUIRED_AS_INT
Anint
value associated with the REQUIRED instance of this class.
-
Method Summary
Methods Modifier and Type Method and Description static CBRQueryRankOverride
getInstanceFromInt(int value)
Returns an instance of this class using its associated integer value.int
getValue()
Returns the internal integer value associated with a specific instance of this class.java.lang.String
toString()
Returns aString
representation of this enumeration instance.
-
-
-
Field Detail
-
ENABLED_AS_INT
public static final int ENABLED_AS_INT
Anint
value associated with the ENABLED instance of this class. Consider using the static instances of this class instead of the associated int values. The int values risk binary incompatibility (but not source incompatibility) from release to release.- See Also:
- Constant Field Values
-
ENABLED
public static final CBRQueryRankOverride ENABLED
Allows the Content Engine to operate in dynamic switching mode for queries that combine a CBR search and a database (DB) search. Results for CBR-first searches return in rank order; results for DB-first searches do not return in rank order.
-
REQUIRED_AS_INT
public static final int REQUIRED_AS_INT
Anint
value associated with the REQUIRED instance of this class. Consider using the static instances of this class instead of the associated int values. The int values risk binary incompatibility (but not source incompatibility) from release to release.- See Also:
- Constant Field Values
-
REQUIRED
public static final CBRQueryRankOverride REQUIRED
Suppresses a request for rank order for all CBR searches, with or without dynamic switching enabled, including CBR-first searches.
-
DISABLED_AS_INT
public static final int DISABLED_AS_INT
Anint
value associated with the DISABLED instance of this class. Consider using the static instances of this class instead of the associated int values. The int values risk binary incompatibility (but not source incompatibility) from release to release.- See Also:
- Constant Field Values
-
DISABLED
public static final CBRQueryRankOverride DISABLED
Forces CBR-first only searches for queries that combine a CBR search and a relational search on a database (DB). Results return in rank order.
-
-
Method Detail
-
getValue
public int getValue()
Returns the internal integer value associated with a specific instance of this class.- Returns:
- The enumeration instance's ordinal value.
- See Also:
getInstanceFromInt(int)
-
toString
public java.lang.String toString()
Returns aString
representation of this enumeration instance.- Overrides:
toString
in classjava.lang.Object
- Returns:
- The enumeration instance's description.
-
getInstanceFromInt
public static CBRQueryRankOverride getInstanceFromInt(int value)
Returns an instance of this class using its associated integer value.- Parameters:
value
- The integer value. (See the *_AS_INT fields.)- Returns:
- The enumeration instance with the given ordinal value.
- Throws:
EngineRuntimeException
- If an enumeration instance with the given ordinal value does not exist.- See Also:
getValue()
-
-