Skip navigation links

Overview  Package   Class  Tree  Deprecated  Index  Help 
Oracle® Fusion Middleware Content Integration Suite (CIS) Java API Reference
11g Release 1 (11.1)
E17350-01
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD

com.stellent.cis.client.api.scs.search
Interface ISCSSearchAPI

All Superinterfaces:
ICommandAPI
public interface ISCSSearchAPI
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:

 ISCSSearchAPI commandAPI =
       (ISCSSearchAPI)m_commandFacade.getCommandAPI ("search", 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, ISCSSearchQuery searchQuery)
          Command the implements searching against the content server.
 ISCSSearchResponse search(ISCSContext SCSContext, java.lang.String queryText, int resultCount)
          Command the implements searching against the content server.
 ISCSSearchResponse search(ISCSContext SCSContext, java.lang.String queryText, int resultCount, java.lang.String sortField, java.lang.String sortOrder, int startIndex)
          Command the implements searching against the content server.
 ISCSSearchResponse search(ISCSRequestModifier requestModifier, ISCSContext SCSContext, ISCSSearchQuery searchQuery)
          Command the implements searching against the content server.
 ISCSSearchResponse search(ISCSRequestModifier requestModifier, ISCSContext SCSContext, java.lang.String queryText, int resultCount)
          Command the implements searching against the content server.
 ISCSSearchResponse search(ISCSRequestModifier requestModifier, ISCSContext SCSContext, java.lang.String queryText, int resultCount, java.lang.String sortField, java.lang.String sortOrder, int startIndex)
          Command the implements searching against the content server.
 ISCSSearchResponse searchUniversal(ISCSContext SCSContext, java.lang.String queryText, int resultCount)
          Command the implements searching against the content server.
 ISCSSearchResponse searchUniversal(ISCSContext SCSContext, java.lang.String queryText, int resultCount, java.lang.String sortField, java.lang.String sortOrder, int startIndex)
          Command the implements searching against the content server.
 ISCSSearchResponse searchUniversal(ISCSRequestModifier requestModifier, ISCSContext SCSContext, java.lang.String queryText, int resultCount)
          Command the implements searching against the content server.
 ISCSSearchResponse searchUniversal(ISCSRequestModifier requestModifier, ISCSContext SCSContext, java.lang.String queryText, int resultCount, java.lang.String sortField, java.lang.String sortOrder, int startIndex)
          Command the implements searching against the content server.

 

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,
                          ISCSSearchQuery searchQuery)
                          throws CommandException
Command the implements searching against the content server. Results are returned inside the ISCSServerBinder in a List named "SearchResults". The universal search methods refer to the universal query capability available in Content Servers 7.5 and above. Using these methods allow the user to specify a queryText that is a subset of the Verity language.
Parameters:
SCSContext - the context object representing the current user
searchQuery - the content server query object
Throws:
CommandException
See Also:
"Content Server Documentation for: GET_SEARCH_RESULTS"

search

ISCSSearchResponse search(ISCSRequestModifier requestModifier,
                          ISCSContext SCSContext,
                          ISCSSearchQuery searchQuery)
                          throws CommandException
Command the implements searching against the content server. Results are returned inside the ISCSServerBinder in a List named "SearchResults". The universal search methods refer to the universal query capability available in Content Servers 7.5 and above. Using these methods allow the user to specify a queryText that is a subset of the Verity language.
Parameters:
requestModifier - modify the request
SCSContext - the context object representing the current user
searchQuery - the content server query object
Throws:
CommandException
See Also:
"Content Server Documentation for: GET_SEARCH_RESULTS"

search

ISCSSearchResponse search(ISCSContext SCSContext,
                          java.lang.String queryText,
                          int resultCount)
                          throws CommandException
Command the implements searching against the content server. Results are returned inside the ISCSServerBinder in a List named "SearchResults". The universal search methods refer to the universal query capability available in Content Servers 7.5 and above. Using these methods allow the user to specify a queryText that is a subset of the Verity language.
Parameters:
SCSContext - the context object representing the current user
queryText - the string that is will be used to query the server
resultCount - the maximum number of results
Throws:
CommandException
See Also:
"Content Server Documentation for: GET_SEARCH_RESULTS"

search

ISCSSearchResponse search(ISCSRequestModifier requestModifier,
                          ISCSContext SCSContext,
                          java.lang.String queryText,
                          int resultCount)
                          throws CommandException
Command the implements searching against the content server. Results are returned inside the ISCSServerBinder in a List named "SearchResults". The universal search methods refer to the universal query capability available in Content Servers 7.5 and above. Using these methods allow the user to specify a queryText that is a subset of the Verity language.
Parameters:
requestModifier - modify the request
SCSContext - the context object representing the current user
queryText - the string that is will be used to query the server
resultCount - the maximum number of results
Throws:
CommandException
See Also:
"Content Server Documentation for: GET_SEARCH_RESULTS"

searchUniversal

ISCSSearchResponse searchUniversal(ISCSContext SCSContext,
                                   java.lang.String queryText,
                                   int resultCount)
                                   throws CommandException
