Interface EntryQuerySession

All Superinterfaces:
AutoCloseable, Closeable, OsidSession, OsidSession
All Known Subinterfaces:
EntrySearchSession
public interface EntryQuerySession extends OsidSession

This session provides methods for searching among Entries. The search query is constructed using the EntryQuery.

This session defines views that offer differing behaviors for searching.

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

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

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

    • canSearchEntries

      boolean canSearchEntries()
      Tests if this user can perform Entry 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 entries 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.

    • getEntryQuery

      EntryQuery getEntryQuery()
      Gets an entry query.
      Returns:
      the entry query
      Compliance:
      mandatory - This method must be implemented.

    • getEntriesByQuery

      EntryList getEntriesByQuery(EntryQuery entryQuery) throws OperationFailedException, PermissionDeniedException
      Gets a list of Entries matching the given entry query.
      Parameters:
      entryQuery - the entry query
      Returns:
      the returned EntryList
      Throws:
      NullArgumentException - entryQuery is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      UnsupportedException - entryQuery is not of this service
      Compliance:
      mandatory - This method must be implemented.