Interface RealmQuery

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

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

  • Method Details

    • matchPersonId

      void matchPersonId(Id personId, boolean match)
      Sets the person Id for this query to match persons assigned to realms.
      Parameters:
      personId - a person Id
      match - true for a positive match, false for a negative match
      Throws:
      NullArgumentException - personId is null
      Compliance:
      mandatory - This method must be implemented.

    • clearPersonIdTerms

      void clearPersonIdTerms()
      Clears all person Id terms.
      Compliance:
      mandatory - This method must be implemented.

    • supportsPersonQuery

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

    • getPersonQuery

      PersonQuery getPersonQuery()
      Gets the query for a person.
      Returns:
      the person query
      Throws:
      UnimplementedException - supportsPersonQuery() is false
      Compliance:
      optional - This method must be implemented if {@code supportsPersonQuery()} is {@code true} .

    • matchAnyPerson

      void matchAnyPerson(boolean match)
      Matches realms with any person.
      Parameters:
      match - true to match realms with any person, false to match realms with no persons
      Compliance:
      mandatory - This method must be implemented.

    • clearPersonTerms

      void clearPersonTerms()
      Clears all person terms.
      Compliance:
      mandatory - This method must be implemented.

    • matchOrganizationId

      void matchOrganizationId(Id organizationId, boolean match)
      Sets the organization Id for this query to match organizations assigned to realms.
      Parameters:
      organizationId - an organization Id
      match - true for a positive match, false for a negative match
      Throws:
      NullArgumentException - organizationId is null
      Compliance:
      mandatory - This method must be implemented.

    • clearOrganizationIdTerms

      void clearOrganizationIdTerms()
      Clears all organization Id terms.
      Compliance:
      mandatory - This method must be implemented.

    • supportsOrganizationQuery

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

    • getOrganizationQuery

      OrganizationQuery getOrganizationQuery()
      Gets the query for an organization.
      Returns:
      the organization query
      Throws:
      UnimplementedException - supportsOrganizationQuery() is false
      Compliance:
      optional - This method must be implemented if {@code supportsOrganizationQuery()} is {@code true} .

    • matchAnyOrganization

      void matchAnyOrganization(boolean match)
      Matches realms with any organization.
      Parameters:
      match - true to match realms with any organization, false to match realms with no organizations
      Compliance:
      mandatory - This method must be implemented.

    • clearOrganizationTerms

      void clearOrganizationTerms()
      Clears all organization terms.
      Compliance:
      mandatory - This method must be implemented.

    • matchPositionId

      void matchPositionId(Id positionId, boolean match)
      Sets the position Id for this query to match positions assigned to realms.
      Parameters:
      positionId - a position Id
      match - true for a positive match, false for a negative match
      Throws:
      NullArgumentException - positionId is null
      Compliance:
      mandatory - This method must be implemented.

    • clearPositionIdTerms

      void clearPositionIdTerms()
      Clears all position Id terms.
      Compliance:
      mandatory - This method must be implemented.

    • supportsPositionQuery

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

    • getPositionQuery

      PositionQuery getPositionQuery()
      Gets the query for a position.
      Returns:
      the position query
      Throws:
      UnimplementedException - supportsPositionQuery() is false
      Compliance:
      optional - This method must be implemented if {@code supportsPositionQuery()} is {@code true} .

    • matchAnyPosition

      void matchAnyPosition(boolean match)
      Matches realms with any position.
      Parameters:
      match - true to match realms with any position, false to match realms with no positions
      Compliance:
      mandatory - This method must be implemented.

    • clearPositionTerms

      void clearPositionTerms()
      Clears all position terms.
      Compliance:
      mandatory - This method must be implemented.

    • matchAppointmentId

      void matchAppointmentId(Id appointmentId, boolean match)
      Sets the appointment Id for this query to match positions assigned to realms.
      Parameters:
      appointmentId - an appointment Id
      match - true for a positive match, false for a negative match
      Throws:
      NullArgumentException - appointmentId is null
      Compliance:
      mandatory - This method must be implemented.

    • clearAppointmentIdTerms

      void clearAppointmentIdTerms()
      Clears all appointment Id terms.
      Compliance:
      mandatory - This method must be implemented.

    • supportsAppointmentQuery

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

    • getAppointmentQuery

      AppointmentQuery getAppointmentQuery()
      Gets the query for an appointment.
      Returns:
      the appointment query
      Throws:
      UnimplementedException - supportsAppointmentQuery() is false
      Compliance:
      optional - This method must be implemented if {@code supportsAppointmentQuery()} is {@code true} .

    • matchAnyAppointment

      void matchAnyAppointment(boolean match)
      Matches realms with any appointment.
      Parameters:
      match - true to match realms with any appointment, false to match realms with no appointments
      Compliance:
      mandatory - This method must be implemented.

    • clearAppointmentTerms

      void clearAppointmentTerms()
      Clears all appointment terms.
      Compliance:
      mandatory - This method must be implemented.

    • matchAncestorRealmId

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

    • clearAncestorRealmIdTerms

      void clearAncestorRealmIdTerms()
      Clears all ancestor realm Id terms.
      Compliance:
      mandatory - This method must be implemented.

    • supportsAncestorRealmQuery

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

    • getAncestorRealmQuery

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

    • matchAnyAncestorRealm

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

    • clearAncestorRealmTerms

      void clearAncestorRealmTerms()
      Clears all ancestor realm terms.
      Compliance:
      mandatory - This method must be implemented.

    • matchDescendantRealmId

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

    • clearDescendantRealmIdTerms

      void clearDescendantRealmIdTerms()
      Clears all descendant realm Id terms.
      Compliance:
      mandatory - This method must be implemented.

    • supportsDescendantRealmQuery

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

    • getDescendantRealmQuery

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

    • matchAnyDescendantRealm

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

    • clearDescendantRealmTerms

      void clearDescendantRealmTerms()
      Clears all descendant realm terms.
      Compliance:
      mandatory - This method must be implemented.

    • getRealmQueryRecord

      RealmQueryRecord getRealmQueryRecord(Type realmRecordType) throws OperationFailedException
      Gets the record query corresponding to the given Realm record Type .Multiple record retrievals produce a nested boolean OR term.
      Parameters:
      realmRecordType - a realm record type
      Returns:
      the realm query record
      Throws:
      NullArgumentException - realmRecordType is null
      OperationFailedException - unable to complete request
      UnsupportedException - hasRecordType(realmRecordType) is false
      Compliance:
      mandatory - This method must be implemented.