OSID - osid.room.construction.ProjectAdminSession Service Interface Definition

Interface	osid.room.construction.ProjectAdminSession
Implements	`osid.OsidSession`
Implemented By	`osid.room.construction.batch.ProjectBatchAdminSession`
Used By	`osid.room.construction.RoomConstructionManager`
Used By	`osid.room.construction.RoomConstructionProxyManager`
Description	This session creates, updates, and deletes `Projects`. 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 `Project`, a `ProjectForm` is requested using `getProjectFormForCreate()` specifying the desired building and record `Types` or none if no record `Types` are needed. The returned `ProjectForm` 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 `ProjectForm` is submiited to a create operation, it cannot be reused with another create operation unless the first operation was unsuccessful. Each `ProjectForm` corresponds to an attempted transaction. For updates, `ProjectForms` are requested to the `Project` `Id` that is to be updated using `getProjectFormForUpdate()`. Similarly, the `ProjectForm` has metadata about the data that can be updated and it can perform validation before submitting the update. The `ProjectForm` can only be used once for a successful update and cannot be reused. The delete operations delete `Projects`. To unmap a `Project` from the current `Campus`, the `ProjectCampusAssignmentSession` should be used. These delete operations attempt to remove the `Project` 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.
Method	getCampusId
Description	Gets the `Campus` `Id` associated with this session.
Return	`osid.id.Id`		the `Campus Id` associated with this session
Compliance	`mandatory`		This method must be implemented.
Method	getCampus
Description	Gets the `Campus` associated with this session.
Return	`osid.room.Campus`		the campus
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	canCreateProjects
Description	Tests if this user can create `Projects`. A return of true does not guarantee successful authorization. A return of false indicates that it is known creating a `Project` 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.
Return	`boolean`		`false` if `Project` creation is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	canCreateProjectWithRecordTypes
Description	Tests if this user can create a single `Project` using the desired record types. While `RoomConstructionManager.getProjectRecordTypes()` can be used to examine which record interfaces are supported, this method tests which record(s) are required for creating a specific `Project`. Providing an empty array tests if a `Project` can be created with no records.
Parameters	`osid.type.Type[]`	`projectRecordTypes`	array of project record types
Return	`boolean`		`true` if `Project` creation using the specified record `Types` is supported, `false` otherwise
Errors	NULL_ARGUMENT		`projectRecordTypes` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	getProjectFormForCreate
Description	Gets the project form for creating new projects. A new form should be requested for each create transaction.
Parameters	`osid.id.Id`	`buildingId`	the `Id` of the building
Parameters	`osid.type.Type[]`	`projectRecordTypes`	array of project record types
Return	`osid.room.construction.ProjectForm`		the project form
Errors	NOT_FOUND		`buildngId` is not found
	NULL_ARGUMENT		`buildngId` or `projectRecordTypes` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		unable to get from for requested record types
Compliance	`mandatory`		This method must be implemented.
Method	createProject
Description	Creates a new `Project`.
Parameters	`osid.room.construction.ProjectForm`	`projectForm`	the form for this `Project`
Return	`osid.room.construction.Project`		the new `Project`
Errors	ILLEGAL_STATE		`projectForm` already used in a create transaction
	INVALID_ARGUMENT		one or more of the form elements is invalid
	NULL_ARGUMENT		`projectForm` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`projectForm` did not originate from `getProjectFormForCreate()`
Compliance	`mandatory`		This method must be implemented.
Method	canUpdateProjects
Description	Tests if this user can update `Projects`. A return of true does not guarantee successful authorization. A return of false indicates that it is known updating a `Project` 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.
Return	`boolean`		`false` if `Project` modification is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getProjectFormForUpdate
Description	Gets the project form for updating an existing project. A new project form should be requested for each update transaction.
Parameters	`osid.id.Id`	`projectId`	the `Id` of the `Project`
Return	`osid.room.construction.ProjectForm`		the project form
Errors	NOT_FOUND		`projectId` is not found
	NULL_ARGUMENT		`projectId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	updateProject
Description	Updates an existing project.
Parameters	`osid.room.construction.ProjectForm`	`projectForm`	the form containing the elements to be updated
Errors	ILLEGAL_STATE		`projectForm` already used in an update transaction
	INVALID_ARGUMENT		the form contains an invalid value
	NULL_ARGUMENT		`projectForm` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`projectForm` did not originate from `getProjectFormForUpdate()`
Compliance	`mandatory`		This method must be implemented.
Method	canDeleteProjects
Description	Tests if this user can delete `Projects` A return of true does not guarantee successful authorization. A return of false indicates that it is known deleting a `Project` 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.
Return	`boolean`		`false` if `Project` deletion is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	deleteProject
Description	Deletes a `Project`.
Parameters	`osid.id.Id`	`projectId`	the `Id` of the `Project` to remove
Errors	NOT_FOUND		`projectId` not found
	NULL_ARGUMENT		`projectId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	canManageProjectAliases
Description	Tests if this user can manage `Id` aliases for `Projects`. 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.
Return	`boolean`		`false` if `Project` aliasing is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	aliasProject
Description	Adds an `Id` to a `Project` for the purpose of creating compatibility. The primary `Id` of the `Project` is determined by the provider. The new `Id` performs as an alias to the primary `Id`. If the alias is a pointer to another project, it is reassigned to the given project `Id`.
Parameters	`osid.id.Id`	`projectId`	the `Id` of a `Project`
Parameters	`osid.id.Id`	`aliasId`	the alias `Id`
Errors	ALREADY_EXISTS		`aliasId` is already assigned
	NOT_FOUND		`projectId` not found
	NULL_ARGUMENT		`projectId` or `aliasId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.