public interface ItemLookupSession extends OsidSession
This session defines methods for retrieving items.
This lookup session defines several views:
Items
with the ItemAdminSession.
The methods useFederatedBusinessView()
and
useIsolatedBusinessView()
behave as a radio group and one should
be selected before invoking any lookup methods.
items may have an additional records indicated by their respective
record types. The record may not be accessed through a cast of the
Item.
Modifier and Type | Method and Description |
---|---|
boolean |
canLookupItems()
Tests if this user can perform
Item lookups. |
Business |
getBusiness()
Gets the
Business associated with this session. |
Id |
getBusinessId()
Gets the
Business Id associated with
this session. |
Item |
getItem(Id itemId)
Gets the
Item specified by its Id. |
ItemList |
getItems()
Gets all
Items. |
ItemList |
getItemsByAccount(Id accountId)
Gets an
ItemList of the given general ledger account. |
ItemList |
getItemsByCategory(Id categoryId)
Gets an
ItemList of the given category. |
ItemList |
getItemsByGenusType(Type itemGenusType)
Gets an
ItemList corresponding to the given item genus
Type which does not include items of types derived from
the specified Type. |
ItemList |
getItemsByIds(IdList itemIds)
Gets an
ItemList corresponding to the given
IdList. |
ItemList |
getItemsByParentGenusType(Type itemGenusType)
Gets an
ItemList corresponding to the given item genus
Type and include any additional items with genus types
derived from the specified Type. |
ItemList |
getItemsByProduct(Id productId)
Gets an
ItemList of the given product. |
ItemList |
getItemsByRecordType(Type itemRecordType)
Gets an
ItemList containing the given item record
Type. |
void |
useComparativeItemView()
The returns from the lookup methods may omit or translate elements
based on this session, such as authorization, and not result in an
error.
|
void |
useFederatedBusinessView()
Federates the view for methods in this session.
|
void |
useIsolatedBusinessView()
Isolates the view for methods in this session.
|
void |
usePlenaryItemView()
A complete view of the
Item returns is desired. |
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
Id getBusinessId()
Business
Id
associated with
this session. Business Id
associated with this sessionmandatory
- This method must be implemented. Business getBusiness() throws OperationFailedException, PermissionDeniedException
Business
associated with this session.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. boolean canLookupItems()
Item
lookups. A return
of true does not guarantee successful authorization. A return of false
indicates that it is known all methods in this session will result in
a PERMISSION_DENIED.
This is intended as a hint to an
application that may not offer lookup operations to unauthorized
users. false
if lookup methods are not authorized,
true
otherwisemandatory
- This method must be implemented. void useComparativeItemView()
mandatory
- This method is must be implemented. void usePlenaryItemView()
Item
returns is desired. Methods
will return what is requested or result in an error. This view is used
when greater precision is desired at the expense of interoperability.mandatory
- This method is must be implemented. void useFederatedBusinessView()
mandatory
- This method is must be implemented. void useIsolatedBusinessView()
mandatory
- This method is must be implemented. Item getItem(Id itemId) throws NotFoundException, OperationFailedException, PermissionDeniedException
Item
specified by its Id.
In
plenary mode, the exact Id
is found or a
NOT_FOUND
results. Otherwise, the returned Item
may have a different Id
than requested, such as the
case where a duplicate Id
was assigned to a Item
and retained for compatibility.itemId
- the Id
of the Item
to
retrieve Item
NotFoundException
- no Item
found with
the given Id
NullArgumentException
- itemId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. ItemList getItemsByIds(IdList itemIds) throws NotFoundException, OperationFailedException, PermissionDeniedException
ItemList
corresponding to the given
IdList.
In plenary mode, the returned list contains all of the
items specified in the Id
list, in the order of the
list, including duplicates, or an error results if an Id
in the supplied list is not found or inaccessible. Otherwise,
inaccessible Items
may be omitted from the list and may
present the elements in any order including returning a unique set.itemIds
- the list of Ids
to retrieve Item
listNotFoundException
- an Id was
not foundNullArgumentException
- itemIds
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. ItemList getItemsByGenusType(Type itemGenusType) throws OperationFailedException, PermissionDeniedException
ItemList
corresponding to the given item genus
Type
which does not include items of types derived from
the specified Type.
In plenary mode, the returned list
contains all known items or an error results. Otherwise, the returned
list may contain only those items that are accessible through this
session.itemGenusType
- an item genus type Item
listNullArgumentException
- itemGenusType
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. ItemList getItemsByParentGenusType(Type itemGenusType) throws OperationFailedException, PermissionDeniedException
ItemList
corresponding to the given item genus
Type
and include any additional items with genus types
derived from the specified Type.
In plenary mode, the
returned list contains all known items or an error results. Otherwise,
the returned list may contain only those items that are accessible
through this session.itemGenusType
- an item genus type Item
listNullArgumentException
- itemGenusType
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. ItemList getItemsByRecordType(Type itemRecordType) throws OperationFailedException, PermissionDeniedException
ItemList
containing the given item record
Type.
In plenary mode, the returned list contains all
known items or an error results. Otherwise, the returned list may
contain only those items that are accessible through this session.itemRecordType
- an item record type Item
listNullArgumentException
- itemRecordType
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. ItemList getItemsByCategory(Id categoryId) throws OperationFailedException, PermissionDeniedException
ItemList
of the given category. In plenary
mode, the returned list contains all known items or an error results.
Otherwise, the returned list may contain only those items that are
accessible through this session.categoryId
- an item category Id
Item
listNullArgumentException
- categoryId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. ItemList getItemsByAccount(Id accountId) throws OperationFailedException, PermissionDeniedException
ItemList
of the given general ledger account.
In plenary mode, the returned list contains all known items or an
error results. Otherwise, the returned list may contain only those
items that are accessible through this session.accountId
- a category Id
Item
listNullArgumentException
- accountId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. ItemList getItemsByProduct(Id productId) throws OperationFailedException, PermissionDeniedException
ItemList
of the given product. In plenary mode,
the returned list contains all known items or an error results.
Otherwise, the returned list may contain only those items that are
accessible through this session.productId
- a product Id
Item
listNullArgumentException
- productId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. ItemList getItems() throws OperationFailedException, PermissionDeniedException
Items.
In plenary mode, the returned list
contains all known items or an error results. Otherwise, the returned
list may contain only those items that are accessible through this
session. Items
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented.