Interface ProjectQuerySession

All Superinterfaces:
AutoCloseable, Closeable, OsidSession, OsidSession
All Known Subinterfaces:
ProjectSearchSession
public interface ProjectQuerySession extends OsidSession

This session provides methods for searching Projects. The search query is constructed using the ProjectQuery. The project record Type also specifies the record for the project query.

Projects may have a query record indicated by their respective record types. The query record is accessed via the ProjectQuery. The returns in this session may not be cast directly to these interfaces.

  • Method Details

    • getCampusId

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

    • getCampus

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

    • canSearchProjects

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

    • useFederatedCampusView

      void useFederatedCampusView()
      Federates the view for methods in this session. A federated view will include projects in campuses which are children of this campus in the campus hierarchy.
      Compliance:
      mandatory - This method is must be implemented.

    • useIsolatedCampusView

      void useIsolatedCampusView()
      Isolates the view for methods in this session. An isolated view restricts retrievals to this campus only.
      Compliance:
      mandatory - This method is must be implemented.

    • getProjectQuery

      ProjectQuery getProjectQuery()
      Gets a project query.
      Returns:
      the project query
      Compliance:
      mandatory - This method must be implemented.

    • getProjectsByQuery

      ProjectList getProjectsByQuery(ProjectQuery projectQuery) throws OperationFailedException, PermissionDeniedException
      Gets a list of Projects matching the given project query.
      Parameters:
      projectQuery - the project query
      Returns:
      the returned ProjectList
      Throws:
      NullArgumentException - projectQuery is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      UnsupportedException - ProjectQuery is not of this service
      Compliance:
      mandatory - This method must be implemented.