Interface CampusQuery

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

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

Like all OsidQueries, CampusQuery is stateful and must not be accessed by multiple processing threads.

  • Method Details

    • matchRoomId

      void matchRoomId(Id roomId, boolean match)
      Sets the room Id for this query to match rooms assigned to campuses.
      Parameters:
      roomId - a room Id
      match - true for a positive match, false for a negative match
      Throws:
      NullArgumentException - roomId is null
      Compliance:
      mandatory - This method must be implemented.

    • clearRoomIdTerms

      void clearRoomIdTerms()
      Clears the room Id terms.
      Compliance:
      mandatory - This method must be implemented.

    • supportsRoomQuery

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

    • getRoomQuery

      RoomQuery getRoomQuery()
      Gets the query for a room.
      Returns:
      the room query
      Throws:
      UnimplementedException - supportsRoomQuery() is false
      Compliance:
      optional - This method must be implemented if {@code supportsRoomQuery()} is {@code true}.

    • matchAnyRoom

      void matchAnyRoom(boolean match)
      Matches campuses with any room.
      Parameters:
      match - true to match campuses with any room, false to match campuses with no rooms
      Compliance:
      mandatory - This method must be implemented.

    • clearRoomTerms

      void clearRoomTerms()
      Clears the room terms.
      Compliance:
      mandatory - This method must be implemented.

    • matchFloorId

      void matchFloorId(Id floorId, boolean match)
      Sets the floor Id for this query to match rooms assigned to campuses.
      Parameters:
      floorId - a floor Id
      match - true for a positive match, false for a negative match
      Throws:
      NullArgumentException - floorId is null
      Compliance:
      mandatory - This method must be implemented.

    • clearFloorIdTerms

      void clearFloorIdTerms()
      Clears the floor Id terms.
      Compliance:
      mandatory - This method must be implemented.

    • supportsFloorQuery

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

    • getFloorQuery

      FloorQuery getFloorQuery()
      Gets the query for a floor.
      Returns:
      the floor query
      Throws:
      UnimplementedException - supportsFloorQuery() is false
      Compliance:
      optional - This method must be implemented if {@code supportsFloorQuery()} is {@code true}.

    • matchAnyFloor

      void matchAnyFloor(boolean match)
      Matches campuses with any floor.
      Parameters:
      match - true to match campuses with any floor, false to match campuses with no floors
      Compliance:
      mandatory - This method must be implemented.

    • clearFloorTerms

      void clearFloorTerms()
      Clears the floor terms.
      Compliance:
      mandatory - This method must be implemented.

    • matchBuildingId

      void matchBuildingId(Id buildingId, boolean match)
      Sets the building Id for this query to match rooms assigned to buildings.
      Parameters:
      buildingId - a building Id
      match - true for a positive match, false for a negative match
      Throws:
      NullArgumentException - buildingId is null
      Compliance:
      mandatory - This method must be implemented.

    • clearBuildingIdTerms

      void clearBuildingIdTerms()
      Clears the building Id terms.
      Compliance:
      mandatory - This method must be implemented.

    • supportsBuildingQuery

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

    • getBuildingQuery

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

    • matchAnyBuilding

      void matchAnyBuilding(boolean match)
      Matches campuses with any building.
      Parameters:
      match - true to match campuses with any building, false to match campuses with no buildings
      Compliance:
      mandatory - This method must be implemented.

    • clearBuildingTerms

      void clearBuildingTerms()
      Clears the building terms.
      Compliance:
      mandatory - This method must be implemented.

    • matchAncestorCampusId

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

    • clearAncestorCampusIdTerms

      void clearAncestorCampusIdTerms()
      Clears the ancestor campus Id terms.
      Compliance:
      mandatory - This method must be implemented.

    • supportsAncestorCampusQuery

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

    • getAncestorCampusQuery

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

    • matchAnyAncestorCampus

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

    • clearAncestorCampusTerms

      void clearAncestorCampusTerms()
      Clears the ancestor campus terms.
      Compliance:
      mandatory - This method must be implemented.

    • matchDescendantCampusId

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

    • clearDescendantCampusIdTerms

      void clearDescendantCampusIdTerms()
      Clears the descendant campus Id terms.
      Compliance:
      mandatory - This method must be implemented.

    • supportsDescendantCampusQuery

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

    • getDescendantCampusQuery

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

    • matchAnyDescendantCampus

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

    • clearDescendantCampusTerms

      void clearDescendantCampusTerms()
      Clears the descendant campus terms.
      Compliance:
      mandatory - This method must be implemented.

    • getCampusQueryRecord

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