Interface CommitmentEnablerLookupSession

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

This session provides methods for retrieving CommitmentEnablers .

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 calendar view: All commitment enabler methods in this session operate, retrieve and pertain to commitment enablers defined explicitly in the current calendar. Using an isolated view is useful for managing CommitmentEnablers with the CommitmentEnablerAdminSession .
  • federated calendar view: All commitment enabler methods in this session operate, retrieve and pertain to all commitment enablers defined in this calendar and any other commitment enablers implicitly available in this calendar through calendar inheritence.
  • active commitment enabler view: All commitment enabler lookup methods return active commitment enablers.
  • any status commitment enabler view: Commitment 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

    • getCalendarId

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

    • getCalendar

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

    • canLookupCommitmentEnablers

      boolean canLookupCommitmentEnablers()
      Tests if this user can perform CommitmentEnablers 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.

    • useComparativeCommitmentEnablerView

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

    • usePlenaryCommitmentEnablerView

      void usePlenaryCommitmentEnablerView()
      A complete view of the CommitmentEnabler 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.

    • useFederatedCalendarView

      void useFederatedCalendarView()
      Federates the view for methods in this session. A federated view will include commitment enablers in calendars which are children of this calendar in the calendar hierarchy.
      Compliance:
      mandatory - This method is must be implemented.

    • useIsolatedCalendarView

      void useIsolatedCalendarView()
      Isolates the view for methods in this session. An isolated view restricts lookups to this calendar only.
      Compliance:
      mandatory - This method is must be implemented.

    • useActiveCommitmentEnablerView

      void useActiveCommitmentEnablerView()
      Only active commitment enablers are returned by methods in this session.
      Compliance:
      mandatory - This method is must be implemented.

    • useAnyStatusCommitmentEnablerView

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

    • getCommitmentEnabler

      CommitmentEnabler getCommitmentEnabler(Id commitmentEnablerId) throws NotFoundException, OperationFailedException, PermissionDeniedException
      Gets the CommitmentEnabler specified by its Id . In plenary mode, the exact Id is found or a NOT_FOUND results. Otherwise, the returned CommitmentEnabler may have a different Id than requested, such as the case where a duplicate Id was assigned to a CommitmentEnabler and retained for compatibility. In active mode, commitment enablers are returned that are currently active. In any status mode, active and inactive commitment enablers are returned.
      Parameters:
      commitmentEnablerId - Id of the CommitmentEnabler
      Returns:
      the commitment enabler
      Throws:
      NotFoundException - commitmentEnablerId not found
      NullArgumentException - commitmentEnablerId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method is must be implemented.

    • getCommitmentEnablersByIds

      CommitmentEnablerList getCommitmentEnablersByIds(IdList commitmentEnablerIds) throws NotFoundException, OperationFailedException, PermissionDeniedException
      Gets a CommitmentEnablerList corresponding to the given IdList . In plenary mode, the returned list contains all of the commitment 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 CommitmentEnablers may be omitted from the list and may present the elements in any order including returning a unique set. In active mode, commitment enablers are returned that are currently active. In any status mode, active and inactive commitment enablers are returned.
      Parameters:
      commitmentEnablerIds - the list of Ids to retrieve
      Returns:
      the returned CommitmentEnabler list
      Throws:
      NotFoundException - an Id was not found
      NullArgumentException - commitmentEnablerIds is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • getCommitmentEnablersByGenusType

      CommitmentEnablerList getCommitmentEnablersByGenusType(Type commitmentEnablerGenusType) throws OperationFailedException, PermissionDeniedException
      Gets a CommitmentEnablerList corresponding to the given commitment enabler genus Type which does not include commitment enablers of genus types derived from the specified Type . In plenary mode, the returned list contains all known commitment enablers or an error results. Otherwise, the returned list may contain only those commitment enablers that are accessible through this session. In active mode, commitment enablers are returned that are currently active. In any status mode, active and inactive commitment enablers are returned.
      Parameters:
      commitmentEnablerGenusType - a commitment enabler genus type
      Returns:
      the returned CommitmentEnabler list
      Throws:
      NullArgumentException - commitmentEnablerGenusType is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • getCommitmentEnablersByParentGenusType

      CommitmentEnablerList getCommitmentEnablersByParentGenusType(Type commitmentEnablerGenusType) throws OperationFailedException, PermissionDeniedException
      Gets a CommitmentEnablerList corresponding to the given commitment enabler genus Type and include any additional commitment enablers with genus types derived from the specified Type . In plenary mode, the returned list contains all known commitment enablers or an error results. Otherwise, the returned list may contain only those commitment enablers that are accessible through this session. In active mode, commitment enablers are returned that are currently active. In any status mode, active and inactive commitment enablers are returned.
      Parameters:
      commitmentEnablerGenusType - a commitment enabler genus type
      Returns:
      the returned CommitmentEnabler list
      Throws:
      NullArgumentException - commitmentEnablerGenusType is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • getCommitmentEnablersByRecordType

      CommitmentEnablerList getCommitmentEnablersByRecordType(Type commitmentEnablerRecordType) throws OperationFailedException, PermissionDeniedException
      Gets a CommitmentEnablerList containing the given commitment enabler record Type . In plenary mode, the returned list contains all known commitment enablers or an error results. Otherwise, the returned list may contain only those commitment enablers that are accessible through this session. In effective mode, commitments are returned that are currently effective. In any effective mode, effective commitments and those currently expired are returned.
      Parameters:
      commitmentEnablerRecordType - a commitment enabler record type
      Returns:
      the returned CommitmentEnabler list
      Throws:
      NullArgumentException - commitmentEnablerRecordType is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • getCommitmentEnablersOnDate

      CommitmentEnablerList getCommitmentEnablersOnDate(DateTime from, DateTime to) throws OperationFailedException, PermissionDeniedException
      Gets a CommitmentEnablerList effective during 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 commitment enablers or an error results. Otherwise, the returned list may contain only those commitment enablers that are accessible through this session. In active mode, commitment enablers are returned that are currently active in addition to being effective during the given date range. In any status mode, active and inactive commitment enablers are returned.
      Parameters:
      from - a start date
      to - an end date
      Returns:
      the returned CommitmentEnabler 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.

    • getCommitmentEnablersOnDateWithAgent

      CommitmentEnablerList getCommitmentEnablersOnDateWithAgent(Id agentId, DateTime from, DateTime to) throws OperationFailedException, PermissionDeniedException
      Gets a CommitmentEnablerList effective during the entire given date range inclusive but not confined to the date range evaluated against the given agent. In plenary mode, the returned list contains all known commitment enablers or an error results. Otherwise, the returned list may contain only those commitment enablers that are accessible through this session. In active mode, commitment enablers are returned that are currently active in addition to being effective during the given date range. In any status mode, active and inactive commitment enablers are returned.
      Parameters:
      agentId - an agent Id
      from - a start date
      to - an end date
      Returns:
      the returned CommitmentEnabler 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.

    • getCommitmentEnablers

      CommitmentEnablerList getCommitmentEnablers() throws OperationFailedException, PermissionDeniedException
      Gets all CommitmentEnablers . In plenary mode, the returned list contains all known commitment enablers or an error results. Otherwise, the returned list may contain only those commitment enablers that are accessible through this session. In active mode, commitment enablers are returned that are currently active. In any status mode, active and inactive commitment enablers are returned.
      Returns:
      the returned CommitmentEnabler list
      Throws:
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.