Interface SubscriptionEnablerQuerySession

All Superinterfaces:
AutoCloseable, Closeable, OsidSession, OsidSession
All Known Subinterfaces:
SubscriptionEnablerSearchSession
public interface SubscriptionEnablerQuerySession extends OsidSession

This session provides methods for searching among SubscriptionEnabler objects. The search query is constructed using the SubscriptionEnablerQuery.

This session defines views that offer differing behaviors for searching.

  • federated publisher view: searches include subscription enablers in publishers of which this publisher is an ancestor in the publisher hierarchy
  • isolated publisher view: searches are restricted to subscription enablers in this publisher

Subscription enablers may have a query record indicated by their respective record types. The query record is accessed via the SubscriptionEnablerQuery.

  • 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.

    • canSearchSubscriptionEnablers

      boolean canSearchSubscriptionEnablers()
      Tests if this user can perform SubscriptionEnabler lookups. 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 offer lookup 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 subscription enablers 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 lookups to this publisher only.
      Compliance:
      mandatory - This method is must be implemented.

    • getSubscriptionEnablerQuery

      SubscriptionEnablerQuery getSubscriptionEnablerQuery()
      Gets a subscription enabler query.
      Returns:
      the subscription enabler query
      Compliance:
      mandatory - This method must be implemented.

    • getSubscriptionEnablersByQuery

      SubscriptionEnablerList getSubscriptionEnablersByQuery(SubscriptionEnablerQuery subscriptionEnablerQuery) throws OperationFailedException, PermissionDeniedException
      Gets a list of SubscriptionEnablers matching the given subscription enabler query.
      Parameters:
      subscriptionEnablerQuery - the subscription enabler query
      Returns:
      the returned SubscriptionEnablerList
      Throws:
      NullArgumentException - subscriptionEnablerQuery is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      UnsupportedException - subscriptionEnablerQuery is not of this service
      Compliance:
      mandatory - This method must be implemented.