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 .

  • Method Details

    • getDictionaryId

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

    • getDictionary

      Dictionary getDictionary() throws OperationFailedException, PermissionDeniedException
      Gets the Dictionary associated with this session.
      Returns:
      the Dictionary associated with this session
      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 dictionary entry 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.

    • useFederatedDictionaryView

      void useFederatedDictionaryView()
      Federates the view for methods in this session. A federated view will include entries from descendant dictionaries in the catalog hierarchy.
      Compliance:
      mandatory - This method is must be implemented.

    • useIsolatedDictionaryView

      void useIsolatedDictionaryView()
      Isolates the view for methods in this session. An isolated view restricts notifications for entries to this dictionary 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 Entry elements matching the given search.
      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.