Interface | osid.journaling.JournalAdminSession | ||
---|---|---|---|
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 | canCreateJournals | ||
Description |
Tests if this user can create | ||
Return | boolean | false if Journal creation is not authorized,
true otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | canCreateJournalWithRecordTypes | ||
Description |
Tests if this user can create a single | ||
Parameters | osid.type.Type[] | journalRecordTypes | array of journal record types |
Return | boolean | true if Journal creation using the specified
record Types is supported, false otherwise | |
Errors | NULL_ARGUMENT | journalRecordTypes is null | |
Compliance | mandatory | This method must be implemented. | |
Method | getJournalFormForCreate | ||
Description |
Gets the journal form for creating new journals. A new form should be requested for each create transaction. | ||
Parameters | osid.type.Type[] | journalRecordTypes | array of journal record types |
Return | osid.journaling.JournalForm | the journal form | |
Errors | NULL_ARGUMENT | journalRecordTypes 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 | createJournal | ||
Description |
Creates a new | ||
Parameters | osid.journaling.JournalForm | journalForm | the form for this Journal |
Return | osid.journaling.Journal | the new Journal | |
Errors | ILLEGAL_STATE | journalForm already used in a create transaction | |
INVALID_ARGUMENT | one or more of the form elements is invalid | ||
NULL_ARGUMENT | journalForm is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
UNSUPPORTED | journalForm did not originate from
getJournalFormForCreate() | ||
Compliance | mandatory | This method must be implemented. | |
Method | canUpdateJournals | ||
Description |
Tests if this user can update | ||
Return | boolean | false if Journal modification is not
authorized, true otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | getJournalFormForUpdate | ||
Description |
Gets the journal form for updating an existing journal. A new journal form should be requested for each update transaction. | ||
Parameters | osid.id.Id | journalId | the Id of the Journal |
Return | osid.journaling.JournalForm | the journal form | |
Errors | NULL_ARGUMENT | journalId is null | |
Compliance | mandatory | This method must be implemented. | |
Method | updateJournal | ||
Description |
Updates an existing journal. | ||
Parameters | osid.journaling.JournalForm | journalForm | the form containing the elements to be updated |
Errors | ILLEGAL_STATE | journalForm already used in an update transaction | |
INVALID_ARGUMENT | the form contains an invalid value | ||
NULL_ARGUMENT | journalForm is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
UNSUPPORTED | journalForm did not originate from
getJournalFormForUpdate() | ||
Compliance | mandatory | This method must be implemented. | |
Method | canDeleteJournals | ||
Description |
Tests if this user can delete | ||
Return | boolean | false if Journal deletion is not authorized,
true otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | deleteJournal | ||
Description |
Deletes a | ||
Parameters | osid.id.Id | journalId | the Id of the Journal to remove |
Errors | NOT_FOUND | journalId not found | |
NULL_ARGUMENT | journalId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | canManageJournalAliases | ||
Description |
Tests if this user can manage | ||
Return | boolean | false if Journal aliasing is not authorized,
true otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | aliasJournal | ||
Description |
Adds an | ||
Parameters | osid.id.Id | journalId | the Id of a Journal |
osid.id.Id | aliasId | the alias Id | |
Errors | ALREADY_EXISTS | aliasId is already assigned | |
NOT_FOUND | journalId not found | ||
NULL_ARGUMENT | journalId or aliasId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. |