Interface | osid.contact.rules.ContactEnablerQuerySession | ||
---|---|---|---|
Implements | osid.OsidSession | ||
Description |
This session provides methods for searching among This session defines views that offer differing behaviors for searching.
Contact enablers may have a query record indicated by
their respective record types. The query record is accessed
via the | ||
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 | canSearchContactEnablers | ||
Description |
Tests if this user can perform | ||
Return | boolean | false if search methods are not authorized, true
otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | useFederatedAddressBookView | ||
Description |
Federates the view for methods in this session. A federated view will include contact enablers in address books which are children of this broker in the address book hierarchy. | ||
Compliance | mandatory | This method is must be implemented. | |
Method | useIsolatedAddressBookView | ||
Description |
Isolates the view for methods in this session. An isolated view restricts lookups to this address book only. | ||
Compliance | mandatory | This method is 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 | getContactEnablersByQuery | ||
Description |
Gets a list of | ||
Parameters | osid.contact.rules.ContactEnablerQuery | contactEnablerQuery | the contact enabler query |
Return | osid.contact.rules.ContactEnablerList | the returned ContactEnablerList | |
Errors | NULL_ARGUMENT | contactEnablerQuery is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
UNSUPPORTED | contactEnablerQuery is not of this service | ||
Compliance | mandatory | This method must be implemented. |