OSID - osid.resourcing.EffortFoundryAssignmentSession Service Interface Definition

Interface	osid.resourcing.EffortFoundryAssignmentSession
Implements	`osid.OsidSession`
Used By	`osid.resourcing.ResourcingManager`
Used By	`osid.resourcing.ResourcingProxyManager`
Description	This session provides methods to re-assign `Efforts` to `Foundry` mappings. An `Effort` may appear in multiple `Foundry` objects and removing the last reference to an `Effort` is the equivalent of deleting it. Each `Foundry` may have its own authorizations governing who is allowed to operate on it. Adding a reference of an `Effort` to another `Foundry` is not a copy operation (eg: does not change its `Id`).
Method	canAssignEfforts
Description	Tests if this user can alter effort/foundry 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 assignment operations to unauthorized users.
Return	`boolean`		`false` if resourcing is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	canAssignEffortsToFoundry
Description	Tests if this user can alter effort/foundry 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 assignment operations to unauthorized users.
Parameters	`osid.id.Id`	`foundryId`	the `Id` of the `Foundry`
Return	`boolean`		`false` if resourcing is not authorized, `true` otherwise
Errors	NULL_ARGUMENT		`foundryId` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	getAssignableFoundryIds
Description	Gets a list of foundries including and under the given foundry node in which any effort can be assigned.
Parameters	`osid.id.Id`	`foundryId`	the `Id` of the `Foundry`
Return	`osid.id.IdList`		list of assignable foundry `Ids`
Errors	NULL_ARGUMENT		`foundryId` is `null`
Errors	OPERATION_FAILED		unable to complete request
Compliance	`mandatory`		This method must be implemented.
Method	getAssignableFoundryIdsForEffort
Description	Gets a list of foundries including and under the given foundry node in which a specific effort can be assigned.
Parameters	`osid.id.Id`	`foundryId`	the `Id` of the `Foundry`
Parameters	`osid.id.Id`	`effortId`	the `Id` of the `Effort`
Return	`osid.id.IdList`		list of assignable foundry `Ids`
Errors	NULL_ARGUMENT		`foundryId` or `effortId` is `null`
Errors	OPERATION_FAILED		unable to complete request
Compliance	`mandatory`		This method must be implemented.
Method	assignEffortToFoundry
Description	Adds an existing `Effort` to a `Foundry`.
Parameters	`osid.id.Id`	`effortId`	the `Id` of the `Effort`
Parameters	`osid.id.Id`	`foundryId`	the `Id` of the `Foundry`
Errors	NOT_FOUND		`effortId` or `foundryId` not found
	NULL_ARGUMENT		`effortId` or `foundryId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	unassignEffortFromFoundry
Description	Removes an `Effort` from a `Foundry`.
Parameters	`osid.id.Id`	`effortId`	the `Id` of the `Effort`
Parameters	`osid.id.Id`	`foundryId`	the `Id` of the `Foundry`
Errors	NOT_FOUND		`effortId` or `foundryId` not found
	NULL_ARGUMENT		`effortId` or `foundryId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	reassignEffortToFoundry
Description	Moves an `Effort` from one `Foundry` to another. Mappings to other `Foundries` are unaffected.
Parameters	`osid.id.Id`	`effortId`	the `Id` of the `Effort`
	`osid.id.Id`	`fromFoundryId`	the `Id` of the current `Foundry`
	`osid.id.Id`	`toFoundryId`	the `Id` of the destination `Foundry`
Errors	ALREADY_EXISTS		`effortId` already assigned to `toFoundryId`
	NOT_FOUND		`effortId, fromFoundryId`, or `toFoundryId` not found or `effortId` not mapped to `fromFoundryId`
	NULL_ARGUMENT		`effortId, fromFoundryId`, or `toFoundryId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.