Interface ProcessProcessorOfficeSession

All Superinterfaces:

AutoCloseable, Closeable, OsidSession, OsidSession

public interface ProcessProcessorOfficeSession
extends OsidSession

This session provides methods to retrieve ProcessProcessor to Office mappings. A ProcessProcessor 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	canLookupProcessProcessorOfficeMappings()	Tests if this user can perform lookups of process processor/office mappings.
IdList	getOfficeIdsByProcessProcessor(Id processProcessorId)	Gets the Office Ids mapped to a ProcessProcessor .
OfficeList	getOfficesByProcessProcessor(Id processProcessorId)	Gets the Offices mapped to a ProcessConstrainer .
IdList	getProcessProcessorIdsByOffice(Id officeId)	Gets the list of ProcessProcessorIds associated with an Office .
IdList	getProcessProcessorIdsByOffices(IdList officeIds)	Gets the list of ProcessConstrainerIds corresponding to a list of Offices .
ProcessProcessorList	getProcessProcessorsByOffice(Id officeId)	Gets the list of ProcessProcessors associated with an Office .
ProcessProcessorList	getProcessProcessorsByOffices(IdList officeIds)	Gets the list of ProcessConstrainers corresponding to a list of Offices .
void	useComparativeProcessProcessorOfficeView()	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	usePlenaryProcessProcessorOfficeView()	A complete view of the ProcessProcessor 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

canLookupProcessProcessorOfficeMappings

boolean canLookupProcessProcessorOfficeMappings()

Tests if this user can perform lookups of process 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. T his 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.

useComparativeProcessProcessorOfficeView

void useComparativeProcessProcessorOfficeView()

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.

usePlenaryProcessProcessorOfficeView

void usePlenaryProcessProcessorOfficeView()

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

getProcessProcessorIdsByOffice

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

Gets the list of ProcessProcessorIds associated with an Office .

Parameters:

officeId - Id of the Office

Returns:

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

getProcessProcessorsByOffice

ProcessProcessorList getProcessProcessorsByOffice(Id officeId)
                                           throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets the list of ProcessProcessors associated with an Office .

Parameters:

officeId - Id of the Office

Returns:

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

getProcessProcessorIdsByOffices

IdList getProcessProcessorIdsByOffices(IdList officeIds)
                                throws OperationFailedException,
PermissionDeniedException

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

Parameters:

officeIds - list of office Ids

Returns:

list of process processor Ids

Throws:

NullArgumentException - officeIds is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getProcessProcessorsByOffices

ProcessProcessorList getProcessProcessorsByOffices(IdList officeIds)
                                            throws OperationFailedException,
PermissionDeniedException

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

Parameters:

officeIds - list of office Ids

Returns:

list of process processors

Throws:

NullArgumentException - officeIds is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getOfficeIdsByProcessProcessor

IdList getOfficeIdsByProcessProcessor(Id processProcessorId)
                               throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets the Office Ids mapped to a ProcessProcessor .

Parameters:

processProcessorId - Id of a ProcessProcessor

Returns:

list of office Ids

Throws:

NotFoundException - processProcessorId is not found

NullArgumentException - processProcessorId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getOfficesByProcessProcessor

OfficeList getOfficesByProcessProcessor(Id processProcessorId)
                                 throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets the Offices mapped to a ProcessConstrainer .

Parameters:

processProcessorId - Id of a ProcessProcessor

Returns:

list of offices

Throws:

NotFoundException - processProcessorId is not found

NullArgumentException - processProcessorId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.