Interface CommissionLookupSession

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

This session provides methods for retrieving Commission relationships.

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 methods in this session operate, retrieve and pertain to commissions defined explicitly in the current foundry. Using an isolated view is useful for managing Commissions with the CommissionAdminSession .
  • federated foundry view: All commission methods in this session operate, retrieve and pertain to all commissions defined in this foundry and any other commissions implicitly available in this foundry through foundry inheritence.
  • effective commission view: All commission lookup methods return commissions where the current date falls in between the effective dates inclusive.
  • any effective commission view: Commissions of any effective date 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 any lookup methods.

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

    • canLookupCommissions

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

    • useComparativeCommissionView

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

    • usePlenaryCommissionView

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

    • useEffectiveCommissionView

      void useEffectiveCommissionView()
      Only commissions whose effective dates are current are returned by methods in this session.
      Compliance:
      mandatory - This method is must be implemented.

    • useAnyEffectiveCommissionView

      void useAnyEffectiveCommissionView()
      All commissions of any effective dates are returned by methods in this session.
      Compliance:
      mandatory - This method is must be implemented.

    • getCommission

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

    • getCommissionsByIds

      CommissionList getCommissionsByIds(IdList commissionIds) throws NotFoundException, OperationFailedException, PermissionDeniedException
      Gets a CommissionList corresponding to the given IdList . In plenary mode, the returned list contains all of the commissions 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 Commissions may be omitted from the list and may present the elements in any order including returning a unique set. In effective mode, commissions are returned that are currently effective. In any effective mode, effective commissions and those currently expired are returned.
      Parameters:
      commissionIds - the list of Ids to retrieve
      Returns:
      the returned Commission list
      Throws:
      NotFoundException - an Id was not found
      NullArgumentException - commissionIds is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • getCommissionsByGenusType

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

    • getCommissionsByParentGenusType

      CommissionList getCommissionsByParentGenusType(Type commissionGenusType) throws OperationFailedException, PermissionDeniedException
      Gets a CommissionList corresponding to the given commission genus Type and include any additional commissions with genus types derived from the specified Type . In plenary mode, the returned list contains all known commissions or an error results. Otherwise, the returned list may contain only those commissions that are accessible through this session. In both cases, the order of the set is by the start effective date. In effective mode, commissions are returned that are currently effective. In any effective mode, effective commissions and those currently expired are returned.
      Parameters:
      commissionGenusType - a commission genus type
      Returns:
      the returned Commission list
      Throws:
      NullArgumentException - commissionGenusType is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • getCommissionsByRecordType

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

    • getCommissionsOnDate

      CommissionList getCommissionsOnDate(DateTime from, DateTime to) throws OperationFailedException, PermissionDeniedException
      Gets a list of commissions effective during the entire given date range inclusive but not confined to the date range. In plenary mode, the returned list contains all known commissions or an error results. Otherwise, the returned list may contain only those commissions that are accessible through this session. In effective mode, commissions are returned that are currently effective. In any effective mode, effective commissions and those currently expired are returned.
      Parameters:
      from - start of date range
      to - end of date range
      Returns:
      the returned Commission 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.

    • getCommissionsForResource

      CommissionList getCommissionsForResource(Id resourceId) throws OperationFailedException, PermissionDeniedException
      Gets a list of commissions for a resource. In plenary mode, the returned list contains all known commissions or an error results. Otherwise, the returned list may contain only those commissions that are accessible through this session. In effective mode, commissions are returned that are currently effective. In any effective mode, effective commissions and those currently expired are returned.
      Parameters:
      resourceId - a resource Id
      Returns:
      the returned Commission list
      Throws:
      NullArgumentException - resourceId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • getCommissionsForResourceOnDate

      CommissionList getCommissionsForResourceOnDate(Id resourceId, DateTime from, DateTime to) throws OperationFailedException, PermissionDeniedException
      Gets a list of commissions for a resource and effective during the entire given date range inclusive but not confined to the date range. In plenary mode, the returned list contains all known commissions or an error results. Otherwise, the returned list may contain only those commissions that are accessible through this session. In effective mode, commissions are returned that are currently effective. In any effective mode, effective commissions and those currently expired are returned.
      Parameters:
      resourceId - a resource Id
      from - start of date range
      to - end of date range
      Returns:
      the returned Commission list
      Throws:
      InvalidArgumentException - from is greater than to
      NullArgumentException - resourceId, from or to is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • getCommissionsForWork

      CommissionList getCommissionsForWork(Id workId) throws OperationFailedException, PermissionDeniedException
      Gets a list of commissions for a work. In plenary mode, the returned list contains all known commissions or an error results. Otherwise, the returned list may contain only those commissions that are accessible through this session. In effective mode, commissions are returned that are currently effective. In any effective mode, effective commissions and those currently expired are returned.
      Parameters:
      workId - a work Id
      Returns:
      the returned C ommission list
      Throws:
      NullArgumentException - workId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • getCommissionsForWorkOnDate

      CommissionList getCommissionsForWorkOnDate(Id workId, DateTime from, DateTime to) throws OperationFailedException, PermissionDeniedException
      Gets a list of commissions for a work and effective during the entire given date range inclusive but not confined to the date range. In plenary mode, the returned list contains all known commissions or an error results. Otherwise, the returned list may contain only those commissions that are accessible through this session. In effective mode, commissions are returned that are currently effective. In any effective mode, effective commissions and those currently expired are returned.
      Parameters:
      workId - a work Id
      from - start of date range
      to - end of date range
      Returns:
      the returned C ommission list
      Throws:
      InvalidArgumentException - from is greater than to
      NullArgumentException - workId, from or to is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • getCommissionsForResourceAndWork

      CommissionList getCommissionsForResourceAndWork(Id resourceId, Id workId) throws OperationFailedException, PermissionDeniedException
      Gets a list of commissions for a resource and work. In plenary mode, the returned list contains all known commissions or an error results. Otherwise, the returned list may contain only those commissions that are accessible through this session. In effective mode, commissions are returned that are currently effective. In any effective mode, effective commissions and those currently expired are returned.
      Parameters:
      resourceId - a resource Id
      workId - a work Id
      Returns:
      the returned C ommission list
      Throws:
      NullArgumentException - resourceId or workId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • getCommissionsForResourceAndWorkOnDate

      CommissionList getCommissionsForResourceAndWorkOnDate(Id resourceId, Id workId, DateTime from, DateTime to) throws OperationFailedException, PermissionDeniedException
      Gets a list of commissions for a resource and work and effective during the entire given date range inclusive but not confined to the date range. In plenary mode, the returned list contains all known commissions or an error results. Otherwise, the returned list may contain only those commissions that are accessible through this session. In effective mode, commissions are returned that are currently effective. In any effective mode, effective commissions and those currently expired are returned.
      Parameters:
      resourceId - a resource Id
      workId - a work Id
      from - start of date range
      to - end of date range
      Returns:
      the returned C ommission list
      Throws:
      InvalidArgumentException - from is greater than to
      NullArgumentException - resourceId, workId, from or to is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • getCommissions

      CommissionList getCommissions() throws OperationFailedException, PermissionDeniedException
      Gets all Commissions . In plenary mode, the returned list contains all known commissions or an error results. Otherwise, the returned list may contain only those commissions that are accessible through this session. In effective mode, commissions are returned that are currently effective. In any effective mode, effective commissions and those currently expired are returned.
      Returns:
      a list of Commissions
      Throws:
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.