Interface SubscriptionEnablerSearchSession

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

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

getSubscriptionEnablersByQuery() is the basic search method and returns a list of SubscriptionEnablers. A more advanced search may be performed with getSubscriptionEnablersBySearch(). It accepts a SubscriptionEnablerSearch in addition to the query for the purpose of specifying additional options affecting the entire search, such as ordering. getSubscriptionEnablersBySearch() returns a SubscriptionEnablerSearchResults that can be used to access the resulting SubscriptionEnablerList or be used to perform a search within the result set through SubscriptionEnablerSearch.

This session defines views that offer differing behaviors for searching.

  • federated subscription view: searches include subscription enablers in subscriptions of which this subscription is an ancestor in the subscription hierarchy
  • isolated subscription view: searches are restricted to subscription enablers in this subscription
SubscriptionEnablers may have a query record indicated by their respective record types. The query record is accessed via the SubscriptionEnablerQuery.

  • Method Details

    • getSubscriptionEnablerSearch

      SubscriptionEnablerSearch getSubscriptionEnablerSearch()
      Gets a subscription enabler search.
      Returns:
      the subscription enabler search
      Compliance:
      mandatory - This method must be implemented.

    • getSubscriptionEnablerSearchOrder

      SubscriptionEnablerSearchOrder getSubscriptionEnablerSearchOrder()
      Gets a subscription enabler search order. The SubscriptionEnablerSearchOrder is supplied to a SubscriptionEnablerSearch to specify the ordering of results.
      Returns:
      the subscription enabler search order
      Compliance:
      mandatory - This method must be implemented.

    • getSubscriptionEnablersBySearch

      SubscriptionEnablerSearchResults getSubscriptionEnablersBySearch(SubscriptionEnablerQuery subscriptionEnablerQuery, SubscriptionEnablerSearch subscriptionEnablerSearch) throws OperationFailedException, PermissionDeniedException
      Gets the search results matching the given search query using the given search.
      Parameters:
      subscriptionEnablerQuery - the subscription enabler query
      subscriptionEnablerSearch - the subscription enabler search
      Returns:
      the returned search results
      Throws:
      NullArgumentException - subscriptionEnablerQuery or subscriptionEnablerSearch is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      UnsupportedException - subscriptionEnablerQuery or subscriptionEnablerSearch is not of this service
      Compliance:
      mandatory - This method must be implemented.

    • getSubscriptionEnablerQueryFromInspector

      SubscriptionEnablerQuery getSubscriptionEnablerQueryFromInspector(SubscriptionEnablerQueryInspector subscriptionEnablerQueryInspector)
      Gets a subscription enabler query from an inspector. The inspector is available from a SubscriptionEnablerSearchResults.
      Parameters:
      subscriptionEnablerQueryInspector - a subscription enabler query inspector
      Returns:
      the subscription enabler query
      Throws:
      NullArgumentException - subscriptionEnablerQueryInspector is null
      UnsupportedException - subscriptionEnablerQueryInspector is not of this service
      Compliance:
      mandatory - This method must be implemented.