Skip navigation links

oracle.imaging
Interface SearchService

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:

• Create a Search - RESERVED for internal Oracle use only
• delete search
• execute a saved search
• execute an ad hoc search - RESERVED for internal Oracle use only
• get a search
• get a list of searches
• get search parameters
• list all searches
• modify a search - RESERVED for internal Oracle use only

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 Searchspecified 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

createSearch

NameId createSearch(Search aSearch)
                    throws ImagingException,
                           ValidationException

RESERVED for internal Oracle use only

Throws:

ImagingException

ValidationException

deleteSearch

void deleteSearch(NameId searchNameId)
                  throws ImagingException

The deleteSearch() method will delete the Search specified in the NameId parameter. If the search does not exist or the user does not have the delete privilege, then an ImagingException will be thrown.

Parameters:

searchNameId - The unique name and Id of the search

Throws:

ImagingException

executeSavedSearch

Search.ResultSet executeSavedSearch(NameId searchNameId,
                                    java.util.List<SearchArgument> searchArguments)
                                    throws ImagingException

This method uses the search and the search parameters to return the results of a search for documents in the system.

Parameters:

searchNameId - The unique name and Id of the search

searchArguments - A list of values to be substituted into the search expression.

Returns:

a Search$ResultSet containg the matches for the executed search.

Throws:

ImagingException

executeSearch

Search.ResultSet executeSearch(Search search,
                               java.util.List<SearchArgument> searchArguments)
                               throws ImagingException

RESERVED for internal Oracle use only

Throws:

ImagingException

getSearch

Search getSearch(NameId searchNameId,
                 Search.SectionSet sectionSet)
                 throws ImagingException

This method returns the Searchspecified by the NameId input.

Parameters:

searchNameId - a NameIdcontaining either the name or the guid of the desired search.

sectionSet - The section flags indicating which section(s) of the search to return.

Returns:

The requested Search with only the specified sections.

Throws:

ImagingException

getSearches

java.util.List<Search> getSearches(java.util.List<NameId> searchNameIds,
                                   Search.SectionSet sectionSet)
                                   throws ImagingException

This method returns the Searches specified by the NameId array.

Parameters:

searchNameIds - an array of requested searches

sectionSet - The section set indicating which section(s) of each search to return.

Returns:

The requested Searches with only the specified sections.

Throws:

ImagingException

listSearches

java.util.List<NameId> listSearches(Search.Ability ability)
                                    throws ImagingException

Enumerates the list of existing searches. The operation will only return those searches which the calling user is allowed to see based on the user's rights to the search. If the user has no access to any searches, the returned value will be an empty list.

Parameters:

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.

Returns:

A list of NameIddata structures. The returned structures will contain the name and guid properties for the associates searches.

Throws:

ImagingException

getSearchParameters

SearchParameters getSearchParameters(NameId searchNameId)
                                     throws ImagingException

This method returns the search parameters defined for the search.

Parameters:

searchNameId - The NameId of the containing search.

Returns:

the SearchParameters containing a list of Search$ParameterDefinition objects representing the availible user parameters for the search.

Throws:

ImagingException

modifySearch

void modifySearch(Search search,
                  Search.SectionSet sectionSet)
                  throws ImagingException,
                         ValidationException

RESERVED for internal Oracle use only

Throws:

ImagingException

ValidationException

Skip navigation links