Interface | osid.financials.posting.PostAdminSession | ||
---|---|---|---|
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 | getBusinessId | ||
Description |
Gets the | ||
Return | osid.id.Id | the Business Id associated with this session | |
Compliance | mandatory | This method must be implemented. | |
Method | getBusiness | ||
Description |
Gets the | ||
Return | osid.financials.Business | the business | |
Errors | OPERATION_FAILED | unable to complete request | |
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | canCreatePosts | ||
Description |
Tests if this user can create | ||
Return | boolean | false if Post creation is not authorized,
true otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | canCreatePostWithRecordTypes | ||
Description |
Tests if this user can create a single | ||
Parameters | osid.type.Type[] | postRecordTypes | array of post record types |
Return | boolean | true if Post creation using the specified
record Types is supported, false otherwise | |
Errors | NULL_ARGUMENT | postRecordTypes is null | |
Compliance | mandatory | This method must be implemented. | |
Method | getPostFormForCreate | ||
Description |
Gets the payer form for creating new posts. A new form should be requested for each create transaction. | ||
Parameters | osid.type.Type[] | postRecordTypes | array of post record types |
Return | osid.financials.posting.PostForm | the post form | |
Errors | NULL_ARGUMENT | postRecordTypes 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 | createPost | ||
Description |
Creates a new | ||
Parameters | osid.financials.posting.PostForm | postForm | the form for this Post |
Return | osid.financials.posting.Post | the new Post | |
Errors | ILLEGAL_STATE | postForm already used in a create transaction | |
INVALID_ARGUMENT | one or more of the form elements is invalid | ||
NULL_ARGUMENT | postForm is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
UNSUPPORTED | entryForm did not originate from getPostFormForCreate() | ||
Compliance | mandatory | This method must be implemented. | |
Method | post | ||
Description |
Submits a | ||
Parameters | osid.id.Id | postId | the post Id |
Errors | ILLEGAL_STATE | postId already posted | |
NULL_ARGUMENT | payerId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | canUpdatePosts | ||
Description |
Tests if this user can update | ||
Return | boolean | false if Post modification is not authorized,
true otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | getPostFormForUpdate | ||
Description |
Gets the post form for updating an existing post. A new post form should be requested for each update transaction. | ||
Parameters | osid.id.Id | postId | the Id of the Post |
Return | osid.financials.posting.PostForm | the post form | |
Errors | NOT_FOUND | postId is not found | |
NULL_ARGUMENT | postId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | updatePost | ||
Description |
Updates an existing post. | ||
Parameters | osid.financials.posting.PostForm | postForm | the form containing the elements to be updated |
Errors | ILLEGAL_STATE | postForm already used in an update transaction | |
INVALID_ARGUMENT | the form contains an invalid value | ||
NULL_ARGUMENT | postForm is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
UNSUPPORTED | entryForm did not originate from getPostFormForUpdate() | ||
Compliance | mandatory | This method must be implemented. | |
Method | canDeletePosts | ||
Description |
Tests if this user can delete | ||
Return | boolean | false if Post deletion is not authorized,
true otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | deletePost | ||
Description |
Deletes a | ||
Parameters | osid.id.Id | postId | the Id of the Post to remove |
Errors | NOT_FOUND | postId not found | |
NULL_ARGUMENT | postId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | canManagePostAliases | ||
Description |
Tests if this user can manage | ||
Return | boolean | false if Post aliasing is not authorized,
true otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | aliasPost | ||
Description |
Adds an | ||
Parameters | osid.id.Id | postId | the Id of a Post |
osid.id.Id | aliasId | the alias Id | |
Errors | ALREADY_EXISTS | aliasId is in use as a primary Id | |
NOT_FOUND | postId not found | ||
NULL_ARGUMENT | postId or aliasId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. |