OSID - osid.forum.ReplyAdminSession Service Interface Definition

Interface	osid.forum.ReplyAdminSession
Implements	`osid.OsidSession`
Description	This session creates, updates, and deletes `Replies.` 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 `Reply,` a `ReplyForm` is requested using `getReplyFormForCreate()` specifying the desired post and record `Types` or none if no record `Types` are needed. The returned `ReplyForm` 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 `ReplyForm` is submiited to a create operation, it cannot be reused with another create operation unless the first operation was unsuccessful. Each `ReplyForm` corresponds to an attempted transaction. For updates, `ReplyForms` are requested to the `Reply` `Id` that is to be updated using `getReplyFormForUpdate().` Similarly, the `ReplyForm` has metadata about the data that can be updated and it can perform validation before submitting the update. The `ReplyForm` can only be used once for a successful update and cannot be reused. The delete operations delete `Replies.` To unmap a `Reply` from the current `Forum,` the `ReplyForumAssignmentSession` should be used. These delete operations attempt to remove the `Reply` itself thus removing it from all known `Forum` catalogs. This session includes an `Id` aliasing mechanism to assign an external `Id` to an internally assigned Id.
Method	getForumId
Description	Gets the `Forum` `Id` associated with this session.
Return	`osid.id.Id`		the `Forum Id` associated with this session
Compliance	`mandatory`		This method must be implemented.
Method	getForum
Description	Gets the `Forum` associated with this session.
Return	`osid.forum.Forum`		the forum
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	canCreateReplies
Description	Tests if this user can create hournal entries. A return of true does not guarantee successful authorization. A return of false indicates that it is known creating a `Reply` 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 `Reply` creation is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	canCreateReplyWithRecordTypes
Description	Tests if this user can create a single `Reply` using the desired record types. While `ForumManager.getReplyRecordTypes()` can be used to examine which records are supported, this method tests which record(s) are required for creating a specific `Reply.` Providing an empty array tests if a `Reply` can be created with no records.
Parameters	`osid.type.Type[]`	`replyRecordTypes`	array of reply record types
Return	`boolean`		`true` if `Reply` creation using the specified record `Types` is supported, `false` otherwise
Errors	NULL_ARGUMENT		`replyRecordTypes` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	getReplyFormForCreateToPost
Description	Gets the reply form for creating new replies to a post. A new form should be requested for each create transaction.
Parameters	`osid.id.Id`	`postId`	the `Id` for the post
Parameters	`osid.type.Type[]`	`replyRecordTypes`	array of reply record types
Return	`osid.forum.ReplyForm`		the reply form
Errors	NOT_FOUND		`postId` is not found
	NULL_ARGUMENT		`postId` or `replyRecordTypes` 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	getReplyFormForCreateToReply
Description	Gets the reply form for creating new replies to another reply. A new form should be requested for each create transaction.
Parameters	`osid.id.Id`	`replyId`	the `Id` for the reply
Parameters	`osid.type.Type[]`	`replyRecordTypes`	array of reply record types
Return	`osid.forum.ReplyForm`		the reply form
Errors	NOT_FOUND		`replyId` is not found
	NULL_ARGUMENT		`replyId` or `replyRecordTypes` 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	createReply
Description	Creates a new `Reply.`
Parameters	`osid.forum.ReplyForm`	`replyForm`	the form for this `Reply`
Return	`osid.forum.Reply`		the new `Reply`
Errors	ILLEGAL_STATE		`replyForm` already used in a create transaction
	INVALID_ARGUMENT		one or more of the form elements is invalid
	NULL_ARGUMENT		`replyForm` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`replyForm` did not originate from `getReplyFormForCreateToPost()` or `getReplyFormForCreateToReply()`
Compliance	`mandatory`		This method must be implemented.
Method	canUpdateReplies
Description	Tests if this user can update replies. A return of true does not guarantee successful authorization. A return of false indicates that it is known updating a `Reply` 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 `Reply` modification is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getReplyFormForUpdate
Description	Gets the reply form for updating an existing reply. A new reply form should be requested for each update transaction.
Parameters	`osid.id.Id`	`replyId`	the `Id` of the `Reply`
Return	`osid.forum.ReplyForm`		the reply form
Errors	NOT_FOUND		`replyId` is not found
	NULL_ARGUMENT		`replyId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	updateReply
Description	Updates an existing reply.
Parameters	`osid.forum.ReplyForm`	`replyForm`	the form containing the elements to be updated
Errors	ILLEGAL_STATE		`replyForm` already used in an update transaction
	INVALID_ARGUMENT		the form contains an invalid value
	NULL_ARGUMENT		`replyForm` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`replyForm` did not originate from `getReplyFormForUpdate()`
Compliance	`mandatory`		This method must be implemented.
Method	canDeleteReplies
Description	Tests if this user can delete replies. A return of true does not guarantee successful authorization. A return of false indicates that it is known deleting an `Reply` 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 `Reply` deletion is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	deleteReply
Description	Deletes an `Reply.`
Parameters	`osid.id.Id`	`replyId`	the `Id` of the `Reply` to remove
Errors	NOT_FOUND		`replyId` not found
	NULL_ARGUMENT		`replyId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	canManageReplyAliases
Description	Tests if this user can manage `Id` aliases for `Comnents.` 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 `Reply` aliasing is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	aliasReply
Description	Adds an `Id` to a `Reply` for the purpose of creating compatibility. The primary `Id` of the `Reply` is determined by the provider. The new `Id` performs as an alias to the primary `Id.` If the alias is a pointer to another reply, it is reassigned to the given reply `Id.`
Parameters	`osid.id.Id`	`replyId`	the `Id` of a `Reply`
Parameters	`osid.id.Id`	`aliasId`	the alias `Id`
Errors	ALREADY_EXISTS		`aliasId` is already assigned
	NOT_FOUND		`replyId` not found
	NULL_ARGUMENT		`replyId` or `aliasId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.