Interface MyWorkSession

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

This session defines methods for retrieving work for the resource related to the authenticated agent.

This lookup session defines several views:

  • effective work view: All lookup methods return availabilities, efforts and commissions where the current date falls in between the effective dates inclusive.
  • any effective work view: Availabilities, efforts and commissions of any effective date are returned from 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.

    • canLookupMyWork

      boolean canLookupMyWork()
      Tests if this user can perform Availability 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 not offer lookup operations to unauthorized users.
      Returns:
      false if lookup methods are not authorized, true otherwise
      Compliance:
      mandatory - This method must be implemented.

    • useEffectiveWorkView

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

    • useAnyEffectiveWorkView

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

    • getMyAvailabilities

      AvailabilityList getMyAvailabilities() throws OperationFailedException, PermissionDeniedException
      Gets the availabilities for the resource related to this agent.
      Returns:
      the returned AvailabilityList
      Throws:
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • getMyCommissions

      CommissionList getMyCommissions() throws OperationFailedException, PermissionDeniedException
      Gets the commissions for the resource related to this agent.
      Returns:
      the returned Commission list
      Throws:
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • getMyEfforts

      EffortList getMyEfforts() throws OperationFailedException, PermissionDeniedException
      Gets the efforts for the resource related to this agent.
      Returns:
      the returned Effort list
      Throws:
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • getMyJobs

      JobList getMyJobs() throws OperationFailedException, PermissionDeniedException
      Gets the jobs for the resource related to this agent.
      Returns:
      the returned Job list
      Throws:
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.