Interface SubscriptionProfile

All Superinterfaces:
OsidProfile, Sourceable
All Known Subinterfaces:
SubscriptionManager, SubscriptionProxyManager
public interface SubscriptionProfile extends OsidProfile

The subscription profile describes the interoperability among subscription services.

  • Method Details

    • supportsVisibleFederation

      boolean supportsVisibleFederation()
      Tests if any dispatch federation is exposed. Federation is exposed when a specific dispatch may be identified, selected and used to create a lookup or admin session. Federation is not exposed when a set of dispatches appears as a single dispatch.
      Returns:
      true if visible federation is supported, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsMySubscription

      boolean supportsMySubscription()
      Tests for the availability of a my subscription lookup service.
      Returns:
      true if my subscription lookup is available, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsMySubscriptionAdmin

      boolean supportsMySubscriptionAdmin()
      Tests for the availability of a my subscription administrative service.
      Returns:
      true if my subscription admin is available, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsSubscriptionLookup

      boolean supportsSubscriptionLookup()
      Tests for the availability of a subscription lookup service.
      Returns:
      true if subscription lookup is available, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsSubscriptionQuery

      boolean supportsSubscriptionQuery()
      Tests if querying subscriptions is available.
      Returns:
      true if subscription query is available, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsSubscriptionSearch

      boolean supportsSubscriptionSearch()
      Tests if searching for subscriptions is available.
      Returns:
      true if subscription search is available, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsSubscriptionAdmin

      boolean supportsSubscriptionAdmin()
      Tests if searching for subscriptions is available.
      Returns:
      true if subscription search is available, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsSubscriptionNotification

      boolean supportsSubscriptionNotification()
      Tests if subscription notification is available.
      Returns:
      true if subscription notification is available, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsSubscriptionPublisher

      boolean supportsSubscriptionPublisher()
      Tests if a subscription to publisher lookup session is available.
      Returns:
      true if subscription publisher lookup session is supported, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsSubscriptionPublisherAssignment

      boolean supportsSubscriptionPublisherAssignment()
      Tests if a subscription to publisher assignment session is available.
      Returns:
      true if subscription publisher assignment is supported, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsSubscriptionSmartPublisher

      boolean supportsSubscriptionSmartPublisher()
      Tests if a subscription smart publisher session is available.
      Returns:
      true if subscription smart publisher is supported, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsDispatchLookup

      boolean supportsDispatchLookup()
      Tests for the availability of a dispatch lookup service.
      Returns:
      true if dispatch lookup is available, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsDispatchQuery

      boolean supportsDispatchQuery()
      Tests if querying dispatches is available.
      Returns:
      true if dispatch query is available, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsDispatchSearch

      boolean supportsDispatchSearch()
      Tests if searching for dispatches is available.
      Returns:
      true if dispatch search is available, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsDispatchAdmin

      boolean supportsDispatchAdmin()
      Tests for the availability of a dispatch administrative service for creating and deleting dispatches.
      Returns:
      true if dispatch administration is available, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsDispatchNotification

      boolean supportsDispatchNotification()
      Tests for the availability of a dispatch notification service.
      Returns:
      true if dispatch notification is available, false otherwise
      Compliance:
      mandatory - This method must be implemented in all providers.

    • supportsDispatchPublisher

      boolean supportsDispatchPublisher()
      Tests if a dispatch to publisher lookup session is available.
      Returns:
      true if dispatch publisher lookup session is supported, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsDispatchPublisherAssignment

      boolean supportsDispatchPublisherAssignment()
      Tests if a dispatch to publisher assignment session is available.
      Returns:
      true if dispatch publisher assignment is supported, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsDispatchSmartPublisher

      boolean supportsDispatchSmartPublisher()
      Tests if a dispatch smart publisher session is available.
      Returns:
      true if dispatch smart publisher is supported, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsPublisherLookup

      boolean supportsPublisherLookup()
      Tests for the availability of a publisher lookup service.
      Returns:
      true if publisher lookup is available, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsPublisherQuery

      boolean supportsPublisherQuery()
      Tests if querying publishers is available.
      Returns:
      true if publisher query is available, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsPublisherSearch

      boolean supportsPublisherSearch()
      Tests if searching for publishers is available.
      Returns:
      true if publisher search is available, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsPublisherAdmin

      boolean supportsPublisherAdmin()
      Tests for the availability of a publisher administrative service for creating and deleting publishers.
      Returns:
      true if publisher administration is available, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsPublisherNotification

      boolean supportsPublisherNotification()
      Tests for the availability of a publisher notification service.
      Returns:
      true if publisher notification is available, false otherwise
      Compliance:
      mandatory - This method must be implemented in all providers.

    • supportsPublisherHierarchy

      boolean supportsPublisherHierarchy()
      Tests for the availability of a publisher hierarchy traversal service.
      Returns:
      true if publisher hierarchy traversal is available, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsPublisherHierarchyDesign

      boolean supportsPublisherHierarchyDesign()
      Tests for the availability of a publisher hierarchy design service.
      Returns:
      true if publisher hierarchy design is available, false otherwise
      Compliance:
      mandatory - This method must be implemented in all providers.

    • supportsSubscriptionBatch

      boolean supportsSubscriptionBatch()
      Tests for the availability of a subscription batch service.
      Returns:
      true if a subscription batch service is available, false otherwise
      Compliance:
      mandatory - This method must be implemented in all providers.

    • supportsSubscriptionRules

      boolean supportsSubscriptionRules()
      Tests for the availability of a subscription rules service.
      Returns:
      true if a subscription rules service is available, false otherwise
      Compliance:
      mandatory - This method must be implemented in all providers.

    • getSubscriptionRecordTypes

      TypeList getSubscriptionRecordTypes()
      Gets the supported Subscription record types.
      Returns:
      a list containing the supported subscription record types
      Compliance:
      mandatory - This method must be implemented.

    • supportsSubscriptionRecordType

      boolean supportsSubscriptionRecordType(Type subscriptionRecordType)
      Tests if the given Subscription record type is supported.
      Parameters:
      subscriptionRecordType - a Type indicating a Subscription record type
      Returns:
      true if the given Type is supported, false otherwise
      Throws:
      NullArgumentException - subscriptionRecordType is null
      Compliance:
      mandatory - This method must be implemented.

    • getSubscriptionSearchRecordTypes

      TypeList getSubscriptionSearchRecordTypes()
      Gets the supported subscription search record types.
      Returns:
      a list containing the supported subscription search record types
      Compliance:
      mandatory - This method must be implemented.

    • supportsSubscriptionSearchRecordType

      boolean supportsSubscriptionSearchRecordType(Type subscriptionSearchRecordType)
      Tests if the given subscription search record type is supported.
      Parameters:
      subscriptionSearchRecordType - a Type indicating a subscription record type
      Returns:
      true if the given Type is supported, false otherwise
      Throws:
      NullArgumentException - subscriptionSearchRecordType is null
      Compliance:
      mandatory - This method must be implemented.

    • getDispatchRecordTypes

      TypeList getDispatchRecordTypes()
      Gets the supported Dispatch record types.
      Returns:
      a list containing the supported dispatch record types
      Compliance:
      mandatory - This method must be implemented.

    • supportsDispatchRecordType

      boolean supportsDispatchRecordType(Type dispatchRecordType)
      Tests if the given Dispatch record type is supported.
      Parameters:
      dispatchRecordType - a Type indicating a Dispatch record type
      Returns:
      true if the given Type is supported, false otherwise
      Throws:
      NullArgumentException - dispatchRecordType is null
      Compliance:
      mandatory - This method must be implemented.

    • getDispatchSearchRecordTypes

      TypeList getDispatchSearchRecordTypes()
      Gets the supported dispatch search record types.
      Returns:
      a list containing the supported dispatch search record types
      Compliance:
      mandatory - This method must be implemented.

    • supportsDispatchSearchRecordType

      boolean supportsDispatchSearchRecordType(Type dispatchSearchRecordType)
      Tests if the given dispatch search record type is supported.
      Parameters:
      dispatchSearchRecordType - a Type indicating a dispatch record type
      Returns:
      true if the given Type is supported, false otherwise
      Throws:
      NullArgumentException - dispatchSearchRecordType is null
      Compliance:
      mandatory - This method must be implemented.

    • getPublisherRecordTypes

      TypeList getPublisherRecordTypes()
      Gets the supported Publisher record types.
      Returns:
      a list containing the supported publisher record types
      Compliance:
      mandatory - This method must be implemented.

    • supportsPublisherRecordType

      boolean supportsPublisherRecordType(Type publisherRecordType)
      Tests if the given Publisher record type is supported.
      Parameters:
      publisherRecordType - a Type indicating a Publisher record type
      Returns:
      true if the given Type is supported, false otherwise
      Throws:
      NullArgumentException - publisherRecordType is null
      Compliance:
      mandatory - This method must be implemented.

    • getPublisherSearchRecordTypes

      TypeList getPublisherSearchRecordTypes()
      Gets the supported publisher search record types.
      Returns:
      a list containing the supported publisher search record types
      Compliance:
      mandatory - This method must be implemented.

    • supportsPublisherSearchRecordType

      boolean supportsPublisherSearchRecordType(Type publisherSearchRecordType)
      Tests if the given publisher search record type is supported.
      Parameters:
      publisherSearchRecordType - a Type indicating a publisher record type
      Returns:
      true if the given Type is supported, false otherwise
      Throws:
      NullArgumentException - publisherSearchRecordType is null
      Compliance:
      mandatory - This method must be implemented.