OSID - osid.financials.posting.PostEntryAdminSession Service Interface Definition

Interface	osid.financials.posting.PostEntryAdminSession
Implements	`osid.OsidSession`
Implemented By	`osid.financials.posting.batch.PostEntryBatchAdminSession`
Used By	`osid.financials.posting.FinancialsPostingManager`
Used By	`osid.financials.posting.FinancialsPostingProxyManager`
Description	This session creates, updates, and deletes `PostEntries`. The data for create and update is provided by the consumer via the form. `OsidForms` are requested for each create or update and may not be reused. Create and update operations differ in their usage. To create a `PostEntry`, a `PostEntryForm` is requested using `getPostEntryFormForCreate()` specifying the desired post and record `Types` or none if no record `Types` are needed. The returned `PostEntryForm` 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 `PostEntryForm` is submiited to a create operation, it cannot be reused with another create operation unless the first operation was unsuccessful. Each `PostEntryForm` corresponds to an attempted transaction. For updates, `PostEntryForms` are requested to the `PostEntry` `Id` that is to be updated using `getPostEntryFormForUpdate()`. Similarly, the `PostEntryForm` has metadata about the data that can be updated and it can perform validation before submitting the update. The `PostEntryForm` can only be used once for a successful update and cannot be reused. The delete operations delete `PostEntryForms`. To unmap a `PostEntry` from the current `Business`, the `PostEntryBusinessAssignmentSession` should be used. These delete operations attempt to remove the `PostEntryForm` itself thus removing it from all known `Business` catalogs. This session includes an `Id` aliasing mechanism to assign an external `Id` to an internally assigned Id.
Method	getBusinessId
Description	Gets the `Business` `Id` associated with this session.
Return	`osid.id.Id`		the `Business Id` associated with this session
Compliance	`mandatory`		This method must be implemented.
Method	getBusiness
Description	Gets the `Business` associated with this session.
Return	`osid.financials.Business`		the business
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	canCreatePostEntries
Description	Tests if this user can create `PostEntries` . A return of true does not guarantee successful authorization. A return of false indicates that it is known creating a `PostEntry` will result in a `PERMISSION_DENIED`. This is intended as a hint to an application that may opt not to offer create operations to an unauthorized user.
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 `PostEntry` using the desired record types. While `FinancialsPostingManager.getPostEntryRecordTypes()` can be used to examine which records are supported, this method tests which record(s) are required for creating a specific `PostEntry`. Providing an empty array tests if a `PostEntry` can be created with no records.
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`
Parameters	`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 `PostEntry`.
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 `PostEntries` . A return of true does not guarantee successful authorization. A return of false indicates that it is known updating a `PostEntry` will result in a `PERMISSION_DENIED`. This is intended as a hint to an application that may opt not to offer update operations to an unauthorized user.
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 `PostEntries` . A return of true does not guarantee successful authorization. A return of false indicates that it is known deleting a `PostEntry` will result in a `PERMISSION_DENIED`. This is intended as a hint to an application that may opt not to offer delete operations to an unauthorized user.
Return	`boolean`		`false` if `PostEntry` deletion is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	deletePostEntry
Description	Deletes a `PostEntry`.
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 `Id` aliases for `PostEntries`. 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 `PostEntry` aliasing is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	aliasPostEntry
Description	Adds an `Id` to a `PostEntry` for the purpose of creating compatibility. The primary `Id` of the `PostEntry` is deentryined by the provider. The new `Id` performs as an alias to the primary `Id`. If the alias is a pointer to another post entry, it is reassigned to the given post entry `Id`.
Parameters	`osid.id.Id`	`postEntryId`	the `Id` of a `PostEntry`
Parameters	`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.