Interface BuildingQuerySession

All Superinterfaces:
AutoCloseable, Closeable, OsidSession, OsidSession
All Known Subinterfaces:
BuildingSearchSession
public interface BuildingQuerySession extends OsidSession

This session provides methods for searching Buildings. The search query is constructed using the BuildingQuery. The building record Type also specifies the record for the building query.

Buildings may have a query record indicated by their respective record types. The query record is accessed via the BuildingQuery. The returns in this session may not be cast directly to these interfaces.

  • Method Details

    • getCampusId

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

    • getCampus

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

    • canSearchBuildings

      boolean canSearchBuildings()
      Tests if this user can perform Building 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.

    • useFederatedCampusView

      void useFederatedCampusView()
      Federates the view for methods in this session. A federated view will include buildings in campuses which are children of this campus in the campus hierarchy.
      Compliance:
      mandatory - This method is must be implemented.

    • useIsolatedCampusView

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

    • getBuildingQuery

      BuildingQuery getBuildingQuery()
      Gets a building query.
      Returns:
      the building query
      Compliance:
      mandatory - This method must be implemented.

    • getBuildingsByQuery

      BuildingList getBuildingsByQuery(BuildingQuery buildingQuery) throws OperationFailedException, PermissionDeniedException
      Gets a list of Buildings matching the given building query.
      Parameters:
      buildingQuery - the building query
      Returns:
      the returned BuildingList
      Throws:
      NullArgumentException - buildingQuery is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      UnsupportedException - buildingQuery is not of this service
      Compliance:
      mandatory - This method must be implemented.