org.osid.room.squatting

Interface RoomSquattingProfile

All Superinterfaces:

OsidProfile, Sourceable

All Known Subinterfaces:

RoomSquattingManager, RoomSquattingProxyManager

public interface RoomSquattingProfile
extends OsidProfile

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

Method Summary

Methods

Modifier and Type	Method and Description
TypeList	getDeedRecordTypes() Gets the supported Deed record types.
TypeList	getDeedSearchRecordTypes() Gets the supported deed search record types.
TypeList	getLeaseRecordTypes() Gets the supported Lease record types.
TypeList	getLeaseSearchRecordTypes() Gets the supported lease search record types.
boolean	supportsDeedAdmin() Tests for the availability of a deed administrative service for creating and deleting deeds.
boolean	supportsDeedCampus() Tests if a deed to campus lookup session is available.
boolean	supportsDeedCampusAssignment() Tests if a deed to campus assignment session is available.
boolean	supportsDeedLookup() Tests for the availability of an deed lookup service.
boolean	supportsDeedNotification() Tests for the availability of a deed notification service.
boolean	supportsDeedQuery() Tests if querying deeds is available.
boolean	supportsDeedRecordType(Type deedRecordType) Tests if the given Deed record type is supported.
boolean	supportsDeedSearch() Tests if searching for deeds is available.
boolean	supportsDeedSearchRecordType(Type deedSearchRecordType) Tests if the given deed search record type is supported.
boolean	supportsDeedSmartCampus() Tests if a deed smart campus session is available.
boolean	supportsLeaseAdmin() Tests for the availability of a lease administrative service for creating and deleting leasees.
boolean	supportsLeaseCampus() Tests if a lease to campus lookup session is available.
boolean	supportsLeaseCampusAssignment() Tests if a lease to campus assignment session is available.
boolean	supportsLeaseLookup() Tests for the availability of an lease lookup service.
boolean	supportsLeaseNotification() Tests for the availability of a lease notification service.
boolean	supportsLeaseQuery() Tests if querying leasees is available.
boolean	supportsLeaseRecordType(Type leaseRecordType) Tests if the given Lease record type is supported.
boolean	supportsLeaseSearch() Tests if searching for leasees is available.
boolean	supportsLeaseSearchRecordType(Type leaseSearchRecordType) Tests if the given lease search record type is supported.
boolean	supportsLeaseSmartCampus() Tests if a lease smart campus session is available.
boolean	supportsRoomSquattingBatch() Tests if a service to manage squatters in bulk is available.
boolean	supportsVisibleFederation() Tests if any deed federation is exposed.

Methods inherited from interface org.osid.OsidProfile

getBranch, getBranchId, getDescription, getDisplayName, getId, getLocales, getProxyRecordTypes, getReleaseDate, getVersion, supportsJournalBranching, supportsJournalRollback, supportsOSIDVersion, supportsProxyRecordType

Methods inherited from interface org.osid.Sourceable

getBranding, getBrandingIds, getLicense, getProvider, getProviderId

Method Detail

supportsVisibleFederation

boolean supportsVisibleFederation()

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.

Returns:

true if visible federation is supported, false otherwise

Compliance:

mandatory - This method must be implemented.

supportsLeaseLookup

boolean supportsLeaseLookup()

Tests for the availability of an lease lookup service.

Returns:

true if lease lookup is available, false otherwise

Compliance:

mandatory - This method must be implemented.

supportsLeaseQuery

boolean supportsLeaseQuery()

Tests if querying leasees is available.

Returns:

true if lease query is available, false otherwise

Compliance:

mandatory - This method must be implemented.

supportsLeaseSearch

boolean supportsLeaseSearch()

Tests if searching for leasees is available.

Returns:

true if lease search is available, false otherwise

Compliance:

mandatory - This method must be implemented.

supportsLeaseAdmin

boolean supportsLeaseAdmin()

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

Returns:

true if lease administration is available, false otherwise

Compliance:

mandatory - This method must be implemented.

supportsLeaseNotification

boolean supportsLeaseNotification()

Tests for the availability of a lease notification service.

Returns:

true if lease notification is available, false otherwise

Compliance:

mandatory - This method must be implemented in all providers.

supportsLeaseCampus

boolean supportsLeaseCampus()

Tests if a lease to campus lookup session is available.

Returns:

true if lease campus lookup session is supported, false otherwise

Compliance:

mandatory - This method must be implemented.

supportsLeaseCampusAssignment

boolean supportsLeaseCampusAssignment()

Tests if a lease to campus assignment session is available.

