com.stellent.cis.client.api.sis.search
Interface ISISSearchAPI

All Superinterfaces:

ICommandAPI

public interface ISISSearchAPI
extends ICommandAPI

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

 ISISSearchAPI commandAPI =
       (ISISSearchAPI)m_commandFacade.getCommandAPI ("search", m_commandFacade.getCommandTypeForName ("fixed"));
 

Field Summary

static java.lang.String

API_CATEGORY Category for this Command API

Method Summary

ISISSearchResponse	adhocSearch(ISISContext SISContext, ISISAdhocQuery adhocQuery, int pageSize) This allows the client to execute an ad-hoc search against the IBPM system.
ISISSearchResponse	continueSearch(ISISContext SISContext, ISISSearchCookie searchCookie) Continues a previously started search.
ISISSearchResponse	continueSearch(ISISContext SISContext, java.lang.String searchConnectionID) Continues a previously started search.
ISISAdhocQuery	getApplicationQuery(ISISContext SISContext, ISISApplication application) This allows the client to obtain a list of prompts for the specified Application.
ISISAdhocQuery	getApplicationQuery(ISISContext SISContext, ISISApplication application, int queryType) This allows the client to obtain a list of prompts for the specified Application.
ISISAdhocQuery	getApplicationQuery(ISISContext SISContext, java.lang.String applicationName) This allows the client to obtain a list of prompts for the specified Application.
ISISAdhocQuery	getApplicationQuery(ISISContext SISContext, java.lang.String applicationName, int queryType) This allows the client to obtain a list of prompts for the specified Application.
java.util.List	getSavedSearchNames(ISISContext SISContext) Returns a list of predefined queries.
java.util.List	getSavedSearchPrompts(ISISContext SISContext, ISISSavedSearch savedSearch) Returns a list of prompts that are associated with the specified saved search.
java.util.List	getSavedSearchPrompts(ISISContext SISContext, java.lang.String searchName) Returns a list of prompts that are associated with the specified saved search.
ISISApplication	getSearchableApplication(ISISContext SISContext, java.lang.String applicationName) Retrieves a list of application types that can be used in ad hoc searches.
ISISApplicationResponse	getSearchableApplications(ISISContext SISContext) Retrieves a list of application types that can be used in ad hoc searches.
ISISContent	lookup(ISISContext SISContext, ISISID identifier) Looks up a piece of fixed content by identifier or a combination of application name and row
ISISContent	lookup(ISISContext SISContext, java.lang.String applicationName, java.lang.String rowIdentifier) Looks up a piece of fixed content by identifier or a combination of application name and row
ISISSearchResponse	search(ISISContext SISContext, java.lang.String searchName) Performs the specified search for fixed content.
ISISSearchResponse	search(ISISContext SISContext, java.lang.String searchName, int pageSize) Performs the specified search for fixed content.
ISISSearchResponse	search(ISISContext SISContext, java.lang.String searchName, java.util.List searchPrompts, int pageSize) Performs the specified search for fixed content.
java.lang.Boolean	stopSearch(ISISContext SISContext, ISISSearchCookie searchCookie) Stops a previously started search.

Field Detail

API_CATEGORY

static final java.lang.String API_CATEGORY

Category for this Command API

See Also:

Constant Field Values

Method Detail

adhocSearch

ISISSearchResponse adhocSearch(ISISContext SISContext,
                               ISISAdhocQuery adhocQuery,
                               int pageSize)
                               throws CommandException

This allows the client to execute an ad-hoc search against the IBPM system.

Parameters:

SISContext - the context object representing the current user

adhocQuery - The parameters of the adhoc search.

pageSize - The number of results to return.

Throws:

CommandException

continueSearch

ISISSearchResponse continueSearch(ISISContext SISContext,
                                  ISISSearchCookie searchCookie)
                                  throws CommandException

Continues a previously started search.

Parameters:

SISContext - the context object representing the current user

searchCookie - The identifier for the started search.

Throws:

CommandException

continueSearch

ISISSearchResponse continueSearch(ISISContext SISContext,
                                  java.lang.String searchConnectionID)
                                  throws CommandException

Continues a previously started search.

Parameters:

SISContext - the context object representing the current user

searchConnectionID - The identifier for the started search.

Throws:

CommandException

getApplicationQuery

ISISAdhocQuery getApplicationQuery(ISISContext SISContext,
                                   ISISApplication application)
                                   throws CommandException

This allows the client to obtain a list of prompts for the specified Application. The prompts will be returned in a format that is ready for an Ad-hoc Search request. The return will describe a single Ad-hoc search

Parameters:

SISContext - the context object representing the current user

application - The application to retrieve prompts for.

Throws:

CommandException

getApplicationQuery

ISISAdhocQuery getApplicationQuery(ISISContext SISContext,
                                   ISISApplication application,
                                   int queryType)
                                   throws CommandException

This allows the client to obtain a list of prompts for the specified Application. The prompts will be returned in a format that is ready for an Ad-hoc Search request. The return will describe a single Ad-hoc search

