Skip navigation links

com.stellent.cis.client.api.scs.component.multisort
Interface ISCSComponentMultisortAPI

All Superinterfaces:

ICommandAPI

public interface ISCSComponentMultisortAPI

extends ICommandAPI

The command API implementation of the component.multisort commands. This implementation can be accessed directly via the ICommandFacade class, using the API name component.multisort, with the following syntax:

 ISCSComponentMultisortAPI commandAPI =
       (ISCSComponentMultisortAPI)m_commandFacade.getCommandAPI ("component.multisort", m_commandFacade.getCommandTypeForName ("active"));
 

Field Summary

static java.lang.String

API_CATEGORY Category for this Command API

Method Summary

ICISAPIObjectFactory	getObjectFactory() Retrieve the object factory associated with this API
ISCSSearchResponse	search(ISCSContext SCSContext, ISCSMultisortSearchQuery searchQuery) Searches the content server based on user specified query.
ISCSSearchResponse	search(ISCSContext SCSContext, java.lang.String queryText, int resultCount, java.lang.String sortSpec, java.lang.String sortField, java.lang.String sortOrder, int startIndex) Searches the content server based on user specified query.
ISCSSearchResponse	search(ISCSRequestModifier requestModifier, ISCSContext SCSContext, ISCSMultisortSearchQuery searchQuery) Searches the content server based on user specified query.
ISCSSearchResponse	search(ISCSRequestModifier requestModifier, ISCSContext SCSContext, java.lang.String queryText, int resultCount, java.lang.String sortSpec, java.lang.String sortField, java.lang.String sortOrder, int startIndex) Searches the content server based on user specified query.

Field Detail

API_CATEGORY

static final java.lang.String API_CATEGORY

Category for this Command API

See Also:

Constant Field Values

Method Detail

getObjectFactory

ICISAPIObjectFactory getObjectFactory()

Retrieve the object factory associated with this API

search

ISCSSearchResponse search(ISCSContext SCSContext,
                          java.lang.String queryText,
                          int resultCount,
                          java.lang.String sortSpec,
                          java.lang.String sortField,
                          java.lang.String sortOrder,
                          int startIndex)
                          throws CommandException

Searches the content server based on user specified query. Able to sort by multiple criteria. Example SortSpec "dDocTitle ASC dDocAuthor DESC" This would sort by title first ascending, then by author descending. NOTE: The multi sort component is required for this to execute properly.

Parameters:

SCSContext - the context object representing the current user

queryText - The user specified query text.

resultCount - The number of results to return.

sortSpec - The sort specification string.

sortField - The field to sort on, this value is set in case server does not support multi sort.

sortOrder - The order to sort with, this value is set in case server does not support multi sort.

startIndex - The index to start returning results at.

Throws:

CommandException

See Also:

"Content Server Documentation for: GET_SEARCH_RESULTS"

search

ISCSSearchResponse search(ISCSRequestModifier requestModifier,
                          ISCSContext SCSContext,
                          java.lang.String queryText,
                          int resultCount,
                          java.lang.String sortSpec,
                          java.lang.String sortField,
                          java.lang.String sortOrder,
                          int startIndex)
                          throws CommandException

Searches the content server based on user specified query. Able to sort by multiple criteria. Example SortSpec "dDocTitle ASC dDocAuthor DESC" This would sort by title first ascending, then by author descending. NOTE: The multi sort component is required for this to execute properly.

Parameters:

requestModifier - modify the request

SCSContext - the context object representing the current user

queryText - The user specified query text.

resultCount - The number of results to return.

sortSpec - The sort specification string.

sortField - The field to sort on, this value is set in case server does not support multi sort.

sortOrder - The order to sort with, this value is set in case server does not support multi sort.

startIndex - The index to start returning results at.

Throws:

CommandException

See Also:

"Content Server Documentation for: GET_SEARCH_RESULTS"

search

ISCSSearchResponse search(ISCSContext SCSContext,
                          ISCSMultisortSearchQuery searchQuery)
                          throws CommandException

Searches the content server based on user specified query. Able to sort by multiple criteria. Example SortSpec "dDocTitle ASC dDocAuthor DESC" This would sort by title first ascending, then by author descending. NOTE: The multi sort component is required for this to execute properly.

Parameters:

SCSContext - the context object representing the current user

searchQuery - the multiple sort search query

Throws:

CommandException

See Also:

"Content Server Documentation for: GET_SEARCH_RESULTS"

search

ISCSSearchResponse search(ISCSRequestModifier requestModifier,
                          ISCSContext SCSContext,
                          ISCSMultisortSearchQuery searchQuery)
                          throws CommandException

Searches the content server based on user specified query. Able to sort by multiple criteria. Example SortSpec "dDocTitle ASC dDocAuthor DESC" This would sort by title first ascending, then by author descending. NOTE: The multi sort component is required for this to execute properly.

Parameters:

requestModifier - modify the request

SCSContext - the context object representing the current user

searchQuery - the multiple sort search query

Throws:

CommandException

See Also:

"Content Server Documentation for: GET_SEARCH_RESULTS"

Skip navigation links