OSID Logo
OSID Specifications
contact package
Version 3.0.0
Interfaceosid.contact.ContactSession
Implementsosid.OsidSession
Used Byosid.contact.ContactManager
osid.contact.ContactProxyManager
Description

This session defines methods for evaluating and retrieving active and applicable contacts.

MethodgetAddressBookId
Description

Gets the AddressBook Id associated with this session.

Returnosid.id.Idthe AddressBook Id associated with this session
CompliancemandatoryThis method must be implemented.
MethodgetAddressBook
Description

Gets the AddressBook associated with this session.

Returnosid.contact.AddressBookthe address book
ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodcanGetContacts
Description

Tests if this user can lookup contacts. A return of true does not guarantee successful authorization. A return of false indicates that it is known all methods in this session will result in a PERMISSION_DENIED . This is intended as a hint to an application that may opt not to offer these operations.

Returnbooleanfalse if contact lookup methods are not authorized, true otherwise
CompliancemandatoryThis method must be implemented.
MethodgetApplicableContacts
Description

Gets a list of all current available contacts corresponding to a reference Id sorted from highlest to lowest priority.

Parametersosid.id.IdreferenceIdthe Id of the reference
Returnosid.contact.ContactListthe returned ContactList
ErrorsNULL_ARGUMENTreferenceId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetApplicableContactsByGenusType
Description

Gets all current available contacts for a reference and by contact genus Type sorted from highest to lowest priority.

Parametersosid.id.IdreferenceIdthe Id of the reference
osid.type.TypecontactGenusTypea contact genus Type
Returnosid.contact.ContactLista list of contacts
ErrorsNULL_ARGUMENTreferenceId or contactGenusType is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.