OSID - osid.resourcing.FoundryAdminSession Service Interface Definition

Interface	osid.resourcing.FoundryAdminSession
Implements	`osid.OsidSession`
Description	This session creates, updates, and deletes `Foundries.` 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 `Foundry,` a `FoundryForm` is requested using `getFoundryFormForCreate()` specifying the desired record `Types` or none if no record `Types` are needed. The returned `FoundryForm` 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 `FoundryForm` is submiited to a create operation, it cannot be reused with another create operation unless the first operation was unsuccessful. Each `FoundryForm` corresponds to an attempted transaction. For updates, `FoundryForms` are requested to the `Foundry` `Id` that is to be updated using `getFoundryFormForUpdate().` Similarly, the `FoundryForm` has metadata about the data that can be updated and it can perform validation before submitting the update. The `FoundryForm` can only be used once for a successful update and cannot be reused. The delete operations delete `Foundries,` It is safer to remove all mappings to the `Foundry` catalogs before deletion. This session includes an `Id` aliasing mechanism to assign an external `Id` to an internally assigned Id.
Method	canCreateFoundries
Description	Tests if this user can create `Foundries.` A return of true does not guarantee successful authorization. A return of false indicates that it is known creating a `Foundry.` 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 `Foundry` creation is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	canCreateFoundryWithRecordTypes
Description	Tests if this user can create a single `Foundry` using the desired record types. While `ResourcingManager.getFoundryRecordTypes()` can be used to examine which records are supported, this method tests which record(s) are required for creating a specific `Foundry.` Providing an empty array tests if a `Foundry` can be created with no records.
Parameters	`osid.type.Type[]`	`foundryRecordTypes`	array of foundry record types
Return	`boolean`		`true` if `Foundry` creation using the specified record `Types` is supported, `false` otherwise
Errors	NULL_ARGUMENT		`foundryRecordTypes` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	getFoundryFormForCreate
Description	Gets the foundry form for creating new foundries. A new form should be requested for each create transaction.
Parameters	`osid.type.Type[]`	`foundryRecordTypes`	array of foundry record types
Return	`osid.resourcing.FoundryForm`		the foundry form
Errors	NULL_ARGUMENT		`foundryRecordTypes` 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	createFoundry
Description	Creates a new `Foundry.`
Parameters	`osid.resourcing.FoundryForm`	`foundryForm`	the form for this `Foundry`
Return	`osid.resourcing.Foundry`		the new `Foundry`
Errors	ILLEGAL_STATE		`foundryForm` already used in a create transaction
	INVALID_ARGUMENT		one or more of the form elements is invalid
	NULL_ARGUMENT		`foundryForm` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`foundryForm` did not originate from `getFoundryFormForCreate()`
Compliance	`mandatory`		This method must be implemented.
Method	canUpdateFoundries
Description	Tests if this user can update `Foundries.` A return of true does not guarantee successful authorization. A return of false indicates that it is known updating a `Foundry` 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 `Foundry` modification is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getFoundryFormForUpdate
Description	Gets the foundry form for updating an existing foundry. A new foundry form should be requested for each update transaction.
Parameters	`osid.id.Id`	`foundryId`	the `Id` of the `Foundry`
Return	`osid.resourcing.FoundryForm`		the foundry form
Errors	NOT_FOUND		`foundryId` is not found
	NULL_ARGUMENT		`foundryId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	updateFoundry
Description	Updates an existing foundry
Parameters	`osid.resourcing.FoundryForm`	`foundryForm`	the form containing the elements to be updated
Errors	ILLEGAL_STATE		`foundryForm` already used in an update transaction
	INVALID_ARGUMENT		the form contains an invalid value
	NULL_ARGUMENT		`foundryForm` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`foundryForm` did not originate from `getFoundryFormForUpdate()`
Compliance	`mandatory`		This method must be implemented.
Method	canDeleteFoundries
Description	Tests if this user can delete `Foundries.` A return of true does not guarantee successful authorization. A return of false indicates that it is known deleting a `Foundry` 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 `Foundry` deletion is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	deleteFoundry
Description	Deletes a `Foundry.`
Parameters	`osid.id.Id`	`foundryId`	the `Id` of the `Foundry` to remove
Errors	NOT_FOUND		`foundryId` not found
	NULL_ARGUMENT		`foundryId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	canManageFoundryAliases
Description	Tests if this user can manage `Id` aliases for `Foundries.` 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 `Foundry` aliasing is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	aliasFoundry
Description	Adds an `Id` to a `Foundry` for the purpose of creating compatibility. The primary `Id` of the `Foundry` is determined by the provider. The new `Id` performs as an alias to the primary `Id.`
Parameters	`osid.id.Id`	`foundryId`	the `Id` of a `Foundry`
Parameters	`osid.id.Id`	`aliasId`	the alias `Id`
Errors	ALREADY_EXISTS		`aliasId` is already assigned
	NOT_FOUND		`foundryId` not found
	NULL_ARGUMENT		`foundryId` or `aliasId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.