public interface ContactEnablerAddressBookAssignmentSession extends OsidSession
This session provides methods to re-assign ContactEnabler
to AddressBook
mappings. A ContactEnabler
may appear in multiple AddressBook
objects and
removing the last reference to a ContactEnabler
is the
equivalent of deleting it. Each AddressBook
may have its
own authorizations governing who is allowed to operate on it.
Adding a reference of a ContactEnabler
to another
AddressBook
is not a copy operation (eg: does not change
its Id
).
Modifier and Type | Method and Description |
---|---|
void |
assignContactEnablerToAddressBook(Id contactEnablerId,
Id addressBookId)
Adds an existing
ContactEnabler to an
AddressBook. |
boolean |
canAssignContactEnablers()
Tests if this user can alter contact enabler/address book mappings.
|
boolean |
canAssignContactEnablersToAddressBook(Id addressBookId)
Tests if this user can alter contact enabler/address book mappings.
|
IdList |
getAssignableAddressBookIds(Id addressBookId)
Gets a list of address books including and under the given address
book node in which any contact enabler can be assigned.
|
IdList |
getAssignableAddressBookIdsForContactEnabler(Id addressBookId,
Id contactEnablerId)
Gets a list of address books including and under the given address
book node in which a specific contact enabler can be assigned.
|
void |
reassignContactEnablerToAddressBook(Id contactEnablerId,
Id fromAddressBookId,
Id toAddressBookId)
Moves a
ContactEnabler from one AddressBook
to another. |
void |
unassignContactEnablerFromAddressBook(Id contactEnablerId,
Id addressBookId)
Removes a
ContactEnabler from an AddressBook. |
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
boolean canAssignContactEnablers()
PERMISSION_DENIED.
This is intended as
a hint to an application that may opt not to offer lookup operations
to unauthorized users. false
if mapping is not authorized, true
otherwisemandatory
- This method must be implemented. boolean canAssignContactEnablersToAddressBook(Id addressBookId)
PERMISSION_DENIED.
This is intended as
a hint to an application that may opt not to offer lookup operations
to unauthorized users.addressBookId
- the Id
of the AddressBook
false
if mapping is not authorized, true
otherwiseNullArgumentException
- addressBookId
is
null
mandatory
- This method must be implemented. IdList getAssignableAddressBookIds(Id addressBookId) throws OperationFailedException
addressBookId
- the Id
of the AddressBook
Ids
NullArgumentException
- addressBookId
is
null
OperationFailedException
- unable to complete requestmandatory
- This method must be implemented. IdList getAssignableAddressBookIdsForContactEnabler(Id addressBookId, Id contactEnablerId) throws OperationFailedException
addressBookId
- the Id
of the AddressBook
contactEnablerId
- the Id
of the
ContactEnabler
Ids
NullArgumentException
- addressBookId
or
contactEnablerId
is null
OperationFailedException
- unable to complete requestmandatory
- This method must be implemented. void assignContactEnablerToAddressBook(Id contactEnablerId, Id addressBookId) throws AlreadyExistsException, NotFoundException, OperationFailedException, PermissionDeniedException
ContactEnabler
to an
AddressBook.
contactEnablerId
- the Id
of the
ContactEnabler
addressBookId
- the Id
of the AddressBook
AlreadyExistsException
- contactEnablerId
is already assigned to addressBookId
NotFoundException
- contactEnablerId
or
addressBookId
not foundNullArgumentException
- contactEnablerId
or addressBookId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void unassignContactEnablerFromAddressBook(Id contactEnablerId, Id addressBookId) throws NotFoundException, OperationFailedException, PermissionDeniedException
ContactEnabler
from an AddressBook.
contactEnablerId
- the Id
of the
ContactEnabler
addressBookId
- the Id
of the AddressBook
NotFoundException
- contactEnablerId
or
addressBookId
not found or
contactEnablerId
is not assigned to
addressBookId
NullArgumentException
- contactEnablerId
or addressBookId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void reassignContactEnablerToAddressBook(Id contactEnablerId, Id fromAddressBookId, Id toAddressBookId) throws NotFoundException, OperationFailedException, PermissionDeniedException
ContactEnabler
from one AddressBook
to another. Mappings to other AddressBooks
are
unaffected.contactEnablerId
- the Id
of the
ContactEnabler
fromAddressBookId
- the Id
of the current
AddressBook
toAddressBookId
- the Id
of the destination
AddressBook
NotFoundException
- contactEnablerId,
fromAddressBookId,
or toAddressBookId
not found or contactEnablerId
not mapped to
fromAddressBookId
NullArgumentException
- contactEnablerId,
fromAddressBookId,
or toAddressBookId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented.