Interface PositionSearchSession

All Superinterfaces:
AutoCloseable, Closeable, OsidSession, OsidSession, PositionQuerySession
public interface PositionSearchSession extends PositionQuerySession

This session provides methods for searching Position objects. The search query is constructed using the PositionQuery. The position record Type also specifies the record for the position query.

getPositionsByQuery() is the basic search method and returns a list of Position elements. A more advanced search may be performed with getPositionsBySearch().It accepts a PositionSearch in addition to the query for the purpose of specifying additional options affecting the entire search, such as ordering. getPositionsBySearch() returns a PositionSearchResults that can be used to access the resulting PositionList or be used to perform a search within the result set through PositionSearch.

This session defines views that offer differing behaviors for searching.

  • federated realm view: searches include positions in realms of which this realm is an ancestor in the realm hierarchy
  • isolated realm view: searches are restricted to positions in this realm

Positions may have a query record indicated by their respective record types. The query record is accessed via the PositionQuery. The returns in this session may not be cast directly to these interfaces.

Like all OsidSessions, PositionSearchSessions are dedicated to single processing threads and a single authenticated user.

  • Method Details

    • getPositionSearch

      PositionSearch getPositionSearch()
      Gets a position search.
      Returns:
      the position search
      Compliance:
      mandatory - This method must be implemented.

    • getPositionSearchOrder

      PositionSearchOrder getPositionSearchOrder()
      Gets a position search order. The PositionSearchOrder is supplied to a PositionSearch to specify the ordering of results.
      Returns:
      the position search order
      Compliance:
      mandatory - This method must be implemented.

    • getPositionsBySearch

      PositionSearchResults getPositionsBySearch(PositionQuery positionQuery, PositionSearch positionSearch) throws OperationFailedException, PermissionDeniedException
      Gets the search results matching the given search.
      Parameters:
      positionQuery - the position query
      positionSearch - the position search
      Returns:
      the search results
      Throws:
      NullArgumentException - positionQuery or positionSearch is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      UnsupportedException - positionQuery or positionSearch is not of this service
      Compliance:
      mandatory - This method must be implemented.

    • getPositionQueryFromInspector

      PositionQuery getPositionQueryFromInspector(PositionQueryInspector positionQueryInspector)
      Gets a position query from an inspector. The inspector is available from a PositionSearchResults.
      Parameters:
      positionQueryInspector - a position query inspector
      Returns:
      the position query
      Throws:
      NullArgumentException - positionQueryInspector is null
      UnsupportedException - positionQueryInspector is not of this service
      Compliance:
      mandatory - This method must be implemented.