|
Oracle® Fusion Middleware Oracle Imaging and Process Management Java API Reference 11g Release 1 (11.1.1) E12853-02 |
|||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface SearchService
This is the interface for the search functions within the imaging system. Each implementor of this interface is required to provide the capabilities identified by this interface. The following are the capabilities of the search interface:
Method Summary | |
---|---|
NameId |
createSearch(Search aSearch) RESERVED for internal Oracle use only |
void |
deleteSearch(NameId searchNameId) The deleteSearch() method will delete the Search specified in the NameId parameter. |
Search.ResultSet |
executeSavedSearch(NameId searchNameId, java.util.List<SearchArgument> searchArguments) This method uses the search and the search parameters to return the results of a search for documents in the system. |
Search.ResultSet |
executeSearch(Search search, java.util.List<SearchArgument> searchArguments) RESERVED for internal Oracle use only |
Search |
getSearch(NameId searchNameId, Search.SectionSet sectionSet) This method returns the Search specified by the NameId input. |
java.util.List<Search> |
getSearches(java.util.List<NameId> searchNameIds, Search.SectionSet sectionSet) This method returns the Searches specified by the NameId array. |
SearchParameters |
getSearchParameters(NameId searchNameId) This method returns the search parameters defined for the search. |
java.util.List<NameId> |
listSearches(Search.Ability ability) Enumerates the list of existing searches. |
void |
modifySearch(Search search, Search.SectionSet sectionSet) RESERVED for internal Oracle use only |
Method Detail |
---|
NameId createSearch(Search aSearch) throws ImagingException, ValidationException
ImagingException
ValidationException
void deleteSearch(NameId searchNameId) throws ImagingException
searchNameId
- The unique name and Id of the searchImagingException
Search.ResultSet executeSavedSearch(NameId searchNameId, java.util.List<SearchArgument> searchArguments) throws ImagingException
searchNameId
- The unique name and Id of the searchsearchArguments
- A list of values to be substituted into the search expression.Search$ResultSet
containg the matches for the executed search.ImagingException
Search.ResultSet executeSearch(Search search, java.util.List<SearchArgument> searchArguments) throws ImagingException
ImagingException
Search getSearch(NameId searchNameId, Search.SectionSet sectionSet) throws ImagingException
Search
specified by the NameId input.searchNameId
- a NameId
containing either the name or the guid of the desired search.sectionSet
- The section flags indicating which section(s) of the search to return.ImagingException
java.util.List<Search> getSearches(java.util.List<NameId> searchNameIds, Search.SectionSet sectionSet) throws ImagingException
NameId
array.searchNameIds
- an array of requested searchessectionSet
- The section set indicating which section(s) of each search to return.ImagingException
java.util.List<NameId> listSearches(Search.Ability ability) throws ImagingException
ability
- Returns only searches the current user has specific to that ability.
For example, to return back a list of searches the current user can manage, the Search.Ability.MANAGE
enumeration should be specified.
NameId
data structures. The returned structures will contain the name and guid properties for the associates searches.ImagingException
SearchParameters getSearchParameters(NameId searchNameId) throws ImagingException
searchNameId
- The NameId
of the containing search.SearchParameters
containing a list of Search$ParameterDefinition
objects representing the availible user parameters for the search.ImagingException
void modifySearch(Search search, Search.SectionSet sectionSet) throws ImagingException, ValidationException
ImagingException
ValidationException
|
Oracle® Fusion Middleware Oracle Imaging and Process Management Java API Reference 11g Release 1 (11.1.1) E12853-02 |
|||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |