Interface ContactAddressBookSession

All Superinterfaces:

AutoCloseable, Closeable, OsidSession, OsidSession

public interface ContactAddressBookSession
extends OsidSession

This session provides methods to retrieve Contact to AddressBook mappings. A Contact may appear in multiple AddressBooks . Each AddressBook may have its own authorizations governing who is allowed to look at it.

This lookup session defines several views:

• comparative view: elements may be silently omitted or re-ordered
• plenary view: provides a complete result set or is an error condition

Method Summary

Modifier and Type	Method	Description
boolean	canLookupContactAddressBookMappings()	Tests if this user can perform lookups of contact/address book mappings.
IdList	getAddressBookIdsByContact(Id contactId)	Gets the list of AddressBook Ids mapped to a Contact .
AddressBookList	getAddressBooksByContact(Id contactId)	Gets the list of AddressBook objects mapped to a Contact .
IdList	getContactIdsByAddressBook(Id addressBookId)	Gets the list of Contact Ids associated with an AddressBook .
IdList	getContactIdsByAddressBooks(IdList addressBookIds)	Gets the list of Contact Ids corresponding to a list of AddressBook objects.
ContactList	getContactsByAddressBook(Id addressBookId)	Gets the list of Contacts associated with an AddressBook .
ContactList	getContactsByAddressBooks(IdList addressBookIds)	Gets the list of Contacts corresponding to a list of AddressBooks .
void	useComparativeAddressBookView()	The returns from the lookup methods may omit or translate elements based on this session, such as authorization, and not result in an error.
void	usePlenaryAddressBookView()	A complete view of the Contact and AddressBook returns is desired.

Methods inherited from interface Closeable

close

Methods inherited from interface OsidSession

close

Modifier and Type	Method	Description
void	close()	Close this session.

Methods inherited from interface OsidSession

getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions

Modifier and Type	Method	Description
Agent	getAuthenticatedAgent()	Gets the agent authenticated to this session.
Id	getAuthenticatedAgentId()	Gets the Id of the agent authenticated to this session.
BigDecimal	getClockRate()	Gets the rate of the service clock.
Date	getDate()	Gets the service date which may be the current date or the effective date in which this session exists.
Agent	getEffectiveAgent()	Gets the effective agent in use by this session.
Id	getEffectiveAgentId()	Gets the Id of the effective agent in use by this session.
Type	getFormatType()	Gets the DisplayText format Type preference in effect for this session.
Locale	getLocale()	Gets the locale indicating the localization preferences in effect for this session.
boolean	isAuthenticated()	Tests if an agent is authenticated to this session.
Transaction	startTransaction()	Starts a new transaction for this sesson.
boolean	supportsTransactions()	Tests for the availability of transactions.

Method Details

canLookupContactAddressBookMappings

boolean canLookupContactAddressBookMappings()

Tests if this user can perform lookups of contact/address book mappings. A return of true does not guarantee successful authorization. A return of false indicates that it is known lookup methods in this session will result in a PERMISSION_DENIED . This is intendedas a hint to an application that may opt not to offer lookup operations to unauthorized users.

Returns:

false if looking up mappings is not authorized, true otherwise

Compliance:

mandatory - This method must be implemented.

useComparativeAddressBookView

void useComparativeAddressBookView()

The returns from the lookup methods may omit or translate elements based on this session, such as authorization, and not result in an error. This view is used when greater interoperability is desired at the expense of precision.

Compliance:

mandatory - This method is must be implemented.

usePlenaryAddressBookView

void usePlenaryAddressBookView()

A complete view of the Contact and AddressBook returns is desired. Methods will return what is requested or result in an error. This view is used when greater precision is desired at the expense of interoperability.

Compliance:

mandatory - This method is must be implemented.

getContactIdsByAddressBook

IdList getContactIdsByAddressBook(Id addressBookId)
                           throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets the list of Contact Ids associated with an AddressBook .

Parameters:

addressBookId - Id of an AddressBook .

Returns:

list of related contact Ids

Throws:

NotFoundException - addressBookId is not found

NullArgumentException - addressBookId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getContactsByAddressBook

ContactList getContactsByAddressBook(Id addressBookId)
                              throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets the list of Contacts associated with an AddressBook .

Parameters:

addressBookId - Id of an AddressBook

Returns:

list of related contacts

Throws:

NotFoundException - addressBookId is not found

NullArgumentException - addressBookId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getContactIdsByAddressBooks

IdList getContactIdsByAddressBooks(IdList addressBookIds)
                            throws OperationFailedException,
PermissionDeniedException

Gets the list of Contact Ids corresponding to a list of AddressBook objects.

Parameters:

addressBookIds - list of address book Ids

Returns:

list of contact Ids

Throws:

NullArgumentException - addressBookIds is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getContactsByAddressBooks

ContactList getContactsByAddressBooks(IdList addressBookIds)
                               throws OperationFailedException,
PermissionDeniedException

Gets the list of Contacts corresponding to a list of AddressBooks .

Parameters:

addressBookIds - list of address book Ids

Returns:

list of contacts

Throws:

NullArgumentException - addressBookIds is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getAddressBookIdsByContact

IdList getAddressBookIdsByContact(Id contactId)
                           throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets the list of AddressBook Ids mapped to a Contact .

Parameters:

contactId - Id of a Contact

Returns:

list of address book Ids

Throws:

NotFoundException - contactId is not found

NullArgumentException - contactId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getAddressBooksByContact

AddressBookList getAddressBooksByContact(Id contactId)
                                  throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets the list of AddressBook objects mapped to a Contact .

Parameters:

contactId - Id of a Contact

Returns:

list of address books

Throws:

NotFoundException - contactId is not found

NullArgumentException - contactId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.