org.osid.workflow.rules

Interface StepConstrainerOfficeAssignmentSession

All Superinterfaces:

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

public interface StepConstrainerOfficeAssignmentSession
extends OsidSession

This session provides methods to re-assign StepConstrainer to Office mappings. a StepConstrainer may appear in multiple Office objects and removing the last reference to a StepConstrainer 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 StepConstrainer to another Office is not a copy operation (eg: does not change its Id ).

Method Summary

Methods

Modifier and Type	Method and Description
void	assignStepConstrainerToOffice(Id stepConstrainerId, Id officeId) Adds an existing StepConstrainer to an Office.
boolean	canAssignStepConstrainers() Tests if this user can alter step constrainer/office mappings.
boolean	canAssignStepConstrainersToOffice(Id officeId) Tests if this user can alter step constrainer/office mappings.
IdList	getAssignableOfficeIds(Id officeId) Gets a list of office including and under the given office node in which any step constrainer can be assigned.
IdList	getAssignableOfficeIdsForStepConstrainer(Id officeId, Id stepConstrainerId) Gets a list of office including and under the given office node in which a specific step constrainer can be assigned.
void	reassignStepConstrainerToOffice(Id stepConstrainerId, Id fromOfficeId, Id toOfficeId) Moves a StepConstrainer from one Office to another.
void	unassignStepConstrainerFromOffice(Id stepConstrainerId, Id officeId) Removes a StepConstrainer from an 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

canAssignStepConstrainers

boolean canAssignStepConstrainers()

Tests if this user can alter step constrainer/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 lookup operations to unauthorized users.

Returns:

false if mapping is not authorized, true otherwise

Compliance:

mandatory - This method must be implemented.

canAssignStepConstrainersToOffice

boolean canAssignStepConstrainersToOffice(Id officeId)

Tests if this user can alter step constrainer/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 lookup 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 office including and under the given office node in which any step constrainer 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.

getAssignableOfficeIdsForStepConstrainer

IdList getAssignableOfficeIdsForStepConstrainer(Id officeId,
                                              Id stepConstrainerId)
                                                throws OperationFailedException

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

Parameters:

officeId - the Id of the Office

stepConstrainerId - the Id of the StepConstrainer

Returns:

list of assignable office Ids

Throws:

NullArgumentException - officeId or stepConstrainerId is null

OperationFailedException - unable to complete request

Compliance:

mandatory - This method must be implemented.

assignStepConstrainerToOffice

void assignStepConstrainerToOffice(Id stepConstrainerId,
                                 Id officeId)
                                   throws AlreadyExistsException,
                                          NotFoundException,
                                          OperationFailedException,
                                          PermissionDeniedException

Adds an existing StepConstrainer to an Office.

Parameters:

stepConstrainerId - the Id of the StepConstrainer

officeId - the Id of the Office

Throws:

AlreadyExistsException - stepConstrainerId is already assigned to officeId

NotFoundException - stepConstrainerId or officeId not found

NullArgumentException - stepConstrainerId or officeId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

unassignStepConstrainerFromOffice

void unassignStepConstrainerFromOffice(Id stepConstrainerId,
                                     Id officeId)
                                       throws NotFoundException,
                                              OperationFailedException,
                                              PermissionDeniedException

Removes a StepConstrainer from an Office.

Parameters:

stepConstrainerId - the Id of the StepConstrainer

officeId - the Id of the Office

Throws:

NotFoundException - stepConstrainerId or officeId not found or stepConstrainerId not assigned to officeId

NullArgumentException - stepConstrainerId or officeId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

reassignStepConstrainerToOffice

void reassignStepConstrainerToOffice(Id stepConstrainerId,
                                   Id fromOfficeId,
                                   Id toOfficeId)
                                     throws NotFoundException,
                                            OperationFailedException,
                                            PermissionDeniedException

Moves a StepConstrainer from one Office to another. Mappings to other Offices are unaffected.

Parameters:

stepConstrainerId - the Id of the StepConstrainer

fromOfficeId - the Id of the current Office

toOfficeId - the Id of the destination Office

Throws:

NotFoundException - stepConstrainerId, fromOfficeId, or toOfficeId not found or stepConstrainerId not mapped to fromOfficeId

NullArgumentException - stepConstrainerId, fromOfficeId, or toOfficeId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.