Interface WorkOfficeSession

All Superinterfaces:

AutoCloseable, Closeable, OsidSession, OsidSession

public interface WorkOfficeSession
extends OsidSession

This session provides methods to retrieve Work to Office workflows. A Work may appear in multiple Offices . Each office 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	canLookupWorkOfficeAvailabilities()	Tests if this user can perform lookups of work/office mappings.
IdList	getOfficeIdsByWork(Id workId)	Gets the Office Ids mapped to a Work .
OfficeList	getOfficesByWork(Id workId)	Gets the Offices mapped to a Work .
IdList	getWorkIdsByOffice(Id officeId)	Gets the list of Work Ids associated with an Office .
IdList	getWorkIdsByOffices(IdList officeIds)	Gets the list of Work Ids corresponding to a list of Offices .
WorkList	getWorksByOffice(Id officeId)	Gets the list of Works associated with an Office .
WorkList	getWorksByOffices(IdList officeIds)	Gets the list of Work corresponding to a list of Offices .
void	useComparativeWorkOfficeView()	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	usePlenaryWorkOfficeView()	A complete view of the Work and Office 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

canLookupWorkOfficeAvailabilities

boolean canLookupWorkOfficeAvailabilities()

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

useComparativeWorkOfficeView

void useComparativeWorkOfficeView()

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.

usePlenaryWorkOfficeView

void usePlenaryWorkOfficeView()

A complete view of the Work and Office 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.

getWorkIdsByOffice

IdList getWorkIdsByOffice(Id officeId)
                   throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets the list of Work Ids associated with an Office .

Parameters:

officeId - Id of the Office

Returns:

list of related work Ids

Throws:

NotFoundException - officeId is not found

NullArgumentException - officeId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getWorksByOffice

WorkList getWorksByOffice(Id officeId)
                   throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets the list of Works associated with an Office .

Parameters:

officeId - Id of the Office

Returns:

list of related works

Throws:

NotFoundException - officeId is not found

NullArgumentException - officeId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getWorkIdsByOffices

IdList getWorkIdsByOffices(IdList officeIds)
                    throws OperationFailedException,
PermissionDeniedException

Gets the list of Work Ids corresponding to a list of Offices .

Parameters:

officeIds - list of office Ids

Returns:

list of work Ids

Throws:

NullArgumentException - officeIds is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getWorksByOffices

WorkList getWorksByOffices(IdList officeIds)
                    throws OperationFailedException,
PermissionDeniedException

Gets the list of Work corresponding to a list of Offices .

Parameters:

officeIds - list of office Ids

Returns:

list of works

Throws:

NullArgumentException - officeIds is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getOfficeIdsByWork

IdList getOfficeIdsByWork(Id workId)
                   throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets the Office Ids mapped to a Work .

Parameters:

workId - Id of a Work

Returns:

list of offices

Throws:

NotFoundException - workId is not found

NullArgumentException - workId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getOfficesByWork

OfficeList getOfficesByWork(Id workId)
                     throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets the Offices mapped to a Work .

Parameters:

workId - Id of a Work

Returns:

list of offices

Throws:

NotFoundException - workId is not found

NullArgumentException - workId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.