OSID - osid.room.RoomProfile Service Interface Definition

Interface	osid.room.RoomProfile
Implements	`osid.OsidProfile`
Description	The room profile describes the interoperability among room services.
Method	supportsVisibleFederation
Description	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.
Return	`boolean`		`true` if visible federation is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsRoomLookup
Description	Tests for the availability of a room lookup service.
Return	`boolean`		`true` if room lookup is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsRoomQuery
Description	Tests if querying rooms is available.
Return	`boolean`		`true` if room query is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsRoomSearch
Description	Tests if searching for rooms is available.
Return	`boolean`		`true` if room search is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsRoomAdmin
Description	Tests if searching for rooms is available.
Return	`boolean`		`true` if room search is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsRoomNotification
Description	Tests if room notification is available.
Return	`boolean`		`true` if room notification is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsRoomCampus
Description	Tests if a room to campus lookup session is available.
Return	`boolean`		`true` if room campus lookup session is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsRoomCampusAssignment
Description	Tests if a room to campus assignment session is available.
Return	`boolean`		`true` if room campus assignment is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsRoomSmartCampus
Description	Tests if a room smart campus session is available.
Return	`boolean`		`true` if room smart campus is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsFloorLookup
Description	Tests for the availability of an floor lookup service.
Return	`boolean`		`true` if floor lookup is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsFloorQuery
Description	Tests if querying floores is available.
Return	`boolean`		`true` if floor query is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsFloorSearch
Description	Tests if searching for floores is available.
Return	`boolean`		`true` if floor search is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsFloorAdmin
Description	Tests for the availability of a floor administrative service for creating and deleting floores.
Return	`boolean`		`true` if floor administration is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsFloorNotification
Description	Tests for the availability of a floor notification service.
Return	`boolean`		`true` if floor notification is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented in all providers.
Method	supportsFloorCampus
Description	Tests if a floor to campus lookup session is available.
Return	`boolean`		`true` if floor campus lookup session is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsFloorCampusAssignment
Description	Tests if a floor to campus assignment session is available.
Return	`boolean`		`true` if floor campus assignment is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsFloorSmartCampus
Description	Tests if a floor smart campus session is available.
Return	`boolean`		`true` if floor smart campus is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsBuildingLookup
Description	Tests for the availability of an building lookup service.
Return	`boolean`		`true` if building lookup is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsBuildingQuery
Description	Tests if querying buildinges is available.
Return	`boolean`		`true` if building query is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsBuildingSearch
Description	Tests if searching for buildinges is available.
Return	`boolean`		`true` if building search is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsBuildingAdmin
Description	Tests for the availability of a building administrative service for creating and deleting buildinges.
Return	`boolean`		`true` if building administration is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsBuildingNotification
Description	Tests for the availability of a building notification service.
Return	`boolean`		`true` if building notification is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented in all providers.
Method	supportsBuildingCampus
Description	Tests if a building to campus lookup session is available.
Return	`boolean`		`true` if building campus lookup session is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsBuildingCampusAssignment
Description	Tests if a building to campus assignment session is available.
Return	`boolean`		`true` if building campus assignment is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsBuildingSmartCampus
Description	Tests if a building smart campus session is available.
Return	`boolean`		`true` if building smart campus is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsCampusLookup
Description	Tests for the availability of an campus lookup service.
Return	`boolean`		`true` if campus lookup is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsCampusQuery
Description	Tests if querying campuses is available.
Return	`boolean`		`true` if campus query is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsCampusSearch
Description	Tests if searching for campuses is available.
Return	`boolean`		`true` if campus search is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsCampusAdmin
Description	Tests for the availability of a campus administrative service for creating and deleting campuses.
Return	`boolean`		`true` if campus administration is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsCampusNotification
Description	Tests for the availability of a campus notification service.
Return	`boolean`		`true` if campus notification is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented in all providers.
Method	supportsCampusHierarchy
Description	Tests for the availability of a campus hierarchy traversal service.
Return	`boolean`		`true` if campus hierarchy traversal is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsCampusHierarchyDesign
Description	Tests for the availability of a campus hierarchy design service.
Return	`boolean`		`true` if campus hierarchy design is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented in all providers.
Method	supportsRoomBatch
Description	Tests for the availability of a room batch service.
Return	`boolean`		`true` if a room batch service is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented in all providers.
Method	supportsRoomConstruction
Description	Tests for the availability of a room construction service.
Return	`boolean`		`true` if a room construction service is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented in all providers.
Method	supportsRoomSquatting
Description	Tests for the availability of a room squatting service.
Return	`boolean`		`true` if a room squatting service is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented in all providers.
Method	getRoomRecordTypes
Description	Gets the supported `Room` record types.
Return	`osid.type.TypeList`		a list containing the supported room record types
Compliance	`mandatory`		This method must be implemented.
Method	supportsRoomRecordType
Description	Tests if the given `Room` record type is supported.
Parameters	`osid.type.Type`	`roomRecordType`	a `Type` indicating a `Room` record type
Return	`boolean`		`true` if the given `Type` is supported, `false` otherwise
Errors	NULL_ARGUMENT		`roomRecordType` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	getRoomSearchRecordTypes
Description	Gets the supported room search record types.
Return	`osid.type.TypeList`		a list containing the supported room search record types
Compliance	`mandatory`		This method must be implemented.
Method	supportsRoomSearchRecordType
Description	Tests if the given room search record type is supported.
Parameters	`osid.type.Type`	`roomSearchRecordType`	a `Type` indicating a room record type
Return	`boolean`		`true` if the given `Type` is supported, `false` otherwise
Errors	NULL_ARGUMENT		`roomSearchRecordType` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	getFloorRecordTypes
Description	Gets the supported `Floor` record types.
Return	`osid.type.TypeList`		a list containing the supported floor record types
Compliance	`mandatory`		This method must be implemented.
Method	supportsFloorRecordType
Description	Tests if the given `Floor` record type is supported.
Parameters	`osid.type.Type`	`floorRecordType`	a `Type` indicating a `Floor` record type
Return	`boolean`		`true` if the given `Type` is supported, `false` otherwise
Errors	NULL_ARGUMENT		`floorRecordType` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	getFloorSearchRecordTypes
Description	Gets the supported floor search record types.
Return	`osid.type.TypeList`		a list containing the supported floor search record types
Compliance	`mandatory`		This method must be implemented.
Method	supportsFloorSearchRecordType
Description	Tests if the given floor search record type is supported.
Parameters	`osid.type.Type`	`floorSearchRecordType`	a `Type` indicating a floor record type
Return	`boolean`		`true` if the given `Type` is supported, `false` otherwise
Errors	NULL_ARGUMENT		`floorSearchRecordType` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	getBuildingRecordTypes
Description	Gets the supported `Building` record types.
Return	`osid.type.TypeList`		a list containing the supported building record types
Compliance	`mandatory`		This method must be implemented.
Method	supportsBuildingRecordType
Description	Tests if the given `Building` record type is supported.
Parameters	`osid.type.Type`	`buildingRecordType`	a `Type` indicating a `Building` record type
Return	`boolean`		`true` if the given `Type` is supported, `false` otherwise
Errors	NULL_ARGUMENT		`buildingRecordType` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	getBuildingSearchRecordTypes
Description	Gets the supported building search record types.
Return	`osid.type.TypeList`		a list containing the supported building search record types
Compliance	`mandatory`		This method must be implemented.
Method	supportsBuildingSearchRecordType
Description	Tests if the given building search record type is supported.
Parameters	`osid.type.Type`	`buildingSearchRecordType`	a `Type` indicating a building record type
Return	`boolean`		`true` if the given `Type` is supported, `false` otherwise
Errors	NULL_ARGUMENT		`buildingSearchRecordType` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	getCampusRecordTypes
Description	Gets the supported `Campus` record types.
Return	`osid.type.TypeList`		a list containing the supported campus record types
Compliance	`mandatory`		This method must be implemented.
Method	supportsCampusRecordType
Description	Tests if the given `Campus` record type is supported.
Parameters	`osid.type.Type`	`campusRecordType`	a `Type` indicating a `Campus` record type
Return	`boolean`		`true` if the given `Type` is supported, `false` otherwise
Errors	NULL_ARGUMENT		`campusRecordType` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	getCampusSearchRecordTypes
Description	Gets the supported campus search record types.
Return	`osid.type.TypeList`		a list containing the supported campus search record types
Compliance	`mandatory`		This method must be implemented.
Method	supportsCampusSearchRecordType
Description	Tests if the given campus search record type is supported.
Parameters	`osid.type.Type`	`campusSearchRecordType`	a `Type` indicating a campus record type
Return	`boolean`		`true` if the given `Type` is supported, `false` otherwise
Errors	NULL_ARGUMENT		`campusSearchRecordType` is `null`
Compliance	`mandatory`		This method must be implemented.