Interface IssueConstrainerQuerySession

All Superinterfaces:
AutoCloseable, Closeable, OsidSession, OsidSession
All Known Subinterfaces:
IssueConstrainerSearchSession
public interface IssueConstrainerQuerySession extends OsidSession

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

This session defines views that offer differing behaviors for searching.

  • federated oubliette view: searches include issue constrainers in oubliettes of which this oubliette is an ancestor in the oubliette hierarchy
  • isolated oubliette view: searches are restricted to issue constrainers in this oubliette

Issue constrainers may have a query record indicated by their respective record types. The query record is accessed via the IssueConstrainerQuery.

  • Method Details

    • getOublietteId

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

    • getOubliette

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

    • canSearchIssueConstrainers

      boolean canSearchIssueConstrainers()
      Tests if this user can perform IssueConstrai ner 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.

    • useFederatedOublietteView

      void useFederatedOublietteView()
      Federates the view for methods in this session. A federated view will include issue constrainers in oubliettes which are children of this oubliette in the oubliette hierarchy.
      Compliance:
      mandatory - This method is must be implemented.

    • useIsolatedOublietteView

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

    • getIssueConstrainerQuery

      IssueConstrainerQuery getIssueConstrainerQuery()
      Gets an issue constrainet query.
      Returns:
      the issue constrainer query
      Compliance:
      mandatory - This method must be implemented.

    • getIssueConstrainersByQuery

      IssueConstrainerList getIssueConstrainersByQuery(IssueConstrainerQuery issueConstrainerQuery) throws OperationFailedException, PermissionDeniedException
      Gets a list of IssueConstrainers matching the given search.
      Parameters:
      issueConstrainerQuery - the issue constrainer query
      Returns:
      the returned IssueConstrainerList
      Throws:
      NullArgumentException - issueConstrainerQuery is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      UnsupportedException - issueConstrainerQuery did not originate from getIssueConstrainerQuery()
      Compliance:
      mandatory - This method must be implemented.