OSID - osid.forum.ForumAdminSession Service Interface Definition

Interface	osid.forum.ForumAdminSession
Implements	`osid.OsidSession`
Description	This session creates, updates, and deletes `Forums.` 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 `Forum,` a `ForumForm` is requested using `getForumFormForCreate()` specifying the desired record `Types` or none if no record `Types` are needed. The returned `ForumForm` 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 `ForumForm` is submiited to a create operation, it cannot be reused with another create operation unless the first operation was unsuccessful. Each `ForumForm` corresponds to an attempted transaction. For updates, `ForumForms` are requested to the `Forum` `Id` that is to be updated using `getForumFormForUpdate().` Similarly, the `ForumForm` has metadata about the data that can be updated and it can perform validation before submitting the update. The `ForumForm` can only be used once for a successful update and cannot be reused. The delete operations delete `Forums.` This session includes an `Id` aliasing mechanism to assign an external `Id` to an internally assigned Id.
Method	canCreateForums
Description	Tests if this user can create `Forums.` A return of true does not guarantee successful authorization. A return of false indicates that it is known creating a `Forum` 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 `Forum` creation is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	canCreateForumWithRecordTypes
Description	Tests if this user can create a single `Forum` using the desired record types. While `ForumManager.getForumRecordTypes()` can be used to examine which records are supported, this method tests which record(s) are required for creating a specific `Forum.` Providing an empty array tests if a `Forum` can be created with no records.
Parameters	`osid.type.Type[]`	`forumRecordTypes`	array of forum record types
Return	`boolean`		`true` if `Forum` creation using the specified record `Types` is supported, `false` otherwise
Errors	NULL_ARGUMENT		`forumRecordTypes` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	getForumFormForCreate
Description	Gets the forum form for creating new forums. A new form should be requested for each create transaction.
Parameters	`osid.type.Type[]`	`forumRecordTypes`	array of forum record types
Return	`osid.forum.ForumForm`		the forum form
Errors	NULL_ARGUMENT		`forumRecordTypes` 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	createForum
Description	Creates a new `Forum.`
Parameters	`osid.forum.ForumForm`	`forumForm`	the form for this `Forum`
Return	`osid.forum.Forum`		the new `Forum`
Errors	ILLEGAL_STATE		`forumForm` already used in a create transaction
	INVALID_ARGUMENT		one or more of the form elements is invalid
	NULL_ARGUMENT		`forumForm` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`forumForm` did not originate from `getForumFormForCreate()`
Compliance	`mandatory`		This method must be implemented.
Method	canUpdateForums
Description	Tests if this user can update `Forums.` A return of true does not guarantee successful authorization. A return of false indicates that it is known updating a `Forum` 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 `Forum` modification is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getForumFormForUpdate
Description	Gets the forum form for updating an existing forum. A new forum form should be requested for each update transaction.
Parameters	`osid.id.Id`	`forumId`	the `Id` of the `Forum`
Return	`osid.forum.ForumForm`		the forum form
Errors	NOT_FOUND		`forumId` is not found
	NULL_ARGUMENT		`forumId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	updateForum
Description	Updates an existing forum.
Parameters	`osid.forum.ForumForm`	`forumForm`	the form containing the elements to be updated
Errors	ILLEGAL_STATE		`forumForm` already used in an update transaction
	INVALID_ARGUMENT		the form contains an invalid value
	NULL_ARGUMENT		`forumForm` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`forumForm` did not originate from `getForumFormForUpdate()`
Compliance	`mandatory`		This method must be implemented.
Method	canDeleteForums
Description	Tests if this user can delete `Forums` A return of true does not guarantee successful authorization. A return of false indicates that it is known deleting a `Forum` 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 `Forum` deletion is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	deleteForum
Description	Deletes a `Forum.`
Parameters	`osid.id.Id`	`forumId`	the `Id` of the `Forum` to remove
Errors	NOT_FOUND		`forumId` not found
	NULL_ARGUMENT		`forumId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	canManageForumAliases
Description	Tests if this user can manage `Id` aliases for `Forums.` 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 `Forum` aliasing is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	aliasForum
Description	Adds an `Id` to a `Forum` for the purpose of creating compatibility. The primary `Id` of the `Forum` is determined by the provider. The new `Id` performs as an alias to the primary `Id.` If the alias is a pointer to another forum, it is reassigned to the given forum `Id.`
Parameters	`osid.id.Id`	`forumId`	the `Id` of a `Forum`
Parameters	`osid.id.Id`	`aliasId`	the alias `Id`
Errors	ALREADY_EXISTS		`aliasId` is already assigned
	NOT_FOUND		`forumId` not found
	NULL_ARGUMENT		`forumId` or `aliasId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.