OSID - osid.tracking.QueueFrontOfficeAssignmentSession Service Interface Definition

Interface	osid.tracking.QueueFrontOfficeAssignmentSession
Implements	`osid.OsidSession`
Used By	`osid.tracking.TrackingManager`
Used By	`osid.tracking.TrackingProxyManager`
Description	This session provides methods to re-assign `Queues` to `FrontOffice` objects. A `Queue` may appear in multiple `FrontOffice` objects and removing the last reference to a `Queue` is the equivalent of deleting it. Each `FrontOffice` may have its own authorizations governing who is allowed to operate on it. Adding a reference of a `Queue` to another `FrontOffice` is not a copy operation (eg: does not change its `Id`).
Method	canAssignQueues
Description	Tests if this user can alter queue/front office mappings. A return of true does not guarantee successful authorization. A return of false indicates that it is known queue methods in this session will result in a `PERMISSION_DENIED`. This is intended as a hint to an application that may opt not to offer assignment operations to unauthorized users.
Return	`boolean`		`false` if mapping is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	canAssignQueuesToFrontOffice
Description	Tests if this user can alter queue/front office mappings. A return of true does not guarantee successful authorization. A return of false indicates that it is known queue methods in this session will result in a `PERMISSION_DENIED`. This is intended as a hint to an application that may opt not to offer assignment operations to unauthorized users.
Parameters	`osid.id.Id`	`frontOfficeId`	the `Id` of the `FrontOffice`
Return	`boolean`		`false` if mapping is not authorized, `true` otherwise
Errors	NULL_ARGUMENT		`frontOfficeId` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	getAssignableFrontOfficeIds
Description	Gets a list of front offices including and under the given front office node in which any queue can be assigned.
Parameters	`osid.id.Id`	`frontOfficeId`	the `Id` of the `FrontOffice`
Return	`osid.id.IdList`		list of assignable front office `Ids`
Errors	NULL_ARGUMENT		`frontOfficeId` is `null`
Errors	OPERATION_FAILED		unable to complete request
Compliance	`mandatory`		This method must be implemented.
Method	getAssignableFrontOfficeIdsForQueue
Description	Gets a list of front offices including and under the given front office node in which a specific queue can be assigned.
Parameters	`osid.id.Id`	`frontOfficeId`	the `Id` of the `FrontOffice`
Parameters	`osid.id.Id`	`queueId`	the `Id` of the `Queue`
Return	`osid.id.IdList`		list of assignable front office `Ids`
Errors	NULL_ARGUMENT		`frontOfficeId` or `queueId` is `null`
Errors	OPERATION_FAILED		unable to complete request
Compliance	`mandatory`		This method must be implemented.
Method	assignQueueToFrontOffice
Description	Adds an existing `Queue` to a `FrontOffice`.
Parameters	`osid.id.Id`	`queueId`	the `Id` of the `Queue`
Parameters	`osid.id.Id`	`frontOfficeId`	the `Id` of the `FrontOffice`
Errors	ALREADY_EXISTS		`queueId` is already assigned to `frontOfficeId`
	NOT_FOUND		`queueId` or `frontOfficeId` not found
	NULL_ARGUMENT		`queueId` or `frontOfficeId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	unassignQueueFromFrontOffice
Description	Removes a `Queue` from a `FrontOffice`.
Parameters	`osid.id.Id`	`queueId`	the `Id` of the `Queue`
Parameters	`osid.id.Id`	`frontOfficeId`	the `Id` of the `FrontOffice`
Errors	NOT_FOUND		`queueId` or `frontOfficeId` not found or `queueId` not assigned to `frontOfficeId`
	NULL_ARGUMENT		`queueId` or `frontOfficeId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	reassignQueueToFrontOffice
Description	Moves a `Queue` from one `FrontOffice` to another. Mappings to other `FrontOffices` are unaffected.
Parameters	`osid.id.Id`	`queueId`	the `Id` of the `Queue`
	`osid.id.Id`	`fromFrontOfficeId`	the `Id` of the current `FrontOffice`
	`osid.id.Id`	`toFrontOfficeId`	the `Id` of the destination `FrontOffice`
Errors	ALREADY_EXISTS		`queueId` already assigned to `toFrontOfficeId`
	NOT_FOUND		`queueId, fromFrontOfficeId`, or `toFrontOfficeId` not found or `queueId` not mapped to `fromFrontOfficeId`
	NULL_ARGUMENT		`queueId, fromFrontOfficeId`, or `toFrontOfficeId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.