OSID - osid.workflow.WorkAdminSession Service Interface Definition

Interface	osid.workflow.WorkAdminSession
Implements	`osid.OsidSession`
Description	This session creates, updates, and deletes `Works.` 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 `Work,` a `WorkForm` is requested using `getWorkFormForCreate()` specifying the desired record `Types` or none if no record `Types` are needed. The returned `WorkForm` 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 `WorkForm` is submiited to a create operation, it cannot be reused with another create operation unless the first operation was unsuccessful. Each `WorkForm` corresponds to an attempted transaction. For updates, `WorkForms` are requested to the `Work` `Id` that is to be updated using `getWorkFormForUpdate().` Similarly, the `WorkForm` has metadata about the data that can be updated and it can perform validation before submitting the update. The `WorkForm` can only be used once for a successful update and cannot be reused. The delete operations delete `Works.` To unmap a `Work` from the current `Office,` the `WorkOfficeAssignmentSession` should be used. These delete operations attempt to remove the `Work` itself thus removing it from all known `Office` catalogs. This session includes an `Id` aliasing mechanism to assign an external `Id` to an internally assigned Id.
Method	getOfficeId
Description	Gets the `Office` `Id` associated with this session.
Return	`osid.id.Id`		the `Office Id` associated with this session
Compliance	`mandatory`		This method must be implemented.
Method	getOffice
Description	Gets the `Office` associated with this session.
Return	`osid.workflow.Office`		the office
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	canCreateWorks
Description	Tests if this user can create `Works.` A return of true does not guarantee successful authorization. A return of false indicates that it is known creating a `Work` 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 `Work` creation is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	canCreateWorkWithRecordTypes
Description	Tests if this user can create a single `Work` using the desired record types. While `WorkflowManager.getWorkRecordTypes()` can be used to examine which records are supported, this method tests which record(s) are required for creating a specific `Work.` Providing an empty array tests if a `Work` can be created with no records.
Parameters	`osid.type.Type[]`	`workRecordTypes`	array of work record types
Return	`boolean`		`true` if `Work` creation using the specified record `Types` is supported, `false` otherwise
Errors	NULL_ARGUMENT		`workRecordTypes` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	getWorkFormForCreate
Description	Gets the work form for creating new works. A new form should be requested for each create transaction.
Parameters	`osid.type.Type[]`	`workRecordTypes`	array of work record types
Return	`osid.workflow.WorkForm`		the work form
Errors	NULL_ARGUMENT		`workRecordTypes` 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	createWork
Description	Creates a new `Work.`
Parameters	`osid.workflow.WorkForm`	`workForm`	the form for this `Work`
Return	`osid.workflow.Work`		the new `Work`
Errors	ILLEGAL_STATE		`workForm` already used in a create transaction
	INVALID_ARGUMENT		one or more of the form elements is invalid
	NULL_ARGUMENT		`workForm` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`workForm` did not originate from `getWorkFormForCreate()`
Compliance	`mandatory`		This method must be implemented.
Method	canUpdateWorks
Description	Tests if this user can update `Works.` A return of true does not guarantee successful authorization. A return of false indicates that it is known updating a `Work` 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 `Work` modification is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getWorkFormForUpdate
Description	Gets the work form for updating an existing work. A new work form should be requested for each update transaction.
Parameters	`osid.id.Id`	`workId`	the `Id` of the `Work`
Return	`osid.workflow.WorkForm`		the work form
Errors	NOT_FOUND		`workId` is not found
	NULL_ARGUMENT		`workId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	updateWork
Description	Updates an existing work.
Parameters	`osid.workflow.WorkForm`	`workForm`	the form containing the elements to be updated
Errors	ILLEGAL_STATE		`workForm` already used in an update transaction
	INVALID_ARGUMENT		the form contains an invalid value
	NULL_ARGUMENT		`workForm` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`workForm` did not originate from `getWorkFormForUpdate()`
Compliance	`mandatory`		This method must be implemented.
Method	canDeleteWorks
Description	Tests if this user can delete `Works.` A return of true does not guarantee successful authorization. A return of false indicates that it is known deleting a `Work` 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 `Work` deletion is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	deleteWork
Description	Deletes a `Work.`
Parameters	`osid.id.Id`	`workId`	the `Id` of the `Work` to remove
Errors	NOT_FOUND		`workId` not found
	NULL_ARGUMENT		`workId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	canManageWorkAliases
Description	Tests if this user can manage `Id` aliases for `Works.` 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 `Work` aliasing is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	aliasWork
Description	Adds an `Id` to a `Work` for the purpose of creating compatibility. The primary `Id` of the `Work` is determined by the provider. The new `Id` performs as an alias to the primary `Id.` If the alias is a pointer to another work, it is reassigned to the given work `Id.`
Parameters	`osid.id.Id`	`workId`	the `Id` of a `Work`
Parameters	`osid.id.Id`	`aliasId`	the alias `Id`
Errors	ALREADY_EXISTS		`aliasId` is already assigned
	NOT_FOUND		`workId` not found
	NULL_ARGUMENT		`workId` or `aliasId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	canMoveWork
Description	Tests if this user can move `Work` among process. A return of true does not guarantee successful authorization. A return of false indicates that it is known deleting a `Work` will result in a `PERMISSION_DENIED.` This is intended as a hint to an application that may opt not to offer move operations to an unauthorized user.
Return	`boolean`		`false` if `Work` moving is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	moveWork
Description	Moves work to another process.
Parameters	`osid.id.Id`	`workId`	the work `Id`
Parameters	`osid.id.Id`	`processId`	the new process `Id`
Errors	ALREADY_EXISTS		work already part of process
	NOT_FOUND		`processId` or `workId` is not found
	NULL_ARGUMENT		`processId` or `workId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	canManageWorkStatus
Description	Tests if this user can change `Work` status. A return of true does not guarantee successful authorization. A return of false indicates that it is known deleting a `Work` will result in a `PERMISSION_DENIED.` This is intended as a hint to an application that may opt not to offer status operations to an unauthorized user.
Return	`boolean`		`false` if `Work` status is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	completeWork
Description	Marks work as complete.
Parameters	`osid.id.Id`	`workId`	the work `Id`
Errors	NOT_FOUND		`workId` is not found
	NULL_ARGUMENT		`workId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	reopenWork
Description	Marks work as incomplete.
Parameters	`osid.id.Id`	`workId`	the work `Id`
Errors	NOT_FOUND		`workId` is not found
	NULL_ARGUMENT		`workId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.