Interface CommissionEnablerRuleLookupSession

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

This session provides methods to retrieve CommissionEnabler to Commission mappings. A Commission with multiple CommissionEnablers means any positive rule evaluation across the enablers result in an accessible Commission .

This lookup session defines several views:

  • comparative view: elements may be silently omitted or re-ordered
  • plenary view: provides a complete result set or is an error condition
  • isolated foundry view: All methods in this session operate, retrieve and pertain commission enabler defined explicitly in the current foundry
  • federated foundry view: All 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.

  • 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.

    • canLookupCommissionEnablerRules

      boolean canLookupCommissionEnablerRules()
      Tests if this user can perform lookups of commission enabler/commission mappings. A return of true does not guarantee successful authorization. A return of false indicates that it is known lookup 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 looking up mappings is not authorized, true otherwise
      Compliance:
      mandatory - This method must be implemented.

    • useComparativeCommissionEnablerRuleView

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

    • usePlenaryCommissionEnablerRuleView

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

    • getCommissionEnablerIdsForCommission

      IdList getCommissionEnablerIdsForCommission(Id commissionId) throws NotFoundException, OperationFailedException, PermissionDeniedException
      Gets the CommissionEnabler Id associated with a Commission .
      Parameters:
      commissionId - Id of the Commission
      Returns:
      the commission enabler Ids
      Throws:
      NotFoundException - commissionId is not found
      NullArgumentException - commissionId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • getCommissionEnablersForCommission

      CommissionEnablerList getCommissionEnablersForCommission(Id commissionId) throws NotFoundException, OperationFailedException, PermissionDeniedException
      Gets the CommissionEnabler associated with a Commission .
      Parameters:
      commissionId - Id of the Commission
      Returns:
      the commission enablers
      Throws:
      NotFoundException - commissionId is not found
      NullArgumentException - commissionId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • getCommissionIdsForCommissionEnabler

      IdList getCommissionIdsForCommissionEnabler(Id commissionEnablerId) throws NotFoundException, OperationFailedException, PermissionDeniedException
      Gets the Commission Ids mapped to a CommissionEnabler .
      Parameters:
      commissionEnablerId - Id of a CommissionEnabler
      Returns:
      list of commission Ids
      Throws:
      NotFoundException - commissionEnablerId is not found
      NullArgumentException - commissionEnablerId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • getCommissionsForCommissionEnabler

      CommissionList getCommissionsForCommissionEnabler(Id commissionEnablerId) throws NotFoundException, OperationFailedException, PermissionDeniedException
      Gets the Commissions mapped to a CommissionEnabler .
      Parameters:
      commissionEnablerId - Id of a CommissionEnabler
      Returns:
      list of commissions
      Throws:
      NotFoundException - commissionEnablerId is not found
      NullArgumentException - commissionEnablerId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.