Interface PersonSmartRealmSession

All Superinterfaces:
AutoCloseable, Closeable, OsidSession, OsidSession
public interface PersonSmartRealmSession extends OsidSession

This session manages queries and sequencing to create "smart" dynamic catalogs. A PersonQuery can be retrieved from this session and mapped to this Realm to create a virtual collection of Persons . The persons may be sequenced using the PersonSearchOrder from this session.

This Realm has a default query that matches any person and a default search order that specifies no sequencing. The queries may be examined using a PersonQueryInspector . The query may be modified by converting the inspector back to a PersonQuery .

  • Method Details

    • getRealmId

      Id getRealmId()
      Gets the Realm Id associated with this session.
      Returns:
      the Realm Id associated with this session
      Compliance:
      mandatory - This method must be implemented.

    • getRealm

      Realm getRealm() throws OperationFailedException, PermissionDeniedException
      Gets the Realm associated with this session.
      Returns:
      the Realm associated with this session
      Throws:
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • canManageSmartRealms

      boolean canManageSmartRealms()
      Tests if this user can manage smart realms. A return of true does not guarantee successful authorization. A return of false indicates that it is known methods in this session will result in a PERMISSION_DENIED . This is intended as a hint to an application that may opt not to offer operations to unauthorized users.
      Returns:
      false if smart realm management is not authorized, true otherwise
      Compliance:
      mandatory - This method must be implemented.

    • getPersonQuery

      PersonQuery getPersonQuery()
      Gets a person query.
      Returns:
      the person query
      Compliance:
      mandatory - This method must be implemented.

    • getPersonSearchOrder

      PersonSearchOrder getPersonSearchOrder()
      Gets a person search order.
      Returns:
      the person search order
      Compliance:
      mandatory - This method must be implemented.

    • applyPersonQuery

      void applyPersonQuery(PersonQuery personQuery) throws OperationFailedException, PermissionDeniedException
      Applies a person query to this realm.
      Parameters:
      personQuery - the person query
      Throws:
      NullArgumentException - personQuery is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure occurred
      UnsupportedException - personQuery not of this service
      Compliance:
      mandatory - This method must be implemented.

    • inspectPersonQuery

      PersonQueryInspector inspectPersonQuery() throws OperationFailedException, PermissionDeniedException
      Gets a person query inspector for this realm.
      Returns:
      the person query inspector
      Throws:
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure occurred
      Compliance:
      mandatory - This method must be implemented.

    • applyPersonSequencing

      void applyPersonSequencing(PersonSearchOrder personSearchOrder) throws OperationFailedException, PermissionDeniedException
      Applies a person search order to this realm.
      Parameters:
      personSearchOrder - the person search order
      Throws:
      NullArgumentException - personSearchOrder is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure occurred
      UnsupportedException - personSearchOrder not of this service
      Compliance:
      mandatory - This method must be implemented.

    • getPersonQueryFromInspector

      PersonQuery getPersonQueryFromInspector(PersonQueryInspector personQueryInspector)
      Gets a person query from an inspector.
      Parameters:
      personQueryInspector - a query inspector
      Returns:
      the person query
      Throws:
      NullArgumentException - personQueryInspector is null
      UnsupportedException - personQueryInspector is not of this service
      Compliance:
      mandatory - This method must be implemented.