Interface AuthorizationSearchSession

All Superinterfaces:
AuthorizationQuerySession, AutoCloseable, Closeable, OsidSession, OsidSession
public interface AuthorizationSearchSession extends AuthorizationQuerySession

This session provides methods for searching Authorization objects. The search query is constructed using the AuthorizationQuery .

getAuthorizationsByQuery() is the basic search method and returns a list of Authorizations . A more advanced search may be performed with getAuthorizationsBySearch() .It accepts an AgentSearch in addition to the query for the purpose of specifying additional options affecting the entire search, such as ordering. getAuthorizationssBySearch() returns an AuthorizationSearchResults that can be used to access the resulting AuthorizationList or be used to perform a search within the result set through AuthorizationSearch .

This session defines views that offer differing behaviors for searching.

  • federated view: searches include authorizations in Vaults of which this vault is an ancestor in the vault hierarchy
  • isolated view: searches are restricted to authorizations in this Vault
  • implicit authorization view: authorizations include implicit authorizations
  • explicit authorization view: only explicit authorizations are returned

  • Method Details

    • getAuthorizationSearch

      AuthorizationSearch getAuthorizationSearch()
      Gets an authorization search.
      Returns:
      the authorization search
      Compliance:
      mandatory - This method must be implemented.

    • getAuthorizationSearchOrder

      AuthorizationSearchOrder getAuthorizationSearchOrder()
      Gets an authorization search order. The AuthorizationSearchOrder is supplied to an AuthorizationSearch to specify the ordering of results.
      Returns:
      the authorization search order
      Compliance:
      mandatory - This method must be implemented.

    • getAuthorizationsBySearch

      AuthorizationSearchResults getAuthorizationsBySearch(AuthorizationQuery authorizationQuery, AuthorizationSearch authorizationSearch) throws OperationFailedException, PermissionDeniedException
      Gets the search results matching the given search query using the given search.
      Parameters:
      authorizationQuery - the authorization query
      authorizationSearch - the authorization search
      Returns:
      the returned search results
      Throws:
      NullArgumentException - authorizationQuery or authorizationSearch is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      UnsupportedException - authorizationSearch or authorizationQuery is not of this service
      Compliance:
      mandatory - This method must be implemented.

    • getAuthorizationQueryFromInspector

      AuthorizationQuery getAuthorizationQueryFromInspector(AuthorizationQueryInspector authorizationQueryInspector)
      Gets an authorization query from an inspector. The inspector is available from an AuthorizationSearchResults .
      Parameters:
      authorizationQueryInspector - an authorization query inspector
      Returns:
      the authorization query
      Throws:
      NullArgumentException - authorizationQueryInspector is null
      UnsupportedException - authorizationQueryInspector is not of this service
      Compliance:
      mandatory - This method must be implemented.