OSID - osid.journaling.JournalEntryAdminSession Service Interface Definition

Interface	osid.journaling.JournalEntryAdminSession
Implements	`osid.OsidSession`
Implemented By	`osid.journaling.batch.JournalEntryBatchAdminSession`
Used By	`osid.journaling.JournalingManager`
Used By	`osid.journaling.JournalingProxyManager`
Description	This session creates, updates, and deletes `JournalEntries`. 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 `JournalEntry`, a `JournalEntryForm` is requested using `getJournalEntryFormForCreate()` specifying the desired record `Types` or none if no record `Types` are needed. The returned `JournalEntryForm` 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 `JournalEntryForm` is submiited to a create operation, it cannot be reused with another create operation unless the first operation was unsuccessful. Each `JournalEntryForm` corresponds to an attempted transaction. For updates, `JournalEntryForms` are requested to the `JournalEntry` `Id` that is to be updated using `getJournalEntryFormForUpdate()`. Similarly, the `JournalEntryForm` has metadata about the data that can be updated and it can perform validation before submitting the update. The `JournalEntryForm` can only be used once for a successful update and cannot be reused. The delete operations delete `JournalEntries`. This session includes an `Id` aliasing mechanism to assign an external `Id` to an internally assigned Id.
Method	getJournalId
Description	Gets the `Journal` `Id` associated with this session.
Return	`osid.id.Id`		the `Journal Id` associated with this session
Compliance	`mandatory`		This method must be implemented.
Method	getJournal
Description	Gets the `Journal` associated with this session.
Return	`osid.journaling.Journal`		the journal
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	canCreateJournalEntries
Description	Tests if this user can create journal entries. A return of true does not guarantee successful authorization. A return of false indicates that it is known creating a `JournalEntry` 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 `JournalEntry` creation is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	canCreateJournalEntryWithRecordTypes
Description	Tests if this user can create a single `JournalEntry` using the desired record interface types. While `JournalingManager.getJournalEntryRecordTypes()` can be used to examine which record interfaces are supported, this method tests which record(s) are required for creating a specific `JournalEntry`. Providing an empty array tests if a `JournalEntry` can be created with no records.
Parameters	`osid.type.Type[]`	`journalEntryRecordTypes`	array of journal entry record types
Return	`boolean`		`true` if `JournalEntry` creation using the specified record `Types` is supported, `false` otherwise
Errors	NULL_ARGUMENT		`journalEntryRecordTypes` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	getJournalEntryFormForCreate
Description	Gets the journal entry form for creating new entries. A new form should be requested for each create transaction.
Parameters	`osid.id.Id`	`branchId`	the `Id` for the branch
	`osid.id.Id`	`sourceId`	the `Id` for the journaled object
	`osid.type.Type[]`	`journalEntryRecordTypes`	array of journal entry record types
Return	`osid.journaling.JournalEntryForm`		the journal entry form
Errors	NOT_FOUND		`branchId` is not found
	NULL_ARGUMENT		`branchId, sourceId`, or `journalEntryRecordTypes` 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	createJournalEntry
Description	Creates a new `JournalEntry`.
Parameters	`osid.journaling.JournalEntryForm`	`journalEntryForm`	the form for this `JournalEntry`
Return	`osid.journaling.JournalEntry`		the new `JournalEntry`
Errors	ILLEGAL_STATE		`journalEntryForm` already used in a create transaction
	INVALID_ARGUMENT		one or more of the form elements is invalid
	NULL_ARGUMENT		`journalEntryForm` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`journalEntryForm` did not originate from `getJournalEntryFormForCreate()`
Compliance	`mandatory`		This method must be implemented.
Method	canUpdateJournalEntries
Description	Tests if this user can update journal entries. A return of true does not guarantee successful authorization. A return of false indicates that it is known updating a `JournalEntry` 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 `JournalEntry` modification is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getJournalEntryFormForUpdate
Description	Gets the journal entry form for updating an existing entry. A new journal entry form should be requested for each update transaction.
Parameters	`osid.id.Id`	`journalEntryId`	the `Id` of the `JournalEntry`
Return	`osid.journaling.JournalEntryForm`		the entry form
Errors	NOT_FOUND		`journalEntryId` is not found
	NULL_ARGUMENT		`journalEntryId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	updateJournalEntry
Description	Updates an existing journal entry.
Parameters	`osid.journaling.JournalEntryForm`	`journalEntryForm`	the form containing the elements to be updated
Errors	ILLEGAL_STATE		`journalEntryForm` already used in an update transaction
	INVALID_ARGUMENT		the form contains an invalid value
	NULL_ARGUMENT		`journalEntryForm` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`journalEntryForm` did not originate from `getJournalEntryFormForUpdate()`
Compliance	`mandatory`		This method must be implemented.
Method	canDeleteJournalEntries
Description	Tests if this user can delete journal entries. A return of true does not guarantee successful authorization. A return of false indicates that it is known deleting a `JournalEntry` 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 `JournalEntry` deletion is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	deleteJournalEntry
Description	Deletes a `JournalEntry`.
Parameters	`osid.id.Id`	`journalEntryId`	the `Id` of the `JournalEntry` to remove
Errors	NOT_FOUND		`journalEntryId` not found
	NULL_ARGUMENT		`journalEntryId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	canManageJournalEntryAliases
Description	Tests if this user can manage `Id` aliases for journal entries. 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 `JournalEntry` aliasing is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	aliasJournalEntry
Description	Adds an `Id` to a `JournalEntry` for the purpose of creating compatibility. The primary `Id` of the `JournalEntry` is determined by the provider. The new `Id` performs as an alias to the primary `Id`. If the alias is a pointer to another journal entry it is reassigned to the given journal entry `Id`.
Parameters	`osid.id.Id`	`journalEntryId`	the `Id` of a `JournalEntry`
Parameters	`osid.id.Id`	`aliasId`	the alias `Id`
Errors	ALREADY_EXISTS		`aliasId` is already assigned
	NOT_FOUND		`journalEntryId` not found
	NULL_ARGUMENT		`journalEntryId` or `aliasId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.