OSID - osid.room.CampusAdminSession Service Interface Definition

Interface	osid.room.CampusAdminSession
Implements	`osid.OsidSession`
Implemented By	`osid.room.batch.CampusBatchAdminSession`
Used By	`osid.room.RoomManager`
Used By	`osid.room.RoomProxyManager`
Description	This session creates and removes campuses. The data for create and update is provided by the consumer via the form.
Method	canCreateCampuses
Description	Tests if this user can create `Campuses`. A return of true does not guarantee successful authorization. A return of false indicates that it is known creating a `Campus` 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 `Campus` creation is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	canCreateCampusWithRecordTypes
Description	Tests if this user can create a single `Campus` using the desired record interface types. While `RoomManager.getCampusRecordTypes()` can be used to examine which record interfaces are supported, this method tests which record(s) are required for creating a specific `Campus`. Providing an empty array tests if a `Campus` can be created with no records.
Parameters	`osid.type.Type[]`	`campusRecordTypes`	array of campus record types
Return	`boolean`		`true` if `Campus` creation using the specified record `Types` is supported, `false` otherwise
Errors	NULL_ARGUMENT		`campusRecordTypes` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	getCampusFormForCreate
Description	Gets the campus form for creating new campuses. A new form should be requested for each create transaction.
Parameters	`osid.type.Type[]`	`campusRecordTypes`	array of campus record types
Return	`osid.room.CampusForm`		the campus form
Errors	NULL_ARGUMENT		`campusRecordTypes` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		unable to get foem for requested record types
Compliance	`mandatory`		This method must be implemented.
Method	createCampus
Description	Creates a new `Campus`.
Parameters	`osid.room.CampusForm`	`campusForm`	the form for this `Campus`
Return	`osid.room.Campus`		the new `Campus`
Errors	ILLEGAL_STATE		`campusForm` already used in a create transaction
	INVALID_ARGUMENT		one or more of the form elements is invalid
	NULL_ARGUMENT		`campusForm` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`campusForm` did not originate from `getCampusFormForCreate()`
Compliance	`mandatory`		This method must be implemented.
Method	canUpdateCampuses
Description	Tests if this user can update `Campuses`. A return of true does not guarantee successful authorization. A return of false indicates that it is known updating a `Campus` 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 `Campus` modification is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getCampusFormForUpdate
Description	Gets the campus form for updating an existing campus. A new campus form should be requested for each update transaction.
Parameters	`osid.id.Id`	`campusId`	the `Id` of the `Campus`
Return	`osid.room.CampusForm`		the campus form
Errors	NOT_FOUND		`campusId` is not found
	NULL_ARGUMENT		`campusId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	updateCampus
Description	Updates an existing campus.
Parameters	`osid.room.CampusForm`	`campusForm`	the form containing the elements to be updated
Errors	ILLEGAL_STATE		`campusForm` already used in an update transaction
	INVALID_ARGUMENT		the form contains an invalid value
	NULL_ARGUMENT		`campusForm` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`campusForm` did not originate from `getCampusFormForUpdate()`
Compliance	`mandatory`		This method must be implemented.
Method	canDeleteCampuses
Description	Tests if this user can delete `Campuses` A return of true does not guarantee successful authorization. A return of false indicates that it is known deleting a `Campus` 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 `Campus` deletion is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	deleteCampus
Description	Deletes a `Campus`.
Parameters	`osid.id.Id`	`campusId`	the `Id` of the `Campus` to remove
Errors	NOT_FOUND		`campusId` not found
	NULL_ARGUMENT		`campusId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	canManageCampusAliases
Description	Tests if this user can manage `Id` aliases for `Campuses`. 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 `Campus` aliasing is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	aliasCampus
Description	Adds an `Id` to a `Campus` for the purpose of creating compatibility. The primary `Id` of the `Campus` is determined by the provider. The new `Id` performs as an alias to the primary `Id`. If the alias is a pointer to another campus, it is reassigned to the given campus `Id`.
Parameters	`osid.id.Id`	`campusId`	the `Id` of a `Campus`
Parameters	`osid.id.Id`	`aliasId`	the alias `Id`
Errors	ALREADY_EXISTS		`aliasId` is already assigned
	NOT_FOUND		`campusId` not found
	NULL_ARGUMENT		`campusId` or `aliasId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.