OSID Logo
OSID Specifications
billing package
Version 3.0.0
Release Candidate Preview
Interfaceosid.billing.EntryAdminSession
Implementsosid.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.

MethodgetBusinessId
Description

Gets the Business Id associated with this session.

Returnosid.id.Idthe Business Id associated with this session
CompliancemandatoryThis method must be implemented.
MethodgetBusiness
Description

Gets the Business associated with this session.

Returnosid.billing.Businessthe business
ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodcanCreateEntries
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.

Returnboolean false if Entry creation is not authorized, true otherwise
CompliancemandatoryThis method must be implemented.
MethodcanCreateEntryWithRecordTypes
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.

Parametersosid.type.Type[]entryRecordTypesarray of entry record types
Returnboolean true if Entry creation using the specified record Types is supported, false otherwise
ErrorsNULL_ARGUMENT entryRecordTypes is null
CompliancemandatoryThis method must be implemented.
MethodgetEntryFormForCreate
Description

Gets the entry form for creating new entries. A new form should be requested for each create transaction.

Parametersosid.id.IdcustomerIda customer Id
osid.id.IditemIdan item Id
osid.id.IdperiodIda period Id
osid.type.Type[]entryRecordTypesarray of entry record types
Returnosid.billing.EntryFormthe entry form
ErrorsNOT_FOUND itemId or periodId is not found
NULL_ARGUMENT itemId, periodId , or entryRecordTypes is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
UNSUPPORTEDunable to get form for requested record types
CompliancemandatoryThis method must be implemented.
MethodcreateEntry
Description

Creates a new Entry.

Parametersosid.billing.EntryFormentryFormthe form for this Entry
Returnosid.billing.Entrythe new Entry
ErrorsILLEGAL_STATE entryForm already used in a create transaction
INVALID_ARGUMENTone or more of the form elements is invalid
NULL_ARGUMENT entryForm is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
UNSUPPORTED entryForm did not originate from getEntryFormForCreate()
CompliancemandatoryThis method must be implemented.
MethodcanUpdateEntries
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.

Returnboolean false if Entry modification is not authorized, true otherwise
CompliancemandatoryThis method must be implemented.
MethodgetEntryFormForUpdate
Description

Gets the entry form for updating an existing entry. A new entry form should be requested for each update transaction.

Parametersosid.id.IdentryIdthe Id of the Entry
Returnosid.billing.EntryFormthe entry form
ErrorsNOT_FOUND entryId is not found
NULL_ARGUMENT entryId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodupdateEntry
Description

Updates an existing entry.

Parametersosid.billing.EntryFormentryFormthe form containing the elements to be updated
ErrorsILLEGAL_STATE entryForm already used in an update transaction
INVALID_ARGUMENTthe form contains an invalid value
NULL_ARGUMENT entryForm is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
UNSUPPORTED entryForm did not originate from getEntryFormForUpdate()
CompliancemandatoryThis method must be implemented.
MethodcanDeleteEntries
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.

Returnboolean false if Entry deletion is not authorized, true otherwise
CompliancemandatoryThis method must be implemented.
MethoddeleteEntry
Description

Deletes an Entry.

Parametersosid.id.IdentryIdthe Id of the Entry to remove
ErrorsNOT_FOUND entryId not found
NULL_ARGUMENT entryId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodcanManageEntryAliases
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.

Returnboolean false if Entry aliasing is not authorized, true otherwise
CompliancemandatoryThis method must be implemented.
MethodaliasEntry
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.

Parametersosid.id.IdentryIdthe Id of an Entry
osid.id.IdaliasIdthe alias Id
ErrorsALREADY_EXISTS aliasId is in use as a primary Id
NOT_FOUND entryId not found
NULL_ARGUMENT entryId or aliasId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.