OSID - osid.inventory.ModelAdminSession Service Interface Definition

Interface	osid.inventory.ModelAdminSession
Implements	`osid.OsidSession`
Implemented By	`osid.inventory.batch.ModelBatchAdminSession`
Used By	`osid.inventory.InventoryManager`
Used By	`osid.inventory.InventoryProxyManager`
Description	This session creates, updates, and deletes `Models`. 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 `Model`, a `ModelForm` is requested using `getModelFormForCreate()` specifying the desired record `Types` or none if no record `Types` are needed. The returned `ModelForm` 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 `ModelForm` is submiited to a create operation, it cannot be reused with another create operation unless the first operation was unsuccessful. Each `ModelForm` corresponds to an attempted transaction. For updates, `ModelForms` are requested to the `Model` `Id` that is to be updated using `getModelFormForUpdate()`. Similarly, the `ModelForm` has metadata about the data that can be updated and it can perform validation before submitting the update. The `ModelForm` can only be used once for a successful update and cannot be reused. The delete operations delete `Models`. To unmap a `Model` from the current `Warehouse`, the `ModelWarehouseAssignmentSession` should be used. These delete operations attempt to remove the `Model` itself thus removing it from all known `Warehouse` catalogs. This session includes an `Id` aliasing mechanism to assign an external `Id` to an internally assigned Id.
Method	getWarehouseId
Description	Gets the `Warehouse` `Id` associated with this session.
Return	`osid.id.Id`		the `Warehouse Id` associated with this session
Compliance	`mandatory`		This method must be implemented.
Method	getWarehouse
Description	Gets the `Warehouse` associated with this session.
Return	`osid.inventory.Warehouse`		the warehouse
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	canCreateModels
Description	Tests if this user can create `Models`. A return of true does not guarantee successful authorization. A return of false indicates that it is known creating a `Model` will result in a `PERMISSION_DENIED`. This is intended as a hint to an application that may opt not to offer create operations to an unauthorized user.
Return	`boolean`		`false` if `Model` creation is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	canCreateModelWithRecordTypes
Description	Tests if this user can create a single `Model` using the desired record types. While `InventoryManager.getModelRecordTypes()` can be used to examine which records are supported, this method tests which record(s) are required for creating a specific `Model`. Providing an empty array tests if a `Model` can be created with no records.
Parameters	`osid.type.Type[]`	`modelRecordTypes`	array of model record types
Return	`boolean`		`true` if `Model` creation using the specified record `Types` is supported, `false` otherwise
Errors	NULL_ARGUMENT		`modelRecordTypes` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	getModelFormForCreate
Description	Gets the model form for creating new models. A new form should be requested for each create transaction.
Parameters	`osid.type.Type[]`	`modelRecordTypes`	array of model record types
Return	`osid.inventory.ModelForm`		the model form
Errors	NULL_ARGUMENT		`modelRecordTypes` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		unable to get form for requested record types
Compliance	`mandatory`		This method must be implemented.
Method	createModel
Description	Creates a new `Model`.
Parameters	`osid.inventory.ModelForm`	`modelForm`	the form for this `Model`
Return	`osid.inventory.Model`		the new `Model`
Errors	ILLEGAL_STATE		`modelForm` already used in a create transaction
	INVALID_ARGUMENT		one or more of the form elements is invalid
	NULL_ARGUMENT		`courseId, termId`, or `modelForm` is `null`
	NOT_FOUND		`modelForm` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`modelForm` did not originate from `getModelFormForCreate()`
Compliance	`mandatory`		This method must be implemented.
Method	canUpdateModels
Description	Tests if this user can update `Models`. A return of true does not guarantee successful authorization. A return of false indicates that it is known updating a `Model` will result in a `PERMISSION_DENIED`. This is intended as a hint to an application that may opt not to offer update operations to an unauthorized user.
Return	`boolean`		`false` if `Model` modification is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getModelFormForUpdate
Description	Gets the model form for updating an existing model. A new model form should be requested for each update transaction.
Parameters	`osid.id.Id`	`modelId`	the `Id` of the `Model`
Return	`osid.inventory.ModelForm`		the model form
Errors	NOT_FOUND		`modelId` is not found
	NULL_ARGUMENT		`modelId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	updateModel
Description	Updates an existing model.
Parameters	`osid.inventory.ModelForm`	`modelForm`	the form containing the elements to be updated
Errors	ILLEGAL_STATE		`modelForm` already used in an update transaction
	INVALID_ARGUMENT		the form contains an invalid value
	NULL_ARGUMENT		`modelForm` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`modelForm` did not originate from `getModelFormForUpdate()`
Compliance	`mandatory`		This method must be implemented.
Method	canDeleteModels
Description	Tests if this user can delete `Models`. A return of true does not guarantee successful authorization. A return of false indicates that it is known deleting a `Model` will result in a `PERMISSION_DENIED`. This is intended as a hint to an application that may opt not to offer delete operations to an unauthorized user.
Return	`boolean`		`false` if `Model` deletion is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	deleteModel
Description	Deletes a `Model`.
Parameters	`osid.id.Id`	`modelId`	the `Id` of the `Model` to remove
Errors	NOT_FOUND		`modelId` not found
	NULL_ARGUMENT		`modelId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	canManageModelAliases
Description	Tests if this user can manage `Id` aliases for `Models`. 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 `Model` aliasing is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	aliasModel
Description	Adds an `Id` to a `Model` for the purpose of creating compatibility. The primary `Id` of the `Model` is determined by the provider. The new `Id` performs as an alias to the primary `Id`. If the alias is a pointer to another model, it is reassigned to the given model `Id`.
Parameters	`osid.id.Id`	`modelId`	the `Id` of a `Model`
Parameters	`osid.id.Id`	`aliasId`	the alias `Id`
Errors	ALREADY_EXISTS		`aliasId` is in use as a primary `Id`
	NOT_FOUND		`modelId` not found
	NULL_ARGUMENT		`modelId` or `aliasId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.