OSID Logo
OSID Specifications
billing package
Version 3.0.0
Release Candidate Preview
Interfaceosid.billing.ItemAdminSession
Implementsosid.OsidSession
Description

This session creates, updates, and deletes Item. 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 Item, an ItemForm is requested using getItemFormForCreate() specifying the desired record Types or none if no record Types are needed. The returned ItemForm 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 ItemForm is submiited to a create operation, it cannot be reused with another create operation unless the first operation was unsuccessful. Each ItemForm corresponds to an attempted transaction.

For updates, ItemForms are requested to the Item Id that is to be updated using getItemFormForUpdate(). Similarly, the ItemForm has metadata about the data that can be updated and it can perform validation before submitting the update. The ItemForm can only be used once for a successful update and cannot be reused.

The delete operations delete Items. To unmap an Item from the current Business, the ItemBusinessAssignmentSession should be used. These delete operations attempt to remove the Item 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.
MethodcanCreateItems
Description

Tests if this user can create Items. A return of true does not guarantee successful authorization. A return of false indicates that it is known creating an Item 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 Item creation is not authorized, true otherwise
CompliancemandatoryThis method must be implemented.
MethodcanCreateItemWithRecordTypes
Description

Tests if this user can create a single Item using the desired record types. While BillingManager.getItemRecordTypes() can be used to examine which records are supported, this method tests which record(s) are required for creating a specific Item. Providing an empty array tests if an Item can be created with no records.

Parametersosid.type.Type[]itemRecordTypesarray of item record types
Returnboolean true if Item creation using the specified record Types is supported, false otherwise
ErrorsNULL_ARGUMENT itemRecordTypes is null
CompliancemandatoryThis method must be implemented.
MethodgetItemFormForCreate
Description

Gets the item form for creating new items. A new form should be requested for each create transaction.

Parametersosid.type.Type[]itemRecordTypesarray of item record types
Returnosid.billing.ItemFormthe item form
ErrorsNULL_ARGUMENT itemRecordTypes is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
UNSUPPORTEDunable to get form for requested record types
CompliancemandatoryThis method must be implemented.
MethodcreateItem
Description

Creates a new Item.

Parametersosid.billing.ItemFormitemFormthe form for this Item
Returnosid.billing.Itemthe new Item
ErrorsILLEGAL_STATE entryForm already used in a create transaction
INVALID_ARGUMENTone or more of the form elements is invalid
NULL_ARGUMENT itemForm is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
UNSUPPORTED itemForm did not originate from getItemFormForCreate()
CompliancemandatoryThis method must be implemented.
MethodcanUpdateItems
Description

Tests if this user can update Items. A return of true does not guarantee successful authorization. A return of false indicates that it is known updating an Item 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 Item modification is not authorized, true otherwise
CompliancemandatoryThis method must be implemented.
MethodgetItemFormForUpdate
Description

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

Parametersosid.id.IditemIdthe Id of the Item
Returnosid.billing.ItemFormthe item form
ErrorsNOT_FOUND itemId is not found
NULL_ARGUMENT itemId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodupdateItem
Description

Updates an existing item.

Parametersosid.billing.ItemFormitemFormthe 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 itemId or customerForm is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
UNSUPPORTED itemForm did not originate from getItemFormForUpdate()
CompliancemandatoryThis method must be implemented.
MethodcanDeleteItems
Description

Tests if this user can delete Items. A return of true does not guarantee successful authorization. A return of false indicates that it is known deleting an Item 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 Item deletion is not authorized, true otherwise
CompliancemandatoryThis method must be implemented.
MethoddeleteItem
Description

Deletes an Item.

Parametersosid.id.IditemIdthe Id of the Item to remove
ErrorsNOT_FOUND itemId not found
NULL_ARGUMENT itemId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodcanManageItemAliases
Description

Tests if this user can manage Id aliases for Items. 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 Item aliasing is not authorized, true otherwise
CompliancemandatoryThis method must be implemented.
MethodaliasItem
Description

Adds an Id to an Item for the purpose of creating compatibility. The primary Id of the Item is deentryined by the provider. The new Id performs as an alias to the primary Id. If the alias is a pointer to another item, it is reassigned to the given item Id.

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