Interface RoomProfile

All Superinterfaces:
OsidProfile, Sourceable
All Known Subinterfaces:
RoomManager, RoomProxyManager
public interface RoomProfile extends OsidProfile

The room profile describes the interoperability among room services.

  • Method Details

    • supportsVisibleFederation

      boolean supportsVisibleFederation()
      Tests if any building federation is exposed. Federation is exposed when a specific building may be identified, selected and used to create a lookup or admin session. Federation is not exposed when a set of buildinges appears as a single building.
      Returns:
      true if visible federation is supported, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsRoomLookup

      boolean supportsRoomLookup()
      Tests for the availability of a room lookup service.
      Returns:
      true if room lookup is available, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsRoomQuery

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

    • supportsRoomSearch

      boolean supportsRoomSearch()
      Tests if searching for rooms is available.
      Returns:
      true if room search is available, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsRoomAdmin

      boolean supportsRoomAdmin()
      Tests if managing rooms is available.
      Returns:
      true if room administration is available, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsRoomNotification

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

    • supportsRoomCampus

      boolean supportsRoomCampus()
      Tests if a room to campus lookup session is available.
      Returns:
      true if room campus lookup session is supported, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsRoomCampusAssignment

      boolean supportsRoomCampusAssignment()
      Tests if a room to campus assignment session is available.
      Returns:
      true if room campus assignment is supported, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsRoomSmartCampus

      boolean supportsRoomSmartCampus()
      Tests if a room smart campus session is available.
      Returns:
      true if room smart campus is supported, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsFloorLookup

      boolean supportsFloorLookup()
      Tests for the availability of a floor lookup service.
      Returns:
      true if floor lookup is available, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsFloorQuery

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

    • supportsFloorSearch

      boolean supportsFloorSearch()
      Tests if searching for floores is available.
      Returns:
      true if floor search is available, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsFloorAdmin

      boolean supportsFloorAdmin()
      Tests for the availability of a floor administrative service for creating and deleting floores.
      Returns:
      true if floor administration is available, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsFloorNotification

      boolean supportsFloorNotification()
      Tests for the availability of a floor notification service.
      Returns:
      true if floor notification is available, false otherwise
      Compliance:
      mandatory - This method must be implemented in all providers.

    • supportsFloorCampus

      boolean supportsFloorCampus()
      Tests if a floor to campus lookup session is available.
      Returns:
      true if floor campus lookup session is supported, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsFloorCampusAssignment

      boolean supportsFloorCampusAssignment()
      Tests if a floor to campus assignment session is available.
      Returns:
      true if floor campus assignment is supported, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsFloorSmartCampus

      boolean supportsFloorSmartCampus()
      Tests if a floor smart campus session is available.
      Returns:
      true if floor smart campus is supported, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsBuildingLookup

      boolean supportsBuildingLookup()
      Tests for the availability of a building lookup service.
      Returns:
      true if building lookup is available, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsBuildingQuery

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

    • supportsBuildingSearch

      boolean supportsBuildingSearch()
      Tests if searching for buildinges is available.
      Returns:
      true if building search is available, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsBuildingAdmin

      boolean supportsBuildingAdmin()
      Tests for the availability of a building administrative service for creating and deleting buildinges.
      Returns:
      true if building administration is available, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsBuildingNotification

      boolean supportsBuildingNotification()
      Tests for the availability of a building notification service.
      Returns:
      true if building notification is available, false otherwise
      Compliance:
      mandatory - This method must be implemented in all providers.

    • supportsBuildingCampus

      boolean supportsBuildingCampus()
      Tests if a building to campus lookup session is available.
      Returns:
      true if building campus lookup session is supported, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsBuildingCampusAssignment

      boolean supportsBuildingCampusAssignment()
      Tests if a building to campus assignment session is available.
      Returns:
      true if building campus assignment is supported, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsBuildingSmartCampus

      boolean supportsBuildingSmartCampus()
      Tests if a building smart campus session is available.
      Returns:
      true if building smart campus is supported, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsCampusLookup

      boolean supportsCampusLookup()
      Tests for the availability of a campus lookup service.
      Returns:
      true if campus lookup is available, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsCampusQuery

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

    • supportsCampusSearch

      boolean supportsCampusSearch()
      Tests if searching for campuses is available.
      Returns:
      true if campus search is available, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsCampusAdmin

      boolean supportsCampusAdmin()
      Tests for the availability of a campus administrative service for creating and deleting campuses.
      Returns:
      true if campus administration is available, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsCampusNotification

      boolean supportsCampusNotification()
      Tests for the availability of a campus notification service.
      Returns:
      true if campus notification is available, false otherwise
      Compliance:
      mandatory - This method must be implemented in all providers.

    • supportsCampusHierarchy

      boolean supportsCampusHierarchy()
      Tests for the availability of a campus hierarchy traversal service.
      Returns:
      true if campus hierarchy traversal is available, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsCampusHierarchyDesign

      boolean supportsCampusHierarchyDesign()
      Tests for the availability of a campus hierarchy design service.
      Returns:
      true if campus hierarchy design is available, false otherwise
      Compliance:
      mandatory - This method must be implemented in all providers.

    • supportsRoomBatch

      boolean supportsRoomBatch()
      Tests for the availability of a room batch service.
      Returns:
      true if a room batch service is available, false otherwise
      Compliance:
      mandatory - This method must be implemented in all providers.

    • supportsRoomConstruction

      boolean supportsRoomConstruction()
      Tests for the availability of a room construction service.
      Returns:
      true if a room construction service is available, false otherwise
      Compliance:
      mandatory - This method must be implemented in all providers.

    • supportsRoomSquatting

      boolean supportsRoomSquatting()
      Tests for the availability of a room squatting service.
      Returns:
      true if a room squatting service is available, false otherwise
      Compliance:
      mandatory - This method must be implemented in all providers.

    • getRoomRecordTypes

      TypeList getRoomRecordTypes()
      Gets the supported Room record types.
      Returns:
      a list containing the supported room record types
      Compliance:
      mandatory - This method must be implemented.

    • supportsRoomRecordType

      boolean supportsRoomRecordType(Type roomRecordType)
      Tests if the given Room record type is supported.
      Parameters:
      roomRecordType - a Type indicating a Room record type
      Returns:
      true if the given Type is supported, false otherwise
      Throws:
      NullArgumentException - roomRecordType is null
      Compliance:
      mandatory - This method must be implemented.

    • getRoomSearchRecordTypes

      TypeList getRoomSearchRecordTypes()
      Gets the supported room search record types.
      Returns:
      a list containing the supported room search record types
      Compliance:
      mandatory - This method must be implemented.

    • supportsRoomSearchRecordType

      boolean supportsRoomSearchRecordType(Type roomSearchRecordType)
      Tests if the given room search record type is supported.
      Parameters:
      roomSearchRecordType - a Type indicating a room record type
      Returns:
      true if the given Type is supported, false otherwise
      Throws:
      NullArgumentException - roomSearchRecordType is null
      Compliance:
      mandatory - This method must be implemented.

    • getFloorRecordTypes

      TypeList getFloorRecordTypes()
      Gets the supported Floor record types.
      Returns:
      a list containing the supported floor record types
      Compliance:
      mandatory - This method must be implemented.

    • supportsFloorRecordType

      boolean supportsFloorRecordType(Type floorRecordType)
      Tests if the given Floor record type is supported.
      Parameters:
      floorRecordType - a Type indicating a Floor record type
      Returns:
      true if the given Type is supported, false otherwise
      Throws:
      NullArgumentException - floorRecordType is null
      Compliance:
      mandatory - This method must be implemented.

    • getFloorSearchRecordTypes

      TypeList getFloorSearchRecordTypes()
      Gets the supported floor search record types.
      Returns:
      a list containing the supported floor search record types
      Compliance:
      mandatory - This method must be implemented.

    • supportsFloorSearchRecordType

      boolean supportsFloorSearchRecordType(Type floorSearchRecordType)
      Tests if the given floor search record type is supported.
      Parameters:
      floorSearchRecordType - a Type indicating a floor record type
      Returns:
      true if the given Type is supported, false otherwise
      Throws:
      NullArgumentException - floorSearchRecordType is null
      Compliance:
      mandatory - This method must be implemented.

    • getBuildingRecordTypes

      TypeList getBuildingRecordTypes()
      Gets the supported Building record types.
      Returns:
      a list containing the supported building record types
      Compliance:
      mandatory - This method must be implemented.

    • supportsBuildingRecordType

      boolean supportsBuildingRecordType(Type buildingRecordType)
      Tests if the given Building record type is supported.
      Parameters:
      buildingRecordType - a Type indicating a Building record type
      Returns:
      true if the given Type is supported, false otherwise
      Throws:
      NullArgumentException - buildingRecordType is null
      Compliance:
      mandatory - This method must be implemented.

    • getBuildingSearchRecordTypes

      TypeList getBuildingSearchRecordTypes()
      Gets the supported building search record types.
      Returns:
      a list containing the supported building search record types
      Compliance:
      mandatory - This method must be implemented.

    • supportsBuildingSearchRecordType

      boolean supportsBuildingSearchRecordType(Type buildingSearchRecordType)
      Tests if the given building search record type is supported.
      Parameters:
      buildingSearchRecordType - a Type indicating a building record type
      Returns:
      true if the given Type is supported, false otherwise
      Throws:
      NullArgumentException - buildingSearchRecordType is null
      Compliance:
      mandatory - This method must be implemented.

    • getCampusRecordTypes

      TypeList getCampusRecordTypes()
      Gets the supported Campus record types.
      Returns:
      a list containing the supported campus record types
      Compliance:
      mandatory - This method must be implemented.

    • supportsCampusRecordType

      boolean supportsCampusRecordType(Type campusRecordType)
      Tests if the given Campus record type is supported.
      Parameters:
      campusRecordType - a Type indicating a Campus record type
      Returns:
      true if the given Type is supported, false otherwise
      Throws:
      NullArgumentException - campusRecordType is null
      Compliance:
      mandatory - This method must be implemented.

    • getCampusSearchRecordTypes

      TypeList getCampusSearchRecordTypes()
      Gets the supported campus search record types.
      Returns:
      a list containing the supported campus search record types
      Compliance:
      mandatory - This method must be implemented.

    • supportsCampusSearchRecordType

      boolean supportsCampusSearchRecordType(Type campusSearchRecordType)
      Tests if the given campus search record type is supported.
      Parameters:
      campusSearchRecordType - a Type indicating a campus record type
      Returns:
      true if the given Type is supported, false otherwise
      Throws:
      NullArgumentException - campusSearchRecordType is null
      Compliance:
      mandatory - This method must be implemented.