OSID - osid.workflow.OfficeAdminSession Service Interface Definition

Interface	osid.workflow.OfficeAdminSession
Implements	`osid.OsidSession`
Description	This session creates, updates, and deletes `Offices.` 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 an `Office,` an `OfficeForm` is requested using `getOfficeFormForCreate()` specifying the desired record `Types` or none if no record `Types` are needed. The returned `OfficeForm` 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 `OfficeForm` is submiited to a create operation, it cannot be reused with another create operation unless the first operation was unsuccessful. Each `OfficeForm` corresponds to an attempted transaction. For updates, `OfficeForms` are requested to the `Office` `Id` that is to be updated using `getOfficeFormForUpdate().` Similarly, the `OfficeForm` has metadata about the data that can be updated and it can perform validation before submitting the update. The `OfficeForm` can only be used once for a successful update and cannot be reused. The delete operations delete `Offices.` This session includes an `Id` aliasing mechanism to assign an external `Id` to an internally assigned Id.
Method	canCreateOffices
Description	Tests if this user can create `Offices.` A return of true does not guarantee successful authorization. A return of false indicates that it is known creating an `Office.` 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 `Office` creation is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	canCreateOfficeWithRecordTypes
Description	Tests if this user can create a single `Office` using the desired record types. While `WorkflowManager.getOfficeRecordTypes()` can be used to examine which records are supported, this method tests which record(s) are required for creating a specific `Office.` Providing an empty array tests if an `Office` can be created with no records.
Parameters	`osid.type.Type[]`	`officeRecordTypes`	array of office record types
Return	`boolean`		`true` if `Office` creation using the specified record `Types` is supported, `false` otherwise
Errors	NULL_ARGUMENT		`officeRecordTypes` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	getOfficeFormForCreate
Description	Gets the office form for creating new offices. A new form should be requested for each create transaction.
Parameters	`osid.type.Type[]`	`officeRecordTypes`	array of office record types
Return	`osid.workflow.OfficeForm`		the office form
Errors	NULL_ARGUMENT		`officeRecordTypes` 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	createOffice
Description	Creates a new `Office.`
Parameters	`osid.workflow.OfficeForm`	`officeForm`	the form for this `Office`
Return	`osid.workflow.Office`		the new `Office`
Errors	ILLEGAL_STATE		`officeForm` already used in a create transaction
	INVALID_ARGUMENT		one or more of the form elements is invalid
	NULL_ARGUMENT		`officeForm` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`officeForm` did not originate from `getOfficeFormForCreate()`
Compliance	`mandatory`		This method must be implemented.
Method	canUpdateOffices
Description	Tests if this user can update `Offices.` A return of true does not guarantee successful authorization. A return of false indicates that it is known updating an `Office` 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 `Office` modification is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getOfficeFormForUpdate
Description	Gets the office form for updating an existing office. A new office form should be requested for each update transaction.
Parameters	`osid.id.Id`	`officeId`	the `Id` of the `Office`
Return	`osid.workflow.OfficeForm`		the office form
Errors	NOT_FOUND		`officeId` is not found
	NULL_ARGUMENT		`officeId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	updateOffice
Description	Updates an existing office
Parameters	`osid.workflow.OfficeForm`	`officeForm`	the form containing the elements to be updated
Errors	ILLEGAL_STATE		`officeForm` already used in an update transaction
	INVALID_ARGUMENT		the form contains an invalid value
	NULL_ARGUMENT		`officeForm` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`officeForm` did not originate from `getOfficeFormForUpdate()`
Compliance	`mandatory`		This method must be implemented.
Method	canDeleteOffices
Description	Tests if this user can delete `Offices.` A return of true does not guarantee successful authorization. A return of false indicates that it is known deleting an `Office` 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 `Office` deletion is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	deleteOffice
Description	Deletes an `Office.`
Parameters	`osid.id.Id`	`officeId`	the `Id` of the `Office` to remove
Errors	NOT_FOUND		`officeId` not found
	NULL_ARGUMENT		`officeId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	canManageOfficeAliases
Description	Tests if this user can manage `Id` aliases for `Offices.` 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 `Office` aliasing is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	aliasOffice
Description	Adds an `Id` to an `Office` for the purpose of creating compatibility. The primary `Id` of the `Office` is determined by the provider. The new `Id` performs as an alias to the primary `Id.`
Parameters	`osid.id.Id`	`officeId`	the `Id` of an `Office`
Parameters	`osid.id.Id`	`aliasId`	the alias `Id`
Errors	ALREADY_EXISTS		`aliasId` is already assigned
	NOT_FOUND		`officeId` not found
	NULL_ARGUMENT		`officeId` or `aliasId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.