Parameters:

SISContext - the context object representing the current user

application - The application to retrieve prompts for.

queryType - The type of prompts to receive prompts for, ISISAdhocQuery.ALL ISISAdhocQuery.DM ISISAdhocQuery.FIELD ISISAdhocQuery.SYSTEM ISISAdhocQuery.FULLTEXT ISISAdhocQuery.UNKNOWN

Throws:

CommandException

getApplicationQuery

ISISAdhocQuery getApplicationQuery(ISISContext SISContext,
                                   java.lang.String applicationName,
                                   int queryType)
                                   throws CommandException

This allows the client to obtain a list of prompts for the specified Application. The prompts will be returned in a format that is ready for an Ad-hoc Search request. The return will describe a single Ad-hoc search

Parameters:

SISContext - the context object representing the current user

applicationName - The application name to retrieve prompts for.

queryType - The type of prompts to receive prompts for, ISISAdhocQuery.ALL ISISAdhocQuery.DM ISISAdhocQuery.FIELD ISISAdhocQuery.SYSTEM ISISAdhocQuery.FULLTEXT ISISAdhocQuery.UNKNOWN

Throws:

CommandException

getApplicationQuery

ISISAdhocQuery getApplicationQuery(ISISContext SISContext,
                                   java.lang.String applicationName)
                                   throws CommandException

This allows the client to obtain a list of prompts for the specified Application. The prompts will be returned in a format that is ready for an Ad-hoc Search request. The return will describe a single Ad-hoc search

Parameters:

SISContext - the context object representing the current user

applicationName - The application name to retrieve prompts for.

Throws:

CommandException

getSearchableApplication

ISISApplication getSearchableApplication(ISISContext SISContext,
                                         java.lang.String applicationName)
                                         throws CommandException

Retrieves a list of application types that can be used in ad hoc searches.

Parameters:

SISContext - the context object representing the current user

applicationName - The name of the application to retrieve.

Throws:

CommandException

getSearchableApplications

ISISApplicationResponse getSearchableApplications(ISISContext SISContext)
                                                  throws CommandException

Retrieves a list of application types that can be used in ad hoc searches.

Parameters:

SISContext - the context object representing the current user

Throws:

CommandException

lookup

ISISContent lookup(ISISContext SISContext,
                   ISISID identifier)
                   throws CommandException

Looks up a piece of fixed content by identifier or a combination of application name and row

Parameters:

SISContext - the context object representing the current user

identifier - The identifier.

Throws:

CommandException

lookup

ISISContent lookup(ISISContext SISContext,
                   java.lang.String applicationName,
                   java.lang.String rowIdentifier)
                   throws CommandException

Looks up a piece of fixed content by identifier or a combination of application name and row

Parameters:

SISContext - the context object representing the current user

applicationName - The application name.

rowIdentifier - The row identifier.

Throws:

CommandException

getSavedSearchNames

java.util.List getSavedSearchNames(ISISContext SISContext)
                                   throws CommandException

Returns a list of predefined queries.

Parameters:

SISContext - the context object representing the current user

Throws:

CommandException

getSavedSearchPrompts

java.util.List getSavedSearchPrompts(ISISContext SISContext,
                                     java.lang.String searchName)
                                     throws CommandException

Returns a list of prompts that are associated with the specified saved search. ICISSearchPrompt

Parameters:

SISContext - the context object representing the current user

searchName - The identifier of the saved search.

Throws:

CommandException

getSavedSearchPrompts

java.util.List getSavedSearchPrompts(ISISContext SISContext,
                                     ISISSavedSearch savedSearch)
                                     throws CommandException

Returns a list of prompts that are associated with the specified saved search. ICISSearchPrompt

Parameters:

SISContext - the context object representing the current user

savedSearch - The identifier of the saved search.

Throws:

CommandException

search

ISISSearchResponse search(ISISContext SISContext,
                          java.lang.String searchName)
                          throws CommandException

Performs the specified search for fixed content.

Parameters:

SISContext - the context object representing the current user

searchName - The saved search name.

Throws:

CommandException

search

ISISSearchResponse search(ISISContext SISContext,
                          java.lang.String searchName,
                          int pageSize)
                          throws CommandException

Performs the specified search for fixed content.

Parameters:

SISContext - the context object representing the current user

searchName - The saved search name.

pageSize - The number of results to return.

Throws:

CommandException

search

ISISSearchResponse search(ISISContext SISContext,
                          java.lang.String searchName,
                          java.util.List searchPrompts,
                          int pageSize)
                          throws CommandException

Performs the specified search for fixed content.

Parameters:

SISContext - the context object representing the current user

searchName - The saved search name.

searchPrompts - ser specified input for this search.

pageSize - The number of results to return.

Throws:

CommandException

stopSearch

java.lang.Boolean stopSearch(ISISContext SISContext,
                             ISISSearchCookie searchCookie)
                             throws CommandException

Stops a previously started search.

Parameters:

SISContext - the context object representing the current user

searchCookie - The identifier for the started search.

Throws:

CommandException