Interface EffortQuerySession

All Superinterfaces:
AutoCloseable, Closeable, OsidSession, OsidSession
All Known Subinterfaces:
EffortSearchSession
public interface EffortQuerySession extends OsidSession

This session provides methods for searching among Effort objects. The search query is constructed using the EffortQuery.

This session defines views that offer differing behaviors for searching.

  • federated foundry view: searches include efforts in foundries of which this foundry is an ancestor in the foundry hierarchy
  • isolated foundry view: searches are restricted to efforts in this foundry

Efforts may have a query record indicated by their respective record types. The query record is accessed via the EffortQuery.

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

    • canSearchEfforts

      boolean canSearchEfforts()
      Tests if this user can perform Effort 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 search methods are not authorized, true otherwise
      Compliance:
      mandatory - This method must be implemented.

    • useFederatedFoundryView

      void useFederatedFoundryView()
      Federates the view for methods in this session. A federated view will include efforts 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 searches to this foundry only.
      Compliance:
      mandatory - This method is must be implemented.

    • getEffortQuery

      EffortQuery getEffortQuery()
      Gets an effort query.
      Returns:
      the effort query
      Compliance:
      mandatory - This method must be implemented.

    • getEffortsByQuery

      EffortList getEffortsByQuery(EffortQuery effortQuery) throws OperationFailedException, PermissionDeniedException
      Gets a list of Efforts matching the given effort query.
      Parameters:
      effortQuery - the effort query
      Returns:
      the returned EffortList
      Throws:
      NullArgumentException - effortQuery is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      UnsupportedException - effortQuery is not of this service
      Compliance:
      mandatory - This method must be implemented.