Interface ItemBusinessSession

All Superinterfaces:

AutoCloseable, Closeable, OsidSession, OsidSession

public interface ItemBusinessSession
extends OsidSession

This session provides methods to retrieve Item to Business mappings. An Item may appear in multiple Businesses . Each catalog may have its own authorizations governing who is allowed to look at it.

This lookup session defines several views:

• comparative view: elements may be silently omitted or re-ordered
• plenary view: provides a complete result set or is an error condition

Method Summary

Modifier and Type	Method	Description
boolean	canLookupItemBusinessMappings()	Tests if this user can perform lookups of item/business mappings.
BusinessList	getBusinessesByItem(Id itemId)	Gets the Business objects mapped to an Item .
IdList	getBusinessIdsByItem(Id itemId)	Gets the Business Ids mapped to an Item .
IdList	getItemIdsByBusiness(Id businessId)	Gets the list of Item Ids associated with a Business .
IdList	getItemIdsByBusinesses(IdList businessIds)	Gets the list of Item Ids corresponding to a list of Business objects.
ItemList	getItemsByBusiness(Id businessId)	Gets the list of Items associated with a Business .
ItemList	getItemsByBusinesses(IdList businessIds)	Gets the list of Items corresponding to a list of Business objects.
void	useComparativeItemBusinessView()	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	usePlenaryItemCatalogView()	A complete view of the Item and Business returns is desired.

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

canLookupItemBusinessMappings

boolean canLookupItemBusinessMappings()

Tests if this user can perform lookups of item/business mappings. A return of true does not guarantee successful authorization. A return of false indicates that it is known lookup methods in this session will result in a PERMISSION_DENIED . This is intended as a hint to an application that may opt not to offer lookup operations to unauthorized users.

Returns:

false if looking up mappings is not authorized, true otherwise

Compliance:

mandatory - This method must be implemented.

useComparativeItemBusinessView

void useComparativeItemBusinessView()

The returns from the lookup methods may omit or translate elements based on this session, such as authorization, and not result in an error. This view is used when greater interoperability is desired at the expense of precision.

Compliance:

mandatory - This method is must be implemented.

usePlenaryItemCatalogView

void usePlenaryItemCatalogView()

A complete view of the Item and Business 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.

Compliance:

mandatory - This method is must be implemented.

getItemIdsByBusiness

IdList getItemIdsByBusiness(Id businessId)
                     throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets the list of Item Ids associated with a Business .

Parameters:

businessId - Id of the Business

Returns:

list of related item Ids

Throws:

NotFoundException - businessId is not found

NullArgumentException - businessId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getItemsByBusiness

ItemList getItemsByBusiness(Id businessId)
                     throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets the list of Items associated with a Business .

Parameters:

businessId - Id of the Business

Returns:

list of related items

Throws:

NotFoundException - businessId is not found

NullArgumentException - businessId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getItemIdsByBusinesses

IdList getItemIdsByBusinesses(IdList businessIds)
                       throws OperationFailedException,
PermissionDeniedException

Gets the list of Item Ids corresponding to a list of Business objects.

Parameters:

businessIds - list of business Ids

Returns:

list of item Ids

Throws:

NullArgumentException - businessIds is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getItemsByBusinesses

ItemList getItemsByBusinesses(IdList businessIds)
                       throws OperationFailedException,
PermissionDeniedException

Gets the list of Items corresponding to a list of Business objects.

Parameters:

businessIds - list of business Ids

Returns:

list of items

Throws:

NullArgumentException - businessIds is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getBusinessIdsByItem

IdList getBusinessIdsByItem(Id itemId)
                     throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets the Business Ids mapped to an Item .

Parameters:

itemId - Id of an Item

Returns:

list of businesses

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.

getBusinessesByItem

BusinessList getBusinessesByItem(Id itemId)
                          throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets the Business objects mapped to an Item .

Parameters:

itemId - Id of an Item

Returns:

list of businesses

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.