org.osid.workflow

Interface StepOfficeAssignmentSession

All Superinterfaces:

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

public interface StepOfficeAssignmentSession
extends OsidSession

This session provides methods to re-assign Step to Office mappings. A Step may appear in multiple Office objects and removing the last reference to a Step is the equivalent of deleting it. Each Office may have its own authorizations governing who is allowed to operate on it.

Adding a reference of a Step to another Office is not a copy operation (eg: does not change its Id ).

Method Summary

Methods

Modifier and Type	Method and Description
void	assignStepToOffice(Id stepId, Id officeId) Adds an existing Step to a Office.
boolean	canAssignStepes() Tests if this user can alter step/office mappings.
boolean	canAssignStepesToOffice(Id officeId) Tests if this user can alter step/office mappings.
IdList	getAssignableOfficeIds(Id officeId) Gets a list of offices including and under the given office node in which any step can be assigned.
IdList	getAssignableOfficeIdsForStep(Id officeId, Id stepId) Gets a list of offices including and under the given office node in which a specific step can be assigned.
void	unassignStepFromOffice(Id stepId, Id officeId) Removes a Step from a Office.

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

canAssignStepes

boolean canAssignStepes()

Tests if this user can alter step/office mappings. A return of true does not guarantee successful authorization. A return of false indicates that it is known mapping 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 assignment operations to unauthorized users.

Returns:

false if mapping is not authorized, true otherwise

Compliance:

mandatory - This method must be implemented.

canAssignStepesToOffice

boolean canAssignStepesToOffice(Id officeId)

Tests if this user can alter step/office mappings. A return of true does not guarantee successful authorization. A return of false indicates that it is known mapping 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 assignment operations to unauthorized users.

Parameters:

officeId - the Id of the Office

Returns:

false if mapping is not authorized, true otherwise

Throws:

NullArgumentException - officeId is null

Compliance:

mandatory - This method must be implemented.

getAssignableOfficeIds

IdList getAssignableOfficeIds(Id officeId)
                              throws OperationFailedException

Gets a list of offices including and under the given office node in which any step can be assigned.

Parameters:

officeId - the Id of the Office

Returns:

list of assignable office Ids

Throws:

NullArgumentException - officeId is null

OperationFailedException - unable to complete request

Compliance:

mandatory - This method must be implemented.

getAssignableOfficeIdsForStep

IdList getAssignableOfficeIdsForStep(Id officeId,
                                   Id stepId)
                                     throws OperationFailedException

Gets a list of offices including and under the given office node in which a specific step can be assigned.

Parameters:

officeId - the Id of the Office

stepId - the Id of the Step

Returns:

list of assignable office Ids

Throws:

NullArgumentException - officeId or stepId is null

OperationFailedException - unable to complete request

Compliance:

mandatory - This method must be implemented.

assignStepToOffice

void assignStepToOffice(Id stepId,
                      Id officeId)
                        throws AlreadyExistsException,
                               NotFoundException,
                               OperationFailedException,
                               PermissionDeniedException

Adds an existing Step to a Office.

Parameters:

stepId - the Id of the Step

officeId - the Id of the Office

Throws:

AlreadyExistsException - stepId is already assigned to officeId

NotFoundException - stepId or officeId not found

NullArgumentException - stepId or officeId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

unassignStepFromOffice

void unassignStepFromOffice(Id stepId,
                          Id officeId)
                            throws NotFoundException,
                                   OperationFailedException,
                                   PermissionDeniedException

Removes a Step from a Office.

Parameters:

stepId - the Id of the Step

officeId - the Id of the Office

Throws:

NotFoundException - stepId or officeId not found or stepId is not assigned to officeId

NullArgumentException - stepId or officeId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.