|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface ISCSComponentMultisortAPI
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 |
---|
static final java.lang.String API_CATEGORY
Method Detail |
---|
ICISAPIObjectFactory getObjectFactory()
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
SCSContext
- the context object representing the current userqueryText
- 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.
CommandException
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
requestModifier
- modify the requestSCSContext
- the context object representing the current userqueryText
- 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.
CommandException
ISCSSearchResponse search(ISCSContext SCSContext, ISCSMultisortSearchQuery searchQuery) throws CommandException
SCSContext
- the context object representing the current usersearchQuery
- the multiple sort search query
CommandException
ISCSSearchResponse search(ISCSRequestModifier requestModifier, ISCSContext SCSContext, ISCSMultisortSearchQuery searchQuery) throws CommandException
requestModifier
- modify the requestSCSContext
- the context object representing the current usersearchQuery
- the multiple sort search query
CommandException
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |