org.osid.tracking.rules

Interface TrackingRulesProfile

All Superinterfaces:

OsidProfile, Sourceable

All Known Subinterfaces:

TrackingRulesManager, TrackingRulesProxyManager

public interface TrackingRulesProfile
extends OsidProfile

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

Method Summary

Methods

Modifier and Type	Method and Description
TypeList	getQueueConstrainerEnablerRecordTypes() Gets the supported QueueConstrainerEnabler record types.
TypeList	getQueueConstrainerEnablerSearchRecordTypes() Gets the supported QueueConstrainerEnabler search record types.
TypeList	getQueueConstrainerRecordTypes() Gets the supported QueueConstrainer record types.
TypeList	getQueueConstrainerSearchRecordTypes() Gets the supported QueueConstrainer search record types.
TypeList	getQueueProcessorEnablerRecordTypes() Gets the supported QueueProcessorEnabler record types.
TypeList	getQueueProcessorEnablerSearchRecordTypes() Gets the supported QueueProcessorEnabler search record types.
TypeList	getQueueProcessorRecordTypes() Gets the supported QueueProcessor record types.
TypeList	getQueueProcessorSearchRecordTypes() Gets the supported QueueProcessor search record types.
boolean	supportsQueueConstrainerAdmin() Tests if a queue constrainer administrative service is supported.
boolean	supportsQueueConstrainerEnablerAdmin() Tests if a queue constrainer enabler administrative service is supported.
boolean	supportsQueueConstrainerEnablerFrontOffice() Tests if a queue constrainer enabler front office lookup service is supported.
boolean	supportsQueueConstrainerEnablerFrontOfficeAssignment() Tests if a queue constrainer enabler front office service is supported.
boolean	supportsQueueConstrainerEnablerLookup() Tests if looking up queue constrainer enablers is supported.
boolean	supportsQueueConstrainerEnablerNotification() Tests if a queue constrainer enabler notification service is supported.
boolean	supportsQueueConstrainerEnablerQuery() Tests if querying queue constrainer enablers is supported.
boolean	supportsQueueConstrainerEnablerRecordType(Type queueConstrainerEnablerRecordType) Tests if the given QueueConstrainerEnabler record type is supported.
boolean	supportsQueueConstrainerEnablerRuleApplication() Tests if a queue constrainer enabler rule application service is supported.
boolean	supportsQueueConstrainerEnablerRuleLookup() Tests if a queue constrainer enabler rule lookup service is supported.
boolean	supportsQueueConstrainerEnablerSearch() Tests if searching queue constrainer enablers is supported.
boolean	supportsQueueConstrainerEnablerSearchRecordType(Type queueConstrainerEnablerSearchRecordType) Tests if the given QueueConstrainerEnabler search record type is supported.
boolean	supportsQueueConstrainerEnablerSmartFrontOffice() Tests if a queue constrainer enabler front office lookup service is supported.
boolean	supportsQueueConstrainerFrontOffice() Tests if a queue constrainer front office lookup service is supported.
boolean	supportsQueueConstrainerFrontOfficeAssignment() Tests if a queue constrainer front office service is supported.
boolean	supportsQueueConstrainerLookup() Tests if looking up queue constrainer is supported.
boolean	supportsQueueConstrainerNotification() Tests if a queue constrainer notification service is supported.
boolean	supportsQueueConstrainerQuery() Tests if querying queue constrainer is supported.
boolean	supportsQueueConstrainerRecordType(Type queueConstrainerRecordType) Tests if the given QueueConstrainer record type is supported.
boolean	supportsQueueConstrainerRuleApplication() Tests if a queue constrainer rule application service is supported.
boolean	supportsQueueConstrainerRuleLookup() Tests if a queue constrainer rule lookup service is supported.
boolean	supportsQueueConstrainerSearch() Tests if searching queue constrainer is supported.
boolean	supportsQueueConstrainerSearchRecordType(Type queueConstrainerSearchRecordType) Tests if the given QueueConstrainer search record type is supported.
boolean	supportsQueueConstrainerSmartFrontOffice() Tests if a queue constrainer front office lookup service is supported.
boolean	supportsQueueProcessorAdmin() Tests if a queue processor administrative service is supported.
boolean	supportsQueueProcessorEnablerAdmin() Tests if a queue processor enabler administrative service is supported.
boolean	supportsQueueProcessorEnablerFrontOffice() Tests if a queue processor enabler front office lookup service is supported.
boolean	supportsQueueProcessorEnablerFrontOfficeAssignment() Tests if a queue processor enabler front office service is supported.
boolean	supportsQueueProcessorEnablerLookup() Tests if looking up queue processor enablers is supported.
boolean	supportsQueueProcessorEnablerNotification() Tests if a queue processor enabler notification service is supported.
boolean	supportsQueueProcessorEnablerQuery() Tests if querying queue processor enablers is supported.
boolean	supportsQueueProcessorEnablerRecordType(Type queueProcessorEnablerRecordType) Tests if the given QueueProcessorEnabler record type is supported.
boolean	supportsQueueProcessorEnablerRuleApplication() Tests if a queue processor enabler rule application service is supported.
boolean	supportsQueueProcessorEnablerRuleLookup() Tests if a queue processor enabler rule lookup service is supported.
boolean	supportsQueueProcessorEnablerSearch() Tests if searching queue processor enablers is supported.
boolean	supportsQueueProcessorEnablerSearchRecordType(Type queueProcessorEnablerSearchRecordType) Tests if the given QueueProcessorEnabler search record type is supported.
boolean	supportsQueueProcessorEnablerSmartFrontOffice() Tests if a queue processor enabler front office lookup service is supported.
boolean	supportsQueueProcessorFrontOffice() Tests if a queue processor front office lookup service is supported.
boolean	supportsQueueProcessorFrontOfficeAssignment() Tests if a queue processor front office service is supported.
boolean	supportsQueueProcessorLookup() Tests if looking up queue processor is supported.
boolean	supportsQueueProcessorNotification() Tests if a queue processor notification service is supported.
boolean	supportsQueueProcessorQuery() Tests if querying queue processor is supported.
boolean	supportsQueueProcessorRecordType(Type queueProcessorRecordType) Tests if the given QueueProcessor record type is supported.
boolean	supportsQueueProcessorRuleApplication() Tests if a queue processor rule application service is supported.
boolean	supportsQueueProcessorRuleLookup() Tests if a queue processor rule lookup service is supported.
boolean	supportsQueueProcessorSearch() Tests if searching queue processor is supported.
boolean	supportsQueueProcessorSearchRecordType(Type queueProcessorSearchRecordType) Tests if the given QueueProcessor search record type is supported.
boolean	supportsQueueProcessorSmartFrontOffice() Tests if a queue processor front office 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.

supportsQueueConstrainerLookup

boolean supportsQueueConstrainerLookup()

Tests if looking up queue constrainer is supported.

Returns:

true if queue constrainer lookup is supported, false otherwise

Compliance:

mandatory - This method must be implemented.

supportsQueueConstrainerQuery

boolean supportsQueueConstrainerQuery()

Tests if querying queue constrainer is supported.

Returns:

true if queue constrainer query is supported, false otherwise

Compliance:

mandatory - This method must be implemented.

supportsQueueConstrainerSearch

boolean supportsQueueConstrainerSearch()

Tests if searching queue constrainer is supported.

Returns:

true if queue constrainer search is supported, false otherwise

Compliance:

mandatory - This method must be implemented.

supportsQueueConstrainerAdmin

boolean supportsQueueConstrainerAdmin()

Tests if a queue constrainer administrative service is supported.

Returns:

true if queue constrainer administration is supported, false otherwise

Compliance:

mandatory - This method must be implemented.

supportsQueueConstrainerNotification

boolean supportsQueueConstrainerNotification()

Tests if a queue constrainer notification service is supported.

Returns:

true if queue constrainer notification is supported, false otherwise

Compliance:

mandatory - This method must be implemented.

supportsQueueConstrainerFrontOffice

boolean supportsQueueConstrainerFrontOffice()

Tests if a queue constrainer front office lookup service is supported.

Returns:

true if a queue constrainer front office lookup service is supported, false otherwise

Compliance:

mandatory - This method must be implemented.

supportsQueueConstrainerFrontOfficeAssignment

boolean supportsQueueConstrainerFrontOfficeAssignment()

Tests if a queue constrainer front office service is supported.

Returns:

true if queue constrainer front office assignment service is supported, false otherwise

Compliance:

mandatory - This method must be implemented.

supportsQueueConstrainerSmartFrontOffice

boolean supportsQueueConstrainerSmartFrontOffice()

Tests if a queue constrainer front office lookup service is supported.

Returns:

true if a queue constrainer front office service is supported, false otherwise

Compliance:

mandatory - This method must be implemented.

supportsQueueConstrainerRuleLookup

boolean supportsQueueConstrainerRuleLookup()

Tests if a queue constrainer rule lookup service is supported.

Returns:

true if a queue constrainer rule lookup service is supported, false otherwise

Compliance:

mandatory - This method must be implemented.

supportsQueueConstrainerRuleApplication

boolean supportsQueueConstrainerRuleApplication()

Tests if a queue constrainer rule application service is supported.

Returns:

true if a queue constrainer rule application service is supported, false otherwise

Compliance:

mandatory - This method must be implemented.

supportsQueueConstrainerEnablerLookup

boolean supportsQueueConstrainerEnablerLookup()

Tests if looking up queue constrainer enablers is supported.

Returns:

true if queue constrainer enabler lookup is supported, false otherwise

Compliance:

mandatory - This method must be implemented.

supportsQueueConstrainerEnablerQuery

boolean supportsQueueConstrainerEnablerQuery()

Tests if querying queue constrainer enablers is supported.

Returns:

true if queue constrainer enabler query is supported, false otherwise

Compliance:

mandatory - This method must be implemented.

supportsQueueConstrainerEnablerSearch

boolean supportsQueueConstrainerEnablerSearch()

Tests if searching queue constrainer enablers is supported.

Returns:

true if queue constrainer enabler search is supported, false otherwise

Compliance:

mandatory - This method must be implemented.

supportsQueueConstrainerEnablerAdmin

boolean supportsQueueConstrainerEnablerAdmin()

Tests if a queue constrainer enabler administrative service is supported.

Returns:

true if queue constrainer enabler administration is supported, false otherwise

Compliance:

mandatory - This method must be implemented.

supportsQueueConstrainerEnablerNotification

boolean supportsQueueConstrainerEnablerNotification()

Tests if a queue constrainer enabler notification service is supported.

Returns:

true if queue constrainer enabler notification is supported, false otherwise

Compliance:

mandatory - This method must be implemented.

supportsQueueConstrainerEnablerFrontOffice

boolean supportsQueueConstrainerEnablerFrontOffice()

Tests if a queue constrainer enabler front office lookup service is supported.

Returns:

true if a queue constrainer enabler front office lookup service is supported, false otherwise

Compliance:

mandatory - This method must be implemented.

supportsQueueConstrainerEnablerFrontOfficeAssignment

boolean supportsQueueConstrainerEnablerFrontOfficeAssignment()

Tests if a queue constrainer enabler front office service is supported.

Returns:

true if queue constrainer enabler front office assignment service is supported, false otherwise

Compliance:

mandatory - This method must be implemented.

supportsQueueConstrainerEnablerSmartFrontOffice

boolean supportsQueueConstrainerEnablerSmartFrontOffice()

Tests if a queue constrainer enabler front office lookup service is supported.

Returns:

true if a queue constrainer enabler front office service is supported, false otherwise

Compliance:

mandatory - This method must be implemented.

supportsQueueConstrainerEnablerRuleLookup

boolean supportsQueueConstrainerEnablerRuleLookup()

Tests if a queue constrainer enabler rule lookup service is supported.

Returns:

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

Compliance:

mandatory - This method must be implemented.

supportsQueueConstrainerEnablerRuleApplication

boolean supportsQueueConstrainerEnablerRuleApplication()

Tests if a queue constrainer enabler rule application service is supported.

Returns:

true if queue constrainer enabler rule application service is supported, false otherwise

Compliance:

mandatory - This method must be implemented.

supportsQueueProcessorLookup

boolean supportsQueueProcessorLookup()

Tests if looking up queue processor is supported.

Returns:

true if queue processor lookup is supported, false otherwise

Compliance:

mandatory - This method must be implemented.

supportsQueueProcessorQuery

boolean supportsQueueProcessorQuery()

Tests if querying queue processor is supported.

Returns:

true if queue processor query is supported, false otherwise

Compliance:

mandatory - This method must be implemented.

supportsQueueProcessorSearch

boolean supportsQueueProcessorSearch()

Tests if searching queue processor is supported.

Returns:

true if queue processor search is supported, false otherwise

Compliance:

mandatory - This method must be implemented.

supportsQueueProcessorAdmin

boolean supportsQueueProcessorAdmin()

Tests if a queue processor administrative service is supported.

Returns:

true if queue processor administration is supported, false otherwise

Compliance:

mandatory - This method must be implemented.

supportsQueueProcessorNotification

boolean supportsQueueProcessorNotification()

Tests if a queue processor notification service is supported.

Returns:

true if queue processor notification is supported, false otherwise

Compliance:

mandatory - This method must be implemented.

supportsQueueProcessorFrontOffice

boolean supportsQueueProcessorFrontOffice()

Tests if a queue processor front office lookup service is supported.

Returns:

true if a queue processor front office lookup service is supported, false otherwise

Compliance:

mandatory - This method must be implemented.

supportsQueueProcessorFrontOfficeAssignment

boolean supportsQueueProcessorFrontOfficeAssignment()

Tests if a queue processor front office service is supported.

Returns:

true if queue processor front office assignment service is supported, false otherwise

Compliance:

mandatory - This method must be implemented.

supportsQueueProcessorSmartFrontOffice

boolean supportsQueueProcessorSmartFrontOffice()

Tests if a queue processor front office lookup service is supported.

Returns:

true if a queue processor front office service is supported, false otherwise

Compliance:

mandatory - This method must be implemented.

supportsQueueProcessorRuleLookup

boolean supportsQueueProcessorRuleLookup()

Tests if a queue processor rule lookup service is supported.

Returns:

true if a queue processor rule lookup service is supported, false otherwise

Compliance:

mandatory - This method must be implemented.

supportsQueueProcessorRuleApplication

boolean supportsQueueProcessorRuleApplication()

Tests if a queue processor rule application service is supported.

Returns:

true if queue processor rule application service is supported, false otherwise

Compliance:

mandatory - This method must be implemented.

supportsQueueProcessorEnablerLookup

boolean supportsQueueProcessorEnablerLookup()

Tests if looking up queue processor enablers is supported.

Returns:

true if queue processor enabler lookup is supported, false otherwise

Compliance:

mandatory - This method must be implemented.

supportsQueueProcessorEnablerQuery

boolean supportsQueueProcessorEnablerQuery()

Tests if querying queue processor enablers is supported.

Returns:

true if queue processor enabler query is supported, false otherwise

Compliance:

mandatory - This method must be implemented.

supportsQueueProcessorEnablerSearch

boolean supportsQueueProcessorEnablerSearch()

Tests if searching queue processor enablers is supported.

Returns:

true if queue processor enabler search is supported, false otherwise

Compliance:

mandatory - This method must be implemented.

supportsQueueProcessorEnablerAdmin

boolean supportsQueueProcessorEnablerAdmin()

