OSID - osid.tracking.FrontOfficeAdminSession Service Interface Definition

Interface	osid.tracking.FrontOfficeAdminSession
Implements	`osid.OsidSession`
Implemented By	`osid.tracking.batch.FrontOfficeBatchAdminSession`
Used By	`osid.tracking.TrackingManager`
Used By	`osid.tracking.TrackingProxyManager`
Description	This session creates, updates, and deletes `FrontOffices`. 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 `FrontOffice`, a `FrontOfficeForm` is requested using `getFrontOfficeFormForCreate()` specifying the desired record `Types` or none if no record `Types` are needed. The returned `FrontOfficeForm` 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 `FrontOfficeForm` is submiited to a create operation, it cannot be reused with another create operation unless the first operation was unsuccessful. Each `FrontOfficeForm` corresponds to an attempted transaction. For updates, `FrontOfficeForms` are requested to the `FrontOffice` `Id` that is to be updated using `getFrontOfficeFormForUpdate()`. Similarly, the `FrontOfficeForm` has metadata about the data that can be updated and it can perform validation before submitting the update. The `FrontOfficeForm` can only be used once for a successful update and cannot be reused. The delete operations delete `FrontOffices`. This session includes an `Id` aliasing mechanism to assign an external `Id` to an internally assigned Id.
Method	canCreateFrontOffices
Description	Tests if this user can create `FrontOffices`. A return of true does not guarantee successful authorization. A return of false indicates that it is known creating a `FrontOffice`. 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 `FrontOffice` creation is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	canCreateFrontOfficeWithRecordTypes
Description	Tests if this user can create a single `FrontOffice` using the desired record types. While `TrackingManager.getFrontOfficeRecordTypes()` can be used to examine which records are supported, this method tests which record(s) are required for creating a specific `FrontOffice`. Providing an empty array tests if a `FrontOffice` can be created with no records.
Parameters	`osid.type.Type[]`	`frontOfficeRecordTypes`	array of front office record types
Return	`boolean`		`true` if `FrontOffice` creation using the specified record `Types` is supported, `false` otherwise
Errors	NULL_ARGUMENT		`frontOfficeRecordTypes` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	getFrontOfficeFormForCreate
Description	Gets the front office form for creating new frontOffices. A new form should be requested for each create transaction.
Parameters	`osid.type.Type[]`	`frontOfficeRecordTypes`	array of front office record types
Return	`osid.tracking.FrontOfficeForm`		the front office form
Errors	NULL_ARGUMENT		`frontOfficeRecordTypes` 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	createFrontOffice
Description	Creates a new `FrontOffice`.
Parameters	`osid.tracking.FrontOfficeForm`	`frontOfficeForm`	the form for this `FrontOffice`
Return	`osid.tracking.FrontOffice`		the new `FrontOffice`
Errors	ILLEGAL_STATE		`frontOfficeForm` already use din a create transaction
	INVALID_ARGUMENT		one or more of the form elements is invalid
	NULL_ARGUMENT		`frontOfficeForm` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`frontOfficeForm` did not originate from `getFrontOfficeFormForCreate()`
Compliance	`mandatory`		This method must be implemented.
Method	canUpdateFrontOffices
Description	Tests if this user can update `FrontOffices`. A return of true does not guarantee successful authorization. A return of false indicates that it is known updating a `FrontOffice` 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 `FrontOffice` modification is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getFrontOfficeFormForUpdate
Description	Gets the front office form for updating an existing front office. A new front office form should be requested for each update transaction.
Parameters	`osid.id.Id`	`frontOfficeId`	the `Id` of the `FrontOffice`
Return	`osid.tracking.FrontOfficeForm`		the front office form
Errors	NOT_FOUND		`frontOfficeId` is not found
	NULL_ARGUMENT		`frontOfficeId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	updateFrontOffice
Description	Updates an existing front office
Parameters	`osid.tracking.FrontOfficeForm`	`frontOfficeForm`	the form containing the elements to be updated
Errors	ILLEGAL_STATE		`frontOfficeForm` already use din an update transaction
	INVALID_ARGUMENT		the form contains an invalid value
	NULL_ARGUMENT		`frontOfficeId` or `frontOfficeForm` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`frontOfficeForm` did not originate from `getFrontOfficeFormForUpdate()`
Compliance	`mandatory`		This method must be implemented.
Method	canDeleteFrontOffices
Description	Tests if this user can delete `FrontOffices`. A return of true does not guarantee successful authorization. A return of false indicates that it is known deleting a `FrontOffice` 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 `FrontOffice` deletion is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	deleteFrontOffice
Description	Deletes a `FrontOffice`.
Parameters	`osid.id.Id`	`frontOfficeId`	the `Id` of the `FrontOffice` to remove
Errors	NOT_FOUND		`frontOfficeId` not found
	NULL_ARGUMENT		`frontOfficeId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	canManageFrontOfficeAliases
Description	Tests if this user can manage `Id` aliases for `FrontOffices`. 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 `FrontOffice` aliasing is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	aliasFrontOffice
Description	Adds an `Id` to a `FrontOffice` for the purpose of creating compatibility. The primary `Id` of the `FrontOffice` is determined by the provider. The new `Id` performs as an alias to the primary `Id`.
Parameters	`osid.id.Id`	`frontOfficeId`	the `Id` of a `FrontOffice`
Parameters	`osid.id.Id`	`aliasId`	the alias `Id`
Errors	ALREADY_EXISTS		`aliasId` is already assigned
	NOT_FOUND		`frontOfficeId` not found
	NULL_ARGUMENT		`frontOfficeId` or `aliasId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.