public interface ContactEnablerAddressBookSession extends OsidSession
This session provides methods to retrieve ContactEnabler
to AddressBook
mappings. A ContactEnabler
may appear in multiple AddressBook
objects. Each address
book may have its own authorizations governing who is allowed to look at
it.
This lookup session defines several views:
Modifier and Type | Method and Description |
---|---|
boolean |
canLookupContactEnablerAddressBookMappings()
Tests if this user can perform lookups of contact enabler/address book
mappings.
|
IdList |
getAddressBookIdsByContactEnabler(Id contactEnablerId)
Gets the
AddressBook Ids mapped to a
ContactEnabler. |
AddressBookList |
getAddressBooksByContactEnabler(Id contactEnablerId)
Gets the
AddressBooks mapped to a
ContactEnabler. |
IdList |
getContactEnablerIdsByAddressBook(Id addressBookId)
Gets the list of
ContactEnablerIds associated with an
AddressBook. |
IdList |
getContactEnablerIdsByAddressBooks(IdList addressBookIds)
Gets the list of
ContactEnabler Ids corresponding to a
list of AddressBooks. |
ContactEnablerList |
getContactEnablersByAddressBook(Id addressBookId)
Gets the list of contact enablers associated with an
AddressBook. |
ContactEnablerList |
getContactEnablersByAddressBooks(IdList addressBookIds)
Gets the list of contact enablers corresponding to a list of
AddressBooks. |
void |
useComparativeContactEnablerAddressBookView()
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 |
usePlenaryContactEnablerAddressBookView()
A complete view of the
ContactEnabler and
AddressBook returns is desired. |
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
boolean canLookupContactEnablerAddressBookMappings()
PERMISSION_DENIED.
This is intended as a hint to an application that may opt not
to offer lookup operations to unauthorized users. false
if looking up mappings is not authorized,
true
otherwisemandatory
- This method must be implemented. void useComparativeContactEnablerAddressBookView()
mandatory
- This method is must be implemented. void usePlenaryContactEnablerAddressBookView()
ContactEnabler
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.mandatory
- This method is must be implemented. IdList getContactEnablerIdsByAddressBook(Id addressBookId) throws NotFoundException, OperationFailedException, PermissionDeniedException
ContactEnablerIds
associated with an
AddressBook.
addressBookId
- Id
of the AddressBook
Ids
NotFoundException
- addressBookId
is not
foundNullArgumentException
- addressBookId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. ContactEnablerList getContactEnablersByAddressBook(Id addressBookId) throws NotFoundException, OperationFailedException, PermissionDeniedException
AddressBook.
addressBookId
- Id
of the AddressBook
NotFoundException
- addressBookId
is not
foundNullArgumentException
- addressBookId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. IdList getContactEnablerIdsByAddressBooks(IdList addressBookIds) throws OperationFailedException, PermissionDeniedException
ContactEnabler Ids
corresponding to a
list of AddressBooks.
addressBookIds
- list of address book Ids
Ids
NullArgumentException
- addressBookIds
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. ContactEnablerList getContactEnablersByAddressBooks(IdList addressBookIds) throws OperationFailedException, PermissionDeniedException
AddressBooks.
addressBookIds
- list of address book Ids
NullArgumentException
- addressBookIds
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. IdList getAddressBookIdsByContactEnabler(Id contactEnablerId) throws NotFoundException, OperationFailedException, PermissionDeniedException
AddressBook
Ids
mapped to a
ContactEnabler.
contactEnablerId
- Id
of a ContactEnabler
NotFoundException
- contactEnablerId
is
not foundNullArgumentException
- contactEnablerId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. AddressBookList getAddressBooksByContactEnabler(Id contactEnablerId) throws NotFoundException, OperationFailedException, PermissionDeniedException
AddressBooks
mapped to a
ContactEnabler.
contactEnablerId
- Id
of a ContactEnabler
NotFoundException
- contactEnablerId
is
not foundNullArgumentException
- contactEnablerId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented.