Interface PeriodBusinessSession

All Superinterfaces:

AutoCloseable, Closeable, OsidSession, OsidSession

public interface PeriodBusinessSession
extends OsidSession

This session provides methods to retrieve Period to Business mappings. A Period 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	canLookupPeriodBusinessMappings()	Tests if this user can perform lookups of period/business mappings.
BusinessList	getBusinessesByPeriod(Id periodId)	Gets the Business objects mapped to a Period .
IdList	getBusinessIdsByPeriod(Id periodId)	Gets the Business Ids mapped to a Period .
IdList	getPeriodIdsByBusiness(Id businessId)	Gets the list of Period Ids associated with a Business .
IdList	getPeriodIdsByBusinesses(IdList businessIds)	Gets the list of Period Ids corresponding to a list of Business objects.
PeriodList	getPeriodsByBusiness(Id businessId)	Gets the list of Period associated with a Business .
PeriodList	getPeriodsByBusinesses(IdList businessIds)	Gets the list of Periods corresponding to a list of Business objects.
void	useComparativePeriodBusinessView()	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	usePlenaryPeriodCatalogView()	A complete view of the Period 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

canLookupPeriodBusinessMappings

boolean canLookupPeriodBusinessMappings()

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

useComparativePeriodBusinessView

void useComparativePeriodBusinessView()

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.

usePlenaryPeriodCatalogView

void usePlenaryPeriodCatalogView()

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

getPeriodIdsByBusiness

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

Gets the list of Period Ids associated with a Business .

Parameters:

businessId - Id of the Business

Returns:

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

getPeriodsByBusiness

PeriodList getPeriodsByBusiness(Id businessId)
                         throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets the list of Period associated with a Business .

Parameters:

businessId - Id of the Business

Returns:

list of related periods

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.

getPeriodIdsByBusinesses

IdList getPeriodIdsByBusinesses(IdList businessIds)
                         throws OperationFailedException,
PermissionDeniedException

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

Parameters:

businessIds - list of catalog Ids

Returns:

list of period Ids

Throws:

NullArgumentException - businessIds is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getPeriodsByBusinesses

PeriodList getPeriodsByBusinesses(IdList businessIds)
                           throws OperationFailedException,
PermissionDeniedException

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

Parameters:

businessIds - list of catalog Ids

Returns:

list of periods

Throws:

NullArgumentException - businessIds is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getBusinessIdsByPeriod

IdList getBusinessIdsByPeriod(Id periodId)
                       throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets the Business Ids mapped to a Period .

Parameters:

periodId - Id of a Period

Returns:

list of businesses

Throws:

NotFoundException - periodId is not found

NullArgumentException - periodId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getBusinessesByPeriod

BusinessList getBusinessesByPeriod(Id periodId)
                            throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets the Business objects mapped to a Period .

Parameters:

periodId - Id of a Period

Returns:

list of businesses

Throws:

NotFoundException - periodId is not found

NullArgumentException - periodId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.