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

Interface	osid.financials.posting.PostAdminSession
Implements	`osid.OsidSession`
Description	This session creates, updates, and deletes `Posts.` 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 `Post,` a `PostForm` is requested using `getPostFormForCreate()` specifying the desired record `Types` or none if no record `Types` are needed. The returned `PostForm` 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 `PostForm` is submiited to a create operation, it cannot be reused with another create operation unless the first operation was unsuccessful. Each `PostForm` corresponds to an attempted transaction. For updates, `PostForms` are requested to the `Post` `Id` that is to be updated using `getPostFormForUpdate().` Similarly, the `PostForm` has metadata about the data that can be updated and it can perform validation before submitting the update. The `PostForm` can only be used once for a successful update and cannot be reused. The delete operations delete `Posts.` To unmap a `Post` from the current `Business,` the `PostBusinessAssignmentSession` should be used. These delete operations attempt to remove the `Post` 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	canCreatePosts
Description	Tests if this user can create `Posts.` A return of true does not guarantee successful authorization. A return of false indicates that it is known creating a `Post` 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 `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 `Post` using the desired record types. While `FinancialsPostingManager.getPostRecordTypes()` can be used to examine which records are supported, this method tests which record(s) are required for creating a specific `Post.` Providing an empty array tests if a `Post` can be created with no records.
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 `Post.`
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 `Post` effective now or at the posting date.
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 `Posts.` A return of true does not guarantee successful authorization. A return of false indicates that it is known updating a `Post` 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 `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 `Posts.` A return of true does not guarantee successful authorization. A return of false indicates that it is known deleting a `Post` 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 `Post` deletion is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	deletePost
Description	Deletes a `Post.`
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 `Id` aliases for `Posts.` 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 `Post` aliasing is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	aliasPost
Description	Adds an `Id` to a `Post` for the purpose of creating compatibility. The primary `Id` of the `Payer` is determined by the provider. The new `Id` performs as an alias to the primary `Id.` If the alias is a pointer to another post, it is reassigned to the given post `Id.`
Parameters	`osid.id.Id`	`postId`	the `Id` of a `Post`
Parameters	`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.