org.osid.calendaring.rules

Interface CalendaringRulesProfile

All Superinterfaces:

OsidProfile, Sourceable

All Known Subinterfaces:

CalendaringRulesManager, CalendaringRulesProxyManager

public interface CalendaringRulesProfile
extends OsidProfile

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

Method Summary

Methods

Modifier and Type	Method and Description
TypeList	getCommitmentEnablerRecordTypes() Gets the supported CommitmentEnabler record types.
TypeList	getCommitmentEnablerSearchRecordTypes() Gets the supported CommitmentEnabler search record types.
TypeList	getOffsetEventEnablerRecordTypes() Gets the supported OffsetEventEnabler record interface types.
TypeList	getOffsetEventEnablerSearchRecordTypes() Gets the supported OffsetEventEnabler search record interface types.
TypeList	getRecurringEventEnablerRecordTypes() Gets the supported RecurringEventEnabler record interface types.
TypeList	getRecurringEventEnablerSearchRecordTypes() Gets the supported RecurringEventEnabler search record interface types.
TypeList	getSupersedingEventEnablerRecordTypes() Gets the supported SupersedingEventEnabler record interface types.
TypeList	getSupersedingEventEnablerSearchRecordTypes() Gets the supported SupersedingEventEnabler search record interface types.
boolean	supportsCommitmentEnablerAdmin() Tests if a commitment enabler administrative service is supported.
boolean	supportsCommitmentEnablerCalendar() Tests if a commitment enabler calendar lookup service is supported.
boolean	supportsCommitmentEnablerCalendarAssignment() Tests if a commitment enabler calendar service is supported.
boolean	supportsCommitmentEnablerLookup() Tests if looking up commitment enablers is supported.
boolean	supportsCommitmentEnablerNotification() Tests if a commitment enabler notification service is supported.
boolean	supportsCommitmentEnablerQuery() Tests if querying commitment enablers is supported.
boolean	supportsCommitmentEnablerRecordType(Type commitmentEnablerRecordType) Tests if the given CommitmentEnabler record type is supported.
boolean	supportsCommitmentEnablerRuleApplication() Tests if a commitment enabler rule application service is supported.
boolean	supportsCommitmentEnablerRuleLookup() Tests if a commitment enabler rule lookup service is supported.
boolean	supportsCommitmentEnablerSearch() Tests if searching commitment enablers is supported.
boolean	supportsCommitmentEnablerSearchRecordType(Type commitmentEnablerSearchRecordType) Tests if the given CommitmentEnabler search record type is supported.
boolean	supportsCommitmentEnablerSmartCalendar() Tests if a commitment enabler calendar lookup service is supported.
boolean	supportsOffsetEventEnablerAdmin() Tests if an offset event enabler administrative service is supported.
boolean	supportsOffsetEventEnablerCalendar() Tests if an offset event enabler calendar lookup service is supported.
boolean	supportsOffsetEventEnablerCalendarAssignment() Tests if an offset event enabler calendar service is supported.
boolean	supportsOffsetEventEnablerLookup() Tests if looking up offset event enablers is supported.
boolean	supportsOffsetEventEnablerNotification() Tests if an offset event enabler notification service is supported.
boolean	supportsOffsetEventEnablerQuery() Tests if querying offset event enablers is supported.
boolean	supportsOffsetEventEnablerRecordType(Type offsetEventEnablerRecordType) Tests if the given OffsetEventEnabler record interface type is supported.
boolean	supportsOffsetEventEnablerRuleApplication() Tests if an offset event enabler rule application service is supported.
boolean	supportsOffsetEventEnablerRuleLookup() Tests if an offset event enabler rule lookup service is supported.
boolean	supportsOffsetEventEnablerSearch() Tests if searching offset event enablers is supported.
boolean	supportsOffsetEventEnablerSearchRecordType(Type offsetEventEnablerSearchRecordType) Tests if the given OffsetEventEnabler search record interface type is supported.
boolean	supportsOffsetEventEnablerSmartCalendar() Tests if an offset event enabler calendar lookup service is supported.
boolean	supportsRecurringEventEnablerAdmin() Tests if an recurring event enabler administrative service is supported.
boolean	supportsRecurringEventEnablerCalendar() Tests if an recurring event enabler calendar lookup service is supported.
boolean	supportsRecurringEventEnablerCalendarAssignment() Tests if an recurring event enabler calendar service is supported.
boolean	supportsRecurringEventEnablerLookup() Tests if looking up recurring event enablers is supported.
boolean	supportsRecurringEventEnablerNotification() Tests if an recurring event enabler notification service is supported.
boolean	supportsRecurringEventEnablerQuery() Tests if querying recurring event enablers is supported.
boolean	supportsRecurringEventEnablerRecordType(Type recurringEventEnablerRecordType) Tests if the given RecurringEventEnabler record interface type is supported.
boolean	supportsRecurringEventEnablerRuleApplication() Tests if an recurring event enabler rule application service is supported.
boolean	supportsRecurringEventEnablerRuleLookup() Tests if an recurring event enabler rule lookup service is supported.
boolean	supportsRecurringEventEnablerSearch() Tests if searching recurring event enablers is supported.
boolean	supportsRecurringEventEnablerSearchRecordType(Type recurringEventEnablerSearchRecordType) Tests if the given RecurringEventEnabler search record interface type is supported.
boolean	supportsRecurringEventEnablerSmartCalendar() Tests if an recurring event enabler calendar lookup service is supported.
boolean	supportsSupersedingEventEnablerAdmin() Tests if an superseding event enabler administrative service is supported.
boolean	supportsSupersedingEventEnablerCalendar() Tests if an superseding event enabler calendar lookup service is supported.
boolean	supportsSupersedingEventEnablerCalendarAssignment() Tests if an superseding event enabler calendar service is supported.
boolean	supportsSupersedingEventEnablerLookup() Tests if looking up superseding event enablers is supported.
boolean	supportsSupersedingEventEnablerNotification() Tests if an superseding event enabler notification service is supported.
boolean	supportsSupersedingEventEnablerQuery() Tests if querying superseding event enablers is supported.
boolean	supportsSupersedingEventEnablerRecordType(Type supersedingEventEnablerRecordType) Tests if the given SupersedingEventEnabler record interface type is supported.
boolean	supportsSupersedingEventEnablerRuleApplication() Tests if an superseding event enabler rule application service is supported.
boolean	supportsSupersedingEventEnablerRuleLookup() Tests if an superseding event enabler rule lookup service is supported.
boolean	supportsSupersedingEventEnablerSearch() Tests if searching superseding event enablers is supported.
boolean	supportsSupersedingEventEnablerSearchRecordType(Type supersedingEventEnablerSearchRecordType) Tests if the given SupersedingEventEnabler search record interface type is supported.
boolean	supportsSupersedingEventEnablerSmartCalendar() Tests if an superseding event enabler calendar 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.

