OSID - osid.subscription.SubscriptionProfile Service Interface Definition

Interface	osid.subscription.SubscriptionProfile
Implements	`osid.OsidProfile`
Description	The subscription profile describes the interoperability among subscription services.
Method	supportsVisibleFederation
Description	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.
Return	`boolean`		`true` if visible federation is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsMySubscription
Description	Tests for the availability of a my subscription lookup service.
Return	`boolean`		`true` if my subscription lookup is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsMySubscriptionAdmin
Description	Tests for the availability of a my subscription administrative service.
Return	`boolean`		`true` if my subscription admin is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsSubscriptionLookup
Description	Tests for the availability of a subscription lookup service.
Return	`boolean`		`true` if subscription lookup is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsSubscriptionQuery
Description	Tests if querying subscriptions is available.
Return	`boolean`		`true` if subscription query is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsSubscriptionSearch
Description	Tests if searching for subscriptions is available.
Return	`boolean`		`true` if subscription search is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsSubscriptionAdmin
Description	Tests if searching for subscriptions is available.
Return	`boolean`		`true` if subscription search is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsSubscriptionNotification
Description	Tests if subscription notification is available.
Return	`boolean`		`true` if subscription notification is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsSubscriptionPublisher
Description	Tests if a subscription to publisher lookup session is available.
Return	`boolean`		`true` if subscription publisher lookup session is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsSubscriptionPublisherAssignment
Description	Tests if a subscription to publisher assignment session is available.
Return	`boolean`		`true` if subscription publisher assignment is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsSubscriptionSmartPublisher
Description	Tests if a subscription smart publisher session is available.
Return	`boolean`		`true` if subscription smart publisher is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsDispatchLookup
Description	Tests for the availability of an dispatch lookup service.
Return	`boolean`		`true` if dispatch lookup is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsDispatchQuery
Description	Tests if querying dispatches is available.
Return	`boolean`		`true` if dispatch query is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsDispatchSearch
Description	Tests if searching for dispatches is available.
Return	`boolean`		`true` if dispatch search is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsDispatchAdmin
Description	Tests for the availability of a dispatch administrative service for creating and deleting dispatches.
Return	`boolean`		`true` if dispatch administration is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsDispatchNotification
Description	Tests for the availability of a dispatch notification service.
Return	`boolean`		`true` if dispatch notification is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented in all providers.
Method	supportsDispatchPublisher
Description	Tests if a dispatch to publisher lookup session is available.
Return	`boolean`		`true` if dispatch publisher lookup session is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsDispatchPublisherAssignment
Description	Tests if a dispatch to publisher assignment session is available.
Return	`boolean`		`true` if dispatch publisher assignment is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsDispatchSmartPublisher
Description	Tests if a dispatch smart publisher session is available.
Return	`boolean`		`true` if dispatch smart publisher is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsPublisherLookup
Description	Tests for the availability of an publisher lookup service.
Return	`boolean`		`true` if publisher lookup is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsPublisherQuery
Description	Tests if querying publishers is available.
Return	`boolean`		`true` if publisher query is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsPublisherSearch
Description	Tests if searching for publishers is available.
Return	`boolean`		`true` if publisher search is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsPublisherAdmin
Description	Tests for the availability of a publisher administrative service for creating and deleting publishers.
Return	`boolean`		`true` if publisher administration is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsPublisherNotification
Description	Tests for the availability of a publisher notification service.
Return	`boolean`		`true` if publisher notification is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented in all providers.
Method	supportsPublisherHierarchy
Description	Tests for the availability of a publisher hierarchy traversal service.
Return	`boolean`		`true` if publisher hierarchy traversal is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsPublisherHierarchyDesign
Description	Tests for the availability of a publisher hierarchy design service.
Return	`boolean`		`true` if publisher hierarchy design is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented in all providers.
Method	supportsSubscriptionBatch
Description	Tests for the availability of a subscription batch service.
Return	`boolean`		`true` if a subscription batch service is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented in all providers.
Method	supportsSubscriptionRules
Description	Tests for the availability of a subscription rules service.
Return	`boolean`		`true` if a subscription rules service is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented in all providers.
Method	getSubscriptionRecordTypes
Description	Gets the supported `Subscription` record types.
Return	`osid.type.TypeList`		a list containing the supported subscription record types
Compliance	`mandatory`		This method must be implemented.
Method	supportsSubscriptionRecordType
Description	Tests if the given `Subscription` record type is supported.
Parameters	`osid.type.Type`	`subscriptionRecordType`	a `Type` indicating a `Subscription` record type
Return	`boolean`		`true` if the given `Type` is supported, `false` otherwise
Errors	NULL_ARGUMENT		`subscriptionRecordType` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	getSubscriptionSearchRecordTypes
Description	Gets the supported subscription search record types.
Return	`osid.type.TypeList`		a list containing the supported subscription search record types
Compliance	`mandatory`		This method must be implemented.
Method	supportsSubscriptionSearchRecordType
Description	Tests if the given subscription search record type is supported.
Parameters	`osid.type.Type`	`subscriptionSearchRecordType`	a `Type` indicating a subscription record type
Return	`boolean`		`true` if the given `Type` is supported, `false` otherwise
Errors	NULL_ARGUMENT		`subscriptionSearchRecordType` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	getDispatchRecordTypes
Description	Gets the supported `Dispatch` record types.
Return	`osid.type.TypeList`		a list containing the supported dispatch record types
Compliance	`mandatory`		This method must be implemented.
Method	supportsDispatchRecordType
Description	Tests if the given `Dispatch` record type is supported.
Parameters	`osid.type.Type`	`dispatchRecordType`	a `Type` indicating a `Dispatch` record type
Return	`boolean`		`true` if the given `Type` is supported, `false` otherwise
Errors	NULL_ARGUMENT		`dispatchRecordType` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	getDispatchSearchRecordTypes
Description	Gets the supported dispatch search record types.
Return	`osid.type.TypeList`		a list containing the supported dispatch search record types
Compliance	`mandatory`		This method must be implemented.
Method	supportsDispatchSearchRecordType
Description	Tests if the given dispatch search record type is supported.
Parameters	`osid.type.Type`	`dispatchSearchRecordType`	a `Type` indicating a dispatch record type
Return	`boolean`		`true` if the given `Type` is supported, `false` otherwise
Errors	NULL_ARGUMENT		`dispatchSearchRecordType` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	getPublisherRecordTypes
Description	Gets the supported `Publisher` record types.
Return	`osid.type.TypeList`		a list containing the supported publisher record types
Compliance	`mandatory`		This method must be implemented.
Method	supportsPublisherRecordType
Description	Tests if the given `Publisher` record type is supported.
Parameters	`osid.type.Type`	`publisherRecordType`	a `Type` indicating a `Publisher` record type
Return	`boolean`		`true` if the given `Type` is supported, `false` otherwise
Errors	NULL_ARGUMENT		`publisherRecordType` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	getPublisherSearchRecordTypes
Description	Gets the supported publisher search record types.
Return	`osid.type.TypeList`		a list containing the supported publisher search record types
Compliance	`mandatory`		This method must be implemented.
Method	supportsPublisherSearchRecordType
Description	Tests if the given publisher search record type is supported.
Parameters	`osid.type.Type`	`publisherSearchRecordType`	a `Type` indicating a publisher record type
Return	`boolean`		`true` if the given `Type` is supported, `false` otherwise
Errors	NULL_ARGUMENT		`publisherSearchRecordType` is `null`
Compliance	`mandatory`		This method must be implemented.