public interface ContactEnablerRuleLookupSession extends OsidSession
This session provides methods to retrieve ContactEnabler
to Contact
mappings. A Contact
with multiple
ContactEnablers
means any positive rule evaluation across
the enablers result in an enabled Contact.
This lookup session defines several views:
Modifier and Type | Method and Description |
---|---|
boolean |
canLookupContactEnablerRules()
Tests if this user can perform lookups of contact enabler/contact
mappings.
|
AddressBook |
getAddressBook()
Gets the
AddressBook associated with this session. |
Id |
getAddressBookId()
Gets the
AddressBook Id associated with
this session. |
IdList |
getContactEnablerIdsForContact(Id contactId)
Gets the
ContactEnabler Id associated with a
Contact. |
ContactEnablerList |
getContactEnablersForContact(Id contactId)
Gets the
ContactEnabler associated with a
Contact. |
IdList |
getContactIdsForContactEnabler(Id contactEnablerId)
Gets the
COntact Ids mapped to a
ContactEnabler. |
ContactList |
getContactsForContactEnabler(Id contactEnablerId)
Gets the
Contacts mapped to a ContactEnabler. |
void |
useComparativeContactEnablerRuleView()
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 |
useFederatedAddressBookView()
Federates the view for methods in this session.
|
void |
useIsolatedAddressBookView()
Isolates the view for methods in this session.
|
void |
usePlenaryContactEnablerRuleView()
A complete view of the
ContactEnabler and
Contact returns is desired. |
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
Id getAddressBookId()
AddressBook
Id
associated with
this session. AddressBook Id
associated with this sessionmandatory
- This method must be implemented. AddressBook getAddressBook() throws OperationFailedException, PermissionDeniedException
AddressBook
associated with this session.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. boolean canLookupContactEnablerRules()
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 useComparativeContactEnablerRuleView()
mandatory
- This method is must be implemented. void usePlenaryContactEnablerRuleView()
ContactEnabler
and
Contact
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. void useFederatedAddressBookView()
mandatory
- This method is must be implemented. void useIsolatedAddressBookView()
mandatory
- This method is must be implemented. IdList getContactEnablerIdsForContact(Id contactId) throws NotFoundException, OperationFailedException, PermissionDeniedException
ContactEnabler Id
associated with a
Contact.
contactId
- Id
of the Contact
Ids
NotFoundException
- contactId
is not
foundNullArgumentException
- contactId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. ContactEnablerList getContactEnablersForContact(Id contactId) throws NotFoundException, OperationFailedException, PermissionDeniedException
ContactEnabler
associated with a
Contact.
contactId
- Id
of the Contact
NotFoundException
- contactId
is not
foundNullArgumentException
- contactId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. IdList getContactIdsForContactEnabler(Id contactEnablerId) throws NotFoundException, OperationFailedException, PermissionDeniedException
COntact
Ids
mapped to a
ContactEnabler.
contactEnablerId
- Id
of a ContactEnabler
Ids
NotFoundException
- contactEnablerId
is
not foundNullArgumentException
- contactEnablerId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. ContactList getContactsForContactEnabler(Id contactEnablerId) throws NotFoundException, OperationFailedException, PermissionDeniedException
Contacts
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.