Interface ContactSession

All Superinterfaces:

AutoCloseable, Closeable, OsidSession, OsidSession

public interface ContactSession
extends OsidSession

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

Method Summary

Modifier and Type	Method	Description
boolean	canGetContacts()	Tests if this user can lookup contacts.
AddressBook	getAddressBook()	Gets the AddressBook associated with this session.
Id	getAddressBookId()	Gets the AddressBook Id associated with this session.
ContactList	getApplicableContacts(Id referenceId)	Gets a list of all current available contacts corresponding to a reference Id sorted from highlest to lowest priority.
ContactList	getApplicableContactsByGenusType(Id referenceId, Type contactGenusType)	Gets all current available contacts for a reference and by contact genus Type sorted from highest to lowest priority.

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

getAddressBookId

Id getAddressBookId()

Gets the AddressBook Id associated with this session.

Returns:

the AddressBook Id associated with this session

Compliance:

mandatory - This method must be implemented.

getAddressBook

AddressBook getAddressBook()
                    throws OperationFailedException,
PermissionDeniedException

Gets the AddressBook associated with this session.

Returns:

the address book

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

canGetContacts

boolean canGetContacts()

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.

Returns:

false if contact lookup methods are not authorized, true otherwise

Compliance:

mandatory - This method must be implemented.

getApplicableContacts

ContactList getApplicableContacts(Id referenceId)
                           throws OperationFailedException,
PermissionDeniedException

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

Parameters:

referenceId - the Id of the reference

Returns:

the returned ContactList

Throws:

NullArgumentException - referenceId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getApplicableContactsByGenusType

ContactList getApplicableContactsByGenusType(Id referenceId,
 Type contactGenusType)
                                      throws OperationFailedException,
PermissionDeniedException

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

Parameters:

referenceId - the Id of the reference

contactGenusType - a contact genus Type

Returns:

a list of contacts

Throws:

NullArgumentException - referenceId or contactGenusType is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.