org.osid.workflow

Interface ProcessLookupSession

All Superinterfaces:

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

public interface ProcessLookupSession
extends OsidSession

This session provides methods for retrieving Process objects.

This session defines views that offer differing behaviors when retrieving multiple objects.

• comparative view: elements may be silently omitted or re-ordered
• plenary view: provides a complete set or is an error condition
• isolated office view: All process methods in this session operate, retrieve and pertain to processes defined explicitly in the current office. Using an isolated view is useful for managing Process with the ProcessAdminSession.
• federated office view: All process methods in this session operate, retrieve and pertain to all process defined in this office and any other process implicitly available in this office through office inheritence.
• active process view: active processes are returned from methods in this session
• any status process view: active and inactive processes are returned from methods in this session

Generally, the comparative view should be used for most applications as it permits operation even if there is data that cannot be accessed. The methods useFederatedOfficeView() and useIsolatedOfficeView() behave as a radio group and one should be selected before invoking any lookup methods.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	canLookupProcesses() Tests if this user can perform Process lookups.
Office	getOffice() Gets the Office associated with this session.
Id	getOfficeId() Gets the Office Id associated with this session.
Process	getProcess(Id processId) Gets the Process specified by its Id.
ProcessList	getProcesses() Gets all Processes.
ProcessList	getProcessesByGenusType(Type processGenusType) Gets a ProcessList corresponding to the given process genus Type which does not include processes of genus types derived from the specified Type.
ProcessList	getProcessesByIds(IdList processIds) Gets a ProcessList corresponding to the given IdList.
ProcessList	getProcessesByParentGenusType(Type processGenusType) Gets a ProcessList corresponding to the given process genus Type and include any additional processes with genus types derived from the specified Type.
ProcessList	getProcessesByProvider(Id resourceId) Gets a ProcessList from the given provider.
ProcessList	getProcessesByRecordType(Type processRecordType) Gets a ProcessList containing the given process record Type.
void	useActiveProcessView() Only active processes are returned from methods in this session.
void	useAnyStatusProcessView() Borth active and inactive processes are returned from methods in this session.
void	useComparativeProcessView() 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	useFederatedOfficeView() Federates the view for methods in this session.
void	useIsolatedOfficeView() Isolates the view for methods in this session.
void	usePlenaryProcessView() A complete view of the Process 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

getOfficeId

Id getOfficeId()

Gets the Office Id associated with this session.

Returns:

the Office Id associated with this session

Compliance:

mandatory - This method must be implemented.

getOffice

Office getOffice()
                 throws OperationFailedException,
                        PermissionDeniedException

Gets the Office associated with this session.

Returns:

the office

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

canLookupProcesses

boolean canLookupProcesses()

Tests if this user can perform Process lookups. A return of true does not guarantee successful authorization. A return of false indicates that it is known all 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 lookup methods are not authorized, true otherwise

Compliance:

mandatory - This method must be implemented.

useComparativeProcessView

void useComparativeProcessView()

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.

usePlenaryProcessView

void usePlenaryProcessView()

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

useFederatedOfficeView

void useFederatedOfficeView()

Federates the view for methods in this session. A federated view will include processes in offices which are children of this office in the office hierarchy.

Compliance:

mandatory - This method is must be implemented.

useIsolatedOfficeView

void useIsolatedOfficeView()

Isolates the view for methods in this session. An isolated view restricts lookups to this office only.

Compliance:

mandatory - This method is must be implemented.

useActiveProcessView

void useActiveProcessView()

Only active processes are returned from methods in this session.

Compliance:

mandatory - This method is must be implemented.

useAnyStatusProcessView

void useAnyStatusProcessView()

Borth active and inactive processes are returned from methods in this session.

Compliance:

mandatory - This method is must be implemented.

getProcess

Process getProcess(Id processId)
                   throws NotFoundException,
                          OperationFailedException,
                          PermissionDeniedException

Gets the Process specified by its Id. In plenary mode, the exact Id is found or a NOT_FOUND results. Otherwise, the returned Process may have a different Id than requested, such as the case where a duplicate Id was assigned to a Process and retained for compatibility. In active mode, processes are returned that are currently active. In any status mode, active and inactive processes are returned.

Parameters:

processId - Id of the Process

Returns:

the process

Throws:

NotFoundException - processId not found

NullArgumentException - processId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method is must be implemented.

getProcessesByIds

ProcessList getProcessesByIds(IdList processIds)
                              throws NotFoundException,
                                     OperationFailedException,
                                     PermissionDeniedException

Gets a ProcessList corresponding to the given IdList. In plenary mode, the returned list contains all of the processes specified in the Id list, in the order of the list, including duplicates, or an error results if an Id in the supplied list is not found or inaccessible. Otherwise, inaccessible Processes may be omitted from the list and may present the elements in any order including returning a unique set. In active mode, processes are returned that are currently active. In any status mode, active and inactive processes are returned.

Parameters:

processIds - the list of Ids to retrieve

Returns:

the returned Process list

Throws:

NotFoundException - an Id was not found

NullArgumentException - processIds is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getProcessesByGenusType

ProcessList getProcessesByGenusType(Type processGenusType)
                                    throws OperationFailedException,
                                           PermissionDeniedException

Gets a ProcessList corresponding to the given process genus Type which does not include processes of genus types derived from the specified Type. In plenary mode, the returned list contains all known processes or an error results. Otherwise, the returned list may contain only those processes that are accessible through this session. In active mode, processes are returned that are currently active. In any status mode, active and inactive processes are returned.

Parameters:

processGenusType - a process genus type

Returns:

the returned Process list

Throws:

NullArgumentException - processGenusType is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getProcessesByParentGenusType

ProcessList getProcessesByParentGenusType(Type processGenusType)
                                          throws OperationFailedException,
                                                 PermissionDeniedException

Gets a ProcessList corresponding to the given process genus Type and include any additional processes with genus types derived from the specified Type. In plenary mode, the returned list contains all known processes or an error results. Otherwise, the returned list may contain only those processes that are accessible through this session. In active mode, processes are returned that are currently active. In any status mode, active and inactive processes are returned.

Parameters:

processGenusType - a process genus type

Returns:

the returned Process list

Throws:

NullArgumentException - processGenusType is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getProcessesByRecordType

ProcessList getProcessesByRecordType(Type processRecordType)
                                     throws OperationFailedException,
                                            PermissionDeniedException

Gets a ProcessList containing the given process record Type. In plenary mode, the returned list contains all known processes or an error results. Otherwise, the returned list may contain only those processes that are accessible through this session. In active mode, processes are returned that are currently active. In any status mode, active and inactive processes are returned.

Parameters:

processRecordType - a process record type

Returns:

the returned Process list

Throws:

NullArgumentException - processRecordType is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getProcessesByProvider

ProcessList getProcessesByProvider(Id resourceId)
                                   throws OperationFailedException,
                                          PermissionDeniedException

Gets a ProcessList from the given provider. In plenary mode, the returned list contains all known processes or an error results. Otherwise, the returned list may contain only those processes that are accessible through this session. In active mode, processes are returned that are currently active. In any status mode, active and inactive processes are returned.

Parameters:

resourceId - a resource Id

Returns:

the returned Process list

Throws:

NullArgumentException - resourceId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getProcesses

ProcessList getProcesses()
                         throws OperationFailedException,
                                PermissionDeniedException

Gets all Processes. In plenary mode, the returned list contains all known processes or an error results. Otherwise, the returned list may contain only those process that are accessible through this session. In active mode, processes are returned that are currently active. In any status mode, active and inactive processes are returned.

Returns:

a list of Processes

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.