Interface OfficeQuery

All Superinterfaces:
Extensible, OsidBrowsableQuery, OsidCatalogQuery, OsidExtensibleQuery, OsidFederateableQuery, OsidIdentifiableQuery, OsidObjectQuery, OsidQuery, OsidSourceableQuery, Suppliable
public interface OfficeQuery extends OsidCatalogQuery

This is the query for searching offices. Each method match specifies an AND term while multiple invocations of the same method produce a nested OR .

  • Method Details

    • matchProcessId

      void matchProcessId(Id processId, boolean match)
      Sets the step Id for this query to match offices containing process.
      Parameters:
      processId - the process Id
      match - true for a positive match, false for a negative match
      Throws:
      NullArgumentException - processId is null
      Compliance:
      mandatory - This method must be implemented.

    • clearProcessIdTerms

      void clearProcessIdTerms()
      Clears the process query terms.
      Compliance:
      mandatory - This method must be implemented.

    • supportsProcessQuery

      boolean supportsProcessQuery()
      Tests if a ProcessQuery is available.
      Returns:
      true if a process query is available, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • getProcessQuery

      ProcessQuery getProcessQuery()
      Gets the query for a process. Multiple retrievals produce a nested OR term.
      Returns:
      the process query
      Throws:
      UnimplementedException - supportsProcessQuery() is false
      Compliance:
      optional - This method must be implemented if {@code supportsProcessQuery()} is {@code true} .

    • matchAnyProcess

      void matchAnyProcess(boolean match)
      Matches offices that have any process.
      Parameters:
      match - true to match offices with any process, false to match offices with no process
      Compliance:
      mandatory - This method must be implemented.

    • clearProcessTerms

      void clearProcessTerms()
      Clears the process query terms.
      Compliance:
      mandatory - This method must be implemented.

    • matchStepId

      void matchStepId(Id stepId, boolean match)
      Sets the step Id for this query.
      Parameters:
      stepId - the step Id
      match - true for a positive match, false for a negative match
      Throws:
      NullArgumentException - stepId is null
      Compliance:
      mandatory - This method must be implemented.

    • clearStepIdTerms

      void clearStepIdTerms()
      Clears the step Id query terms.
      Compliance:
      mandatory - This method must be implemented.

    • supportsStepQuery

      boolean supportsStepQuery()
      Tests if a StepQuery is available.
      Returns:
      true if a step query is available, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • getStepQuery

      StepQuery getStepQuery()
      Gets the query for a step. Multiple retrievals produce a nested OR term.
      Returns:
      the step query
      Throws:
      UnimplementedException - supportsStepQuery() is false
      Compliance:
      optional - This method must be implemented if {@code supportsStepQuery()} is {@code true} .

    • matchAnyStep

      void matchAnyStep(boolean match)
      Matches offices with any step.
      Parameters:
      match - true to match offices with any step, false to match offices with no step
      Compliance:
      mandatory - This method must be implemented.

    • clearStepTerms

      void clearStepTerms()
      Clears the step query terms.
      Compliance:
      mandatory - This method must be implemented.

    • matchWorkId

      void matchWorkId(Id workId, boolean match)
      Sets the work Id for this query.
      Parameters:
      workId - the work Id
      match - true for a positive match, false for a negative match
      Throws:
      NullArgumentException - workId is null
      Compliance:
      mandatory - This method must be implemented.

    • clearWorkIdTerms

      void clearWorkIdTerms()
      Clears the work Id query terms.
      Compliance:
      mandatory - This method must be implemented.

    • supportsWorkQuery

      boolean supportsWorkQuery()
      Tests if a WorkQuery is available.
      Returns:
      true if a work query is available, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • getWorkQuery

      WorkQuery getWorkQuery()
      Gets the query for a work. Multiple retrievals produce a nested OR term.
      Returns:
      the work query
      Throws:
      UnimplementedException - supportsWorkQuery() is false
      Compliance:
      optional - This method must be implemented if {@code supportsWorkQuery()} is {@code true} .

    • matchAnyWork

      void matchAnyWork(boolean match)
      Matches offices that have any work.
      Parameters:
      match - true to match offices with any work, false to match offices with no process
      Compliance:
      mandatory - This method must be implemented.

    • clearWorkTerms

      void clearWorkTerms()
      Clears the work query terms.
      Compliance:
      mandatory - This method must be implemented.

    • matchAncestorOfficeId

      void matchAncestorOfficeId(Id officeId, boolean match)
      Sets the office Id for this query to match offices that have the specified office as an ancestor.
      Parameters:
      officeId - an office Id
      match - true for a positive match, false for a negative match
      Throws:
      NullArgumentException - officeId is null
      Compliance:
      mandatory - This method must be implemented.

    • clearAncestorOfficeIdTerms

      void clearAncestorOfficeIdTerms()
      Clears the ancestor office Id query terms.
      Compliance:
      mandatory - This method must be implemented.

    • supportsAncestorOfficeQuery

      boolean supportsAncestorOfficeQuery()
      Tests if an OfficeQuery is available.
      Returns:
      true if an office query is available, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • getAncestorOfficeQuery

      OfficeQuery getAncestorOfficeQuery()
      Gets the query for an office. Multiple retrievals produce a nested OR term.
      Returns:
      the office query
      Throws:
      UnimplementedException - supportsAncestorOfficeQuery() is false
      Compliance:
      optional - This method must be implemented if {@code supportsAncestorOfficeQuery()} is {@code true} .

    • matchAnyAncestorOffice

      void matchAnyAncestorOffice(boolean match)
      Matches offices with any ancestor.
      Parameters:
      match - true to match offices with any ancestor, false to match root offices
      Compliance:
      mandatory - This method must be implemented.

    • clearAncestorOfficeTerms

      void clearAncestorOfficeTerms()
      Clears the ancestor office query terms.
      Compliance:
      mandatory - This method must be implemented.

    • matchDescendantOfficeId

      void matchDescendantOfficeId(Id officeId, boolean match)
      Sets the office Id for this query to match offices that have the specified office as a descendant.
      Parameters:
      officeId - an office Id
      match - true for a positive match, false for a negative match
      Throws:
      NullArgumentException - officeId is null
      Compliance:
      mandatory - This method must be implemented.

    • clearDescendantOfficeIdTerms

      void clearDescendantOfficeIdTerms()
      Clears the descendant office Id query terms.
      Compliance:
      mandatory - This method must be implemented.

    • supportsDescendantOfficeQuery

      boolean supportsDescendantOfficeQuery()
      Tests if an OfficeQuery is available.
      Returns:
      true if an office query is available, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • getDescendantOfficeQuery

      OfficeQuery getDescendantOfficeQuery()
      Gets the query for an office. Multiple retrievals produce a nested OR term.
      Returns:
      the office query
      Throws:
      UnimplementedException - supportsDescendantOfficeQuery() is false
      Compliance:
      optional - This method must be implemented if {@code supportsDescendantOfficeQuery()} is {@code true} .

    • matchAnyDescendantOffice

      void matchAnyDescendantOffice(boolean match)
      Matches offices with any descendant.
      Parameters:
      match - true to match offices with any descendant, false to match leaf offices
      Compliance:
      mandatory - This method must be implemented.

    • clearDescendantOfficeTerms

      void clearDescendantOfficeTerms()
      Clears the descendant office query terms.
      Compliance:
      mandatory - This method must be implemented.

    • getOfficeQueryRecord

      OfficeQueryRecord getOfficeQueryRecord(Type officeRecordType) throws OperationFailedException
      Gets the office query corresponding to the given Office record Type .Multiple record retrievals produce a nested OR term.
      Parameters:
      officeRecordType - an office record type
      Returns:
      the office query record
      Throws:
      NullArgumentException - officeRecordType is null
      OperationFailedException - unable to complete request
      UnsupportedException - hasRecordType(officeRecordType) is false
      Compliance:
      mandatory - This method must be implemented.