oracle.ifs.fdk
Interface SearchManager

public interface SearchManager

The search management Facade interface.

Method Summary

NamedValueSet[]	getProperties() Get the property information for the seach properties.
NamedValue[]	search(SearchExpression expr, NamedValue[] options, AttributeRequest[] attrReqs) Performs a search.

Method Detail

getProperties

public NamedValueSet[] getProperties()
                              throws FdkException

Get the property information for the seach properties.

Returns:

A NamedValueSet array. Each entry in the array is a named value set containing the following attributes.

• Attributes.SEARCH_PROPERTY_NAME
• Attributes.SEARCH_PROPERTY_DISPLAY_NAME
• Attributes.SEARCH_PROPERTY_TYPE
• Attributes.SEARCH_PROPERTY_SEARCHABLE
• Attributes.SEARCH_PROPERTY_SELECTABLE
• Attributes.SEARCH_PROPERTY_SORTABLE
• Attributes.SEARCH_PROPERTY_LOV (if applicable)

null if no results are returned.

Throws:

FdkException - if the operation fails

search

public NamedValue[] search(SearchExpression expr,
                           NamedValue[] options,
                           AttributeRequest[] attrReqs)
                    throws FdkException

Performs a search. The search conditions are specified by a SearchExpression and this method returns an array of Items for the search results.

Parameters:

expr - The query expression for the search represented as a SearchExpression.

options - The options for the search.

• Options.FOLDER_RESTRICTION - A Long or a long[] specifying the id or ids of folders that the search should be restricted to.
• Options.MULTILEVEL_FOLDER_RESTRICTION - A Boolean specifying if the folder restriction limits the search to just the specified folder, or the specified folder and all sub-folders. Default is TRUE, include all sub-folders.
• Options.SEARCH_VERSION_HISTORY - A Boolean specifying if previous versions of versioned documents should be returned by the search. Default is FALSE, only the current version is returned.
• Options.SEARCH_RECORDS - A Boolean specifying if the search should search records instead of documents. Default is FALSE, the search should perform a regular search for documents and folders.
• Options.SEARCH_RECORDS_CLASSNAME - A String specifying the internal classname for the record category or record folder type. The records search will be restricted to records of the specified type. The string is specified in the format "[ record_class_name ]". Default is NULL, the search will find records of any type.
• Options.SEARCH_ARCHIVE_FOR_WORKSPACE - A String specifying the name of a workspace. The archive will be searched for items deleted from the specified workspace. Wildcards * and ? are allowed. Default is NULL. The user must be a content administrator and the session must be in admin mode in order to perform an archive search.
• Options.SEARCH_ARCHIVE_DELETED_RANGE - A Date[2] specifying the starting and ending dates of a date range. The archive will be searched for items deleted within the specified range. The starting or ending date of the date range may be null. Default is NULL. The user must be a content administrator and the session must be in admin mode in order to perform an archive search.
• Options.RETURN_FROM - An Integer specifying the starting index for returning results. Default is 1 to return items starting from the first search result.
• Options.RETURN_COUNT - An Integer specifying the maximum number of items to return for the search results. Default is to return all search results.
• Options.PRIMARY_SORT_ATTRIBUTE - A String specifying the attribute for sorting. Only attributes that are allowed in a search expression are allowed to be specified for the sort attribute.
• Options.PRIMARY_SORT_DIRECTION - A Boolean specifying the sort order. Default is TRUE for ascending.
• Options.SECONDARY_SORT_ATTRIBUTE - A String specifying the attribute for sorting. Only attributes that are allowed in a search expression are allowed to be specified for the sort attribute.
• Options.SECONDARY_SORT_DIRECTION - A Boolean specifying the sort order. Default is TRUE for ascending.

attrReqs - The requested attributes for each item, or null.

Returns:

A NamedValue array containing the following attributes.

• Attributes.SEARCH_RESULTS - An Item array representing the items returned by the search or null if no results were returned.
• Attributes.SEARCH_RESULT_COUNT - An Integer representing an estimate of the total number of search results.

Throws:

FdkException - if the operation fails