All Libraries | This Library | Package | Class | Use | Tree | Deprecated | Index | Grand Index | Help
|  | Foundation |
PREV PACKAGE NEXT PACKAGE | FRAMES NO FRAMES

Note:
  Extension of the classes in this package is prohibited unless otherwise documented. Similarly, extension or implementation of the interfaces in this package is prohibited except as documented.

## Package com.sas.services.information.search

The com.sas.services.information.search package performs and manages metadata searches for public objects.

See:
Description

Interface Summary
Search | The Search can be used to manage and perform searches for public objects in metadata.
SearchCriteriaModel | The SearchCriteriaModel is used to manage retrieving of search criteria for a search folder.
SearchFilter | The filters used to scope a search, implement the SearchFilter interface.
SearchFolder | The SearchFolder class is a "smart" object for metadata searches.

Class Summary
DateFilter | The DateFilter class is used to filter objects based on their metadata created or metadata modified date values.
DisplayNameFilter | The DisplayNameFilter class is used to filter or search for objects by their DisplayName and Name attributes.
ExtendedAttributesFilter | The ExtendedAttributesFilter class is used to filter or search for objects by their associated extended attributes.
KeywordFilter | The KeywordFilter class is used to filter objects by their associated keywords.
NotesFilter | The NotesFilter class is used to filter or search for objects by their associated notes.
ObjectNameFilter | The ObjectNameFilter class is used to filter or search for objects by their Name attribute.
PublicTypeFilter | PublicTypeFilter
ResponsibilitiesFilter | The ResponsibilitiesFilter class is used to filter objects by the associated ResponsibleParty.
ResultDetails | Used for controlling the amount of information to include on each resulting object when performing a search.
SearchFactory |
SearchUtility |
SearchUtility.ValidCriteriaResults |

Enum Summary
DateFilter.DateType | The type of date to filter on
ResultDetails.ResultLimit |
SearchOperator |
SortOrder |

Exception Summary
SearchCriteriaException |

## Package com.sas.services.information.search Description

The com.sas.services.information.search package performs and manages metadata searches for public objects. The purpose of this package is to support a metadata server public object search facility that is new to release 9.3.

This package consists of client consumable interface definitions, filter classes used to scope a metadata search, and output manipulation classes that control how the search results are returned. (sorting results, result details).

The actual implementation classes are contained in the "impl" sub-package. Consumers of this package should interact with the interfaces and a Factory class.

The starting point for a client application is the SearchFactory class. The factory provides a method to create a Search object used to define and perform the public object search. It also provides methods to create a SearchFolder, which is the smart object used to save these searches to metadata.

A Search object implements the Search interface.
A SearchFolder smart object implements the SearchFolder interface.

A search can be saved to metadata by creating a SearchFolder, associating it to a Search object, and then saving off the SearchFolder.

The filters used to scope a search implement the SearchFilter interface provided in this package.
The amount of search detail returned for matching objects is controlled by the ResultDetails class.
The order in which the matching objects are returned is controlled by the SortOrder class.

See Also:
  Examples of creating and using a Search object
  Examples of creating and using a SearchFolder smart object

Note:
  Extension of the classes in this package is prohibited unless otherwise documented. Similarly, extension or implementation of the interfaces in this package is prohibited except as documented.

All Libraries | This Library | Package | Class | Use | Tree | Deprecated | Index | Grand Index | Help
|  | Foundation |
PREV PACKAGE NEXT PACKAGE | FRAMES NO FRAMES

Copyright © 2009 SAS Institute Inc. All Rights Reserved.