public interface QueryOptionsManager
Modifier and Type | Method and Description |
---|---|
void |
deleteOptions(java.lang.String name)
Remove a search configuration from the REST server.
|
<T extends QueryOptionsListReadHandle> |
optionsList(T listHandle)
Retrieves the list of available named query options in a JSON or
XML representation provided as an object of an IO class.
|
<T> T |
optionsListAs(Format format,
java.lang.Class<T> as)
Retrieves the list of available named query options in a JSON or
XML representation provided as an object of an IO class.
|
<T extends QueryOptionsReadHandle> |
readOptions(java.lang.String name,
T queryOptionsHandle)
Fetch a query options configuration from the REST Server by name.
|
<T> T |
readOptionsAs(java.lang.String name,
Format format,
java.lang.Class<T> as)
Fetch a query options configuration from the REST Server by name.
|
void |
writeOptions(java.lang.String name,
QueryOptionsWriteHandle queryOptionsHandle)
Write a named QueryOptions configuration to the REST server.
|
void |
writeOptionsAs(java.lang.String name,
Format format,
java.lang.Object queryOptions)
Write a named QueryOptions configuration to the REST server in a JSON or
XML representation provided as an object of an IO class.
|
<T> T optionsListAs(Format format, java.lang.Class<T> as) throws ForbiddenUserException, FailedRequestException
ContentHandle
are registered.
Learn more about shortcut methodsT
- the type of object that will be returned by the handle registered for itformat
- whether to provide the list in a JSON or XML representationas
- the IO class for reading the list of optionsForbiddenUserException
FailedRequestException
<T extends QueryOptionsListReadHandle> T optionsList(T listHandle) throws ForbiddenUserException, FailedRequestException
T
- the type of QueryOptionsListReadHandle to returnlistHandle
- a handle for reading the list of name optionsForbiddenUserException
FailedRequestException
<T> T readOptionsAs(java.lang.String name, Format format, java.lang.Class<T> as) throws ResourceNotFoundException, ForbiddenUserException, FailedRequestException
ContentHandle
are registered.
Learn more about shortcut methodsT
- the type of object that will be returned by the handle registered for itname
- the name of options configuration stored on MarkLogic REST instance.format
- whether to provide the options in a JSON or XML representationas
- the IO class for reading the query optionsResourceNotFoundException
ForbiddenUserException
FailedRequestException
<T extends QueryOptionsReadHandle> T readOptions(java.lang.String name, T queryOptionsHandle) throws ResourceNotFoundException, ForbiddenUserException, FailedRequestException
Use a QueryOptionsHandle object for access to the configuration with Java.
T
- the type of QueryOptionsListReadHandle to returnname
- the name of options configuration stored on MarkLogic REST instance.queryOptionsHandle
- an object into which to fetch the query options.ResourceNotFoundException
ForbiddenUserException
FailedRequestException
void writeOptionsAs(java.lang.String name, Format format, java.lang.Object queryOptions) throws ResourceNotFoundException, ResourceNotResendableException, ForbiddenUserException, FailedRequestException
ContentHandle
are registered.
Learn more about shortcut methodsname
- name given to the QueryOptions for use in runtime queriesformat
- whether the options are provided in a JSON or XML representationqueryOptions
- an IO representation of the JSON or XML query optionsResourceNotFoundException
ResourceNotResendableException
ForbiddenUserException
FailedRequestException
void writeOptions(java.lang.String name, QueryOptionsWriteHandle queryOptionsHandle) throws FailedRequestException, ForbiddenUserException, ResourceNotFoundException, ResourceNotResendableException
name
- name given to the QueryOptions for use in runtime queriesqueryOptionsHandle
- an object able to serialize a QueryOptions configurationFailedRequestException
ForbiddenUserException
ResourceNotFoundException
ResourceNotResendableException
void deleteOptions(java.lang.String name) throws ResourceNotFoundException, ForbiddenUserException, FailedRequestException
name
- name of query options to remove from the REST server.ResourceNotFoundException
ForbiddenUserException
FailedRequestException
Copyright © 2013-2018 MarkLogic Corporation.