org.osid.workflow

Interface StepOfficeSession

All Superinterfaces:

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

public interface StepOfficeSession
extends OsidSession

This session provides methods to retrieve Step to Office workflows. A Step 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	canLookupStepOfficeMappings() Tests if this user can perform lookups of step/office mappings.
IdList	getOfficeIdsByStep(Id stepId) Gets the Office Ids mapped to a Step.
OfficeList	getOfficesByStep(Id stepId) Gets the Offices mapped to a Step.
StepList	getStepesByOffice(Id officeId) Gets the list of Steps associated with a Office.
IdList	getStepIdsByOffice(Id officeId) Gets the list of Step Ids associated with a Office.
IdList	getStepIdsByOffices(IdList officeIds) Gets the list of Step Ids corresponding to a list of Offices.
StepList	getStepsByOffices(IdList officeIds) Gets the list of Steps corresponding to a list of Offices.
void	useComparativeStepOfficeView() 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	usePlenaryStepOfficeView() A complete view of the Step 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

canLookupStepOfficeMappings

boolean canLookupStepOfficeMappings()

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

useComparativeStepOfficeView

void useComparativeStepOfficeView()

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.

usePlenaryStepOfficeView

void usePlenaryStepOfficeView()

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

getStepIdsByOffice

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

Gets the list of Step Ids associated with a Office.

Parameters:

officeId - Id of the Office

Returns:

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

getStepesByOffice

StepList getStepesByOffice(Id officeId)
                           throws NotFoundException,
                                  OperationFailedException,
                                  PermissionDeniedException

Gets the list of Steps associated with a Office.

Parameters:

officeId - Id of the Office

Returns:

list of related steps

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.

getStepIdsByOffices

IdList getStepIdsByOffices(IdList officeIds)
                           throws OperationFailedException,
                                  PermissionDeniedException

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

Parameters:

officeIds - list of office Ids

Returns:

list of step Ids

Throws:

NullArgumentException - officeIds is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getStepsByOffices

StepList getStepsByOffices(IdList officeIds)
                           throws OperationFailedException,
                                  PermissionDeniedException

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

Parameters:

officeIds - list of office Ids

Returns:

list of steps

Throws:

NullArgumentException - officeIds is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getOfficeIdsByStep

IdList getOfficeIdsByStep(Id stepId)
                          throws NotFoundException,
                                 OperationFailedException,
                                 PermissionDeniedException

Gets the Office Ids mapped to a Step.

Parameters:

stepId - Id of a Step

Returns:

list of offices

Throws:

NotFoundException - stepId is not found

NullArgumentException - stepId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getOfficesByStep

OfficeList getOfficesByStep(Id stepId)
                            throws NotFoundException,
                                   OperationFailedException,
                                   PermissionDeniedException

Gets the Offices mapped to a Step.

Parameters:

stepId - Id of a Step

Returns:

list of offices

Throws:

NotFoundException - stepId is not found

NullArgumentException - stepId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.