public interface SubscriptionProfile extends OsidProfile
The subscription profile describes the interoperability among subscription services.
Modifier and Type | Method and Description |
---|---|
TypeList |
getDispatchRecordTypes()
Gets the supported
Dispatch record types. |
TypeList |
getDispatchSearchRecordTypes()
Gets the supported dispatch search record types.
|
TypeList |
getPublisherRecordTypes()
Gets the supported
Publisher record types. |
TypeList |
getPublisherSearchRecordTypes()
Gets the supported publisher search record types.
|
TypeList |
getSubscriptionRecordTypes()
Gets the supported
Subscription record types. |
TypeList |
getSubscriptionSearchRecordTypes()
Gets the supported subscription search record types.
|
boolean |
supportsDispatchAdmin()
Tests for the availability of a dispatch administrative service for
creating and deleting dispatches.
|
boolean |
supportsDispatchLookup()
Tests for the availability of an dispatch lookup service.
|
boolean |
supportsDispatchNotification()
Tests for the availability of a dispatch notification service.
|
boolean |
supportsDispatchPublisher()
Tests if a dispatch to publisher lookup session is available.
|
boolean |
supportsDispatchPublisherAssignment()
Tests if a dispatch to publisher assignment session is available.
|
boolean |
supportsDispatchQuery()
Tests if querying dispatches is available.
|
boolean |
supportsDispatchRecordType(Type dispatchRecordType)
Tests if the given
Dispatch record type is supported. |
boolean |
supportsDispatchSearch()
Tests if searching for dispatches is available.
|
boolean |
supportsDispatchSearchRecordType(Type dispatchSearchRecordType)
Tests if the given dispatch search record type is supported.
|
boolean |
supportsDispatchSmartPublisher()
Tests if a dispatch smart publisher session is available.
|
boolean |
supportsMySubscription()
Tests for the availability of a my subscription lookup service.
|
boolean |
supportsMySubscriptionAdmin()
Tests for the availability of a my subscription administrative
service.
|
boolean |
supportsPublisherAdmin()
Tests for the availability of a publisher administrative service for
creating and deleting publishers.
|
boolean |
supportsPublisherHierarchy()
Tests for the availability of a publisher hierarchy traversal service.
|
boolean |
supportsPublisherHierarchyDesign()
Tests for the availability of a publisher hierarchy design service.
|
boolean |
supportsPublisherLookup()
Tests for the availability of an publisher lookup service.
|
boolean |
supportsPublisherNotification()
Tests for the availability of a publisher notification service.
|
boolean |
supportsPublisherQuery()
Tests if querying publishers is available.
|
boolean |
supportsPublisherRecordType(Type publisherRecordType)
Tests if the given
Publisher record type is supported. |
boolean |
supportsPublisherSearch()
Tests if searching for publishers is available.
|
boolean |
supportsPublisherSearchRecordType(Type publisherSearchRecordType)
Tests if the given publisher search record type is supported.
|
boolean |
supportsSubscriptionAdmin()
Tests if searching for subscriptions is available.
|
boolean |
supportsSubscriptionBatch()
Tests for the availability of a subscription batch service.
|
boolean |
supportsSubscriptionLookup()
Tests for the availability of a subscription lookup service.
|
boolean |
supportsSubscriptionNotification()
Tests if subscription notification is available.
|
boolean |
supportsSubscriptionPublisher()
Tests if a subscription to publisher lookup session is available.
|
boolean |
supportsSubscriptionPublisherAssignment()
Tests if a subscription to publisher assignment session is available.
|
boolean |
supportsSubscriptionQuery()
Tests if querying subscriptions is available.
|
boolean |
supportsSubscriptionRecordType(Type subscriptionRecordType)
Tests if the given
Subscription record type is
supported. |
boolean |
supportsSubscriptionRules()
Tests for the availability of a subscription rules service.
|
boolean |
supportsSubscriptionSearch()
Tests if searching for subscriptions is available.
|
boolean |
supportsSubscriptionSearchRecordType(Type subscriptionSearchRecordType)
Tests if the given subscription search record type is supported.
|
boolean |
supportsSubscriptionSmartPublisher()
Tests if a subscription smart publisher session is available.
|
boolean |
supportsVisibleFederation()
Tests if any dispatch federation is exposed.
|
getBranch, getBranchId, getDescription, getDisplayName, getId, getLocales, getProxyRecordTypes, getReleaseDate, getVersion, supportsJournalBranching, supportsJournalRollback, supportsOSIDVersion, supportsProxyRecordType
getBranding, getBrandingIds, getLicense, getProvider, getProviderId
boolean supportsVisibleFederation()
true
if visible federation is supported,
false
otherwisemandatory
- This method must be implemented. boolean supportsMySubscription()
true
if my subscription lookup is available,
false
otherwisemandatory
- This method must be implemented. boolean supportsMySubscriptionAdmin()
true
if my subscription admin is available,
false
otherwisemandatory
- This method must be implemented. boolean supportsSubscriptionLookup()
true
if subscription lookup is available,
false
otherwisemandatory
- This method must be implemented. boolean supportsSubscriptionQuery()
true
if subscription query is available,
false
otherwisemandatory
- This method must be implemented. boolean supportsSubscriptionSearch()
true
if subscription search is available,
false
otherwisemandatory
- This method must be implemented. boolean supportsSubscriptionAdmin()
true
if subscription search is available,
false
otherwisemandatory
- This method must be implemented. boolean supportsSubscriptionNotification()
true
if subscription notification is available,
false
otherwisemandatory
- This method must be implemented. boolean supportsSubscriptionPublisher()
true
if subscription publisher lookup session
is supported, false
otherwisemandatory
- This method must be implemented. boolean supportsSubscriptionPublisherAssignment()
true
if subscription publisher assignment is
supported, false
otherwisemandatory
- This method must be implemented. boolean supportsSubscriptionSmartPublisher()
true
if subscription smart publisher is
supported, false
otherwisemandatory
- This method must be implemented. boolean supportsDispatchLookup()
true
if dispatch lookup is available,
false
otherwisemandatory
- This method must be implemented. boolean supportsDispatchQuery()
true
if dispatch query is available,
false
otherwisemandatory
- This method must be implemented. boolean supportsDispatchSearch()
true
if dispatch search is available,
false
otherwisemandatory
- This method must be implemented. boolean supportsDispatchAdmin()
true
if dispatch administration is available,
false
otherwisemandatory
- This method must be implemented. boolean supportsDispatchNotification()
true
if dispatch notification is available,
false
otherwisemandatory
- This method must be implemented in all
providers. boolean supportsDispatchPublisher()
true
if dispatch publisher lookup session is
supported, false
otherwisemandatory
- This method must be implemented. boolean supportsDispatchPublisherAssignment()
true
if dispatch publisher assignment is
supported, false
otherwisemandatory
- This method must be implemented. boolean supportsDispatchSmartPublisher()
true
if dispatch smart publisher is supported,
false
otherwisemandatory
- This method must be implemented. boolean supportsPublisherLookup()
true
if publisher lookup is available,
false
otherwisemandatory
- This method must be implemented. boolean supportsPublisherQuery()
true
if publisher query is available,
false
otherwisemandatory
- This method must be implemented. boolean supportsPublisherSearch()
true
if publisher search is available,
false
otherwisemandatory
- This method must be implemented. boolean supportsPublisherAdmin()
true
if publisher administration is available,
false
otherwisemandatory
- This method must be implemented. boolean supportsPublisherNotification()
true
if publisher notification is available,
false
otherwisemandatory
- This method must be implemented in all
providers. boolean supportsPublisherHierarchy()
true
if publisher hierarchy traversal is
available, false
otherwisemandatory
- This method must be implemented. boolean supportsPublisherHierarchyDesign()
true
if publisher hierarchy design is
available, false
otherwisemandatory
- This method must be implemented in all
providers. boolean supportsSubscriptionBatch()
true
if a subscription batch service is
available, false
otherwisemandatory
- This method must be implemented in all
providers. boolean supportsSubscriptionRules()
true
if a subscription rules service is
available, false
otherwisemandatory
- This method must be implemented in all
providers. TypeList getSubscriptionRecordTypes()
Subscription
record types.mandatory
- This method must be implemented. boolean supportsSubscriptionRecordType(Type subscriptionRecordType)
Subscription
record type is
supported.subscriptionRecordType
- a Type
indicating a
Subscription
record type true
if the given Type
is
supported, false
otherwiseNullArgumentException
- subscriptionRecordType
is null
mandatory
- This method must be implemented. TypeList getSubscriptionSearchRecordTypes()
mandatory
- This method must be implemented. boolean supportsSubscriptionSearchRecordType(Type subscriptionSearchRecordType)
subscriptionSearchRecordType
- a Type
indicating
a subscription record type true
if the given Type
is
supported, false
otherwiseNullArgumentException
-
subscriptionSearchRecordType
is null
mandatory
- This method must be implemented. TypeList getDispatchRecordTypes()
Dispatch
record types.mandatory
- This method must be implemented. boolean supportsDispatchRecordType(Type dispatchRecordType)
Dispatch
record type is supported.dispatchRecordType
- a Type
indicating a
Dispatch
record type true
if the given Type
is
supported, false
otherwiseNullArgumentException
- dispatchRecordType
is null
mandatory
- This method must be implemented. TypeList getDispatchSearchRecordTypes()
mandatory
- This method must be implemented. boolean supportsDispatchSearchRecordType(Type dispatchSearchRecordType)
dispatchSearchRecordType
- a Type
indicating a
dispatch record type true
if the given Type
is
supported, false
otherwiseNullArgumentException
- dispatchSearchRecordType
is null
mandatory
- This method must be implemented. TypeList getPublisherRecordTypes()
Publisher
record types.mandatory
- This method must be implemented. boolean supportsPublisherRecordType(Type publisherRecordType)
Publisher
record type is supported.publisherRecordType
- a Type
indicating a
Publisher
record type true
if the given Type
is
supported, false
otherwiseNullArgumentException
- publisherRecordType
is null
mandatory
- This method must be implemented. TypeList getPublisherSearchRecordTypes()
mandatory
- This method must be implemented. boolean supportsPublisherSearchRecordType(Type publisherSearchRecordType)
publisherSearchRecordType
- a Type
indicating a
publisher record type true
if the given Type
is
supported, false
otherwiseNullArgumentException
-
publisherSearchRecordType
is null
mandatory
- This method must be implemented.