supportsRecurringEventEnablerLookup

boolean supportsRecurringEventEnablerLookup()

Tests if looking up recurring event enablers is supported.

Returns:

true if recurring event enabler lookup is supported, false otherwise

Compliance:

mandatory - This method must be implemented.

supportsRecurringEventEnablerQuery

boolean supportsRecurringEventEnablerQuery()

Tests if querying recurring event enablers is supported.

Returns:

true if recurring event enabler query is supported, false otherwise

Compliance:

mandatory - This method must be implemented.

supportsRecurringEventEnablerSearch

boolean supportsRecurringEventEnablerSearch()

Tests if searching recurring event enablers is supported.

Returns:

true if recurring event enabler search is supported, false otherwise

Compliance:

mandatory - This method must be implemented.

supportsRecurringEventEnablerAdmin

boolean supportsRecurringEventEnablerAdmin()

Tests if an recurring event enabler administrative service is supported.

Returns:

true if recurring event enabler administration is supported, false otherwise

Compliance:

mandatory - This method must be implemented.

supportsRecurringEventEnablerNotification

boolean supportsRecurringEventEnablerNotification()

Tests if an recurring event enabler notification service is supported.

Returns:

true if recurring event enabler notification is supported, false otherwise

Compliance:

mandatory - This method must be implemented.

