Interface | osid.contact.rules.ContactEnablerLookupSession | ||
---|---|---|---|
Implements | osid.OsidSession | ||
Description |
This session provides methods for retrieving This session defines views that offer differing behaviors when retrieving multiple objects.
Generally, the comparative view should be used for most
applications as it permits operation even if there is data
that cannot be accessed. The methods | ||
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 | canLookupContactEnablers | ||
Description |
Tests if this user can perform | ||
Return | boolean | false if lookup methods are not authorized, true
otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | useComparativeContactEnablerView | ||
Description |
The returns from the lookup methods may omit or translate elements based on this session, such as authorization, and not result in an error. This view is used when greater interoperability is desired at the expense of precision. | ||
Compliance | mandatory | This method is must be implemented. | |
Method | usePlenaryContactEnablerView | ||
Description |
A complete view of the | ||
Compliance | mandatory | This method is 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 address book 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 | useActiveContactEnablerView | ||
Description |
Only actuve contact enablers are returned by methods in this session. | ||
Compliance | mandatory | This method is must be implemented. | |
Method | useAnyStatusContactEnablerView | ||
Description |
All active and inactive contact enablers are returned by methods in this session. | ||
Compliance | mandatory | This method is must be implemented. | |
Method | getContactEnabler | ||
Description |
Gets the In active mode, contact enablers are returned that are currently active. In any status mode, active and inactive contact enablers are returned. | ||
Parameters | osid.id.Id | contactEnablerId | Id of the ContactEnabler |
Return | osid.contact.rules.ContactEnabler | the contact enabler | |
Errors | NOT_FOUND | contactEnablerId not found | |
NULL_ARGUMENT | contactEnablerId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method is must be implemented. | |
Method | getContactEnablersByIds | ||
Description |
Gets a | ||
Parameters | osid.id.IdList | contactEnablerIds | the list of Ids to retrieve |
Return | osid.contact.rules.ContactEnablerList | the returned ContactEnabler list | |
Errors | NOT_FOUND | an Id was not found | |
NULL_ARGUMENT | contactEnablerIds is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getContactEnablersByGenusType | ||
Description |
Gets a In active mode, contact enablers are returned that are currently active. In any status mode, active and inactive contact enablers are returned. | ||
Parameters | osid.type.Type | contactEnablerGenusType | a contact enabler genus type |
Return | osid.contact.rules.ContactEnablerList | the returned ContactEnabler list | |
Errors | NULL_ARGUMENT | contactEnablerGenusType is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getContactEnablersByParentGenusType | ||
Description |
Gets a In active mode, contact enablers are returned that are currently active. In any status mode, active and inactive contact enablers are returned. | ||
Parameters | osid.type.Type | contactEnablerGenusType | a contact enabler genus type |
Return | osid.contact.rules.ContactEnablerList | the returned ContactEnabler list | |
Errors | NULL_ARGUMENT | contactEnablerGenusType is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getContactEnablersByRecordType | ||
Description |
Gets a In active mode, contact enablers are returned that are currently active. In any status mode, active and inactive contact enablers are returned. | ||
Parameters | osid.type.Type | contactEnablerRecordType | a contact enabler record type |
Return | osid.contact.rules.ContactEnablerList | the returned ContactEnabler list | |
Errors | NULL_ARGUMENT | contactEnablerRecordType is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getContactEnablersOnDate | ||
Description |
Gets a In plenary mode, the returned list contains all known contact enablers or an error results. Otherwise, the returned list may contain only those contact enablers that are accessible through this session. In active mode, contact enablers are returned that are currently active. In any status mode, active and inactive contact enablers are returned. | ||
Parameters | osid.calendaring.DateTime | from | a start date |
osid.calendaring.DateTime | to | an end date | |
Return | osid.contact.rules.ContactEnablerList | the returned ContactEnabler list | |
Errors | INVALID_ARGUMENT | from is greater than to | |
NULL_ARGUMENT | from or to is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getContactEnablersOnDateWithAgent | ||
Description |
Gets a In plenary mode, the returned list contains all known contact enablers or an error results. Otherwise, the returned list may contain only those contact enablers that are accessible through this session. In active mode, contact enablers are returned that are currently active. In any status mode, active and inactive contact enablers are returned. | ||
Parameters | osid.id.Id | agentId | an agent Id |
osid.calendaring.DateTime | from | a start date | |
osid.calendaring.DateTime | to | an end date | |
Return | osid.contact.rules.ContactEnablerList | the returned ContactEnabler list | |
Errors | INVALID_ARGUMENT | from is greater than to | |
NULL_ARGUMENT | agent, from, or to is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getContactEnablers | ||
Description |
Gets all In plenary mode, the returned list contains all known contact enablers or an error results. Otherwise, the returned list may contain only those contact enablers that are accessible through this session. In active mode, contact enablers are returned that are currently active. In any status mode, active and inactive contact enablers are returned. | ||
Return | osid.contact.rules.ContactEnablerList | the returned ContactEnabler list | |
Errors | OPERATION_FAILED | unable to complete request | |
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. |