Interface | osid.financials.posting.PostEntryAdminSession | ||
---|---|---|---|
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 | canCreatePostEntries | ||
Description |
Tests if this user can create | ||
Return | boolean | false if PostEntry creation is not
authorized, true otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | canCreatePostEntryWithRecordTypes | ||
Description |
Tests if this user can create a single | ||
Parameters | osid.type.Type[] | postEntryRecordTypes | array of post entry record types |
Return | boolean | true if PostEntry creation using the
specified record Types is supported, false
otherwise | |
Errors | NULL_ARGUMENT | postEntryRecordTypes is null | |
Compliance | mandatory | This method must be implemented. | |
Method | getPostEntryFormForCreate | ||
Description |
Gets the post entry form for creating new post entries. A new form should be requested for each create transaction. | ||
Parameters | osid.id.Id | postId | a post Id |
osid.type.Type[] | postEntryRecordTypes | array of post entry record types | |
Return | osid.financials.posting.PostEntryForm | the post entry form | |
Errors | NOT_FOUND | postId is not found | |
NULL_ARGUMENT | postId or postEntryRecordTypes 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 | createPostEntry | ||
Description |
Creates a new | ||
Parameters | osid.financials.posting.PostEntryForm | entryForm | the form for this PostEntry |
Return | osid.financials.posting.PostEntry | the new PostEntry | |
Errors | ILLEGAL_STATE | entryForm already used in a create transaction | |
INVALID_ARGUMENT | one or more of the form elements is invalid | ||
NULL_ARGUMENT | entryForm is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
UNSUPPORTED | entryForm did not originate from
getPostEntryFormForCreate() | ||
Compliance | mandatory | This method must be implemented. | |
Method | canUpdatePostEntries | ||
Description |
Tests if this user can update | ||
Return | boolean | false if PostEntry modification is not
authorized, true otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | getPostEntryFormForUpdate | ||
Description |
Gets the post entry form for updating an existing post entries. A new post entry form should be requested for each update transaction. | ||
Parameters | osid.id.Id | postEntryId | the Id of the PostEntry |
Return | osid.financials.posting.PostEntryForm | the post entry form | |
Errors | NOT_FOUND | postEntryId is not found | |
NULL_ARGUMENT | postEntryId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | updatePostEntry | ||
Description |
Updates an existing post entries. | ||
Parameters | osid.financials.posting.PostEntryForm | entryForm | the form containing the elements to be updated |
Errors | ILLEGAL_STATE | entryForm already used in an update transaction | |
INVALID_ARGUMENT | the form contains an invalid value | ||
NULL_ARGUMENT | entryForm is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
UNSUPPORTED | entryForm did not originate from
getPostEntryFormForUpdate() | ||
Compliance | mandatory | This method must be implemented. | |
Method | canDeletePostEntries | ||
Description |
Tests if this user can delete | ||
Return | boolean | false if PostEntry deletion is not
authorized, true otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | deletePostEntry | ||
Description |
Deletes a | ||
Parameters | osid.id.Id | postEntryId | the Id of the PostEntry to remove |
Errors | NOT_FOUND | postEntryId not found | |
NULL_ARGUMENT | postEntryId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | canManagePostEntryAliases | ||
Description |
Tests if this user can manage | ||
Return | boolean | false if PostEntry aliasing is not
authorized, true otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | aliasPostEntry | ||
Description |
Adds an | ||
Parameters | osid.id.Id | postEntryId | the Id of a PostEntry |
osid.id.Id | aliasId | the alias Id | |
Errors | ALREADY_EXISTS | aliasId is in use as a primary Id | |
NOT_FOUND | postEntryId not found | ||
NULL_ARGUMENT | postEntryId or aliasId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. |