org.osid.workflow

Interface ProcessOfficeSession

All Superinterfaces:

java.lang.AutoCloseable, java.io.Closeable, OsidSession

public interface ProcessOfficeSession
extends OsidSession

This session provides methods to retrieve Process to Office workflows. A Process 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

Methods

Modifier and Type	Method and Description
boolean	canLookupProcessOfficeMappings() Tests if this user can perform lookups of process/office mappings.
IdList	getOfficeIdsByProcess(Id processId) Gets the Office Ids mapped to a Process.
OfficeList	getOfficesByProcess(Id processId) Gets the Offices mapped to a Process.
ProcessList	getProcessesByOffice(Id officeId) Gets the list of Processes associated with a Office.
ProcessList	getProcessesByOffices(IdList officeIds) Gets the list of Processes corresponding to a list of Offices.
IdList	getProcessIdsByOffice(Id officeId) Gets the list of Process Ids associated with a Office.
IdList	getProcessIdsByOffices(IdList officeIds) Gets the list of Process Ids corresponding to a list of Offices.
void	useComparativeProcessOfficeView() 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	usePlenaryProcessOfficeView() A complete view of the Process and Office returns is desired.

Methods inherited from interface org.osid.OsidSession

getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions

Methods inherited from interface org.osid.binding.java.OsidSession

close

Methods inherited from interface java.io.Closeable

close

Method Detail

canLookupProcessOfficeMappings

boolean canLookupProcessOfficeMappings()

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

useComparativeProcessOfficeView

void useComparativeProcessOfficeView()

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.

usePlenaryProcessOfficeView

void usePlenaryProcessOfficeView()

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

getProcessIdsByOffice

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

Gets the list of Process Ids associated with a Office.

Parameters:

officeId - Id of the Office

Returns:

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

getProcessesByOffice

ProcessList getProcessesByOffice(Id officeId)
                                 throws NotFoundException,
                                        OperationFailedException,
                                        PermissionDeniedException

Gets the list of Processes associated with a Office.

Parameters:

officeId - Id of the Office

Returns:

list of related processes

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.

getProcessIdsByOffices

IdList getProcessIdsByOffices(IdList officeIds)
                              throws OperationFailedException,
                                     PermissionDeniedException

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

Parameters:

officeIds - list of office Ids

Returns:

list of process Ids

Throws:

NullArgumentException - officeIds is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getProcessesByOffices

ProcessList getProcessesByOffices(IdList officeIds)
                                  throws OperationFailedException,
                                         PermissionDeniedException

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

Parameters:

officeIds - list of office Ids

Returns:

list of processes

Throws:

NullArgumentException - officeIds is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getOfficeIdsByProcess

IdList getOfficeIdsByProcess(Id processId)
                             throws NotFoundException,
                                    OperationFailedException,
                                    PermissionDeniedException

Gets the Office Ids mapped to a Process.

Parameters:

processId - Id of a Process

Returns:

list of offices

Throws:

NotFoundException - processId is not found

NullArgumentException - processId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getOfficesByProcess

OfficeList getOfficesByProcess(Id processId)
                               throws NotFoundException,
                                      OperationFailedException,
                                      PermissionDeniedException

Gets the Offices mapped to a Process.

Parameters:

processId - Id of a Process

Returns:

list of offices

Throws:

NotFoundException - processId is not found

NullArgumentException - processId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.