Interface ActivityQuerySession

All Superinterfaces:
AutoCloseable, Closeable, OsidSession, OsidSession
All Known Subinterfaces:
ActivitySearchSession
public interface ActivityQuerySession extends OsidSession

This session provides methods for searching among Activities. The search query is constructed using the ActivityQuery.

This session defines views that offer differing behaviors for searching.

  • federated business view: searches include activities in businesses of which this business is an ancestor in the business hierarchy
  • isolated business view: searches are restricted to activities in this business

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

  • Method Details

    • getBusinessId

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

    • getBusiness

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

    • canSearchActivities

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

    • useFederatedBusinessView

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

    • useIsolatedBusinessView

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

    • getActivityQuery

      ActivityQuery getActivityQuery()
      Gets an activity query.
      Returns:
      the activity query
      Compliance:
      mandatory - This method must be implemented.

    • getActivitiesByQuery

      ActivityList getActivitiesByQuery(ActivityQuery activityQuery) throws OperationFailedException, PermissionDeniedException
      Gets a list of Activities matching the given activity query.
      Parameters:
      activityQuery - the activity query
      Returns:
      the returned ActivityList
      Throws:
      NullArgumentException - activityQuery is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      UnsupportedException - activityQuery is not of this service
      Compliance:
      mandatory - This method must be implemented.