Command the implements searching against the content server. Results are returned inside the ISCSServerBinder in a List named "SearchResults". The universal search methods refer to the universal query capability available in Content Servers 7.5 and above. Using these methods allow the user to specify a queryText that is a subset of the Verity language.
Parameters:
SCSContext - the context object representing the current user
queryText - the string that is will be used to query the server
resultCount - the maximum number of results
Throws:
CommandException
See Also:
"Content Server Documentation for: GET_SEARCH_RESULTS"

searchUniversal

ISCSSearchResponse searchUniversal(ISCSRequestModifier requestModifier,
                                   ISCSContext SCSContext,
                                   java.lang.String queryText,
                                   int resultCount)
                                   throws CommandException
Command the implements searching against the content server. Results are returned inside the ISCSServerBinder in a List named "SearchResults". The universal search methods refer to the universal query capability available in Content Servers 7.5 and above. Using these methods allow the user to specify a queryText that is a subset of the Verity language.
Parameters:
requestModifier - modify the request
SCSContext - the context object representing the current user
queryText - the string that is will be used to query the server
resultCount - the maximum number of results
Throws:
CommandException
See Also:
"Content Server Documentation for: GET_SEARCH_RESULTS"

search

ISCSSearchResponse search(ISCSContext SCSContext,
                          java.lang.String queryText,
                          int resultCount,
                          java.lang.String sortField,
                          java.lang.String sortOrder,
                          int startIndex)
                          throws CommandException
Command the implements searching against the content server. Results are returned inside the ISCSServerBinder in a List named "SearchResults". The universal search methods refer to the universal query capability available in Content Servers 7.5 and above. Using these methods allow the user to specify a queryText that is a subset of the Verity language.
Parameters:
SCSContext - the context object representing the current user
queryText - the string that is will be used to query the server
resultCount - the maximum number of results
sortField - the field to sort the results by
sortOrder - a string representing the order of the results, asc for ascending and desc for descending
startIndex - the start of the result set, to page results, this should be set to #getResultCount + lastStartIndex
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 sortField,
                          java.lang.String sortOrder,
                          int startIndex)
                          throws CommandException
Command the implements searching against the content server. Results are returned inside the ISCSServerBinder in a List named "SearchResults". The universal search methods refer to the universal query capability available in Content Servers 7.5 and above. Using these methods allow the user to specify a queryText that is a subset of the Verity language.
Parameters:
requestModifier - modify the request
SCSContext - the context object representing the current user
queryText - the string that is will be used to query the server
resultCount - the maximum number of results
sortField - the field to sort the results by
sortOrder - a string representing the order of the results, asc for ascending and desc for descending
startIndex - the start of the result set, to page results, this should be set to #getResultCount + lastStartIndex
Throws:
CommandException
See Also:
"Content Server Documentation for: GET_SEARCH_RESULTS"

searchUniversal

ISCSSearchResponse searchUniversal(ISCSContext SCSContext,
                                   java.lang.String queryText,
                                   int resultCount,
                                   java.lang.String sortField,
                                   java.lang.String sortOrder,
                                   int startIndex)
                                   throws CommandException
Command the implements searching against the content server. Results are returned inside the ISCSServerBinder in a List named "SearchResults". The universal search methods refer to the universal query capability available in Content Servers 7.5 and above. Using these methods allow the user to specify a queryText that is a subset of the Verity language.
Parameters:
SCSContext - the context object representing the current user
queryText - the string that is will be used to query the server
resultCount - the maximum number of results
sortField - the field to sort the results by
sortOrder - a string representing the order of the results, asc for ascending and desc for descending
startIndex - the start of the result set, to page results, this should be set to #getResultCount + lastStartIndex
Throws:
CommandException
See Also:
"Content Server Documentation for: GET_SEARCH_RESULTS"

searchUniversal

ISCSSearchResponse searchUniversal(ISCSRequestModifier requestModifier,
                                   ISCSContext SCSContext,
                                   java.lang.String queryText,
                                   int resultCount,
                                   java.lang.String sortField,
                                   java.lang.String sortOrder,
                                   int startIndex)
                                   throws CommandException
Command the implements searching against the content server. Results are returned inside the ISCSServerBinder in a List named "SearchResults". The universal search methods refer to the universal query capability available in Content Servers 7.5 and above. Using these methods allow the user to specify a queryText that is a subset of the Verity language.
Parameters:
requestModifier - modify the request
SCSContext - the context object representing the current user
queryText - the string that is will be used to query the server
resultCount - the maximum number of results
sortField - the field to sort the results by
sortOrder - a string representing the order of the results, asc for ascending and desc for descending
startIndex - the start of the result set, to page results, this should be set to #getResultCount + lastStartIndex
Throws:
CommandException
See Also:
"Content Server Documentation for: GET_SEARCH_RESULTS"

Skip navigation links

Overview  Package   Class  Tree  Deprecated  Index  Help 
Oracle® Fusion Middleware Content Integration Suite (CIS) Java API Reference
11g Release 1 (11.1)
E17350-01
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD

Copyright © 1996, 2010, Oracle and/or its affiliates. All rights reserved.