Interface | osid.forum.ReplyAdminSession | ||
---|---|---|---|
Implements | osid.OsidSession | ||
Description |
This session creates, updates, and deletes Create and update operations differ in their usage. To
create a For updates, The delete operations delete This session includes an | ||
Method | getForumId | ||
Description |
Gets the | ||
Return | osid.id.Id | the Forum Id associated with this session | |
Compliance | mandatory | This method must be implemented. | |
Method | getForum | ||
Description |
Gets the | ||
Return | osid.forum.Forum | the forum | |
Errors | OPERATION_FAILED | unable to complete request | |
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
| ||
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 | ||
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 |
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 |
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 | ||
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 | ||
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 | ||
Return | boolean | false if Reply deletion is not authorized,
true otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | deleteReply | ||
Description |
Deletes an | ||
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 | ||
Return | boolean | false if Reply aliasing is not authorized,
true otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | aliasReply | ||
Description |
Adds an | ||
Parameters | osid.id.Id | replyId | the Id of a Reply |
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. |