Interface MyHoldSession

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

This session defines methods for retrieving holds pertaining to the authenticated agent.

This lookup session defines several views:

  • isolated oubliette view: All hold methods in this session operate, retrieve and pertain to holds defined explicitly in the current oubliette.
  • federated oubliette view: All hold lookup methods holds this session operate, retrieve and pertain to all holds defined in this oubliette and any other availabilities implicitly available in this oubliette through oubliette inheritence.
  • effective work view: All lookup methods return holds where the current date falls in between the effective dates inclusive.
  • any effective work view: Holds of any effective date are returned from methods.

The methods useFederatedOublietteView() and useIsolatedOublietteView() behave as a radio group and one should be selected before invoking any lookup methods.

  • Method Details

    • getOublietteId

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

    • getOubliette

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

    • canLookupMyHolds

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

    • useFederatedOublietteView

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

    • useIsolatedOublietteView

      void useIsolatedOublietteView()
      Isolates the view for methods in this session. An isolated view restricts retrievals to this oubliette only.
      Compliance:
      mandatory - This method is 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.

    • getMyHolds

      HoldList getMyHolds() throws OperationFailedException, PermissionDeniedException
      Gets all the holds associated with the authenticated agent.
      Returns:
      the returned HoldList
      Throws:
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • getMyHoldsForIssue

      HoldList getMyHoldsForIssue(Id issueId) throws OperationFailedException, PermissionDeniedException
      Gets all the holds associated with the authenticated agent for the given issue.
      Parameters:
      issueId - an issue Id
      Returns:
      the returned Hold list
      Throws:
      NullArgumentException - issueId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • getMyHoldsForBlock

      HoldList getMyHoldsForBlock(Id blockId) throws OperationFailedException, PermissionDeniedException
      Gets all the holds associated with the authenticated agent for the given block.
      Parameters:
      blockId - a block Id
      Returns:
      the returned Hold list
      Throws:
      NullArgumentException - blockId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.