OSID - osid.contact.ContactProfile Service Interface Definition

Interface	osid.contact.ContactProfile
Implements	`osid.OsidProfile`
Description	The contact profile describes the interoperability among contact services.
Method	supportsVisibleFederation
Description	Tests if any address federation is exposed. Federation is exposed when a specific address may be identified, selected and used to create a lookup or admin session. Federation is not exposed when a set of addresses appears as a single address.
Return	`boolean`		`true` if visible federation is supproted, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsContact
Description	Tests for the availability of a contact service for getting available contacts for a resource.
Return	`boolean`		`true` if contact is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsContactLookup
Description	Tests for the availability of a contact lookup service.
Return	`boolean`		`true` if contact lookup is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsContactQuery
Description	Tests if querying contacts is available.
Return	`boolean`		`true` if contact query is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsContactSearch
Description	Tests if searching for contacts is available.
Return	`boolean`		`true` if contact search is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsContactAdmin
Description	Tests if managing contacts is available.
Return	`boolean`		`true` if contact admin is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsContactNotification
Description	Tests if contact notification is available.
Return	`boolean`		`true` if contact notification is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsContactAddressBook
Description	Tests if a contact to address book lookup session is available.
Return	`boolean`		`true` if contact address book lookup session is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsContactAddressBookAssignment
Description	Tests if a contact to address book assignment session is available.
Return	`boolean`		`true` if contact address book assignment is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsContactSmartAddressBook
Description	Tests if a contact smart address book session is available.
Return	`boolean`		`true` if contact smart address book is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsAddressLookup
Description	Tests for the availability of an address lookup service.
Return	`boolean`		`true` if address lookup is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsAddressQuery
Description	Tests if querying addresses is available.
Return	`boolean`		`true` if address query is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsAddressSearch
Description	Tests if searching for addresses is available.
Return	`boolean`		`true` if address search is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsAddressAdmin
Description	Tests for the availability of an address administrative service for creating and deleting addresses.
Return	`boolean`		`true` if address administration is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsAddressNotification
Description	Tests for the availability of an address notification service.
Return	`boolean`		`true` if address notification is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented in all providers.
Method	supportsAddressAddressBook
Description	Tests if an address to address book lookup session is available.
Return	`boolean`		`true` if address address book lookup session is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsAddressAddressBookAssignment
Description	Tests if an address to address book assignment session is available.
Return	`boolean`		`true` if address address book assignment is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsAddressSmartAddressBook
Description	Tests if an address smart address book session is available.
Return	`boolean`		`true` if address smart address book is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsAddressBookLookup
Description	Tests for the availability of an address book lookup service.
Return	`boolean`		`true` if address book lookup is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsAddressBookQuery
Description	Tests if querying address books is available.
Return	`boolean`		`true` if address book query is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsAddressBookSearch
Description	Tests if searching for address books is available.
Return	`boolean`		`true` if address book search is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsAddressBookAdmin
Description	Tests for the availability of an address book administrative service for creating and deleting address books.
Return	`boolean`		`true` if address book administration is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsAddressBookNotification
Description	Tests for the availability of an address book notification service.
Return	`boolean`		`true` if address book notification is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented in all providers.
Method	supportsAddressBookHierarchy
Description	Tests for the availability of an address book hierarchy traversal service.
Return	`boolean`		`true` if address book hierarchy traversal is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsAddressBookHierarchyDesign
Description	Tests for the availability of an address book hierarchy design service.
Return	`boolean`		`true` if address book hierarchy design is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented in all providers.
Method	supportsContactBatch
Description	Tests for the availability of a contact batch service.
Return	`boolean`		`true` if a contact batch service is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsContactRules
Description	Tests for the availability of a contact rules service.
Return	`boolean`		`true` if a contact rules service is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getContactRecordTypes
Description	Gets the supported `Contact` record types.
Return	`osid.type.TypeList`		a list containing the supported contact record types
Compliance	`mandatory`		This method must be implemented.
Method	supportsContactRecordType
Description	Tests if the given `Contact` record type is supported.
Parameters	`osid.type.Type`	`contactRecordType`	a `Type` indicating a `Contact` record type
Return	`boolean`		`true` if the given `Type` is supported, `false` otherwise
Errors	NULL_ARGUMENT		`contactRecordType` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	getContactSearchRecordTypes
Description	Gets the supported contact search record types.
Return	`osid.type.TypeList`		a list containing the supported contact search record types
Compliance	`mandatory`		This method must be implemented.
Method	supportsContactSearchRecordType
Description	Tests if the given contact search record type is supported.
Parameters	`osid.type.Type`	`contactSearchRecordType`	a `Type` indicating a contact record type
Return	`boolean`		`true` if the given `Type` is supported, `false` otherwise
Errors	NULL_ARGUMENT		`contactSearchRecordType` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	getAddressRecordTypes
Description	Gets the supported `Address` record types.
Return	`osid.type.TypeList`		a list containing the supported address record types
Compliance	`mandatory`		This method must be implemented.
Method	supportsAddressRecordType
Description	Tests if the given `Address` record type is supported.
Parameters	`osid.type.Type`	`addressRecordType`	a `Type` indicating a `Address` record type
Return	`boolean`		`true` if the given `Type` is supported, `false` otherwise
Errors	NULL_ARGUMENT		`addressRecordType` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	getAddressSearchRecordTypes
Description	Gets the supported address search record types.
Return	`osid.type.TypeList`		a list containing the supported address search record types
Compliance	`mandatory`		This method must be implemented.
Method	supportsAddressSearchRecordType
Description	Tests if the given address search record type is supported.
Parameters	`osid.type.Type`	`addressSearchRecordType`	a `Type` indicating an address record type
Return	`boolean`		`true` if the given `Type` is supported, `false` otherwise
Errors	NULL_ARGUMENT		`addressSearchRecordType` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	getAddressBookRecordTypes
Description	Gets the supported `AddressBook` record types.
Return	`osid.type.TypeList`		a list containing the supported address book record types
Compliance	`mandatory`		This method must be implemented.
Method	supportsAddressBookRecordType
Description	Tests if the given `AddressBook` record type is supported.
Parameters	`osid.type.Type`	`addressBookRecordType`	a `Type` indicating a `AddressBook` record type
Return	`boolean`		`true` if the given `Type` is supported, `false` otherwise
Errors	NULL_ARGUMENT		`addressBookRecordType` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	getAddressBookSearchRecordTypes
Description	Gets the supported address book search record types.
Return	`osid.type.TypeList`		a list containing the supported address book search record types
Compliance	`mandatory`		This method must be implemented.
Method	supportsAddressBookSearchRecordType
Description	Tests if the given address book search record type is supported.
Parameters	`osid.type.Type`	`addressBookSearchRecordType`	a `Type` indicating an address book record type
Return	`boolean`		`true` if the given `Type` is supported, `false` otherwise
Errors	NULL_ARGUMENT		`addressBookSearchRecordType` is `null`
Compliance	`mandatory`		This method must be implemented.