Interface CommissionEnablerLookupSession

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

This session provides methods for retrieving CommissionEnablers .

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 foundry view: All commission enabler methods in this session operate, retrieve and pertain to commission enabler defined explicitly in the current foundry. Using an isolated view is useful for managing CommissionEnablers with the CommissionEnablerAdminSession .
  • federated foundry view: All commission enabler methods in this session operate, retrieve and pertain to all commission enabler defined in this foundry and any other commission enabler implicitly available in this foundry through foundry inheritence.
  • active commission enabler view: All commission enabler lookup methods return active commission enablers.
  • any status commission enabler view: Commission 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 useFederatedFoundryView() and useIsolatedFoundryView() behave as a radio group and one should be selected before invoking the methods in this session.

  • Method Details

    • getFoundryId

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

    • getFoundry

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

    • canLookupCommissionEnablers

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

    • useComparativeCommissionEnablerView

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

    • usePlenaryCommissionEnablerView

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

    • useFederatedFoundryView

      void useFederatedFoundryView()
      Federates the view for methods in this session. A federated view will include commission enabler in foundries which are children of this foundry in the foundry hierarchy.
      Compliance:
      mandatory - This method is must be implemented.

    • useIsolatedFoundryView

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

    • useActiveCommissionEnablerView

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

    • useAnyStatusCommissionEnablerView

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

    • getCommissionEnabler

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

    • getCommissionEnablersByIds

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

    • getCommissionEnablersByGenusType

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

    • getCommissionEnablersByParentGenusType

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

    • getCommissionEnablersByRecordType

      CommissionEnablerList getCommissionEnablersByRecordType(Type commissionEnablerRecordType) throws OperationFailedException, PermissionDeniedException
      Gets a CommissionEnablerList containing the given commission enabler record Type . In plenary mode, the returned list contains all known commission enabler or an error results. Otherwise, the returned list may contain only those commission enabler that are accessible through this session. In active mode, commission enablers are returned that are currently active. In any status mode, active and inactive commission enablers are returned.
      Parameters:
      commissionEnablerRecordType - a commission enabler record type
      Returns:
      the returned CommissionEnabler list
      Throws:
      NullArgumentException - commissionEnablerRecordTYpe is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • getCommissionEnablersOnDate

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

    • getCommissionEnablersOnDateWithAgent

      CommissionEnablerList getCommissionEnablersOnDateWithAgent(Id agentId, DateTime from, DateTime to) throws OperationFailedException, PermissionDeniedException
      Gets a CommissionEnablerList that are effective for the entire given date range inclusive but not confined to the date range and evaluated againstthe given agent. In plenary mode, the returned list contains all known commission enablers or an error results. Otherwise, the returned list may contain only those commission enablers that are accessible through this session. In active mode, commission enablers are returned that are currently active in addition to being effective during the given date range. In any status mode, active and inactive commission enablers are returned.
      Parameters:
      agentId - an agent Id
      from - a start date
      to - an end date
      Returns:
      the returned CommissionEnabler list
      Throws:
      InvalidArgumentException - from is greater than to
      NullArgumentException - agentId, from , or to is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • getCommissionEnablers

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