OSID Logo
OSID Specifications
contact rules package
Version 3.0.0
Release Candidate Preview
Interfaceosid.contact.rules.ContactEnablerLookupSession
Implementsosid.OsidSession
Description

This session provides methods for retrieving ContactEnablers.

This session defines views that offer differing behaviors when retrieving multiple objects.

  • comparative view: elements may be silently omitted or re-ordered
  • plenary view: provides a complete set or is an error condition
  • isolated address book view: All contact enabler methods in this session operate, retrieve and pertain to contact enablers defined explicitly in the current address book. Using an isolated view is useful for managing ContactEnablers with the ContactEnablerAdminSession.
  • federated address book view: All contact enabler methods in this session operate, retrieve and pertain to all contact enablers defined in this address book and any other contact enablers implicitly available in this address book through address book inheritence.
  • active contact enabler view: All contact enabler lookup methods return active contact enablers.
  • any status contact enabler view: Contact enablers of any active or inactive status are returned from methods.

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 useFederatedDistributorView() and useIsolatedDistributorView() behave as a radio group and one should be selected before invoking the methods in this session.

MethodgetAddressBookId
Description

Gets the AddressBook Id associated with this session.

Returnosid.id.Idthe AddressBook Id associated with this session
CompliancemandatoryThis method must be implemented.
MethodgetAddressBook
Description

Gets the AddressBook associated with this session.

Returnosid.contact.AddressBookthe address book
ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodcanLookupContactEnablers
Description

Tests if this user can perform ContactEnablers lookups. A return of true does not guarantee successful authorization. A return of false indicates that it is known all methods in this session will result in a PERMISSION_DENIED. This is intended as a hint to an application that may opt not to offer lookup operations to unauthorized users.

Returnboolean false if lookup methods are not authorized, true otherwise
CompliancemandatoryThis method must be implemented.
MethoduseComparativeContactEnablerView
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.

CompliancemandatoryThis method is must be implemented.
MethodusePlenaryContactEnablerView
Description

A complete view of the ContactEnabler 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.

CompliancemandatoryThis method is must be implemented.
MethoduseFederatedAddressBookView
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.

CompliancemandatoryThis method is must be implemented.
MethoduseIsolatedAddressBookView
Description

Isolates the view for methods in this session. An isolated view restricts lookups to this address book only.

CompliancemandatoryThis method is must be implemented.
MethoduseActiveContactEnablerView
Description

Only actuve contact enablers are returned by methods in this session.

CompliancemandatoryThis method is must be implemented.
MethoduseAnyStatusContactEnablerView
Description

All active and inactive contact enablers are returned by methods in this session.

CompliancemandatoryThis method is must be implemented.
MethodgetContactEnabler
Description

Gets the ContactEnabler specified by its Id.

In plenary mode, the exact Id is found or a NOT_FOUND results. Otherwise, the returned ContactEnabler may have a different Id than requested, such as the case where a duplicate Id was assigned to a ContactEnabler and retained for compatibility.

In active mode, contact enablers are returned that are currently active. In any status mode, active and inactive contact enablers are returned.

Parametersosid.id.IdcontactEnablerId Id of the ContactEnabler
Returnosid.contact.rules.ContactEnablerthe contact enabler
ErrorsNOT_FOUND contactEnablerId not found
NULL_ARGUMENT contactEnablerId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method is must be implemented.
MethodgetContactEnablersByIds
Description

Gets a ContactEnablerList corresponding to the given IdList. In plenary mode, the returned list contains all of the contact enablers specified in the Id list, in the order of the list, including duplicates, or an error results if an Id in the supplied list is not found or inaccessible. Otherwise, inaccessible ContactEnablers may be omitted from the list and may present the elements in any order including returning a unique set.

Parametersosid.id.IdListcontactEnablerIdsthe list of Ids to retrieve
Returnosid.contact.rules.ContactEnablerListthe returned ContactEnabler list
ErrorsNOT_FOUNDan Id was not found
NULL_ARGUMENT contactEnablerIds is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetContactEnablersByGenusType
Description

Gets a ContactEnablerList corresponding to the given contact enabler genus Type which does not include contact enablers of genus types derived from the specified Type.

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.

Parametersosid.type.TypecontactEnablerGenusTypea contact enabler genus type
Returnosid.contact.rules.ContactEnablerListthe returned ContactEnabler list
ErrorsNULL_ARGUMENT contactEnablerGenusType is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetContactEnablersByParentGenusType
Description

Gets a ContactEnablerList corresponding to the given contact enabler genus Type and include any additional contact enablers with genus types derived from the specified Type.

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.

Parametersosid.type.TypecontactEnablerGenusTypea contact enabler genus type
Returnosid.contact.rules.ContactEnablerListthe returned ContactEnabler list
ErrorsNULL_ARGUMENT contactEnablerGenusType is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetContactEnablersByRecordType
Description

Gets a ContactEnablerList containing the given contact enabler record Type.

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.

Parametersosid.type.TypecontactEnablerRecordTypea contact enabler record type
Returnosid.contact.rules.ContactEnablerListthe returned ContactEnabler list
ErrorsNULL_ARGUMENT contactEnablerRecordType is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetContactEnablersOnDate
Description

Gets a ContactEnablerList which are effective for the entire given date range inclusive but not confined to the date range for any agent.

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.

Parametersosid.calendaring.DateTimefroma start date
osid.calendaring.DateTimetoan end date
Returnosid.contact.rules.ContactEnablerListthe returned ContactEnabler list
ErrorsINVALID_ARGUMENT from is greater than to
NULL_ARGUMENT from or to is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetContactEnablersOnDateWithAgent
Description

Gets a ContactEnablerList which are effective for the entire given date range inclusive but not confined to the date range and evaluated against the given agent.

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.

Parametersosid.id.IdagentIdan agent Id
osid.calendaring.DateTimefroma start date
osid.calendaring.DateTimetoan end date
Returnosid.contact.rules.ContactEnablerListthe returned ContactEnabler list
ErrorsINVALID_ARGUMENT from is greater than to
NULL_ARGUMENT agent, from, or to is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetContactEnablers
Description

Gets all ContactEnablers.

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.

Returnosid.contact.rules.ContactEnablerListthe returned ContactEnabler list
ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.