org.osid.contact

Interface ContactSession

All Superinterfaces:

java.lang.AutoCloseable, java.io.Closeable, OsidSession

public interface ContactSession
extends OsidSession

This session defines methods for retrieving contacts.

This lookup session defines several views:

• isolated address book view: All contact methods in this session operate, retrieve and pertain to contacts defined explicitly in the current address book. Using an isolated view is useful for managing contacts with the ContactAdminSession.
• federated address book view: All contact lookup methods in this session operate, retrieve and pertain to all contacts defined in this address book and any other address books implicitly available in this address book through address book inheritence.

The methods useFederatedAddressBookView() and useIsolatedAddressBookView() behave as a radio group and one should be selected before invoking any lookup methods. This session is always in comparative mode.

Method Summary

Methods

Modifier and Type	Method and 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	getAvailableContacts(Id referenceId) Gets a list of all current available contacts corresponding to a reference Id sorted from highlest to lowest priority.
ContactList	getAvailableContactsByGenusType(Id referenceId, Type contactGenusType) Gets all current available contacts for a reference and by contact genus Type sorted from highest to lowest priority.
void	useFederatedAddressBookView() Federates the view for methods in this session.
void	useIsolatedAddressBookView() Isolates the view for methods in this session.

Methods inherited from interface org.osid.OsidSession

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

Methods inherited from interface org.osid.binding.java.OsidSession

close

Methods inherited from interface java.io.Closeable

close

Method Detail

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.

useFederatedAddressBookView

void useFederatedAddressBookView()

Federates the view for methods in this session. A federated view will include contacts in address books which are children of this address book in the address book hierarchy.

Compliance:

mandatory - This method is must be implemented.

useIsolatedAddressBookView

void useIsolatedAddressBookView()

Isolates the view for methods in this session. An isolated view restricts retrievals to this address book only.

Compliance:

mandatory - This method is must be implemented.

getAvailableContacts

ContactList getAvailableContacts(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.

getAvailableContactsByGenusType

ContactList getAvailableContactsByGenusType(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.