Tests if a queue processor enabler administrative service is supported.

Returns:

true if queue processor enabler administration is supported, false otherwise

Compliance:

mandatory - This method must be implemented.

supportsQueueProcessorEnablerNotification

boolean supportsQueueProcessorEnablerNotification()

Tests if a queue processor enabler notification service is supported.

Returns:

true if queue processor enabler notification is supported, false otherwise

Compliance:

mandatory - This method must be implemented.

supportsQueueProcessorEnablerFrontOffice

boolean supportsQueueProcessorEnablerFrontOffice()

Tests if a queue processor enabler front office lookup service is supported.

Returns:

true if a queue processor enabler front office lookup service is supported, false otherwise

Compliance:

mandatory - This method must be implemented.

supportsQueueProcessorEnablerFrontOfficeAssignment

boolean supportsQueueProcessorEnablerFrontOfficeAssignment()

Tests if a queue processor enabler front office service is supported.

Returns:

true if queue processor enabler front office assignment service is supported, false otherwise

Compliance:

mandatory - This method must be implemented.

supportsQueueProcessorEnablerSmartFrontOffice

boolean supportsQueueProcessorEnablerSmartFrontOffice()

Tests if a queue processor enabler front office lookup service is supported.

Returns:

true if a queue processor enabler front office service is supported, false otherwise

Compliance:

mandatory - This method must be implemented.

supportsQueueProcessorEnablerRuleLookup

boolean supportsQueueProcessorEnablerRuleLookup()

Tests if a queue processor enabler rule lookup service is supported.

Returns:

true if an processor enabler rule lookup service is supported, false otherwise

Compliance:

mandatory - This method must be implemented.

supportsQueueProcessorEnablerRuleApplication

boolean supportsQueueProcessorEnablerRuleApplication()

Tests if a queue processor enabler rule application service is supported.

Returns:

true if queue processor enabler rule application service is supported, false otherwise

Compliance:

mandatory - This method must be implemented.

getQueueConstrainerRecordTypes

TypeList getQueueConstrainerRecordTypes()

Gets the supported QueueConstrainer record types.

Returns:

a list containing the supported QueueConstrainer record types

Compliance:

mandatory - This method must be implemented.

supportsQueueConstrainerRecordType

boolean supportsQueueConstrainerRecordType(Type queueConstrainerRecordType)

Tests if the given QueueConstrainer record type is supported.

Parameters:

queueConstrainerRecordType - a Type indicating a QueueConstrainer record type

Returns:

true if the given record type is supported, false otherwise

Throws:

NullArgumentException - queueConstrainerRecordType is null

Compliance:

mandatory - This method must be implemented.

getQueueConstrainerSearchRecordTypes

TypeList getQueueConstrainerSearchRecordTypes()

Gets the supported QueueConstrainer search record types.

Returns:

a list containing the supported QueueConstrainer search record types

Compliance:

mandatory - This method must be implemented.

supportsQueueConstrainerSearchRecordType

boolean supportsQueueConstrainerSearchRecordType(Type queueConstrainerSearchRecordType)

Tests if the given QueueConstrainer search record type is supported.

Parameters:

queueConstrainerSearchRecordType - a Type indicating a QueueConstrainer search record type

Returns:

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

Throws:

NullArgumentException - queueConstrainerSearchRecordType is null

Compliance:

mandatory - This method must be implemented.

getQueueConstrainerEnablerRecordTypes

TypeList getQueueConstrainerEnablerRecordTypes()

Gets the supported QueueConstrainerEnabler record types.

Returns:

a list containing the supported QueueConstrainerEnabler record types

Compliance:

mandatory - This method must be implemented.

supportsQueueConstrainerEnablerRecordType

boolean supportsQueueConstrainerEnablerRecordType(Type queueConstrainerEnablerRecordType)

Tests if the given QueueConstrainerEnabler record type is supported.

Parameters:

queueConstrainerEnablerRecordType - a Type indicating a QueueConstrainerEnabler record type

