Interface CommitmentQuerySession

All Superinterfaces:
AutoCloseable, Closeable, OsidSession, OsidSession
All Known Subinterfaces:
CommitmentSearchSession
public interface CommitmentQuerySession extends OsidSession

This session provides methods for searching Commitment objects. The search query is constructed using the CommitmentQuery . The commitment record Type also specifies the record for the commitment query.

This session defines views that offer differing behaviors for searching.

  • federated calendar view: searches include commitments in calendars of which this calendar is an ancestor in the calendar hierarchy
  • isolated calendar view: searches are restricted to commitments in this calendar only

Commitments may have a query record indicated by their respective record types. The query record is accessed via the CommitmentQuery .

  • Method Details

    • getCalendarId

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

    • getCalendar

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

    • canSearchCommitments

      boolean canSearchCommitments()
      Tests if this user can perform Commitment searches. A return of true does not guarantee successful authorization. A return of false indicates that it is known all 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 search operations to unauthorized users.
      Returns:
      false if search methods are not authorized, true otherwise
      Compliance:
      mandatory - This method must be implemented.

    • useFederatedCalendarView

      void useFederatedCalendarView()
      Federates the view for methods in this session. A federated view will include commitments in calendars which are children of this calendar in the calendar hierarchy.
      Compliance:
      mandatory - This method is must be implemented.

    • useIsolatedCalendarView

      void useIsolatedCalendarView()
      Isolates the view for methods in this session. An isolated view restricts searches to this calendar only.
      Compliance:
      mandatory - This method is must be implemented.

    • getCommitmentQuery

      CommitmentQuery getCommitmentQuery()
      Gets a commitment query.
      Returns:
      the commitment query
      Compliance:
      mandatory - This method must be implemented.

    • getCommitmentsByQuery

      CommitmentList getCommitmentsByQuery(CommitmentQuery commitmentQuery) throws OperationFailedException, PermissionDeniedException
      Gets a list of Commitments matching the given commitment query.
      Parameters:
      commitmentQuery - the commitment query
      Returns:
      the returned CommitmentList
      Throws:
      NullArgumentException - commitmentQuery is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      UnsupportedException - commitmentQuery is not of this service
      Compliance:
      mandatory - This method must be implemented.