Interface | osid.contact.rules.ContactEnablerSmartAddressBookSession | ||
---|---|---|---|
Implements | osid.OsidSession | ||
Description |
This session manages queries and sequencing to create
"smart" dynamic address books. A This | ||
Method | getAddressBookId | ||
Description |
Gets the | ||
Return | osid.id.Id | the AddressBook Id associated with this session | |
Compliance | mandatory | This method must be implemented. | |
Method | getAddressBook | ||
Description |
Gets the | ||
Return | osid.contact.AddressBook | the address book | |
Errors | OPERATION_FAILED | unable to complete request | |
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | canManageSmartAddressBooks | ||
Description |
Tests if this user can manage smart address books. A
return of true does not guarantee successful
authorization. A return of false indicates that it is
known methods in this session will result in a | ||
Return | boolean | false if smart address book management is not authorized,
true otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | getContactEnablerQuery | ||
Description |
Gets a contact enabler query. | ||
Return | osid.contact.rules.ContactEnablerQuery | the contact enabler query | |
Compliance | mandatory | This method must be implemented. | |
Method | getContactEnablerSearchOrder | ||
Description |
Gets a contact enabler search order. | ||
Return | osid.contact.rules.ContactEnablerSearchOrder | the contact enabler search order | |
Compliance | mandatory | This method must be implemented. | |
Method | applyContactEnablerQuery | ||
Description |
Applies a contact enabler query to this address book. | ||
Parameters | osid.contact.rules.ContactEnablerQuery | contactEnablerQuery | the contact enabler query |
Errors | NULL_ARGUMENT | contactEnablerQuery is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure occurred | ||
UNSUPPORTED | contactEnablerQuery not of this service | ||
Compliance | mandatory | This method must be implemented. | |
Method | inspectContactEnablerQuery | ||
Description |
Gets a contact enabler query inspector for this address book. | ||
Return | osid.contact.rules.ContactEnablerQueryInspector | the contact enabler query inspector | |
Errors | OPERATION_FAILED | unable to complete request | |
PERMISSION_DENIED | authorization failure occurred | ||
Compliance | mandatory | This method must be implemented. | |
Method | applyContactEnablerSequencing | ||
Description |
Applies a contact enabler search order to this address book. | ||
Parameters | osid.contact.rules.ContactEnablerSearchOrder | contactEnablerSearchOrder | the contact enabler search order |
Errors | NULL_ARGUMENT | contactEnablerSearchOrder is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure occurred | ||
UNSUPPORTED | contactEnablerSearchOrder not of this service | ||
Compliance | mandatory | This method must be implemented. | |
Method | getContactEnablerQueryFromInspector | ||
Description |
Gets a contact enabler query from an inspector. | ||
Parameters | osid.contact.rules.ContactEnablerQueryInspector | contactEnablerQueryInspector | a contact enabler query inspector |
Return | osid.contact.rules.ContactEnablerQuery | the contact enabler query | |
Errors | NULL_ARGUMENT | contactEnablerQueryInspector is null | |
UNSUPPORTED | contactEnablerQueryInspector is not of this service | ||
Compliance | mandatory | This method must be implemented. |