Interface RoomConstructionProfile
- All Superinterfaces:
OsidProfile, Sourceable
- All Known Subinterfaces:
RoomConstructionManager, RoomConstructionProxyManager
The room construction profile describes the interoperability among room construction services.
-
Method Summary
Modifier and TypeMethodDescriptionGets the supportedProjectrecord types.Gets the supported project search record types.Gets the supportedRenovationrecord types.Gets the supported renovation search record types.booleanTests for the availability of a project administrative service for creating and deleting projects.booleanTests if a project to campus lookup session is available.booleanTests if a project to campus assignment session is available.booleanTests for the availability of a project lookup service.booleanTests for the availability of a project notification service.booleanTests if querying projects is available.booleansupportsProjectRecordType(Type projectRecordType) Tests if the givenProjectrecord type is supported.booleanTests if searching for projects is available.booleansupportsProjectSearchRecordType(Type projectSearchRecordType) Tests if the given project search record type is supported.booleanTests if a project smart campus session is available.booleanTests for the availability of a renovation administrative service for creating and deleting renovationes.booleanTests if a renovation to campus lookup session is available.booleanTests if a renovation to campus assignment session is available.booleanTests for the availability of a renovation lookup service.booleanTests for the availability of a renovation notification service.booleanTests if querying renovationes is available.booleansupportsRenovationRecordType(Type renovationRecordType) Tests if the givenRenovationrecord type is supported.booleanTests if searching for renovationes is available.booleansupportsRenovationSearchRecordType(Type renovationSearchRecordType) Tests if the given renovation search record type is supported.booleanTests if a renovation smart campus session is available.booleanTests if a service to manage construction in bulk is available.booleanTests if any project federation is exposed.Methods inherited from interface OsidProfile
getBranch, getBranchId, getDescription, getDisplayName, getId, getLocales, getProxyRecordTypes, getReleaseDate, getVersion, supportsJournalBranching, supportsJournalRollback, supportsOSIDVersion, supportsProxyRecordTypeModifier and TypeMethodDescriptionGets this service branch.Gets theBranch Idrepresenting this service branch.Gets a description of this service implementation.Gets a display name for this service implementation.getId()Gets an identifier for this service implementation.Gets the locales supported in this service.Gets the proxy recordTypessupported in this service.Gets the date this service implementation was released.Gets the version of this service implementation.booleanTest for support of a journal branching service.booleanTest for support of a journaling rollback service.booleansupportsOSIDVersion(Version version) Test for support of an OSID specification version.booleansupportsProxyRecordType(Type proxyRecordType) Test for support of a proxy type.Methods inherited from interface Sourceable
getBranding, getBrandingIds, getLicense, getProvider, getProviderIdModifier and TypeMethodDescriptionGets a branding, such as an image or logo, expressed using theAssetinterface.Gets the branding assetIds.Gets the terms of usage.Gets theResourcerepresenting the provider.Gets theIdof the provider.
-
Method Details
-
supportsVisibleFederation
boolean supportsVisibleFederation()Tests if any project federation is exposed. Federation is exposed when a specific project may be identified, selected and used to create a lookup or admin session. Federation is not exposed when a set of projects appears as a single project.- Returns:
trueif visible federation is supported,falseotherwise- Compliance:
mandatory- This method must be implemented.
-
supportsRenovationLookup
boolean supportsRenovationLookup()Tests for the availability of a renovation lookup service.- Returns:
trueif renovation lookup is available,falseotherwise- Compliance:
mandatory- This method must be implemented.
-
supportsRenovationQuery
boolean supportsRenovationQuery()Tests if querying renovationes is available.- Returns:
trueif renovation query is available,falseotherwise- Compliance:
mandatory- This method must be implemented.
-
supportsRenovationSearch
boolean supportsRenovationSearch()Tests if searching for renovationes is available.- Returns:
trueif renovation search is available,falseotherwise- Compliance:
mandatory- This method must be implemented.
-
supportsRenovationAdmin
boolean supportsRenovationAdmin()Tests for the availability of a renovation administrative service for creating and deleting renovationes.- Returns:
trueif renovation administration is available,falseotherwise- Compliance:
mandatory- This method must be implemented.
-
supportsRenovationNotification
boolean supportsRenovationNotification()Tests for the availability of a renovation notification service.- Returns:
trueif renovation notification is available,falseotherwise- Compliance:
mandatory- This method must be implemented in all providers.
-
supportsRenovationCampus
boolean supportsRenovationCampus()Tests if a renovation to campus lookup session is available.- Returns:
trueif renovation campus lookup session is supported,falseotherwise- Compliance:
mandatory- This method must be implemented.
-
supportsRenovationCampusAssignment
boolean supportsRenovationCampusAssignment()Tests if a renovation to campus assignment session is available.- Returns:
trueif renovation campus assignment is supported,falseotherwise- Compliance:
mandatory- This method must be implemented.
-
supportsRenovationSmartCampus
boolean supportsRenovationSmartCampus()Tests if a renovation smart campus session is available.- Returns:
trueif renovation smart campus is supported,falseotherwise- Compliance:
mandatory- This method must be implemented.
-
supportsProjectLookup
boolean supportsProjectLookup()Tests for the availability of a project lookup service.- Returns:
trueif project lookup is available,falseotherwise- Compliance:
mandatory- This method must be implemented.
-
supportsProjectQuery
boolean supportsProjectQuery()Tests if querying projects is available.- Returns:
trueif project query is available,falseotherwise- Compliance:
mandatory- This method must be implemented.
-
supportsProjectSearch
boolean supportsProjectSearch()Tests if searching for projects is available.- Returns:
trueif project search is available,falseotherwise- Compliance:
mandatory- This method must be implemented.
-
supportsProjectAdmin
boolean supportsProjectAdmin()Tests for the availability of a project administrative service for creating and deleting projects.- Returns:
trueif project administration is available,falseotherwise- Compliance:
mandatory- This method must be implemented.
-
supportsProjectNotification
boolean supportsProjectNotification()Tests for the availability of a project notification service.- Returns:
trueif project notification is available,falseotherwise- Compliance:
mandatory- This method must be implemented in all providers.
-
supportsProjectCampus
boolean supportsProjectCampus()Tests if a project to campus lookup session is available.- Returns:
trueif project campus lookup session is supported,falseotherwise- Compliance:
mandatory- This method must be implemented.
-
supportsProjectCampusAssignment
boolean supportsProjectCampusAssignment()Tests if a project to campus assignment session is available.- Returns:
trueif project campus assignment is supported,falseotherwise- Compliance:
mandatory- This method must be implemented.
-
supportsProjectSmartCampus
boolean supportsProjectSmartCampus()Tests if a project smart campus session is available.- Returns:
trueif project smart campus is supported,falseotherwise- Compliance:
mandatory- This method must be implemented.
-
supportsRoomConstructionBatch
boolean supportsRoomConstructionBatch()Tests if a service to manage construction in bulk is available.- Returns:
trueif a room construction batch service is supported,falseotherwise- Compliance:
mandatory- This method must be implemented.
-
getRenovationRecordTypes
TypeList getRenovationRecordTypes()Gets the supportedRenovationrecord types.- Returns:
- a list containing the supported renovation record types
- Compliance:
mandatory- This method must be implemented.
-
supportsRenovationRecordType
Tests if the givenRenovationrecord type is supported.- Parameters:
renovationRecordType- aTypeindicating aRenovationrecord type- Returns:
trueif the givenTypeis supported,falseotherwise- Throws:
NullArgumentException-renovationRecordTypeisnull- Compliance:
mandatory- This method must be implemented.
-
getRenovationSearchRecordTypes
TypeList getRenovationSearchRecordTypes()Gets the supported renovation search record types.- Returns:
- a list containing the supported renovation search record types
- Compliance:
mandatory- This method must be implemented.
-
supportsRenovationSearchRecordType
Tests if the given renovation search record type is supported.- Parameters:
renovationSearchRecordType- aTypeindicating a renovation record type- Returns:
trueif the givenTypeis supported,falseotherwise- Throws:
NullArgumentException-renovationSearchRecordTypeisnull- Compliance:
mandatory- This method must be implemented.
-
getProjectRecordTypes
TypeList getProjectRecordTypes()Gets the supportedProjectrecord types.- Returns:
- a list containing the supported project record types
- Compliance:
mandatory- This method must be implemented.
-
supportsProjectRecordType
Tests if the givenProjectrecord type is supported.- Parameters:
projectRecordType- aTypeindicating aProjectrecord type- Returns:
trueif the givenTypeis supported,falseotherwise- Throws:
NullArgumentException-projectRecordTypeisnull- Compliance:
mandatory- This method must be implemented.
-
getProjectSearchRecordTypes
TypeList getProjectSearchRecordTypes()Gets the supported project search record types.- Returns:
- a list containing the supported project search record types
- Compliance:
mandatory- This method must be implemented.
-
supportsProjectSearchRecordType
Tests if the given project search record type is supported.- Parameters:
projectSearchRecordType- aTypeindicating a project record type- Returns:
trueif the givenTypeis supported,falseotherwise- Throws:
NullArgumentException-projectSearchRecordTypeisnull- Compliance:
mandatory- This method must be implemented.
-