Interface ProfileEntryEnablerSearchSession

All Superinterfaces:
AutoCloseable, Closeable, OsidSession, OsidSession, ProfileEntryEnablerQuerySession
public interface ProfileEntryEnablerSearchSession extends ProfileEntryEnablerQuerySession

This session provides methods for searching among ProfileEntryEnabler objects. The search query is constructed using the ProfileEntryEnableryQuery.

getProfileEntryEnablersByQuery() is the basic search method and returns a list of ProfileEntryEnablers. A more advanced search may be performed with getProfileEntryEnablersBySearch(). It accepts a ProfileEntryEnablerSearch in addition to the query for the purpose of specifying additional options affecting the entire search, such as ordering. getProfileEntryEnablersBySearch() returns a ProfileEntryEnablerSearchResults that can be used to access the resulting ProfileEntryEnablerList or be used to perform a search within the result set through ProfileEntryEnablerSearch.

This session defines views that offer differing behaviors for searching.

  • federated profile view: searches include profile entry enablers in profiles of which this profile is an ancestor in the profile hierarchy
  • isolated profile view: searches are restricted to profile entry enablers in this profile
ProfileEntryEnablers may have a query record indicated by their respective record types. The query record is accessed via the ProfileEntryEnablerQuery.

  • Method Details

    • getProfileEntryEnablerSearch

      ProfileEntryEnablerSearch getProfileEntryEnablerSearch()
      Gets a profile entry enabler search.
      Returns:
      the profile entry enabler search
      Compliance:
      mandatory - This method must be implemented.

    • getProfileEntryEnablerSearchOrder

      ProfileEntryEnablerSearchOrder getProfileEntryEnablerSearchOrder()
      Gets a profile entry enabler search order. The ProfileEntryEnablerSearchOrder is supplied to a ProfileEntryEnablerSearch to specify the ordering of results.
      Returns:
      the profile entry enabler search order
      Compliance:
      mandatory - This method must be implemented.

    • getProfileEntryEnablersBySearch

      ProfileEntryEnablerSearchResults getProfileEntryEnablersBySearch(ProfileEntryEnablerQuery profileEntryEnablerQuery, ProfileEntryEnablerSearch profileEntryEnablerSearch) throws OperationFailedException, PermissionDeniedException
      Gets the search results matching the given search query using the given search.
      Parameters:
      profileEntryEnablerQuery - the profile entry enabler query
      profileEntryEnablerSearch - the profile entry enabler search
      Returns:
      the returned search results
      Throws:
      NullArgumentException - profileEntryEnablerQuery or profileEntryEnablerSearch is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      UnsupportedException - profileEntryEnablerQuery or profileEntryEnablerSearch is not of this service
      Compliance:
      mandatory - This method must be implemented.

    • getProfileEntryEnablerQueryFromInspector

      ProfileEntryEnablerQuery getProfileEntryEnablerQueryFromInspector(ProfileEntryEnablerQueryInspector profileEntryEnablerQueryInspector)
      Gets a profile entry enabler query from an inspector. The inspector is available from a ProfileEntryEnablerSearchResults.
      Parameters:
      profileEntryEnablerQueryInspector - a profile entry enabler query inspector
      Returns:
      the profile entry enabler query
      Throws:
      NullArgumentException - profileEntryEnablerQueryInspector is null
      UnsupportedException - profileEntryEnablerQueryInspector is not of this service
      Compliance:
      mandatory - This method must be implemented.