Interface SubscriptionQuerySession

All Superinterfaces:
AutoCloseable, Closeable, OsidSession, OsidSession
All Known Subinterfaces:
SubscriptionSearchSession
public interface SubscriptionQuerySession extends OsidSession

This session provides methods for searching Subscriptions. The search query is constructed using the SubscriptionQuery. The dispatch record Type also specifies the record for the dispatch query.

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

  • Method Details

    • getPublisherId

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

    • getPublisher

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

    • canSearchSubscriptions

      boolean canSearchSubscriptions()
      Tests if this user can perform susbcription 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 not wish to offer search operations to unauthorized users.
      Returns:
      false if search methods are not authorized, true otherwise
      Compliance:
      mandatory - This method must be implemented.

    • useFederatedPublisherView

      void useFederatedPublisherView()
      Federates the view for methods in this session. A federated view will include entries in publishers which are children of this publisher in the publisher hierarchy.
      Compliance:
      mandatory - This method is must be implemented.

    • useIsolatedPublisherView

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

    • getSubscriptionQuery

      SubscriptionQuery getSubscriptionQuery()
      Gets a subscription query.
      Returns:
      the subscription query
      Compliance:
      mandatory - This method must be implemented.

    • getSubscriptionsByQuery

      SubscriptionList getSubscriptionsByQuery(SubscriptionQuery subscriptionQuery) throws OperationFailedException, PermissionDeniedException
      Gets a list of subscriptions matching the given subscription query.
      Parameters:
      subscriptionQuery - the subscription query
      Returns:
      the returned SubscriptionList
      Throws:
      NullArgumentException - subscriptionQuery is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      UnsupportedException - subscriptionQuery is not of this service
      Compliance:
      mandatory - This method must be implemented.