OSID Logo
OSID Specifications
contact package
Version 3.0.0
Release Candidate Preview
Interfaceosid.contact.ContactProfile
Implementsosid.OsidProfile
Description

The contact profile describes the interoperability among contact services.

MethodsupportsVisibleFederation
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.

Returnboolean true if visible federation is supproted, false otherwise
CompliancemandatoryThis method must be implemented.
MethodsupportsContact
Description

Tests for the availability of a contact service for getting available contacts for a resource.

Returnboolean true if contact is available, false otherwise
CompliancemandatoryThis method must be implemented.
MethodsupportsContactLookup
Description

Tests for the availability of a contact lookup service.

Returnboolean true if contact lookup is available, false otherwise
CompliancemandatoryThis method must be implemented.
MethodsupportsContactQuery
Description

Tests if querying contacts is available.

Returnboolean true if contact query is available, false otherwise
CompliancemandatoryThis method must be implemented.
MethodsupportsContactSearch
Description

Tests if searching for contacts is available.

Returnboolean true if contact search is available, false otherwise
CompliancemandatoryThis method must be implemented.
MethodsupportsContactAdmin
Description

Tests if managing contacts is available.

Returnboolean true if contact admin is available, false otherwise
CompliancemandatoryThis method must be implemented.
MethodsupportsContactNotification
Description

Tests if contact notification is available.

Returnboolean true if contact notification is available, false otherwise
CompliancemandatoryThis method must be implemented.
MethodsupportsContactAddressBook
Description

Tests if a contact to address book lookup session is available.

Returnboolean true if contact address book lookup session is supported, false otherwise
CompliancemandatoryThis method must be implemented.
MethodsupportsContactAddressBookAssignment
Description

Tests if a contact to address book assignment session is available.

Returnboolean true if contact address book assignment is supported, false otherwise
CompliancemandatoryThis method must be implemented.
MethodsupportsContactSmartAddressBook
Description

Tests if a contact smart address book session is available.

Returnboolean true if contact smart address book is supported, false otherwise
CompliancemandatoryThis method must be implemented.
MethodsupportsAddressLookup
Description

Tests for the availability of an address lookup service.

Returnboolean true if address lookup is available, false otherwise
CompliancemandatoryThis method must be implemented.
MethodsupportsAddressQuery
Description

Tests if querying addresses is available.

Returnboolean true if address query is available, false otherwise
CompliancemandatoryThis method must be implemented.
MethodsupportsAddressSearch
Description

Tests if searching for addresses is available.

Returnboolean true if address search is available, false otherwise
CompliancemandatoryThis method must be implemented.
MethodsupportsAddressAdmin
Description

Tests for the availability of an address administrative service for creating and deleting addresses.

Returnboolean true if address administration is available, false otherwise
CompliancemandatoryThis method must be implemented.
MethodsupportsAddressNotification
Description

Tests for the availability of an address notification service.

Returnboolean true if address notification is available, false otherwise
CompliancemandatoryThis method must be implemented in all providers.
MethodsupportsAddressAddressBook
Description

Tests if an address to address book lookup session is available.

Returnboolean true if address address book lookup session is supported, false otherwise
CompliancemandatoryThis method must be implemented.
MethodsupportsAddressAddressBookAssignment
Description

Tests if an address to address book assignment session is available.

Returnboolean true if address address book assignment is supported, false otherwise
CompliancemandatoryThis method must be implemented.
MethodsupportsAddressSmartAddressBook
Description

Tests if an address smart address book session is available.

Returnboolean true if address smart address book is supported, false otherwise
CompliancemandatoryThis method must be implemented.
MethodsupportsAddressBookLookup
Description

Tests for the availability of an address book lookup service.

Returnboolean true if address book lookup is available, false otherwise
CompliancemandatoryThis method must be implemented.
MethodsupportsAddressBookQuery
Description

Tests if querying address books is available.

Returnboolean true if address book query is available, false otherwise
CompliancemandatoryThis method must be implemented.
MethodsupportsAddressBookSearch
Description

Tests if searching for address books is available.

Returnboolean true if address book search is available, false otherwise
CompliancemandatoryThis method must be implemented.
MethodsupportsAddressBookAdmin
Description

Tests for the availability of an address book administrative service for creating and deleting address books.

Returnboolean true if address book administration is available, false otherwise
CompliancemandatoryThis method must be implemented.
MethodsupportsAddressBookNotification
Description

Tests for the availability of an address book notification service.

Returnboolean true if address book notification is available, false otherwise
CompliancemandatoryThis method must be implemented in all providers.
MethodsupportsAddressBookHierarchy
Description

Tests for the availability of an address book hierarchy traversal service.

Returnboolean true if address book hierarchy traversal is available, false otherwise
CompliancemandatoryThis method must be implemented.
MethodsupportsAddressBookHierarchyDesign
Description

Tests for the availability of an address book hierarchy design service.

Returnboolean true if address book hierarchy design is available, false otherwise
CompliancemandatoryThis method must be implemented in all providers.
MethodsupportsContactBatch
Description

Tests for the availability of a contact batch service.

Returnboolean true if a contact batch service is available, false otherwise
CompliancemandatoryThis method must be implemented.
MethodsupportsContactRules
Description

Tests for the availability of a contact rules service.

Returnboolean true if a contact rules service is available, false otherwise
CompliancemandatoryThis method must be implemented.
MethodgetContactRecordTypes
Description

Gets the supported Contact record types.

Returnosid.type.TypeLista list containing the supported contact record types
CompliancemandatoryThis method must be implemented.
MethodsupportsContactRecordType
Description

Tests if the given Contact record type is supported.

Parametersosid.type.TypecontactRecordTypea Type indicating a Contact record type
Returnboolean true if the given Type is supported, false otherwise
ErrorsNULL_ARGUMENT contactRecordType is null
CompliancemandatoryThis method must be implemented.
MethodgetContactSearchRecordTypes
Description

Gets the supported contact search record types.

Returnosid.type.TypeLista list containing the supported contact search record types
CompliancemandatoryThis method must be implemented.
MethodsupportsContactSearchRecordType
Description

Tests if the given contact search record type is supported.

Parametersosid.type.TypecontactSearchRecordTypea Type indicating a contact record type
Returnboolean true if the given Type is supported, false otherwise
ErrorsNULL_ARGUMENT contactSearchRecordType is null
CompliancemandatoryThis method must be implemented.
MethodgetAddressRecordTypes
Description

Gets the supported Address record types.

Returnosid.type.TypeLista list containing the supported address record types
CompliancemandatoryThis method must be implemented.
MethodsupportsAddressRecordType
Description

Tests if the given Address record type is supported.

Parametersosid.type.TypeaddressRecordTypea Type indicating a Address record type
Returnboolean true if the given Type is supported, false otherwise
ErrorsNULL_ARGUMENT addressRecordType is null
CompliancemandatoryThis method must be implemented.
MethodgetAddressSearchRecordTypes
Description

Gets the supported address search record types.

Returnosid.type.TypeLista list containing the supported address search record types
CompliancemandatoryThis method must be implemented.
MethodsupportsAddressSearchRecordType
Description

Tests if the given address search record type is supported.

Parametersosid.type.TypeaddressSearchRecordTypea Type indicating an address record type
Returnboolean true if the given Type is supported, false otherwise
ErrorsNULL_ARGUMENT addressSearchRecordType is null
CompliancemandatoryThis method must be implemented.
MethodgetAddressBookRecordTypes
Description

Gets the supported AddressBook record types.

Returnosid.type.TypeLista list containing the supported address book record types
CompliancemandatoryThis method must be implemented.
MethodsupportsAddressBookRecordType
Description

Tests if the given AddressBook record type is supported.

Parametersosid.type.TypeaddressBookRecordTypea Type indicating a AddressBook record type
Returnboolean true if the given Type is supported, false otherwise
ErrorsNULL_ARGUMENT addressBookRecordType is null
CompliancemandatoryThis method must be implemented.
MethodgetAddressBookSearchRecordTypes
Description

Gets the supported address book search record types.

Returnosid.type.TypeLista list containing the supported address book search record types
CompliancemandatoryThis method must be implemented.
MethodsupportsAddressBookSearchRecordType
Description

Tests if the given address book search record type is supported.

Parametersosid.type.TypeaddressBookSearchRecordTypea Type indicating an address book record type
Returnboolean true if the given Type is supported, false otherwise
ErrorsNULL_ARGUMENT addressBookSearchRecordType is null
CompliancemandatoryThis method must be implemented.