Interface StepProcessorOfficeSession

All Superinterfaces:

AutoCloseable, Closeable, OsidSession, OsidSession

public interface StepProcessorOfficeSession
extends OsidSession

This session provides methods to retrieve StepProcessor to Office mappings. a StepProcessor may appear in multiple Office objects. 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	canLookupStepProcessorOfficeMappings()	Tests if this user can perform lookups of step processor/office mappings.
IdList	getOfficeIdsByStepProcessor(Id stepProcessorId)	Gets the Office Ids mapped to a StepProcessor .
OfficeList	getOfficesByStepProcessor(Id stepProcessorId)	Gets the Offices mapped to a StepProcessor .
IdList	getStepProcessorIdsByOffice(Id officeId)	Gets the list of StepProcessorIds associated with an Office .
IdList	getStepProcessorIdsByOffices(IdList officeIds)	Gets the list of StepProcessor Ids corresponding to a list of Offices .
StepProcessorList	getStepProcessorsByOffice(Id officeId)	Gets the list of step processors associated with an Office .
StepProcessorList	getStepProcessorsByOffices(IdList officeIds)	Gets the list of step processor corresponding to a list of Offices .
void	useComparativeStepProcessorOfficeView()	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	usePlenaryStepProcessorOfficeView()	A complete view of the StepProcessor 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

canLookupStepProcessorOfficeMappings

boolean canLookupStepProcessorOfficeMappings()

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

useComparativeStepProcessorOfficeView

void useComparativeStepProcessorOfficeView()

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.

usePlenaryStepProcessorOfficeView

void usePlenaryStepProcessorOfficeView()

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

getStepProcessorIdsByOffice

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

Gets the list of StepProcessorIds associated with an Office .

Parameters:

officeId - Id of the Office

Returns:

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

getStepProcessorsByOffice

StepProcessorList getStepProcessorsByOffice(Id officeId)
                                     throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets the list of step processors associated with an Office .

Parameters:

officeId - Id of the Office

Returns:

list of related step processors

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.

getStepProcessorIdsByOffices

IdList getStepProcessorIdsByOffices(IdList officeIds)
                             throws OperationFailedException,
PermissionDeniedException

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

Parameters:

officeIds - list of office Ids

Returns:

list of step processor Ids

Throws:

NullArgumentException - officeIds is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getStepProcessorsByOffices

StepProcessorList getStepProcessorsByOffices(IdList officeIds)
                                      throws OperationFailedException,
PermissionDeniedException

Gets the list of step processor corresponding to a list of Offices .

Parameters:

officeIds - list of office Ids

Returns:

list of step processors

Throws:

NullArgumentException - officeIds is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getOfficeIdsByStepProcessor

IdList getOfficeIdsByStepProcessor(Id stepProcessorId)
                            throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets the Office Ids mapped to a StepProcessor .

Parameters:

stepProcessorId - Id of a StepProcessor

Returns:

list of offices

Throws:

NotFoundException - stepProcessorId is not found

NullArgumentException - stepProcessorId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getOfficesByStepProcessor

OfficeList getOfficesByStepProcessor(Id stepProcessorId)
                              throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets the Offices mapped to a StepProcessor .

Parameters:

stepProcessorId - Id of a StepProcessor

Returns:

list of offices

Throws:

NotFoundException - stepProcessorId is not found

NullArgumentException - stepProcessorId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.