Interface CalendaringRulesProfile
- All Superinterfaces:
OsidProfile, Sourceable
- All Known Subinterfaces:
CalendaringRulesManager, CalendaringRulesProxyManager
The calendaring rules profile describes the interoperability among calendaring rules services.
-
Method Summary
Modifier and TypeMethodDescriptionGets the supportedCommitmentEnablerrecord types.Gets the supportedCommitmentEnablersearch record types.Gets the supportedOffsetEventEnablerrecord interface types.Gets the supportedOffsetEventEnablersearch record interface types.Gets the supportedRecurringEventEnablerrecord interface types.Gets the supportedRecurringEventEnablersearch record interface types.Gets the supportedSupersedingEventEnablerrecord interface types.Gets the supportedSupersedingEventEnablersearch record interface types.booleanTests if a commitment enabler administrative service is supported.booleanTests if a commitment enabler calendar lookup service is supported.booleanTests if a commitment enabler calendar service is supported.booleanTests if looking up commitment enablers is supported.booleanTests if a commitment enabler notification service is supported.booleanTests if querying commitment enablers is supported.booleansupportsCommitmentEnablerRecordType(Type commitmentEnablerRecordType) Tests if the givenCommitmentEnablerrecord type is supported.booleanTests if a commitment enabler rule application service is supported.booleanTests if a commitment enabler rule lookup service is supported.booleanTests if searching commitment enablers is supported.booleansupportsCommitmentEnablerSearchRecordType(Type commitmentEnablerSearchRecordType) Tests if the givenCommitmentEnablersearch record type is supported.booleanTests if a commitment enabler calendar lookup service is supported.booleanTests if an offset event enabler administrative service is supported.booleanTests if an offset event enabler calendar lookup service is supported.booleanTests if an offset event enabler calendar service is supported.booleanTests if looking up offset event enablers is supported.booleanTests if an offset event enabler notification service is supported.booleanTests if querying offset event enablers is supported.booleansupportsOffsetEventEnablerRecordType(Type offsetEventEnablerRecordType) Tests if the givenOffsetEventEnablerrecord interface type is supported.booleanTests if an offset event enabler rule application service is supported.booleanTests if an offset event enabler rule lookup service is supported.booleanTests if searching offset event enablers is supported.booleansupportsOffsetEventEnablerSearchRecordType(Type offsetEventEnablerSearchRecordType) Tests if the givenOffsetEventEnablersearch record interface type is supported.booleanTests if an offset event enabler calendar lookup service is supported.booleanTests if a recurring event enabler administrative service is supported.booleanTests if a recurring event enabler calendar lookup service is supported.booleanTests if a recurring event enabler calendar service is supported.booleanTests if looking up recurring event enablers is supported.booleanTests if a recurring event enabler notification service is supported.booleanTests if querying recurring event enablers is supported.booleansupportsRecurringEventEnablerRecordType(Type recurringEventEnablerRecordType) Tests if the givenRecurringEventEnablerrecord interface type is supported.booleanTests if a recurring event enabler rule application service is supported.booleanTests if a recurring event enabler rule lookup service is supported.booleanTests if searching recurring event enablers is supported.booleansupportsRecurringEventEnablerSearchRecordType(Type recurringEventEnablerSearchRecordType) Tests if the givenRecurringEventEnablersearch record interface type is supported.booleanTests if a recurring event enabler calendar lookup service is supported.booleanTests if a superseding event enabler administrative service is supported.booleanTests if a superseding event enabler calendar lookup service is supported.booleanTests if a superseding event enabler calendar service is supported.booleanTests if looking up superseding event enablers is supported.booleanTests if a superseding event enabler notification service is supported.booleanTests if querying superseding event enablers is supported.booleansupportsSupersedingEventEnablerRecordType(Type supersedingEventEnablerRecordType) Tests if the givenSupersedingEventEnablerrecord interface type is supported.booleanTests if a superseding event enabler rule application service is supported.booleanTests if a superseding event enabler rule lookup service is supported.booleanTests if searching superseding event enablers is supported.booleansupportsSupersedingEventEnablerSearchRecordType(Type supersedingEventEnablerSearchRecordType) Tests if the givenSupersedingEventEnablersearch record interface type is supported.booleanTests if a superseding event enabler calendar lookup service is supported.booleanTests if any broker federation is exposed.Methods inherited from interface OsidProfile
getBranch, getBranchId, getDescription, getDisplayName, getId, getLocales, getProxyRecordTypes, getReleaseDate, getVersion, supportsJournalBranching, supportsJournalRollback, supportsOSIDVersion, supportsProxyRecordTypeModifier and TypeMethodDescriptionGets this service branch.Gets theBranch Idrepresenting this service branch.Gets a description of this service implementation.Gets a display name for this service implementation.getId()Gets an identifier for this service implementation.Gets the locales supported in this service.Gets the proxy recordTypessupported in this service.Gets the date this service implementation was released.Gets the version of this service implementation.booleanTest for support of a journal branching service.booleanTest for support of a journaling rollback service.booleansupportsOSIDVersion(Version version) Test for support of an OSID specification version.booleansupportsProxyRecordType(Type proxyRecordType) Test for support of a proxy type.Methods inherited from interface Sourceable
getBranding, getBrandingIds, getLicense, getProvider, getProviderIdModifier and TypeMethodDescriptionGets a branding, such as an image or logo, expressed using theAssetinterface.Gets the branding assetIds.Gets the terms of usage.Gets theResourcerepresenting the provider.Gets theIdof the provider.
-
Method Details
-
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:
trueif visible federation is supported,falseotherwise- 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 a 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 a 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 a recurring event enabler calendar lookup service is supported.- Returns:
- true if a recurring event enabler calendar lookup service is supported, false otherwise
- Compliance:
mandatory- This method must be implemented.
-
supportsRecurringEventEnablerCalendarAssignment
boolean supportsRecurringEventEnablerCalendarAssignment()Tests if a 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 a recurring event enabler calendar lookup service is supported.- Returns:
- true if a recurring event enabler calendar service is supported, false otherwise
- Compliance:
mandatory- This method must be implemented.
-
supportsRecurringEventEnablerRuleLookup
boolean supportsRecurringEventEnablerRuleLookup()Tests if a recurring event enabler rule lookup service is supported.- Returns:
- true if a recurring event enabler rule lookup service is supported, false otherwise
- Compliance:
mandatory- This method must be implemented.
-
supportsRecurringEventEnablerRuleApplication
boolean supportsRecurringEventEnablerRuleApplication()Tests if a 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:
trueif offset event enabler lookup is supported,falseotherwise- Compliance:
mandatory- This method must be implemented.
-
supportsOffsetEventEnablerQuery
boolean supportsOffsetEventEnablerQuery()Tests if querying offset event enablers is supported.- Returns:
trueif offset event enabler query is supported,falseotherwise- Compliance:
mandatory- This method must be implemented.
-
supportsOffsetEventEnablerSearch
boolean supportsOffsetEventEnablerSearch()Tests if searching offset event enablers is supported.- Returns:
trueif offset event enabler search is supported,falseotherwise- Compliance:
mandatory- This method must be implemented.
-
supportsOffsetEventEnablerAdmin
boolean supportsOffsetEventEnablerAdmin()Tests if an offset event enabler administrative service is supported.- Returns:
trueif offset event enabler administration is supported,falseotherwise- Compliance:
mandatory- This method must be implemented.
-
supportsOffsetEventEnablerNotification
boolean supportsOffsetEventEnablerNotification()Tests if an offset event enabler notification service is supported.- Returns:
trueif offset event enabler notification is supported,falseotherwise- Compliance:
mandatory- This method must be implemented.
-
supportsOffsetEventEnablerCalendar
boolean supportsOffsetEventEnablerCalendar()Tests if an offset event enabler calendar lookup service is supported.- Returns:
trueif an offset event enabler calendar lookup service is supported,falseotherwise- Compliance:
mandatory- This method must be implemented.
-
supportsOffsetEventEnablerCalendarAssignment
boolean supportsOffsetEventEnablerCalendarAssignment()Tests if an offset event enabler calendar service is supported.- Returns:
trueif offset event enabler calendar assignment service is supported,falseotherwise- Compliance:
mandatory- This method must be implemented.
-
supportsOffsetEventEnablerSmartCalendar
boolean supportsOffsetEventEnablerSmartCalendar()Tests if an offset event enabler calendar lookup service is supported.- Returns:
trueif an offset event enabler calendar service is supported,falseotherwise- Compliance:
mandatory- This method must be implemented.
-
supportsOffsetEventEnablerRuleLookup
boolean supportsOffsetEventEnablerRuleLookup()Tests if an offset event enabler rule lookup service is supported.- Returns:
trueif an offset event enabler rule lookup service is supported,falseotherwise- Compliance:
mandatory- This method must be implemented.
-
supportsOffsetEventEnablerRuleApplication
boolean supportsOffsetEventEnablerRuleApplication()Tests if an offset event enabler rule application service is supported.- Returns:
trueif offset event enabler rule application service is supported,falseotherwise- Compliance:
mandatory- This method must be implemented.
-
supportsSupersedingEventEnablerLookup
boolean supportsSupersedingEventEnablerLookup()Tests if looking up superseding event enablers is supported.- Returns:
trueif superseding event enabler lookup is supported,falseotherwise- Compliance:
mandatory- This method must be implemented.
-
supportsSupersedingEventEnablerQuery
boolean supportsSupersedingEventEnablerQuery()Tests if querying superseding event enablers is supported.- Returns:
trueif superseding event enabler query is supported,falseotherwise- Compliance:
mandatory- This method must be implemented.
-
supportsSupersedingEventEnablerSearch
boolean supportsSupersedingEventEnablerSearch()Tests if searching superseding event enablers is supported.- Returns:
trueif superseding event enabler search is supported,falseotherwise- Compliance:
mandatory- This method must be implemented.
-
supportsSupersedingEventEnablerAdmin
boolean supportsSupersedingEventEnablerAdmin()Tests if a superseding event enabler administrative service is supported.- Returns:
trueif superseding event enabler administration is supported,falseotherwise- Compliance:
mandatory- This method must be implemented.
-
supportsSupersedingEventEnablerNotification
boolean supportsSupersedingEventEnablerNotification()Tests if a superseding event enabler notification service is supported.- Returns:
trueif superseding event enabler notification is supported,falseotherwise- Compliance:
mandatory- This method must be implemented.
-
supportsSupersedingEventEnablerCalendar
boolean supportsSupersedingEventEnablerCalendar()Tests if a superseding event enabler calendar lookup service is supported.- Returns:
trueif a superseding event enabler calendar lookup service is supported,falseotherwise- Compliance:
mandatory- This method must be implemented.
-
supportsSupersedingEventEnablerCalendarAssignment
boolean supportsSupersedingEventEnablerCalendarAssignment()Tests if a superseding event enabler calendar service is supported.- Returns:
trueif a superseding event enabler calendar assignment service is supported,falseotherwise- Compliance:
mandatory- This method must be implemented.
-
supportsSupersedingEventEnablerSmartCalendar
boolean supportsSupersedingEventEnablerSmartCalendar()Tests if a superseding event enabler calendar lookup service is supported.- Returns:
trueif a superseding event enabler calendar service is supported,falseotherwise- Compliance:
mandatory- This method must be implemented.
-
supportsSupersedingEventEnablerRuleLookup
boolean supportsSupersedingEventEnablerRuleLookup()Tests if a superseding event enabler rule lookup service is supported.- Returns:
trueif a superseding event enabler rule lookup service is supported,falseotherwise- Compliance:
mandatory- This method must be implemented.
-
supportsSupersedingEventEnablerRuleApplication
boolean supportsSupersedingEventEnablerRuleApplication()Tests if a superseding event enabler rule application service is supported.- Returns:
trueif a superseding event enabler rule application service is supported,falseotherwise- Compliance:
mandatory- This method must be implemented.
-
supportsCommitmentEnablerLookup
boolean supportsCommitmentEnablerLookup()Tests if looking up commitment enablers is supported.- Returns:
trueif commitment enabler lookup is supported,falseotherwise- Compliance:
mandatory- This method must be implemented.
-
supportsCommitmentEnablerQuery
boolean supportsCommitmentEnablerQuery()Tests if querying commitment enablers is supported.- Returns:
trueif commitment enabler query is supported,falseotherwise- Compliance:
mandatory- This method must be implemented.
-
supportsCommitmentEnablerSearch
boolean supportsCommitmentEnablerSearch()Tests if searching commitment enablers is supported.- Returns:
trueif commitment enabler search is supported,falseotherwise- Compliance:
mandatory- This method must be implemented.
-
supportsCommitmentEnablerAdmin
boolean supportsCommitmentEnablerAdmin()Tests if a commitment enabler administrative service is supported.- Returns:
trueif commitment enabler administration is supported,falseotherwise- Compliance:
mandatory- This method must be implemented.
-
supportsCommitmentEnablerNotification
boolean supportsCommitmentEnablerNotification()Tests if a commitment enabler notification service is supported.- Returns:
trueif commitment enabler notification is supported,falseotherwise- Compliance:
mandatory- This method must be implemented.
-
supportsCommitmentEnablerCalendar
boolean supportsCommitmentEnablerCalendar()Tests if a commitment enabler calendar lookup service is supported.- Returns:
trueif a commitment enabler calendar lookup service is supported,falseotherwise- Compliance:
mandatory- This method must be implemented.
-
supportsCommitmentEnablerCalendarAssignment
boolean supportsCommitmentEnablerCalendarAssignment()Tests if a commitment enabler calendar service is supported.- Returns:
trueif commitment enabler calendar assignment service is supported,falseotherwise- Compliance:
mandatory- This method must be implemented.
-
supportsCommitmentEnablerSmartCalendar
boolean supportsCommitmentEnablerSmartCalendar()Tests if a commitment enabler calendar lookup service is supported.- Returns:
trueif a commitment enabler calendar service is supported,falseotherwise- Compliance:
mandatory- This method must be implemented.
-
supportsCommitmentEnablerRuleLookup
boolean supportsCommitmentEnablerRuleLookup()Tests if a commitment enabler rule lookup service is supported.- Returns:
trueif a commitment enabler rule lookup service is supported,falseotherwise- Compliance:
mandatory- This method must be implemented.
-
supportsCommitmentEnablerRuleApplication
boolean supportsCommitmentEnablerRuleApplication()Tests if a commitment enabler rule application service is supported.- Returns:
trueif commitment enabler rule application service is supported,falseotherwise- Compliance:
mandatory- This method must be implemented.
-
getRecurringEventEnablerRecordTypes
TypeList getRecurringEventEnablerRecordTypes()Gets the supportedRecurringEventEnablerrecord interface types.- Returns:
- a list containing the supported
RecurringEventEnablerrecord types - Compliance:
mandatory- This method must be implemented.
-
supportsRecurringEventEnablerRecordType
Tests if the givenRecurringEventEnablerrecord interface type is supported.- Parameters:
recurringEventEnablerRecordType- aTypeindicating aRecurringEventEnablerrecord type- Returns:
trueif the given record type is supported,falseotherwise- Throws:
NullArgumentException-recurringEventEnablerRecordTypeisnull- Compliance:
mandatory- This method must be implemented.
-
getRecurringEventEnablerSearchRecordTypes
TypeList getRecurringEventEnablerSearchRecordTypes()Gets the supportedRecurringEventEnablersearch record interface types.- Returns:
- a list containing the supported
RecurringEventEnablersearch record types - Compliance:
mandatory- This method must be implemented.
-
supportsRecurringEventEnablerSearchRecordType
Tests if the givenRecurringEventEnablersearch record interface type is supported.- Parameters:
recurringEventEnablerSearchRecordType- aTypeindicating aRecurringEventEnablersearch record type- Returns:
trueif the given search record type is supported,falseotherwise- Throws:
NullArgumentException-recurringEventEnablerSearchRecordTypeisnull- Compliance:
mandatory- This method must be implemented.
-
getOffsetEventEnablerRecordTypes
TypeList getOffsetEventEnablerRecordTypes()Gets the supportedOffsetEventEnablerrecord interface types.- Returns:
- a list containing the supported
OffsetEventEnablerrecord types - Compliance:
mandatory- This method must be implemented.
-
supportsOffsetEventEnablerRecordType
Tests if the givenOffsetEventEnablerrecord interface type is supported.- Parameters:
offsetEventEnablerRecordType- aTypeindicating anOffsetEventEnablerrecord type- Returns:
trueif the given record type is supported,falseotherwise- Throws:
NullArgumentException-offsetEventEnablerRecordTypeisnull- Compliance:
mandatory- This method must be implemented.
-
getOffsetEventEnablerSearchRecordTypes
TypeList getOffsetEventEnablerSearchRecordTypes()Gets the supportedOffsetEventEnablersearch record interface types.- Returns:
- a list containing the supported
OffsetEventEnablersearch record types - Compliance:
mandatory- This method must be implemented.
-
supportsOffsetEventEnablerSearchRecordType
Tests if the givenOffsetEventEnablersearch record interface type is supported.- Parameters:
offsetEventEnablerSearchRecordType- aTypeindicating anOffsetEventEnablersearch record type- Returns:
trueif the given search record type is supported,falseotherwise- Throws:
NullArgumentException-offsetEventEnablerSearchRecordTypeisnull- Compliance:
mandatory- This method must be implemented.
-
getSupersedingEventEnablerRecordTypes
TypeList getSupersedingEventEnablerRecordTypes()Gets the supportedSupersedingEventEnablerrecord interface types.- Returns:
- a list containing the supported
SupersedingEventEnablerrecord types - Compliance:
mandatory- This method must be implemented.
-
supportsSupersedingEventEnablerRecordType
Tests if the givenSupersedingEventEnablerrecord interface type is supported.- Parameters:
supersedingEventEnablerRecordType- aTypeindicating aSupersedingEventEnablerrecord type- Returns:
trueif the given record type is supported,falseotherwise- Throws:
NullArgumentException-supersedingEventEnablerRecordTypeisnull- Compliance:
mandatory- This method must be implemented.
-
getSupersedingEventEnablerSearchRecordTypes
TypeList getSupersedingEventEnablerSearchRecordTypes()Gets the supportedSupersedingEventEnablersearch record interface types.- Returns:
- a list containing the supported
SupersedingEventEnablersearch record types - Compliance:
mandatory- This method must be implemented.
-
supportsSupersedingEventEnablerSearchRecordType
boolean supportsSupersedingEventEnablerSearchRecordType(Type supersedingEventEnablerSearchRecordType) Tests if the givenSupersedingEventEnablersearch record interface type is supported.- Parameters:
supersedingEventEnablerSearchRecordType- aTypeindicating aSupersedingEventEnablersearch record type- Returns:
trueif the given search record type is supported,falseotherwise- Throws:
NullArgumentException-supersedingEventEnablerSearchRecordTypeisnull- Compliance:
mandatory- This method must be implemented.
-
getCommitmentEnablerRecordTypes
TypeList getCommitmentEnablerRecordTypes()Gets the supportedCommitmentEnablerrecord types.- Returns:
- a list containing the supported
CommitmentEnablerrecord types - Compliance:
mandatory- This method must be implemented.
-
supportsCommitmentEnablerRecordType
Tests if the givenCommitmentEnablerrecord type is supported.- Parameters:
commitmentEnablerRecordType- aTypeindicating aCommitmentEnablerrecord type- Returns:
trueif the given record type is supported,falseotherwise- Throws:
NullArgumentException-commitmentEnablerRecordTypeisnull- Compliance:
mandatory- This method must be implemented.
-
getCommitmentEnablerSearchRecordTypes
TypeList getCommitmentEnablerSearchRecordTypes()Gets the supportedCommitmentEnablersearch record types.- Returns:
- a list containing the supported
CommitmentEnablersearch record types - Compliance:
mandatory- This method must be implemented.
-
supportsCommitmentEnablerSearchRecordType
Tests if the givenCommitmentEnablersearch record type is supported.- Parameters:
commitmentEnablerSearchRecordType- aTypeindicating aCommitmentEnablersearch record type- Returns:
trueif the given search record type is supported,falseotherwise- Throws:
NullArgumentException-commitmentEnablerSearchRecordTypeisnull- Compliance:
mandatory- This method must be implemented.
-