OSID Logo
OSID Specifications
room squatting package
Version 3.0.0
Release Candidate Preview
Interfaceosid.room.squatting.RoomSquattingProfile
Implementsosid.OsidProfile
Description

The room squatting profile describes the interoperability among room squatting services.

MethodsupportsVisibleFederation
Description

Tests if any deed federation is exposed. Federation is exposed when a specific deed may be identified, selected and used to create a lookup or admin session. Federation is not exposed when a set of deeds appears as a single deed.

Returnboolean true if visible federation is supported, false otherwise
CompliancemandatoryThis method must be implemented.
MethodsupportsLeaseLookup
Description

Tests for the availability of an lease lookup service.

Returnboolean true if lease lookup is available, false otherwise
CompliancemandatoryThis method must be implemented.
MethodsupportsLeaseQuery
Description

Tests if querying leasees is available.

Returnboolean true if lease query is available, false otherwise
CompliancemandatoryThis method must be implemented.
MethodsupportsLeaseSearch
Description

Tests if searching for leasees is available.

Returnboolean true if lease search is available, false otherwise
CompliancemandatoryThis method must be implemented.
MethodsupportsLeaseAdmin
Description

Tests for the availability of a lease administrative service for creating and deleting leasees.

Returnboolean true if lease administration is available, false otherwise
CompliancemandatoryThis method must be implemented.
MethodsupportsLeaseNotification
Description

Tests for the availability of a lease notification service.

Returnboolean true if lease notification is available, false otherwise
CompliancemandatoryThis method must be implemented in all providers.
MethodsupportsLeaseCampus
Description

Tests if a lease to campus lookup session is available.

Returnboolean true if lease campus lookup session is supported, false otherwise
CompliancemandatoryThis method must be implemented.
MethodsupportsLeaseCampusAssignment
Description

Tests if a lease to campus assignment session is available.

Returnboolean true if lease campus assignment is supported, false otherwise
CompliancemandatoryThis method must be implemented.
MethodsupportsLeaseSmartCampus
Description

Tests if a lease smart campus session is available.

Returnboolean true if lease smart campus is supported, false otherwise
CompliancemandatoryThis method must be implemented.
MethodsupportsDeedLookup
Description

Tests for the availability of an deed lookup service.

Returnboolean true if deed lookup is available, false otherwise
CompliancemandatoryThis method must be implemented.
MethodsupportsDeedQuery
Description

Tests if querying deeds is available.

Returnboolean true if deed query is available, false otherwise
CompliancemandatoryThis method must be implemented.
MethodsupportsDeedSearch
Description

Tests if searching for deeds is available.

Returnboolean true if deed search is available, false otherwise
CompliancemandatoryThis method must be implemented.
MethodsupportsDeedAdmin
Description

Tests for the availability of a deed administrative service for creating and deleting deeds.

Returnboolean true if deed administration is available, false otherwise
CompliancemandatoryThis method must be implemented.
MethodsupportsDeedNotification
Description

Tests for the availability of a deed notification service.

Returnboolean true if deed notification is available, false otherwise
CompliancemandatoryThis method must be implemented in all providers.
MethodsupportsDeedCampus
Description

Tests if a deed to campus lookup session is available.

Returnboolean true if deed campus lookup session is supported, false otherwise
CompliancemandatoryThis method must be implemented.
MethodsupportsDeedCampusAssignment
Description

Tests if a deed to campus assignment session is available.

Returnboolean true if deed campus assignment is supported, false otherwise
CompliancemandatoryThis method must be implemented.
MethodsupportsDeedSmartCampus
Description

Tests if a deed smart campus session is available.

Returnboolean true if deed smart campus is supported, false otherwise
CompliancemandatoryThis method must be implemented.
MethodsupportsRoomSquattingBatch
Description

Tests if a service to manage squatters in bulk is available.

Returnboolean true if a room batch squatting service is supported, false otherwise
CompliancemandatoryThis method must be implemented.
MethodgetLeaseRecordTypes
Description

Gets the supported Lease record types.

Returnosid.type.TypeLista list containing the supported lease record types
CompliancemandatoryThis method must be implemented.
MethodsupportsLeaseRecordType
Description

Tests if the given Lease record type is supported.

Parametersosid.type.TypeleaseRecordTypea Type indicating a Lease record type
Returnboolean true if the given Type is supported, false otherwise
ErrorsNULL_ARGUMENT leaseRecordType is null
CompliancemandatoryThis method must be implemented.
MethodgetLeaseSearchRecordTypes
Description

Gets the supported lease search record types.

Returnosid.type.TypeLista list containing the supported lease search record types
CompliancemandatoryThis method must be implemented.
MethodsupportsLeaseSearchRecordType
Description

Tests if the given lease search record type is supported.

Parametersosid.type.TypeleaseSearchRecordTypea Type indicating a lease record type
Returnboolean true if the given Type is supported, false otherwise
ErrorsNULL_ARGUMENT leaseSearchRecordType is null
CompliancemandatoryThis method must be implemented.
MethodgetDeedRecordTypes
Description

Gets the supported Deed record types.

Returnosid.type.TypeLista list containing the supported deed record types
CompliancemandatoryThis method must be implemented.
MethodsupportsDeedRecordType
Description

Tests if the given Deed record type is supported.

Parametersosid.type.TypedeedRecordTypea Type indicating a Deed record type
Returnboolean true if the given Type is supported, false otherwise
ErrorsNULL_ARGUMENT deedRecordType is null
CompliancemandatoryThis method must be implemented.
MethodgetDeedSearchRecordTypes
Description

Gets the supported deed search record types.

Returnosid.type.TypeLista list containing the supported deed search record types
CompliancemandatoryThis method must be implemented.
MethodsupportsDeedSearchRecordType
Description

Tests if the given deed search record type is supported.

Parametersosid.type.TypedeedSearchRecordTypea Type indicating a deed record type
Returnboolean true if the given Type is supported, false otherwise
ErrorsNULL_ARGUMENT deedSearchRecordType is null
CompliancemandatoryThis method must be implemented.