OSID - osid.workflow.rules.StepConstrainerOfficeAssignmentSession Service Interface Definition

Interface	osid.workflow.rules.StepConstrainerOfficeAssignmentSession
Implements	`osid.OsidSession`
Used By	`osid.workflow.rules.WorkflowRulesManager`
Used By	`osid.workflow.rules.WorkflowRulesProxyManager`
Description	This session provides methods to re-assign `StepConstrainer` to `Office` mappings. a `StepConstrainer` may appear in multiple `Office` objects and removing the last reference to a `StepConstrainer` is the equivalent of deleting it. Each `Office` may have its own authorizations governing who is allowed to operate on it. Adding a reference of a `StepConstrainer` to another `Office` is not a copy operation (eg: does not change its `Id`).
Method	canAssignStepConstrainers
Description	Tests if this user can alter step constrainer/office mappings. A return of true does not guarantee successful authorization. A return of false indicates that it is known mapping 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 lookup operations to unauthorized users.
Return	`boolean`		`false` if mapping is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	canAssignStepConstrainersToOffice
Description	Tests if this user can alter step constrainer/office mappings. A return of true does not guarantee successful authorization. A return of false indicates that it is known mapping 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 lookup operations to unauthorized users.
Parameters	`osid.id.Id`	`officeId`	the `Id` of the `Office`
Return	`boolean`		`false` if mapping is not authorized, `true` otherwise
Errors	NULL_ARGUMENT		`officeId` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	getAssignableOfficeIds
Description	Gets a list of office including and under the given office node in which any step constrainer can be assigned.
Parameters	`osid.id.Id`	`officeId`	the `Id` of the `Office`
Return	`osid.id.IdList`		list of assignable office `Ids`
Errors	NULL_ARGUMENT		`officeId` is `null`
Errors	OPERATION_FAILED		unable to complete request
Compliance	`mandatory`		This method must be implemented.
Method	getAssignableOfficeIdsForStepConstrainer
Description	Gets a list of office including and under the given office node in which a specific step constrainer can be assigned.
Parameters	`osid.id.Id`	`officeId`	the `Id` of the `Office`
Parameters	`osid.id.Id`	`stepConstrainerId`	the `Id` of the `StepConstrainer`
Return	`osid.id.IdList`		list of assignable office `Ids`
Errors	NULL_ARGUMENT		`officeId` or `stepConstrainerId` is `null`
Errors	OPERATION_FAILED		unable to complete request
Compliance	`mandatory`		This method must be implemented.
Method	assignStepConstrainerToOffice
Description	Adds an existing `StepConstrainer` to an `Office`.
Parameters	`osid.id.Id`	`stepConstrainerId`	the `Id` of the `StepConstrainer`
Parameters	`osid.id.Id`	`officeId`	the `Id` of the `Office`
Errors	ALREADY_EXISTS		`stepConstrainerId` is already assigned to `officeId`
	NOT_FOUND		`stepConstrainerId` or `officeId` not found
	NULL_ARGUMENT		`stepConstrainerId` or `officeId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	unassignStepConstrainerFromOffice
Description	Removes a `StepConstrainer` from an `Office`.
Parameters	`osid.id.Id`	`stepConstrainerId`	the `Id` of the `StepConstrainer`
Parameters	`osid.id.Id`	`officeId`	the `Id` of the `Office`
Errors	NOT_FOUND		`stepConstrainerId` or `officeId` not found or `stepConstrainerId` not assigned to `officeId`
	NULL_ARGUMENT		`stepConstrainerId` or `officeId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	reassignStepConstrainerToOffice
Description	Moves a `StepConstrainer` from one `Office` to another. Mappings to other `Offices` are unaffected.
Parameters	`osid.id.Id`	`stepConstrainerId`	the `Id` of the `StepConstrainer`
	`osid.id.Id`	`fromOfficeId`	the `Id` of the current `Office`
	`osid.id.Id`	`toOfficeId`	the `Id` of the destination `Office`
Errors	ALREADY_EXISTS		`stepConstrainerId` already assigned to `toOfficeId`
	NOT_FOUND		`stepConstrainerId, fromOfficeId`, or `toOfficeId` not found or `stepConstrainerId` not mapped to `fromOfficeId`
	NULL_ARGUMENT		`stepConstrainerId, fromOfficeId`, or `toOfficeId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.