supportsRecurringEventEnablerCalendar

boolean supportsRecurringEventEnablerCalendar()

Tests if an recurring event enabler calendar lookup service is supported.

Returns:

true if an recurring event enabler calendar lookup service is supported, false otherwise

Compliance:

mandatory - This method must be implemented.

supportsRecurringEventEnablerCalendarAssignment

boolean supportsRecurringEventEnablerCalendarAssignment()

Tests if an recurring event enabler calendar service is supported.

Returns:

true if recurring event enabler calendar assignment service is supported, false otherwise

Compliance:

mandatory - This method must be implemented.

supportsRecurringEventEnablerSmartCalendar

boolean supportsRecurringEventEnablerSmartCalendar()

Tests if an recurring event enabler calendar lookup service is supported.

Returns:

true if an recurring event enabler calendar service is supported, false otherwise

Compliance:

mandatory - This method must be implemented.

supportsRecurringEventEnablerRuleLookup

boolean supportsRecurringEventEnablerRuleLookup()

Tests if an recurring event enabler rule lookup service is supported.

Returns:

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

Compliance:

mandatory - This method must be implemented.

supportsRecurringEventEnablerRuleApplication

boolean supportsRecurringEventEnablerRuleApplication()

Tests if an recurring event enabler rule application service is supported.

Returns:

true if recurring event enabler rule application service is supported, false otherwise

Compliance:

mandatory - This method must be implemented.

supportsOffsetEventEnablerLookup

boolean supportsOffsetEventEnablerLookup()

Tests if looking up offset event enablers is supported.

Returns:

true if offset event enabler lookup is supported, false otherwise

Compliance:

mandatory - This method must be implemented.

supportsOffsetEventEnablerQuery

boolean supportsOffsetEventEnablerQuery()

Tests if querying offset event enablers is supported.

Returns:

true if offset event enabler query is supported, false otherwise

Compliance:

mandatory - This method must be implemented.

supportsOffsetEventEnablerSearch

boolean supportsOffsetEventEnablerSearch()

Tests if searching offset event enablers is supported.

Returns:

true if offset event enabler search is supported, false otherwise

Compliance:

mandatory - This method must be implemented.

supportsOffsetEventEnablerAdmin

boolean supportsOffsetEventEnablerAdmin()

Tests if an offset event enabler administrative service is supported.

Returns:

true if offset event enabler administration is supported, false otherwise

Compliance:

mandatory - This method must be implemented.

supportsOffsetEventEnablerNotification

boolean supportsOffsetEventEnablerNotification()

Tests if an offset event enabler notification service is supported.

Returns:

true if offset event enabler notification is supported, false otherwise

Compliance:

mandatory - This method must be implemented.

supportsOffsetEventEnablerCalendar

boolean supportsOffsetEventEnablerCalendar()

Tests if an offset event enabler calendar lookup service is supported.

Returns:

true if an offset event enabler calendar lookup service is supported, false otherwise

Compliance:

mandatory - This method must be implemented.

supportsOffsetEventEnablerCalendarAssignment

boolean supportsOffsetEventEnablerCalendarAssignment()

Tests if an offset event enabler calendar service is supported.

Returns:

true if offset event enabler calendar assignment service is supported, false otherwise

Compliance:

mandatory - This method must be implemented.

supportsOffsetEventEnablerSmartCalendar

boolean supportsOffsetEventEnablerSmartCalendar()

Tests if an offset event enabler calendar lookup service is supported.

Returns:

true if an offset event enabler calendar service is supported, false otherwise

Compliance:

mandatory - This method must be implemented.

supportsOffsetEventEnablerRuleLookup

boolean supportsOffsetEventEnablerRuleLookup()

Tests if an offset event enabler rule lookup service is supported.

Returns:

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

Compliance:

mandatory - This method must be implemented.

supportsOffsetEventEnablerRuleApplication

boolean supportsOffsetEventEnablerRuleApplication()

Tests if an offset event enabler rule application service is supported.

Returns:

true if offset event enabler rule application service is supported, false otherwise

Compliance:

mandatory - This method must be implemented.

supportsSupersedingEventEnablerLookup

boolean supportsSupersedingEventEnablerLookup()

Tests if looking up superseding event enablers is supported.

Returns:

true if superseding event enabler lookup is supported, false otherwise

Compliance:

mandatory - This method must be implemented.

supportsSupersedingEventEnablerQuery

boolean supportsSupersedingEventEnablerQuery()

Tests if querying superseding event enablers is supported.

Returns:

true if superseding event enabler query is supported, false otherwise

Compliance:

mandatory - This method must be implemented.

supportsSupersedingEventEnablerSearch

boolean supportsSupersedingEventEnablerSearch()

Tests if searching superseding event enablers is supported.

Returns:

true if superseding event enabler search is supported, false otherwise

Compliance:

mandatory - This method must be implemented.

supportsSupersedingEventEnablerAdmin

boolean supportsSupersedingEventEnablerAdmin()

Tests if an superseding event enabler administrative service is supported.

Returns:

true if superseding event enabler administration is supported, false otherwise

Compliance:

mandatory - This method must be implemented.

supportsSupersedingEventEnablerNotification

boolean supportsSupersedingEventEnablerNotification()

Tests if an superseding event enabler notification service is supported.

Returns:

true if superseding event enabler notification is supported, false otherwise

Compliance:

mandatory - This method must be implemented.

supportsSupersedingEventEnablerCalendar

boolean supportsSupersedingEventEnablerCalendar()

Tests if an superseding event enabler calendar lookup service is supported.

Returns:

true if an superseding event enabler calendar lookup service is supported, false otherwise

Compliance:

mandatory - This method must be implemented.

supportsSupersedingEventEnablerCalendarAssignment

boolean supportsSupersedingEventEnablerCalendarAssignment()

Tests if an superseding event enabler calendar service is supported.

Returns:

true if superseding event enabler calendar assignment service is supported, false otherwise

Compliance:

mandatory - This method must be implemented.

supportsSupersedingEventEnablerSmartCalendar

boolean supportsSupersedingEventEnablerSmartCalendar()

Tests if an superseding event enabler calendar lookup service is supported.

Returns:

true if an superseding event enabler calendar service is supported, false otherwise

Compliance:

mandatory - This method must be implemented.

supportsSupersedingEventEnablerRuleLookup

boolean supportsSupersedingEventEnablerRuleLookup()

Tests if an superseding event enabler rule lookup service is supported.

Returns:

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

Compliance:

mandatory - This method must be implemented.

supportsSupersedingEventEnablerRuleApplication

boolean supportsSupersedingEventEnablerRuleApplication()

Tests if an superseding event enabler rule application service is supported.

Returns:

true if superseding event enabler rule application service is supported, false otherwise

Compliance:

mandatory - This method must be implemented.

supportsCommitmentEnablerLookup

boolean supportsCommitmentEnablerLookup()

Tests if looking up commitment enablers is supported.

Returns:

true if commitment enabler lookup is supported, false otherwise

Compliance:

mandatory - This method must be implemented.

supportsCommitmentEnablerQuery

boolean supportsCommitmentEnablerQuery()

Tests if querying commitment enablers is supported.

Returns:

true if commitment enabler query is supported, false otherwise

Compliance:

mandatory - This method must be implemented.

supportsCommitmentEnablerSearch

boolean supportsCommitmentEnablerSearch()

Tests if searching commitment enablers is supported.

Returns:

true if commitment enabler search is supported, false otherwise

Compliance:

mandatory - This method must be implemented.

supportsCommitmentEnablerAdmin

boolean supportsCommitmentEnablerAdmin()

Tests if a commitment enabler administrative service is supported.

Returns:

true if commitment enabler administration is supported, false otherwise

Compliance:

mandatory - This method must be implemented.

supportsCommitmentEnablerNotification

boolean supportsCommitmentEnablerNotification()

Tests if a commitment enabler notification service is supported.

Returns:

true if commitment enabler notification is supported, false otherwise

Compliance:

mandatory - This method must be implemented.

supportsCommitmentEnablerCalendar

boolean supportsCommitmentEnablerCalendar()

Tests if a commitment enabler calendar lookup service is supported.

Returns:

true if a commitment enabler calendar lookup service is supported, false otherwise

Compliance:

mandatory - This method must be implemented.

supportsCommitmentEnablerCalendarAssignment

boolean supportsCommitmentEnablerCalendarAssignment()

Tests if a commitment enabler calendar service is supported.

Returns:

true if commitment enabler calendar assignment service is supported, false otherwise

Compliance:

mandatory - This method must be implemented.

supportsCommitmentEnablerSmartCalendar

boolean supportsCommitmentEnablerSmartCalendar()

Tests if a commitment enabler calendar lookup service is supported.

Returns:

true if a commitment enabler calendar service is supported, false otherwise

Compliance:

mandatory - This method must be implemented.

supportsCommitmentEnablerRuleLookup

boolean supportsCommitmentEnablerRuleLookup()

Tests if a commitment enabler rule lookup service is supported.

Returns:

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

Compliance:

mandatory - This method must be implemented.

supportsCommitmentEnablerRuleApplication

boolean supportsCommitmentEnablerRuleApplication()

Tests if a commitment enabler rule application service is supported.

Returns:

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

Compliance:

mandatory - This method must be implemented.

getRecurringEventEnablerRecordTypes

TypeList getRecurringEventEnablerRecordTypes()

Gets the supported RecurringEventEnabler record interface types.

Returns:

a list containing the supported RecurringEventEnabler record types

Compliance:

mandatory - This method must be implemented.

supportsRecurringEventEnablerRecordType

boolean supportsRecurringEventEnablerRecordType(Type recurringEventEnablerRecordType)

Tests if the given RecurringEventEnabler record interface type is supported.

Parameters:

recurringEventEnablerRecordType - a Type indicating a RecurringEventEnabler record type

Returns:

true if the given record type is supported, false otherwise

Throws:

NullArgumentException - recurringEventEnablerRecordType is null

Compliance:

mandatory - This method must be implemented.

getRecurringEventEnablerSearchRecordTypes

TypeList getRecurringEventEnablerSearchRecordTypes()

Gets the supported RecurringEventEnabler search record interface types.

Returns:

a list containing the supported RecurringEventEnabler search record types

Compliance:

mandatory - This method must be implemented.

supportsRecurringEventEnablerSearchRecordType

boolean supportsRecurringEventEnablerSearchRecordType(Type recurringEventEnablerSearchRecordType)

Tests if the given RecurringEventEnabler search record interface type is supported.

Parameters:

recurringEventEnablerSearchRecordType - a Type indicating a RecurringEventEnabler search record type

Returns:

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

Throws:

NullArgumentException - recurringEventEnablerSearchRecordType is null

Compliance:

mandatory - This method must be implemented.

getOffsetEventEnablerRecordTypes

TypeList getOffsetEventEnablerRecordTypes()

Gets the supported OffsetEventEnabler record interface types.

Returns:

a list containing the supported OffsetEventEnabler record types

Compliance:

mandatory - This method must be implemented.

supportsOffsetEventEnablerRecordType

boolean supportsOffsetEventEnablerRecordType(Type offsetEventEnablerRecordType)

Tests if the given OffsetEventEnabler record interface type is supported.

Parameters:

offsetEventEnablerRecordType - a Type indicating an OffsetEventEnabler record type

Returns:

true if the given record type is supported, false otherwise

Throws:

NullArgumentException - offsetEventEnablerRecordType is null

Compliance:

mandatory - This method must be implemented.

getOffsetEventEnablerSearchRecordTypes

TypeList getOffsetEventEnablerSearchRecordTypes()

Gets the supported OffsetEventEnabler search record interface types.

Returns:

a list containing the supported OffsetEventEnabler search record types

Compliance:

mandatory - This method must be implemented.

supportsOffsetEventEnablerSearchRecordType

boolean supportsOffsetEventEnablerSearchRecordType(Type offsetEventEnablerSearchRecordType)

Tests if the given OffsetEventEnabler search record interface type is supported.

Parameters:

offsetEventEnablerSearchRecordType - a Type indicating an OffsetEventEnabler search record type

Returns:

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

Throws:

NullArgumentException - offsetEventEnablerSearchRecordType is null

Compliance:

mandatory - This method must be implemented.

getSupersedingEventEnablerRecordTypes

TypeList getSupersedingEventEnablerRecordTypes()

Gets the supported SupersedingEventEnabler record interface types.

Returns:

a list containing the supported SupersedingEventEnabler record types

Compliance:

mandatory - This method must be implemented.

supportsSupersedingEventEnablerRecordType

boolean supportsSupersedingEventEnablerRecordType(Type supersedingEventEnablerRecordType)

Tests if the given SupersedingEventEnabler record interface type is supported.

Parameters:

supersedingEventEnablerRecordType - a Type indicating an SupersedingEventEnabler record type

Returns:

true if the given record type is supported, false otherwise

Throws:

NullArgumentException - supersedingEventEnablerRecordType is null

Compliance:

mandatory - This method must be implemented.

getSupersedingEventEnablerSearchRecordTypes

TypeList getSupersedingEventEnablerSearchRecordTypes()

Gets the supported SupersedingEventEnabler search record interface types.

Returns:

a list containing the supported SupersedingEventEnabler search record types

Compliance:

mandatory - This method must be implemented.

supportsSupersedingEventEnablerSearchRecordType

boolean supportsSupersedingEventEnablerSearchRecordType(Type supersedingEventEnablerSearchRecordType)

Tests if the given SupersedingEventEnabler search record interface type is supported.

Parameters:

supersedingEventEnablerSearchRecordType - a Type indicating an SupersedingEventEnabler search record type

Returns:

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

Throws:

NullArgumentException - supersedingEventEnablerSearchRecordType is null

Compliance:

mandatory - This method must be implemented.

getCommitmentEnablerRecordTypes

TypeList getCommitmentEnablerRecordTypes()

Gets the supported CommitmentEnabler record types.

Returns:

a list containing the supported CommitmentEnabler record types

Compliance:

mandatory - This method must be implemented.

supportsCommitmentEnablerRecordType

boolean supportsCommitmentEnablerRecordType(Type commitmentEnablerRecordType)

Tests if the given CommitmentEnabler record type is supported.

Parameters:

commitmentEnablerRecordType - a Type indicating a CommitmentEnabler record type

Returns:

true if the given record type is supported, false otherwise

Throws:

NullArgumentException - commitmentEnablerRecordType is null

Compliance:

mandatory - This method must be implemented.

getCommitmentEnablerSearchRecordTypes

TypeList getCommitmentEnablerSearchRecordTypes()

Gets the supported CommitmentEnabler search record types.

Returns:

a list containing the supported CommitmentEnabler search record types

Compliance:

mandatory - This method must be implemented.

supportsCommitmentEnablerSearchRecordType

boolean supportsCommitmentEnablerSearchRecordType(Type commitmentEnablerSearchRecordType)

Tests if the given CommitmentEnabler search record type is supported.

Parameters:

commitmentEnablerSearchRecordType - a Type indicating a CommitmentEnabler search record type

Returns:

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

Throws:

NullArgumentException - commitmentEnablerSearchRecordType is null

Compliance:

mandatory - This method must be implemented.