OSID - osid.billing.EntryAdminSession Service Interface Definition

Interface	osid.billing.EntryAdminSession
Implements	`osid.OsidSession`
Description	This session creates, updates, and deletes `Entries.` 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 an `Entry,` an `EntryForm` is requested using `getEntryFormForCreate()` specifying the desired customer, item, period, and record `Types` or none if no record `Types` are needed. The returned `EntryForm` 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 `EntryForm` is submiited to a create operation, it cannot be reused with another create operation unless the first operation was unsuccessful. Each `EntryForm` corresponds to an attempted transaction. For updates, `EntryForms` are requested to the `Entry` `Id` that is to be updated using `getEntryFormForUpdate().` Similarly, the `EntryForm` has metadata about the data that can be updated and it can perform validation before submitting the update. The `EntryForm` can only be used once for a successful update and cannot be reused. The delete operations delete `EntryForms.` To unmap an `Entry` from the current `Business,` the `EntryBusinessAssignmentSession` should be used. These delete operations attempt to remove the `EntryForm` 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.billing.Business`		the business
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	canCreateEntries
Description	Tests if this user can create `Entries.` A return of true does not guarantee successful authorization. A return of false indicates that it is known creating an `Entry` 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 `Entry` creation is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	canCreateEntryWithRecordTypes
Description	Tests if this user can create a single `Entry` using the desired record types. While `BillingManager.getEntryRecordTypes()` can be used to examine which records are supported, this method tests which record(s) are required for creating a specific `Entry.` Providing an empty array tests if an `Entry` can be created with no records.
Parameters	`osid.type.Type[]`	`entryRecordTypes`	array of entry record types
Return	`boolean`		`true` if `Entry` creation using the specified record `Types` is supported, `false` otherwise
Errors	NULL_ARGUMENT		`entryRecordTypes` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	getEntryFormForCreate
Description	Gets the entry form for creating new entries. A new form should be requested for each create transaction.
Parameters	`osid.id.Id`	`customerId`	a customer `Id`
	`osid.id.Id`	`itemId`	an item `Id`
	`osid.id.Id`	`periodId`	a period `Id`
	`osid.type.Type[]`	`entryRecordTypes`	array of entry record types
Return	`osid.billing.EntryForm`		the entry form
Errors	NOT_FOUND		`itemId` or `periodId` is not found
	NULL_ARGUMENT		`itemId, periodId` , or `entryRecordTypes` 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	createEntry
Description	Creates a new `Entry.`
Parameters	`osid.billing.EntryForm`	`entryForm`	the form for this `Entry`
Return	`osid.billing.Entry`		the new `Entry`
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 `getEntryFormForCreate()`
Compliance	`mandatory`		This method must be implemented.
Method	canUpdateEntries
Description	Tests if this user can update `Entries.` A return of true does not guarantee successful authorization. A return of false indicates that it is known updating an `Entry` 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 `Entry` modification is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getEntryFormForUpdate
Description	Gets the entry form for updating an existing entry. A new entry form should be requested for each update transaction.
Parameters	`osid.id.Id`	`entryId`	the `Id` of the `Entry`
Return	`osid.billing.EntryForm`		the entry form
Errors	NOT_FOUND		`entryId` is not found
	NULL_ARGUMENT		`entryId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	updateEntry
Description	Updates an existing entry.
Parameters	`osid.billing.EntryForm`	`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 `getEntryFormForUpdate()`
Compliance	`mandatory`		This method must be implemented.
Method	canDeleteEntries
Description	Tests if this user can delete `Entries.` A return of true does not guarantee successful authorization. A return of false indicates that it is known deleting an `Entry` 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 `Entry` deletion is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	deleteEntry
Description	Deletes an `Entry.`
Parameters	`osid.id.Id`	`entryId`	the `Id` of the `Entry` to remove
Errors	NOT_FOUND		`entryId` not found
	NULL_ARGUMENT		`entryId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	canManageEntryAliases
Description	Tests if this user can manage `Id` aliases for `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 `Entry` aliasing is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	aliasEntry
Description	Adds an `Id` to an `Entry` for the purpose of creating compatibility. The primary `Id` of the `Entry` is deentryined by the provider. The new `Id` performs as an alias to the primary `Id` . If the alias is a pointer to another entry, it is reassigned to the given entry `Id.`
Parameters	`osid.id.Id`	`entryId`	the `Id` of an `Entry`
Parameters	`osid.id.Id`	`aliasId`	the alias `Id`
Errors	ALREADY_EXISTS		`aliasId` is in use as a primary `Id`
	NOT_FOUND		`entryId` not found
	NULL_ARGUMENT		`entryId` or `aliasId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.