Interface ItemAdminSession

All Superinterfaces:

AutoCloseable, Closeable, OsidSession, OsidSession

All Known Subinterfaces:

ItemBatchAdminSession

public interface ItemAdminSession
extends OsidSession

This session creates, updates, and deletes Items . 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 geItemFormForCreate() 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 Store , the ItemStoreAssignmentSession should be used. These delete operations attempt to remove the Item itself thus removing it from all known Store catalogs.

This session includes an Id aliasing mechanism to assign an external Id to an internally assigned Id.

Method Summary

Modifier and Type	Method	Description
void	aliasItem(Id itemId, Id aliasId)	Adds an Id to an Item for the purpose of creating compatibility.
boolean	canCreateItems()	Tests if this user can create Items .
boolean	canCreateItemWithRecordTypes(Type[] itemRecordTypes)	Tests if this user can create a single Item using the desired record types.
boolean	canDeleteItems()	Tests if this user can delete Items A return of true does not guarantee successful authorization.
boolean	canManageItemAliases()	Tests if this user can manage Id aliases for Items .
boolean	canUpdateItems()	Tests if this user can update Items .
Item	createItem(ItemForm itemForm)	Creates a new Item .
void	deleteItem(Id itemId)	Deletes an Item .
ItemForm	getItemFormForCreate(Id orderId, Id productId, Type[] itemRecordTypes)	Gets the item form for creating new items.
ItemForm	getItemFormForUpdate(Id itemId)	Gets the item form for updating an existing item.
Store	getStore()	Gets the Store associated with this session.
Id	getStoreId()	Gets the Store Id associated with this session.
void	updateItem(ItemForm itemForm)	Updates an existing item.

Methods inherited from interface Closeable

close

Methods inherited from interface OsidSession

close

Modifier and Type	Method	Description
void	close()	Close this session.

Methods inherited from interface OsidSession

getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions

Modifier and Type	Method	Description
Agent	getAuthenticatedAgent()	Gets the agent authenticated to this session.
Id	getAuthenticatedAgentId()	Gets the Id of the agent authenticated to this session.
BigDecimal	getClockRate()	Gets the rate of the service clock.
Date	getDate()	Gets the service date which may be the current date or the effective date in which this session exists.
Agent	getEffectiveAgent()	Gets the effective agent in use by this session.
Id	getEffectiveAgentId()	Gets the Id of the effective agent in use by this session.
Type	getFormatType()	Gets the DisplayText format Type preference in effect for this session.
Locale	getLocale()	Gets the locale indicating the localization preferences in effect for this session.
boolean	isAuthenticated()	Tests if an agent is authenticated to this session.
Transaction	startTransaction()	Starts a new transaction for this sesson.
boolean	supportsTransactions()	Tests for the availability of transactions.

Method Details

getStoreId

Id getStoreId()

Gets the Store Id associated with this session.

Returns:

the Store Id associated with this session

Compliance:

mandatory - This method must be implemented.

getStore

Store getStore()
        throws OperationFailedException,
PermissionDeniedException

Gets the Store associated with this session.

Returns:

the store

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

canCreateItems

boolean canCreateItems()

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 not wish to offer create operations to unauthorized users.

Returns:

false if Item creation is not authorized, true otherwise

Compliance:

mandatory - This method must be implemented.

canCreateItemWithRecordTypes

boolean canCreateItemWithRecordTypes(Type[] itemRecordTypes)

Tests if this user can create a single Item using the desired record types. While OrderingManager.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.

Parameters:

itemRecordTypes - array of item record types

Returns:

true if Item creation using the specified record Types is supported, false otherwise

Throws:

NullArgumentException - itemRecordTypes is null

Compliance:

mandatory - This method must be implemented.

getItemFormForCreate

ItemForm getItemFormForCreate(Id orderId,
 Id productId,
 Type[] itemRecordTypes)
                       throws NotFoundException,
OperationFailedException,
PermissionDeniedException

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

Parameters:

orderId - the order Id

productId - the product Id

itemRecordTypes - array of item record types

Returns:

the item form

Throws:

NotFoundException - orderId or productId is not found

NullArgumentException - orderId, productId or itemRecordTypes is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

UnsupportedException - unable to get form for requested record types

Compliance:

mandatory - This method must be implemented.

createItem

Item createItem(ItemForm itemForm)
         throws OperationFailedException,
PermissionDeniedException

Creates a new Item .

Parameters:

itemForm - the form for this Item

Returns:

the new Item

Throws:

IllegalStateException - itemForm already used in a create transaction

InvalidArgumentException - one or more of the form elements is invalid

NullArgumentException - itemForm is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

UnsupportedException - itemForm did not originate from getItemForForCreate()

Compliance:

mandatory - This method must be implemented.

canUpdateItems

boolean canUpdateItems()

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 not wish to offer update operations to unauthorized users.

Returns:

false if Item modification is not authorized, true otherwise

Compliance:

mandatory - This method must be implemented.

getItemFormForUpdate

ItemForm getItemFormForUpdate(Id itemId)
                       throws NotFoundException,
OperationFailedException,
PermissionDeniedException

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

Parameters:

itemId - the Id of the Item

Returns:

the item form

Throws:

NotFoundException - itemId is not found

NullArgumentException - itemId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

updateItem

void updateItem(ItemForm itemForm)
         throws OperationFailedException,
PermissionDeniedException

Updates an existing item.

Parameters:

itemForm - the form containing the elements to be updated

Throws:

IllegalStateException - itemForm already used in an update transaction

InvalidArgumentException - the form contains an invalid value

NullArgumentException - itemForm is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

UnsupportedException - itemForm did not originate from getItemForForUpdate()

Compliance:

mandatory - This method must be implemented.

canDeleteItems

boolean canDeleteItems()

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 not wish to offer delete operations to unauthorized users.

Returns:

false if Item deletion is not authorized, true otherwise

Compliance:

mandatory - This method must be implemented.

deleteItem

void deleteItem(Id itemId)
         throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Deletes an Item .

Parameters:

itemId - the Id of the Item to remove

Throws:

NotFoundException - itemId not found

NullArgumentException - itemId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

canManageItemAliases

boolean canManageItemAliases()

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.

Returns:

false if Item aliasing is not authorized, true otherwise

Compliance:

mandatory - This method must be implemented.

aliasItem

void aliasItem(Id itemId,
 Id aliasId)
        throws AlreadyExistsException,
NotFoundException,
OperationFailedException,
PermissionDeniedException

Adds an Id to an Item for the purpose of creating compatibility. The primary Id of the Item is determined 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 .

Parameters:

itemId - the Id of an Item

aliasId - the alias Id

Throws:

AlreadyExistsException - aliasId is already assigned

NotFoundException - itemId not found

NullArgumentException - itemId or aliasId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.