Interface EntryBusinessSession

All Superinterfaces:

AutoCloseable, Closeable, OsidSession, OsidSession

public interface EntryBusinessSession
extends OsidSession

This session provides methods to retrieve Entry to Business mappings. An Entry 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	canLookupEntryBusinessMappings()	Tests if this user can perform lookups of entry/business mappings.
EntryList	getActivitieByBusiness(Id businessId)	Gets the list of Entry associated with a Business .
EntryList	getActivitieByBusinesses(IdList businessIds)	Gets the list of Entries corresponding to a list of Business objects.
BusinessList	getBusinessesByEntry(Id entryId)	Gets the Business objects mapped to an Entry .
IdList	getBusinessIdsByEntry(Id entryId)	Gets the Business Ids mapped to an Entry .
IdList	getEntryIdsByBusiness(Id businessId)	Gets the list of Entry Ids associated with a Business .
IdList	getEntryIdsByBusinesses(IdList businessIds)	Gets the list of Entry Ids corresponding to a list of Business objects.
void	useComparativeEntryBusinessView()	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	usePlenaryEntryBusinessView()	A complete view of the Entry 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

canLookupEntryBusinessMappings

boolean canLookupEntryBusinessMappings()

Tests if this user can perform lookups of entry/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.

useComparativeEntryBusinessView

void useComparativeEntryBusinessView()

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.

usePlenaryEntryBusinessView

void usePlenaryEntryBusinessView()

A complete view of the Entry 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.

getEntryIdsByBusiness

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

Gets the list of Entry Ids associated with a Business .

Parameters:

businessId - Id of the Business

Returns:

list of related entry 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.

getActivitieByBusiness

EntryList getActivitieByBusiness(Id businessId)
                          throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets the list of Entry associated with a Business .

Parameters:

businessId - Id of the Business

Returns:

list of related entries

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.

getEntryIdsByBusinesses

IdList getEntryIdsByBusinesses(IdList businessIds)
                        throws OperationFailedException,
PermissionDeniedException

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

Parameters:

businessIds - list of catalog Ids

Returns:

list of entry Ids

Throws:

NullArgumentException - businessIds is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getActivitieByBusinesses

EntryList getActivitieByBusinesses(IdList businessIds)
                            throws OperationFailedException,
PermissionDeniedException

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

Parameters:

businessIds - list of catalog Ids

Returns:

list of entries

Throws:

NullArgumentException - businessIds is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getBusinessIdsByEntry

IdList getBusinessIdsByEntry(Id entryId)
                      throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets the Business Ids mapped to an Entry .

Parameters:

entryId - Id of an Entry

Returns:

list of businesses

Throws:

NotFoundException - entryId is not found

NullArgumentException - entryId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getBusinessesByEntry

BusinessList getBusinessesByEntry(Id entryId)
                           throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets the Business objects mapped to an Entry .

Parameters:

entryId - Id of an Entry

Returns:

list of businesses

Throws:

NotFoundException - entryId is not found

NullArgumentException - entryId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.