public interface AddressAddressBookSession extends OsidSession
This session provides methods to retrieve Address
to
AddressBook
mappings. An Address
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:
Modifier and Type | Method and Description |
---|---|
boolean |
canLookupAddressAddressBookMappings()
Tests if this user can perform lookups of address/address book
mappings.
|
IdList |
getAddressBookIdsByAddress(Id addressId)
Gets the list of
AddressBook Ids mapped
to an Address. |
AddressBookList |
getAddressBooksByAddress(Id addressId)
Gets the list of
AddressBook objects mapped to an
Address. |
AddressList |
getAddressesByAddressBook(Id addressBookId)
Gets the list of
Addresses associated with an
AddressBook. |
AddressList |
getAddressesByAddressBooks(IdList addressBookIds)
Gets the list of
Addresses corresponding to a list of
AddressBooks. |
IdList |
getAddressIdsByAddressBook(Id addressBookId)
Gets the list of Address Ids associated with an
AddressBook. |
IdList |
getAddressIdsByAddressBooks(IdList addressBookIds)
Gets the list of
Address Ids corresponding to a list of
AddressBook objects. |
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
Address and AddressBook
returns is desired. |
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
boolean canLookupAddressAddressBookMappings()
PERMISSION_DENIED.
This is intendedas 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 useComparativeAddressBookView()
mandatory
- This method is must be implemented. void usePlenaryAddressBookView()
Address
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 getAddressIdsByAddressBook(Id addressBookId) throws NotFoundException, OperationFailedException, PermissionDeniedException
AddressBook.
addressBookId
- Id
of an AddressBook.
Ids
NotFoundException
- addressBookId
is not
foundNullArgumentException
- addressBookId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. AddressList getAddressesByAddressBook(Id addressBookId) throws NotFoundException, OperationFailedException, PermissionDeniedException
Addresses
associated with an
AddressBook.
addressBookId
- Id
of an AddressBook
NotFoundException
- addressBookId
is not
foundNullArgumentException
- addressBookId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. IdList getAddressIdsByAddressBooks(IdList addressBookIds) throws OperationFailedException, PermissionDeniedException
Address Ids
corresponding to a list of
AddressBook
objects.addressBookIds
- list of address book Ids
Ids
NullArgumentException
- addressBookIds
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. AddressList getAddressesByAddressBooks(IdList addressBookIds) throws OperationFailedException, PermissionDeniedException
Addresses
corresponding to a list of
AddressBooks.
addressBookIds
- list of address book Ids
NullArgumentException
- addressBookIds
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. IdList getAddressBookIdsByAddress(Id addressId) throws NotFoundException, OperationFailedException, PermissionDeniedException
AddressBook
Ids
mapped
to an Address.
addressId
- Id
of an Address
Ids
NotFoundException
- addressId
is not
foundNullArgumentException
- addressId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. AddressBookList getAddressBooksByAddress(Id addressId) throws NotFoundException, OperationFailedException, PermissionDeniedException
AddressBook
objects mapped to an
Address.
addressId
- Id
of an Address
NotFoundException
- addressId
is not
foundNullArgumentException
- addressId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented.