OSID Logo
OSID Specifications
contact package
Version 3.0.0
Release Candidate Preview
Interfaceosid.contact.ContactProxyManager
Implementsosid.OsidProxyManager
osid.contact.ContactProfile
Description

The contact manager provides access to contact sessions and provides interoperability tests for various aspects of this service. Methods in this manager accept a Proxy for passing information from a server environment. The sessions included in this manager are:

  • ContactSession : a session to get available contacts for a resource
  • ContactLookupSession: a session to lookup contacts
  • ContactQuerySession: a session to query contacts
  • ContactSearchSession: a session to search contacts
  • ContactAdminSession: a session to manage contacts
  • ContactNotificationSession: a session to subscribe to notifications of contact changes
  • ContactAddressBookSession: a session to lookup contact address book mappings
  • ContactAddressBookAssignmentSession: a session to manage contact address book mappings
  • ContactSmartAddressBookSession: a session to manage smart address books of contacts
  • AddressLookupSession: a session to retrieve addresses
  • AddressQuerySession: a session to query addresses
  • AddressSearchSession: a session to search for addresses
  • AddressAdminSession: a session to create, update and delete addresses
  • AddressNotificationSession: a session to receive notifications for changes in addresses
  • AddressAddressBookSession: a session to lookup address address book mappings
  • AddressAddressBookAssignmentSession: a session to manage address address book mappings
  • AddressSmartAddressBookSession: a session to manage smart address books of addresses
  • AddressBookLookupSession: a session to retrieve address books
  • AddressBookQuerySession: a session to query address books
  • AddressBookSearchSession: a session to search for address books
  • AddressBookAdminSession: a session to create, update and delete address books
  • AddressBookNotificationSession: a session to receive notifications for changes in address books
  • AddressBookHierarchyTraversalSession: a session to traverse hierarchies of address books
  • AddressBookHierarchyDesignSession: a session to manage hierarchies of address books

The contact manager also provides a profile for determing the supported search types supported by this service.

MethodgetContactSession
Description

Gets the OsidSession associated with the contact service.

Parametersosid.proxy.Proxyproxya proxy
Returnosid.contact.ContactSessiona ContactSession
ErrorsNULL_ARGUMENT proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsContact() is false
ComplianceoptionalThis method must be implemented if supportsContact() is true.
MethodgetContactSessionForAddressBook
Description

Gets the OsidSession associated with the contact service for the given address book.

Parametersosid.id.IdaddressIdthe Id of the Address
osid.proxy.Proxyproxya proxy
Returnosid.contact.ContactSessiona ContactLookupSession
ErrorsNOT_FOUNDno Address found by the given Id
NULL_ARGUMENT addressId or proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsContact() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsContact() and supportsVisibleFederation() are true
MethodgetContactLookupSession
Description

Gets the OsidSession associated with the contact lookup service.

Parametersosid.proxy.Proxyproxya proxy
Returnosid.contact.ContactLookupSessiona ContactLookupSession
ErrorsNULL_ARGUMENT proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsContactLookup() is false
ComplianceoptionalThis method must be implemented if supportsContactLookup() is true.
MethodgetContactLookupSessionForAddressBook
Description

Gets the OsidSession associated with the contact lookup service for the given address book.

Parametersosid.id.IdaddressIdthe Id of the Address
osid.proxy.Proxyproxya proxy
Returnosid.contact.ContactLookupSessiona ContactLookupSession
ErrorsNOT_FOUNDno Address found by the given Id
NULL_ARGUMENT addressId or proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsContactLookup() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsContactLookup() and supportsVisibleFederation() are true
MethodgetContactQuerySession
Description

Gets the OsidSession associated with the contact query service.

Parametersosid.proxy.Proxyproxya proxy
Returnosid.contact.ContactQuerySessiona ContactQuerySession
ErrorsNULL_ARGUMENT proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsContactQuery() is false
ComplianceoptionalThis method must be implemented if supportsContactQuery() is true.
MethodgetContactQuerySessionForAddressBook
Description

Gets the OsidSession associated with the contact query service for the given address book.

Parametersosid.id.IdaddressIdthe Id of the Address
osid.proxy.Proxyproxya proxy
Returnosid.contact.ContactQuerySessiona ContactQuerySession
ErrorsNOT_FOUNDno Contact found by the given Id
NULL_ARGUMENT addressId or proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsContactQuery() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsContactQuery() and supportsVisibleFederation() are true
MethodgetContactSearchSession
Description

Gets the OsidSession associated with the contact search service.

Parametersosid.proxy.Proxyproxya proxy
Returnosid.contact.ContactSearchSessiona ContactSearchSession
ErrorsNULL_ARGUMENT proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsContactSearch() is false
ComplianceoptionalThis method must be implemented if supportsContactSearch() is true.
MethodgetContactSearchSessionForAddressBook
Description

Gets the OsidSession associated with the contact search service for the given address book.

Parametersosid.id.IdaddressIdthe Id of the Address
osid.proxy.Proxyproxya proxy
Returnosid.contact.ContactSearchSessiona ContactSearchSession
ErrorsNOT_FOUNDno Contact found by the given Id
NULL_ARGUMENT addressId or proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsContactSearch() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsContactSearch() and supportsVisibleFederation() are true
MethodgetContactAdminSession
Description

Gets the OsidSession associated with the contact administration service.

Parametersosid.proxy.Proxyproxya proxy
Returnosid.contact.ContactAdminSessiona ContactAdminSession
ErrorsNULL_ARGUMENT proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsContactAdmin() is false
ComplianceoptionalThis method must be implemented if supportsContactAdmin() is true.
MethodgetContactAdminSessionForAddressBook
Description

Gets the OsidSession associated with the contact administration service for the given address book.

Parametersosid.id.IdaddressIdthe Id of the Address
osid.proxy.Proxyproxya proxy
Returnosid.contact.ContactAdminSessiona ContactAdminSession
ErrorsNOT_FOUNDno Contact found by the given Id
NULL_ARGUMENT addressId or proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsContactAdmin() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsContactAdmin() and supportsVisibleFederation() are true
MethodgetContactNotificationSession
Description

Gets the OsidSession associated with the contact notification service.

Parametersosid.contact.ContactReceivercontactReceiverthe receiver
osid.proxy.Proxyproxya proxy
Returnosid.contact.ContactNotificationSessiona ContactNotificationSession
ErrorsNULL_ARGUMENT contactReceiver or proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsContactNotification() is false
ComplianceoptionalThis method must be implemented if supportsContactNotification() is true.
MethodgetContactNotificationSessionForAddressBook
Description

Gets the OsidSession associated with the contact notification service for the given address book.

Parametersosid.contact.ContactReceivercontactReceiverthe receiver
osid.id.IdaddressIdthe Id of the Address
osid.proxy.Proxyproxya proxy
Returnosid.contact.ContactNotificationSessiona ContactNotificationSession
ErrorsNOT_FOUNDno Contact found by the given Id
NULL_ARGUMENT contactReceiver, addressId or proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsContactNotification() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsContactNotification() and supportsVisibleFederation() are true
MethodgetContactAddressBookSession
Description

Gets the session for retrieving contact to address book mappings.

Parametersosid.proxy.Proxyproxya proxy
Returnosid.contact.ContactAddressBookSessiona ContactAddressBookSession
ErrorsNULL_ARGUMENT proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsContactAddressBook() is false
ComplianceoptionalThis method must be implemented if supportsContactAddressBook() is true.
MethodgetContactAddressBookAssignmentSession
Description

Gets the session for assigning contact to address book mappings.

Parametersosid.proxy.Proxyproxya proxy
Returnosid.contact.ContactAddressBookAssignmentSessiona ContactAddressBookAssignmentSession
ErrorsNULL_ARGUMENT proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsContactAddressBookAssignment() is false
ComplianceoptionalThis method must be implemented if supportsContactAddressBookAssignment() is true.
MethodgetContactSmartAddressBookSession
Description

Gets the session associated with the contact smart address book for the given address book.

Parametersosid.id.IdaddressBookIdthe Id of the contact book
osid.proxy.Proxyproxya proxy
Returnosid.contact.ContactSmartAddressBookSessiona ContactSmartAddressBookSession
ErrorsNOT_FOUND contactBookId not found
NULL_ARGUMENT contactBookId or proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsContactSmartAddressBook() is false
ComplianceoptionalThis method must be implemented if supportsContactSmartAddressBook() is true.
MethodgetAddressLookupSession
Description

Gets the OsidSession associated with the address lookup service.

Parametersosid.proxy.Proxyproxya proxy
Returnosid.contact.AddressLookupSessionan AddressLookupSession
ErrorsNULL_ARGUMENT proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsAddressLookup() is false
ComplianceoptionalThis method must be implemented if supportsAddressLookup() is true.
MethodgetAddressLookupSessionForAddressBook
Description

Gets the OsidSession associated with the address lookup service for the given address book.

Parametersosid.id.IdaddressBookIdthe Id of the AddressBook
osid.proxy.Proxyproxya proxy
Returnosid.contact.AddressLookupSessionan AddressLookupSession
ErrorsNOT_FOUNDno AddressBook found by the given Id
NULL_ARGUMENT addressBookId or proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsAddressLookup() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsAddressLookup() and supportsVisibleFederation() are true
MethodgetAddressQuerySession
Description

Gets the OsidSession associated with the address query service.

Parametersosid.proxy.Proxyproxya proxy
Returnosid.contact.AddressQuerySessionan AddressQuerySession
ErrorsNULL_ARGUMENT proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsAddressQuery() is false
ComplianceoptionalThis method must be implemented if supportsAddressQuery() is true.
MethodgetAddressQuerySessionForAddressBook
Description

Gets the OsidSession associated with the address query service for the given address book.

Parametersosid.id.IdaddressBookIdthe Id of the AddressBook
osid.proxy.Proxyproxya proxy
Returnosid.contact.AddressQuerySessionan AddressQuerySession
ErrorsNOT_FOUNDno Address found by the given Id
NULL_ARGUMENT addressBookId or proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsAddressQuery() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsAddressQuery() and supportsVisibleFederation() are true
MethodgetAddressSearchSession
Description

Gets the OsidSession associated with the address search service.

Parametersosid.proxy.Proxyproxya proxy
Returnosid.contact.AddressSearchSessionan AddressSearchSession
ErrorsNULL_ARGUMENT proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsAddressSearch() is false
ComplianceoptionalThis method must be implemented if supportsAddressSearch() is true.
MethodgetAddressSearchSessionForAddressBook
Description

Gets the OsidSession associated with the address search service for the given address book.

Parametersosid.id.IdaddressBookIdthe Id of the AddressBook
osid.proxy.Proxyproxya proxy
Returnosid.contact.AddressSearchSessionan AddressSearchSession
ErrorsNOT_FOUNDno Address found by the given Id
NULL_ARGUMENT addressBookId or proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsAddressSearch() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsAddressSearch() and supportsVisibleFederation() are true
MethodgetAddressAdminSession
Description

Gets the OsidSession associated with the address administrative service.

Parametersosid.proxy.Proxyproxya proxy
Returnosid.contact.AddressAdminSessionan AddressAdminSession
ErrorsNULL_ARGUMENT proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsAddressAdmin() is false
ComplianceoptionalThis method must be implemented if supportsAddressAdmin() is true.
MethodgetAddressAdminSessionForAddressBook
Description

Gets the OsidSession associated with the address administration service for the given address book.

Parametersosid.id.IdaddressBookIdthe Id of the AddressBook
osid.proxy.Proxyproxya proxy
Returnosid.contact.AddressAdminSessionan AddressAdminSession
ErrorsNOT_FOUNDno Address found by the given Id
NULL_ARGUMENT addressBookId or proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsAddressAdmin() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsAddressAdmin() and supportsVisibleFederation() are true
MethodgetAddressNotificationSession
Description

Gets the OsidSession associated with the address notification service.

Parametersosid.contact.AddressReceiveraddressReceiverthe receiver
osid.proxy.Proxyproxya proxy
Returnosid.contact.AddressNotificationSessionan AddressNotificationSession
ErrorsNULL_ARGUMENT addressReceiver or proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsAddressNotification() is false
ComplianceoptionalThis method must be implemented if supportsAddressNotification() is true.
MethodgetAddressNotificationSessionForAddressBook
Description

Gets the OsidSession associated with the address notification service for the given address book.

Parametersosid.contact.AddressReceiveraddressReceiverthe receiver
osid.id.IdaddressBookIdthe Id of the AddressBook
osid.proxy.Proxyproxya proxy
Returnosid.contact.AddressNotificationSessionan AddressNotificationSession
ErrorsNOT_FOUNDno Address found by the given Id
NULL_ARGUMENT addressReceiver, addressBookId or proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsAddressNotification() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsAddressNotification() and supportsVisibleFederation() are true
MethodgetAddressAddressBookSession
Description

Gets the session for retrieving address to address book mappings.

Parametersosid.proxy.Proxyproxya proxy
Returnosid.contact.AddressAddressBookSessionan AddressAddressBookSession
ErrorsNULL_ARGUMENT proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsAddressAddressBook() is false
ComplianceoptionalThis method must be implemented if supportsAddressAddressBook() is true.
MethodgetAddressAddressBookAssignmentSession
Description

Gets the session for assigning address to address book mappings.

Parametersosid.proxy.Proxyproxya proxy
Returnosid.contact.AddressAddressBookAssignmentSessionan AddressAddressBookAssignmentSession
ErrorsNULL_ARGUMENT proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsAddressAddressBookAssignment() is false
ComplianceoptionalThis method must be implemented if supportsAddressAddressBookAssignment() is true.
MethodgetAddressSmartAddressBookSession
Description

Gets the session for managing dynamic address address books for the given address book.

Parametersosid.id.IdaddressBookIdthe Id of an address book
osid.proxy.Proxyproxya proxy
Returnosid.contact.AddressSmartAddressBookSessionan AddressSmartAddressBookSession
ErrorsNOT_FOUND addressBookId is not found
NULL_ARGUMENT addressBookId or proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsAddressSmartAddressBook() is false
ComplianceoptionalThis method must be implemented if supportsAddressSmartAddressBook() is true.
MethodgetAddressBookLookupSession
Description

Gets the OsidSession associated with the address book lookup service.

Parametersosid.proxy.Proxyproxya proxy
Returnosid.contact.AddressBookLookupSessionan AddressBookLookupSession
ErrorsNULL_ARGUMENT proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsAddressBookLookup() is false
ComplianceoptionalThis method must be implemented if supportsAddressBookLookup() is true.
MethodgetAddressBookQuerySession
Description

Gets the OsidSession associated with the address book query service.

Parametersosid.proxy.Proxyproxya proxy
Returnosid.contact.AddressBookQuerySessionan AddressBookQuerySession
ErrorsNULL_ARGUMENT proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsAddressBookQuery() is false
ComplianceoptionalThis method must be implemented if supportsAddressBookQuery() is true.
MethodgetAddressBookSearchSession
Description

Gets the OsidSession associated with the address book search service.

Parametersosid.proxy.Proxyproxya proxy
Returnosid.contact.AddressBookSearchSessionan AddressBookSearchSession
ErrorsNULL_ARGUMENT proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsAddressBookSearch() is false
ComplianceoptionalThis method must be implemented if supportsAddressBookSearch() is true.
MethodgetAddressBookAdminSession
Description

Gets the OsidSession associated with the address book administrative service.

Parametersosid.proxy.Proxyproxya proxy
Returnosid.contact.AddressBookAdminSessionan AddressBookAdminSession
ErrorsNULL_ARGUMENT proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsAddressBookAdmin() is false
ComplianceoptionalThis method must be implemented if supportsAddressBookAdmin() is true.
MethodgetAddressBookNotificationSession
Description

Gets the OsidSession associated with the address book notification service.

Parametersosid.contact.AddressBookReceiveraddressBookReceiverthe receiver
osid.proxy.Proxyproxya proxy
Returnosid.contact.AddressBookNotificationSessionan AddressBookNotificationSession
ErrorsNULL_ARGUMENT addressBookReceiver or proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsAddressBookNotification() is false
ComplianceoptionalThis method must be implemented if supportsAddressBookNotification() is true.
MethodgetAddressBookHierarchySession
Description

Gets the OsidSession associated with the address book hierarchy service.

Parametersosid.proxy.Proxyproxya proxy
Returnosid.contact.AddressBookHierarchySessionan AddressBookHierarchySession
ErrorsNULL_ARGUMENT proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsAddressBookHierarchy() is false
ComplianceoptionalThis method must be implemented if supportsAddressBookHierarchy() is true.
MethodgetAddressBookHierarchyDesignSession
Description

Gets the OsidSession associated with the address book hierarchy design service.

Parametersosid.proxy.Proxyproxya proxy
Returnosid.contact.AddressBookHierarchyDesignSessionan AddressBookHierarchyDesignSession
ErrorsNULL_ARGUMENT proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsAddressBookHierarchyDesign() is false
ComplianceoptionalThis method must be implemented if supportsAddressBookHierarchyDesign() is true.
MethodgetContactBatchProxyManager
Description

Gets the ContactBatchProxyManager.

Returnosid.contact.batch.ContactBatchProxyManagera ContactBatchProxyManager
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsContactBatch() is false
ComplianceoptionalThis method must be implemented if supportsContactBatch() is true.
MethodgetContactRulesProxyManager
Description

Gets the ContactRulesProxyManager.

Returnosid.contact.rules.ContactRulesProxyManagera ContactRulesProxyManager
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsContactRules() is false
ComplianceoptionalThis method must be implemented if supportsContactRules() is true.