org.osid.subscription.rules

Interface SubscriptionRulesProfile

All Superinterfaces:

OsidProfile, Sourceable

All Known Subinterfaces:

SubscriptionRulesManager, SubscriptionRulesProxyManager

public interface SubscriptionRulesProfile
extends OsidProfile

The subscription rules profile describes the interoperability among subscription rules services.

Method Summary

Methods

Modifier and Type	Method and Description
TypeList	getSubscriptionEnablerRecordTypes() Gets the supported SubscriptionEnabler record types.
TypeList	getSubscriptionEnablerSearchRecordTypes() Gets the supported SubscriptionEnabler search record types.
boolean	supportsSubscriptionEnablerAdmin() Tests if a subscription enabler administrative service is supported.
boolean	supportsSubscriptionEnablerLookup() Tests if looking up subscription enablers is supported.
boolean	supportsSubscriptionEnablerNotification() Tests if a subscription enabler notification service is supported.
boolean	supportsSubscriptionEnablerPublisher() Tests if a subscription enabler publisher lookup service is supported.
boolean	supportsSubscriptionEnablerPublisherAssignment() Tests if a subscription enabler publisher service is supported.
boolean	supportsSubscriptionEnablerQuery() Tests if querying subscription enablers is supported.
boolean	supportsSubscriptionEnablerRecordType(Type subscriptionEnablerRecordType) Tests if the given SubscriptionEnabler record type is supported.
boolean	supportsSubscriptionEnablerRuleApplication() Tests if a subscription enabler rule application service is supported.
boolean	supportsSubscriptionEnablerRuleLookup() Tests if a subscription enabler rule lookup service is supported.
boolean	supportsSubscriptionEnablerSearch() Tests if searching subscription enablers is supported.
boolean	supportsSubscriptionEnablerSearchRecordType(Type subscriptionEnablerSearchRecordType) Tests if the given SubscriptionEnabler search record type is supported.
boolean	supportsSubscriptionEnablerSmartSubscription() Tests if a subscription enabler subscription lookup service is supported.
boolean	supportsVisibleFederation() Tests if any broker federation is exposed.

Methods inherited from interface org.osid.OsidProfile

getBranch, getBranchId, getDescription, getDisplayName, getId, getLocales, getProxyRecordTypes, getReleaseDate, getVersion, supportsJournalBranching, supportsJournalRollback, supportsOSIDVersion, supportsProxyRecordType

Methods inherited from interface org.osid.Sourceable

getBranding, getBrandingIds, getLicense, getProvider, getProviderId

Method Detail

supportsVisibleFederation

boolean supportsVisibleFederation()

Tests if any broker federation is exposed. Federation is exposed when a specific broker may be identified, selected and used to create a lookup or admin session. Federation is not exposed when a set of brokers appears as a single broker.

Returns:

true if visible federation is supported, false otherwise

Compliance:

mandatory - This method must be implemented.

supportsSubscriptionEnablerLookup

boolean supportsSubscriptionEnablerLookup()

Tests if looking up subscription enablers is supported.

Returns:

true if subscription enabler lookup is supported, false otherwise

Compliance:

mandatory - This method must be implemented.

supportsSubscriptionEnablerQuery

boolean supportsSubscriptionEnablerQuery()

Tests if querying subscription enablers is supported.

Returns:

true if subscription enabler query is supported, false otherwise

Compliance:

mandatory - This method must be implemented.

supportsSubscriptionEnablerSearch

boolean supportsSubscriptionEnablerSearch()

Tests if searching subscription enablers is supported.

Returns:

true if subscription enabler search is supported, false otherwise

Compliance:

mandatory - This method must be implemented.

supportsSubscriptionEnablerAdmin

boolean supportsSubscriptionEnablerAdmin()

Tests if a subscription enabler administrative service is supported.

Returns:

true if subscription enabler administration is supported, false otherwise

Compliance:

mandatory - This method must be implemented.

supportsSubscriptionEnablerNotification

boolean supportsSubscriptionEnablerNotification()

Tests if a subscription enabler notification service is supported.

Returns:

true if subscription enabler notification is supported, false otherwise

Compliance:

mandatory - This method must be implemented.

supportsSubscriptionEnablerPublisher

boolean supportsSubscriptionEnablerPublisher()

Tests if a subscription enabler publisher lookup service is supported.

Returns:

true if a publisher enabler subscription lookup service is supported, false otherwise

Compliance:

mandatory - This method must be implemented.

supportsSubscriptionEnablerPublisherAssignment

boolean supportsSubscriptionEnablerPublisherAssignment()

Tests if a subscription enabler publisher service is supported.

Returns:

true if subscription enabler publisher assignment service is supported, false otherwise

Compliance:

mandatory - This method must be implemented.

supportsSubscriptionEnablerSmartSubscription

boolean supportsSubscriptionEnablerSmartSubscription()

Tests if a subscription enabler subscription lookup service is supported.

Returns:

true if a subscription enabler subscription service is supported, false otherwise

Compliance:

mandatory - This method must be implemented.

supportsSubscriptionEnablerRuleLookup

boolean supportsSubscriptionEnablerRuleLookup()

Tests if a subscription enabler rule lookup service is supported.

Returns:

true if a subscription enabler rule lookup service is supported, false otherwise

Compliance:

mandatory - This method must be implemented.

supportsSubscriptionEnablerRuleApplication

boolean supportsSubscriptionEnablerRuleApplication()

Tests if a subscription enabler rule application service is supported.

Returns:

true if subscription enabler rule application service is supported, false otherwise

Compliance:

mandatory - This method must be implemented.

getSubscriptionEnablerRecordTypes

TypeList getSubscriptionEnablerRecordTypes()

Gets the supported SubscriptionEnabler record types.

Returns:

a list containing the supported SubscriptionEnabler record types

Compliance:

mandatory - This method must be implemented.

supportsSubscriptionEnablerRecordType

boolean supportsSubscriptionEnablerRecordType(Type subscriptionEnablerRecordType)

Tests if the given SubscriptionEnabler record type is supported.

Parameters:

subscriptionEnablerRecordType - a Type indicating a SubscriptionEnabler record type

Returns:

true if the given record type is supported, false otherwise

Throws:

NullArgumentException - subscriptionEnablerRecordType is null

Compliance:

mandatory - This method must be implemented.

getSubscriptionEnablerSearchRecordTypes

TypeList getSubscriptionEnablerSearchRecordTypes()

Gets the supported SubscriptionEnabler search record types.

Returns:

a list containing the supported SubscriptionEnabler search record types

Compliance:

mandatory - This method must be implemented.

supportsSubscriptionEnablerSearchRecordType

boolean supportsSubscriptionEnablerSearchRecordType(Type subscriptionEnablerSearchRecordType)

Tests if the given SubscriptionEnabler search record type is supported.

Parameters:

subscriptionEnablerSearchRecordType - a Type indicating a SubscriptionEnabler search record type

Returns:

true if the given search record type is supported, false otherwise

Throws:

NullArgumentException - subscriptionEnablerSearchRecordType is null

Compliance:

mandatory - This method must be implemented.