Returns:

true if the given record type is supported, false otherwise

Throws:

NullArgumentException - queueConstrainerEnablerRecordType is null

Compliance:

mandatory - This method must be implemented.

getQueueConstrainerEnablerSearchRecordTypes

TypeList getQueueConstrainerEnablerSearchRecordTypes()

Gets the supported QueueConstrainerEnabler search record types.

Returns:

a list containing the supported QueueConstrainerEnabler search record types

Compliance:

mandatory - This method must be implemented.

supportsQueueConstrainerEnablerSearchRecordType

boolean supportsQueueConstrainerEnablerSearchRecordType(Type queueConstrainerEnablerSearchRecordType)

Tests if the given QueueConstrainerEnabler search record type is supported.

Parameters:

queueConstrainerEnablerSearchRecordType - a Type indicating a QueueConstrainerEnabler search record type

Returns:

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

Throws:

NullArgumentException - queueConstrainerEnablerSearchRecordType is null

Compliance:

mandatory - This method must be implemented.

getQueueProcessorRecordTypes

TypeList getQueueProcessorRecordTypes()

Gets the supported QueueProcessor record types.

Returns:

a list containing the supported QueueProcessor record types

Compliance:

mandatory - This method must be implemented.

supportsQueueProcessorRecordType

boolean supportsQueueProcessorRecordType(Type queueProcessorRecordType)

Tests if the given QueueProcessor record type is supported.

Parameters:

queueProcessorRecordType - a Type indicating a QueueProcessor record type

Returns:

true if the given record type is supported, false otherwise

Throws:

NullArgumentException - queueProcessorRecordType is null

Compliance:

mandatory - This method must be implemented.

getQueueProcessorSearchRecordTypes

TypeList getQueueProcessorSearchRecordTypes()

Gets the supported QueueProcessor search record types.

Returns:

a list containing the supported QueueProcessor search record types

Compliance:

mandatory - This method must be implemented.

supportsQueueProcessorSearchRecordType

boolean supportsQueueProcessorSearchRecordType(Type queueProcessorSearchRecordType)

Tests if the given QueueProcessor search record type is supported.

Parameters:

queueProcessorSearchRecordType - a Type indicating a QueueProcessor search record type

Returns:

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

Throws:

NullArgumentException - queueProcessorSearchRecordType is null

Compliance:

mandatory - This method must be implemented.

getQueueProcessorEnablerRecordTypes

TypeList getQueueProcessorEnablerRecordTypes()

Gets the supported QueueProcessorEnabler record types.

Returns:

a list containing the supported QueueProcessorEnabler record types

Compliance:

mandatory - This method must be implemented.

supportsQueueProcessorEnablerRecordType

boolean supportsQueueProcessorEnablerRecordType(Type queueProcessorEnablerRecordType)

Tests if the given QueueProcessorEnabler record type is supported.

Parameters:

queueProcessorEnablerRecordType - a Type indicating a QueueProcessorEnabler record type

Returns:

true if the given record type is supported, false otherwise

Throws:

NullArgumentException - queueProcessorEnablerRecordType is null

Compliance:

mandatory - This method must be implemented.

getQueueProcessorEnablerSearchRecordTypes

TypeList getQueueProcessorEnablerSearchRecordTypes()

Gets the supported QueueProcessorEnabler search record types.

Returns:

a list containing the supported QueueProcessorEnabler search record types

Compliance:

mandatory - This method must be implemented.

supportsQueueProcessorEnablerSearchRecordType

boolean supportsQueueProcessorEnablerSearchRecordType(Type queueProcessorEnablerSearchRecordType)

Tests if the given QueueProcessorEnabler search record type is supported.

Parameters:

queueProcessorEnablerSearchRecordType - a Type indicating a QueueProcessorEnabler search record type

Returns:

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

Throws:

NullArgumentException - queueProcessorEnablerSearchRecordType is null

Compliance:

mandatory - This method must be implemented.