Interface ContactEnablerLookupSession

All Superinterfaces:
AutoCloseable, Closeable, OsidSession, OsidSession
public interface ContactEnablerLookupSession extends OsidSession

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.

  • Method Details

    • getAddressBookId

      Id getAddressBookId()
      Gets the AddressBook Id associated with this session.
      Returns:
      the AddressBook Id associated with this session
      Compliance:
      mandatory - This method must be implemented.

    • getAddressBook

      AddressBook getAddressBook() throws OperationFailedException, PermissionDeniedException
      Gets the AddressBook associated with this session.
      Returns:
      the address book
      Throws:
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • canLookupContactEnablers

      boolean canLookupContactEnablers()
      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.
      Returns:
      false if lookup methods are not authorized, true otherwise
      Compliance:
      mandatory - This method must be implemented.

    • useComparativeContactEnablerView

      void useComparativeContactEnablerView()
      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.

    • usePlenaryContactEnablerView

      void usePlenaryContactEnablerView()
      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.
      Compliance:
      mandatory - This method is must be implemented.

    • useFederatedAddressBookView

      void useFederatedAddressBookView()
      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.

    • useIsolatedAddressBookView

      void useIsolatedAddressBookView()
      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.

    • useActiveContactEnablerView

      void useActiveContactEnablerView()
      Only actuve contact enablers are returned by methods in this session.
      Compliance:
      mandatory - This method is must be implemented.

    • useAnyStatusContactEnablerView

      void useAnyStatusContactEnablerView()
      All active and inactive contact enablers are returned by methods in this session.
      Compliance:
      mandatory - This method is must be implemented.

    • getContactEnabler

      ContactEnabler getContactEnabler(Id contactEnablerId) throws NotFoundException, OperationFailedException, PermissionDeniedException
      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.
      Parameters:
      contactEnablerId - Id of the ContactEnabler
      Returns:
      the contact enabler
      Throws:
      NotFoundException - contactEnablerId not found
      NullArgumentException - contactEnablerId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method is must be implemented.

    • getContactEnablersByIds

      ContactEnablerList getContactEnablersByIds(IdList contactEnablerIds) throws NotFoundException, OperationFailedException, PermissionDeniedException
      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.
      Parameters:
      contactEnablerIds - the list of Ids to retrieve
      Returns:
      the returned ContactEnabler list
      Throws:
      NotFoundException - an Id was not found
      NullArgumentException - contactEnablerIds is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • getContactEnablersByGenusType

      ContactEnablerList getContactEnablersByGenusType(Type contactEnablerGenusType) throws OperationFailedException, PermissionDeniedException
      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.
      Parameters:
      contactEnablerGenusType - a contact enabler genus type
      Returns:
      the returned ContactEnabler list
      Throws:
      NullArgumentException - contactEnablerGenusType is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • getContactEnablersByParentGenusType

      ContactEnablerList getContactEnablersByParentGenusType(Type contactEnablerGenusType) throws OperationFailedException, PermissionDeniedException
      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.
      Parameters:
      contactEnablerGenusType - a contact enabler genus type
      Returns:
      the returned ContactEnabler list
      Throws:
      NullArgumentException - contactEnablerGenusType is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • getContactEnablersByRecordType

      ContactEnablerList getContactEnablersByRecordType(Type contactEnablerRecordType) throws OperationFailedException, PermissionDeniedException
      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.
      Parameters:
      contactEnablerRecordType - a contact enabler record type
      Returns:
      the returned ContactEnabler list
      Throws:
      NullArgumentException - contactEnablerRecordType is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • getContactEnablersOnDate

      ContactEnablerList getContactEnablersOnDate(DateTime from, DateTime to) throws OperationFailedException, PermissionDeniedException
      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.
      Parameters:
      from - a start date
      to - an end date
      Returns:
      the returned ContactEnabler list
      Throws:
      InvalidArgumentException - from is greater than to
      NullArgumentException - from or to is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • getContactEnablersOnDateWithAgent

      ContactEnablerList getContactEnablersOnDateWithAgent(Id agentId, DateTime from, DateTime to) throws OperationFailedException, PermissionDeniedException
      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.
      Parameters:
      agentId - an agent Id
      from - a start date
      to - an end date
      Returns:
      the returned ContactEnabler list
      Throws:
      InvalidArgumentException - from is greater than to
      NullArgumentException - agent, from , or to is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • getContactEnablers

      ContactEnablerList getContactEnablers() throws OperationFailedException, PermissionDeniedException
      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.
      Returns:
      the returned ContactEnabler list
      Throws:
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.