OSID - osid.contact.rules.ContactRulesProfile Service Interface Definition

Interface	osid.contact.rules.ContactRulesProfile
Implements	`osid.OsidProfile`
Description	The contact rules profile describes the interoperability among contact rules services.
Method	supportsVisibleFederation
Description	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.
Return	`boolean`		`true` if visible federation is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsContactEnablerLookup
Description	Tests if looking up contact enablers is supported.
Return	`boolean`		`true` if contact enabler lookup is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsContactEnablerQuery
Description	Tests if querying contact enablers is supported.
Return	`boolean`		`true` if contact enabler query is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsContactEnablerSearch
Description	Tests if searching contact enablers is supported.
Return	`boolean`		`true` if contact enabler search is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsContactEnablerAdmin
Description	Tests if a contact enabler administrative service is supported.
Return	`boolean`		`true` if contact enabler administration is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsContactEnablerNotification
Description	Tests if a contact enabler notification service is supported.
Return	`boolean`		`true` if contact enabler notification is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsContactEnablerAddressBook
Description	Tests if a contact enabler address book lookup service is supported.
Return	`boolean`		`true` if a contact enabler address book lookup service is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsContactEnablerAddressBookAssignment
Description	Tests if a contact enabler address book service is supported.
Return	`boolean`		`true` if contact enabler address book assignment service is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsContactEnablerSmartAddressBook
Description	Tests if a contact enabler address book lookup service is supported.
Return	`boolean`		`true` if a contact enabler address book service is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsContactEnablerRuleLookup
Description	Tests if a contact enabler rule lookup service is supported.
Return	`boolean`		`true` if a contact enabler rule lookup service is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsContactEnablerRuleApplication
Description	Tests if a contact enabler rule application service is supported.
Return	`boolean`		`true` if contact enabler rule application service is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getContactEnablerRecordTypes
Description	Gets the supported `ContactEnabler` record types.
Return	`osid.type.TypeList`		a list containing the supported `ContactEnabler` record types
Compliance	`mandatory`		This method must be implemented.
Method	supportsContactEnablerRecordType
Description	Tests if the given `ContactEnabler` record type is supported.
Parameters	`osid.type.Type`	`contactEnablerRecordType`	a `Type` indicating a `ContactEnabler` record type
Return	`boolean`		`true` if the given record type is supported, `false` otherwise
Errors	NULL_ARGUMENT		`contactEnablerRecordType` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	getContactEnablerSearchRecordTypes
Description	Gets the supported `ContactEnabler` search record types.
Return	`osid.type.TypeList`		a list containing the supported `ContactEnabler` search record types
Compliance	`mandatory`		This method must be implemented.
Method	supportsContactEnablerSearchRecordType
Description	Tests if the given `ContactEnabler` search record type is supported.
Parameters	`osid.type.Type`	`contactEnablerSearchRecordType`	a `Type` indicating a `ContactEnabler` search record type
Return	`boolean`		`true` if the given search record type is supported, `false` otherwise
Errors	NULL_ARGUMENT		`contactEnablerSearchRecordType` is `null`
Compliance	`mandatory`		This method must be implemented.