com.marklogic.client.admin

Interface QueryOptionsManager

public interface QueryOptionsManager

A QueryOptionsManager support database operations on QueryOptionsHandle instances.

Method Summary

Modifier and Type	Method and Description
void	deleteOptions(java.lang.String name) Remove a search configuration from the REST server.
<T extends QueryOptionsListReadHandle> T	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> T	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.

Method Detail

optionsListAs

<T> T optionsListAs(Format format,
                    java.lang.Class<T> as)
             throws ForbiddenUserException,
                    FailedRequestException

Retrieves the list of available named query options in a JSON or XML representation provided as an object of an IO class. The IO class must have been registered before creating the database client. By default, the provided handles that implement ContentHandle are registered. Learn more about shortcut methods

Type Parameters:

T - the type of object that will be returned by the handle registered for it

Parameters:

format - whether to provide the list in a JSON or XML representation

as - the IO class for reading the list of options

Returns:

an object of the IO class with the option names

Throws:

ForbiddenUserException

FailedRequestException

optionsList

<T extends QueryOptionsListReadHandle> T optionsList(T listHandle)
                                              throws ForbiddenUserException,
                                                     FailedRequestException

Retrieves the list of available named query options in a JSON or XML representation provided as an object of an IO class. The IO class must have been registered before creating the database client. By default, standard Java IO classes for document content are registered.

Type Parameters:

T - the type of QueryOptionsListReadHandle to return

Parameters:

listHandle - a handle for reading the list of name options

Returns:

the handle populated with the names

Throws:

ForbiddenUserException

FailedRequestException

readOptionsAs

<T> T readOptionsAs(java.lang.String name,
                    Format format,
                    java.lang.Class<T> as)
             throws ResourceNotFoundException,
                    ForbiddenUserException,
                    FailedRequestException

Fetch a query options configuration from the REST Server by name. The IO class must have been registered before creating the database client. By default, the provided handles that implement ContentHandle are registered. Learn more about shortcut methods

Type Parameters:

T - the type of object that will be returned by the handle registered for it

Parameters:

name - the name of options configuration stored on MarkLogic REST instance.

format - whether to provide the options in a JSON or XML representation

as - the IO class for reading the query options

Returns:

an object of the IO class with the query options

Throws:

ResourceNotFoundException

ForbiddenUserException

FailedRequestException

readOptions

<T extends QueryOptionsReadHandle> T readOptions(java.lang.String name,
                                                 T queryOptionsHandle)
                                          throws ResourceNotFoundException,
                                                 ForbiddenUserException,
                                                 FailedRequestException

Fetch a query options configuration from the REST Server by name.

Use a QueryOptionsHandle object for access to the configuration with Java.

Type Parameters:

T - the type of QueryOptionsListReadHandle to return

Parameters:

name - the name of options configuration stored on MarkLogic REST instance.

queryOptionsHandle - an object into which to fetch the query options.

Returns:

an object holding the query configurations

Throws:

ResourceNotFoundException

ForbiddenUserException

FailedRequestException

writeOptionsAs

void writeOptionsAs(java.lang.String name,
                    Format format,
                    java.lang.Object queryOptions)
             throws ResourceNotFoundException,
                    ResourceNotResendableException,
                    ForbiddenUserException,
                    FailedRequestException

Write a named QueryOptions configuration to the REST server in a JSON or XML representation provided as an object of an IO class. The IO class must have been registered before creating the database client. By default, the provided handles that implement ContentHandle are registered. Learn more about shortcut methods

Parameters:

name - name given to the QueryOptions for use in runtime queries

format - whether the options are provided in a JSON or XML representation

queryOptions - an IO representation of the JSON or XML query options

Throws:

ResourceNotFoundException

ResourceNotResendableException

ForbiddenUserException

FailedRequestException

writeOptions

void writeOptions(java.lang.String name,
                  QueryOptionsWriteHandle queryOptionsHandle)
           throws FailedRequestException,
                  ForbiddenUserException,
                  ResourceNotFoundException,
                  ResourceNotResendableException

Write a named QueryOptions configuration to the REST server.

Parameters:

name - name given to the QueryOptions for use in runtime queries

queryOptionsHandle - an object able to serialize a QueryOptions configuration

Throws:

FailedRequestException

ForbiddenUserException

ResourceNotFoundException

ResourceNotResendableException

deleteOptions

void deleteOptions(java.lang.String name)
            throws ResourceNotFoundException,
                   ForbiddenUserException,
                   FailedRequestException

Remove a search configuration from the REST server.

Parameters:

name - name of query options to remove from the REST server.

Throws:

ResourceNotFoundException

ForbiddenUserException

FailedRequestException