OSID Logo
OSID Specifications
room construction package
Version 3.0.0
Release Candidate Preview
Interfaceosid.room.construction.RenovationAdminSession
Implementsosid.OsidSession
Description

This session creates, updates, and deletes Renovations. The data for create and update is provided by the consumer via the form object. OsidForms are requested for each create or update and may not be reused.

Create and update operations differ in their usage. To create a Renovation, a RenovationForm is requested using getRenovationFormForCreate() specifying the desired peers and record Types or none if no record Types are needed. The returned RenovationForm will indicate that it is to be used with a create operation and can be used to examine metdata or validate data prior to creation. Once the RenovationForm is submiited to a create operation, it cannot be reused with another create operation unless the first operation was unsuccessful. Each RenovationForm corresponds to an attempted transaction.

For updates, RenovationForms are requested to the Renovation Id that is to be updated using getRenovationFormForUpdate(). Similarly, the RenovationForm has metadata about the data that can be updated and it can perform validation before submitting the update. The RenovationForm can only be used once for a successful update and cannot be reused.

The delete operations delete Renovations. To unmap a Renovation from the current Campus, the RenovationCampusAssignmentSession should be used. These delete operations attempt to remove the Renovation itself thus removing it from all known Campus catalogs.

This session includes an Id aliasing mechanism to assign an external Id to an internally assigned Id.

MethodgetCampusId
Description

Gets the Campus Id associated with this session.

Returnosid.id.Idthe Campus Id associated with this session
CompliancemandatoryThis method must be implemented.
MethodgetCampus
Description

Gets the Campus associated with this session.

Returnosid.room.Campusthe campus
ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodcanCreateRenovations
Description

Tests if this user can create Renovations. A return of true does not guarantee successful authorization. A return of false indicates that it is known creating a Renovation will result in a PERMISSION_DENIED. This is intended as a hint to an application that may not wish to offer create operations to unauthorized users.

Returnboolean false if Renovation creation is not authorized, true otherwise
CompliancemandatoryThis method must be implemented.
MethodcanCreateRenovationWithRecordTypes
Description

Tests if this user can create a single Renovation using the desired record interface types. While RoomConstructionManager.getRenovationRecordTypes() can be used to examine which record interfaces are supported, this method tests which record(s) are required for creating a specific Renovation. Providing an empty array tests if a Renovation can be created with no records.

Parametersosid.type.Type[]renovationRecordTypesarray of renovation record types
Returnboolean true if Renovation creation using the specified record Types is supported, false otherwise
ErrorsNULL_ARGUMENT renovationRecordTypes is null
CompliancemandatoryThis method must be implemented.
MethodgetRenovationFormForCreate
Description

Gets the renovation form for creating new renovations. A new form should be requested for each create transaction.

Parametersosid.type.Type[]renovationRecordTypesarray of renovation record types
Returnosid.room.construction.RenovationFormthe renovation form
ErrorsNULL_ARGUMENT renovationRecordTypes is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
UNSUPPORTEDunable to get from for requested record types
CompliancemandatoryThis method must be implemented.
MethodcreateRenovation
Description

Creates a new Renovation.

Parametersosid.room.construction.RenovationFormrenovationFormthe form for this Renovation
Returnosid.room.construction.Renovationthe new Renovation
ErrorsILLEGAL_STATE renovationForm already used in a create transaction
INVALID_ARGUMENTone or more of the form elements is invalid
NULL_ARGUMENT renovationForm is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
UNSUPPORTED renovationForm did not originate from getRenovationFormForCreate()
CompliancemandatoryThis method must be implemented.
MethodcanUpdateRenovations
Description

Tests if this user can update Renovations. A return of true does not guarantee successful authorization. A return of false indicates that it is known updating a Renovation will result in a PERMISSION_DENIED. This is intended as a hint to an application that may not wish to offer update operations to unauthorized users.

Returnboolean false if Renovation modification is not authorized, true otherwise
CompliancemandatoryThis method must be implemented.
MethodgetRenovationFormForUpdate
Description

Gets the renovation form for updating an existing renovation. A new renovation form should be requested for each update transaction.

Parametersosid.id.IdrenovationIdthe Id of the Renovation
Returnosid.room.construction.RenovationFormthe renovation form
ErrorsNOT_FOUND renovationId is not found
NULL_ARGUMENT renovationId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodupdateRenovation
Description

Updates an existing renovation.

Parametersosid.room.construction.RenovationFormrenovationFormthe form containing the elements to be updated
ErrorsILLEGAL_STATE renovationForm already used in an update transaction
INVALID_ARGUMENTthe form contains an invalid value
NULL_ARGUMENT renovationForm is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
UNSUPPORTED renovationForm did not originate from getRenovationFormForUpdate()
CompliancemandatoryThis method must be implemented.
MethodcanDeleteRenovations
Description

Tests if this user can delete Renovations A return of true does not guarantee successful authorization. A return of false indicates that it is known deleting a Renovation will result in a PERMISSION_DENIED. This is intended as a hint to an application that may not wish to offer delete operations to unauthorized users.

Returnboolean false if Renovation deletion is not authorized, true otherwise
CompliancemandatoryThis method must be implemented.
MethoddeleteRenovation
Description

Deletes a Renovation.

Parametersosid.id.IdrenovationIdthe Id of the Renovation to remove
ErrorsNOT_FOUND renovationId not found
NULL_ARGUMENT renovationId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodcanManageRenovationAliases
Description

Tests if this user can manage Id aliases for Renovations. A return of true does not guarantee successful authorization. A return of false indicates that it is known changing an alias will result in a PERMISSION_DENIED. This is intended as a hint to an application that may opt not to offer alias operations to an unauthorized user.

Returnboolean false if Renovation aliasing is not authorized, true otherwise
CompliancemandatoryThis method must be implemented.
MethodaliasRenovation
Description

Adds an Id to a Renovation for the purpose of creating compatibility. The primary Id of the Renovation is determined by the provider. The new Id performs as an alias to the primary Id. If the alias is a pointer to another renovation, it is reassigned to the given renovation Id.

Parametersosid.id.IdrenovationIdthe Id of a Renovation
osid.id.IdaliasIdthe alias Id
ErrorsALREADY_EXISTS aliasId is already assigned
NOT_FOUND renovationId not found
NULL_ARGUMENT renovationId or aliasId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.