public static enum IDfXQuery.FtQueryOptions extends java.lang.Enum<IDfXQuery.FtQueryOptions>
Modifier and Type | Class and Description |
---|---|
static class |
IDfXQuery.FtQueryOptions.FTQueryOptionType
Specifies the type of the FtQueryOption
|
Enum Constant and Description |
---|
APPLICATION_CONTEXT
Specify the application context associated with the query.
|
APPLICATION_NAME
Specify the application in which this query is submitted from.
|
BATCH_SIZE
Specify the maximum number of results that ContentServer will fetch from the fulltext engine in
a batch (each fetchResultStream call to the xDB engine).
|
CACHING
Indicate whether to turn on xquery result prefetch caching.
|
LOCALE
Specify the locale that the query is written in.
|
PARALLEL_EXECUTION
Indicate whether execute the query with multiple threads in parallel.
|
QUERY_TYPE
Specify the query type of the query.
|
RETURN_CUTOFF_MESSAGE
Indicate whether to get the cutoff message after retrieving query result.
|
RETURN_SUMMARY
Indicate whether to return summary information (equivalent to selecting DQL fulltext SUMMARY keyword)
The option only takes effect when xhive:highlight() function is called in the xquery statement.
|
RETURN_TEXT
Indicate whether to return text information (equivalent to selecting DQL fulltext TEXT keyword)
The option only takes effect when xhive:highlight() function is called in the xquery statement.
|
SAVE_EXECUTION_PLAN
Indicate whether to return xquery execution plan and debugging information.
|
SECURITY_FILTER
Specify the symbolic security filter name that is used by xquery target to map to a security filter class.
|
SPOOLING
Indicate whether to spool the results of the xquery into a file.
|
TIMEOUT
Specify the timeout value (in milliseconds) for a query.
|
WAIT_FOR_RESULTS
Indicate whether to wait for the query result when the query is submitted.
|
Modifier and Type | Method and Description |
---|---|
IDfXQuery.FtQueryOptions.FTQueryOptionType |
getType() |
static IDfXQuery.FtQueryOptions |
valueOf(java.lang.String name)
Returns the enum constant of this type with the specified name.
|
static IDfXQuery.FtQueryOptions[] |
values()
Returns an array containing the constants of this enum type, in
the order they are declared.
|
public static final IDfXQuery.FtQueryOptions APPLICATION_CONTEXT
public static final IDfXQuery.FtQueryOptions APPLICATION_NAME
public static final IDfXQuery.FtQueryOptions BATCH_SIZE
public static final IDfXQuery.FtQueryOptions CACHING
public static final IDfXQuery.FtQueryOptions LOCALE
public static final IDfXQuery.FtQueryOptions PARALLEL_EXECUTION
public static final IDfXQuery.FtQueryOptions QUERY_TYPE
public static final IDfXQuery.FtQueryOptions RETURN_SUMMARY
public static final IDfXQuery.FtQueryOptions RETURN_TEXT
public static final IDfXQuery.FtQueryOptions SAVE_EXECUTION_PLAN
public static final IDfXQuery.FtQueryOptions SECURITY_FILTER
public static final IDfXQuery.FtQueryOptions SPOOLING
public static final IDfXQuery.FtQueryOptions TIMEOUT
public static final IDfXQuery.FtQueryOptions WAIT_FOR_RESULTS
public static final IDfXQuery.FtQueryOptions RETURN_CUTOFF_MESSAGE
public static IDfXQuery.FtQueryOptions[] values()
for (IDfXQuery.FtQueryOptions c : IDfXQuery.FtQueryOptions.values()) System.out.println(c);
public static IDfXQuery.FtQueryOptions valueOf(java.lang.String name)
name
- the name of the enum constant to be returned.java.lang.IllegalArgumentException
- if this enum type has no constant with the specified namejava.lang.NullPointerException
- if the argument is nullpublic IDfXQuery.FtQueryOptions.FTQueryOptionType getType()
Copyright 1994-2023 OpenText Corporation. All rights reserved.