Interface ActivityBusinessSession

All Superinterfaces:

AutoCloseable, Closeable, OsidSession, OsidSession

public interface ActivityBusinessSession
extends OsidSession

This session provides methods to retrieve Activity to Business mappings. An Activity 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	canLookupActivityBusinessMappings()	Tests if this user can perform lookups of activity/business mappings.
ActivityList	getActivitiesByBusiness(Id businessId)	Gets the list of Activity associated with a Business.
ActivityList	getActivitiesByBusinesses(IdList businessIds)	Gets the list of Activities corresponding to a list of Business objects.
IdList	getActivityIdsByBusiness(Id businessId)	Gets the list of Activity Ids associated with a Business.
IdList	getActivityIdsByBusinesses(IdList businessIds)	Gets the list of Activity Ids corresponding to a list of Business objects.
BusinessList	getBusinessesByActivity(Id activityId)	Gets the Business objects mapped to an Activity.
IdList	getBusinessIdsByActivity(Id activityId)	Gets the Business Ids mapped to an Activity.
void	useComparativeActivityBusinessView()	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	usePlenaryActivityBusinessView()	A complete view of the Activity 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

canLookupActivityBusinessMappings

boolean canLookupActivityBusinessMappings()

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

useComparativeActivityBusinessView

void useComparativeActivityBusinessView()

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.

usePlenaryActivityBusinessView

void usePlenaryActivityBusinessView()

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

getActivityIdsByBusiness

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

Gets the list of Activity Ids associated with a Business.

Parameters:

businessId - Id of the Business

Returns:

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

getActivitiesByBusiness

ActivityList getActivitiesByBusiness(Id businessId)
                              throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets the list of Activity associated with a Business.

Parameters:

businessId - Id of the Business

Returns:

list of related activities

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.

getActivityIdsByBusinesses

IdList getActivityIdsByBusinesses(IdList businessIds)
                           throws OperationFailedException,
PermissionDeniedException

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

Parameters:

businessIds - list of catalog Ids

Returns:

list of activity Ids

Throws:

NullArgumentException - businessIds is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getActivitiesByBusinesses

ActivityList getActivitiesByBusinesses(IdList businessIds)
                                throws OperationFailedException,
PermissionDeniedException

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

Parameters:

businessIds - list of catalog Ids

Returns:

list of activities

Throws:

NullArgumentException - businessIds is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getBusinessIdsByActivity

IdList getBusinessIdsByActivity(Id activityId)
                         throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets the Business Ids mapped to an Activity.

Parameters:

activityId - Id of an Activity

Returns:

list of businesses

Throws:

NotFoundException - activityId is not found

NullArgumentException - activityId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getBusinessesByActivity

BusinessList getBusinessesByActivity(Id activityId)
                              throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets the Business objects mapped to an Activity.

Parameters:

activityId - Id of an Activity

Returns:

list of businesses

Throws:

NotFoundException - activityId is not found

NullArgumentException - activityId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.