Returns:

true if lease campus assignment is supported, false otherwise

Compliance:

mandatory - This method must be implemented.

supportsLeaseSmartCampus

boolean supportsLeaseSmartCampus()

Tests if a lease smart campus session is available.

Returns:

true if lease smart campus is supported, false otherwise

Compliance:

mandatory - This method must be implemented.

supportsDeedLookup

boolean supportsDeedLookup()

Tests for the availability of an deed lookup service.

Returns:

true if deed lookup is available, false otherwise

Compliance:

mandatory - This method must be implemented.

supportsDeedQuery

boolean supportsDeedQuery()

Tests if querying deeds is available.

Returns:

true if deed query is available, false otherwise

Compliance:

mandatory - This method must be implemented.

supportsDeedSearch

boolean supportsDeedSearch()

Tests if searching for deeds is available.

Returns:

true if deed search is available, false otherwise

Compliance:

mandatory - This method must be implemented.

supportsDeedAdmin

boolean supportsDeedAdmin()

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

Returns:

true if deed administration is available, false otherwise

Compliance:

mandatory - This method must be implemented.

supportsDeedNotification

boolean supportsDeedNotification()

Tests for the availability of a deed notification service.

Returns:

true if deed notification is available, false otherwise

Compliance:

mandatory - This method must be implemented in all providers.

supportsDeedCampus

boolean supportsDeedCampus()

Tests if a deed to campus lookup session is available.

Returns:

true if deed campus lookup session is supported, false otherwise

Compliance:

mandatory - This method must be implemented.

supportsDeedCampusAssignment

boolean supportsDeedCampusAssignment()

Tests if a deed to campus assignment session is available.

Returns:

true if deed campus assignment is supported, false otherwise

Compliance:

mandatory - This method must be implemented.

supportsDeedSmartCampus

boolean supportsDeedSmartCampus()

Tests if a deed smart campus session is available.

Returns:

true if deed smart campus is supported, false otherwise

Compliance:

mandatory - This method must be implemented.

supportsRoomSquattingBatch

boolean supportsRoomSquattingBatch()

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

Returns:

true if a room batch squatting service is supported, false otherwise

Compliance:

mandatory - This method must be implemented.

getLeaseRecordTypes

TypeList getLeaseRecordTypes()

Gets the supported Lease record types.

Returns:

a list containing the supported lease record types

Compliance:

mandatory - This method must be implemented.

supportsLeaseRecordType

boolean supportsLeaseRecordType(Type leaseRecordType)

Tests if the given Lease record type is supported.

Parameters:

leaseRecordType - a Type indicating a Lease record type

Returns:

true if the given Type is supported, false otherwise

Throws:

NullArgumentException - leaseRecordType is null

Compliance:

mandatory - This method must be implemented.

getLeaseSearchRecordTypes

TypeList getLeaseSearchRecordTypes()

Gets the supported lease search record types.

Returns:

a list containing the supported lease search record types

Compliance:

mandatory - This method must be implemented.

supportsLeaseSearchRecordType

boolean supportsLeaseSearchRecordType(Type leaseSearchRecordType)

Tests if the given lease search record type is supported.

Parameters:

leaseSearchRecordType - a Type indicating a lease record type

Returns:

true if the given Type is supported, false otherwise

Throws:

NullArgumentException - leaseSearchRecordType is null

Compliance:

mandatory - This method must be implemented.

getDeedRecordTypes

TypeList getDeedRecordTypes()

Gets the supported Deed record types.

Returns:

a list containing the supported deed record types

Compliance:

mandatory - This method must be implemented.

supportsDeedRecordType

boolean supportsDeedRecordType(Type deedRecordType)

Tests if the given Deed record type is supported.

Parameters:

deedRecordType - a Type indicating a Deed record type

Returns:

true if the given Type is supported, false otherwise

Throws:

NullArgumentException - deedRecordType is null

Compliance:

mandatory - This method must be implemented.

getDeedSearchRecordTypes

TypeList getDeedSearchRecordTypes()

Gets the supported deed search record types.

Returns:

a list containing the supported deed search record types

Compliance:

mandatory - This method must be implemented.

supportsDeedSearchRecordType

boolean supportsDeedSearchRecordType(Type deedSearchRecordType)

Tests if the given deed search record type is supported.

Parameters:

deedSearchRecordType - a Type indicating a deed record type

Returns:

true if the given Type is supported, false otherwise

Throws:

NullArgumentException - deedSearchRecordType is null

Compliance:

mandatory - This method must be implemented.