org.osid.workflow.rules

Interface StepConstrainerEnablerOfficeAssignmentSession

All Superinterfaces:

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

public interface StepConstrainerEnablerOfficeAssignmentSession
extends OsidSession

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

Method Summary

Methods

Modifier and Type	Method and Description
void	assignStepConstrainerEnablerToOffice(Id stepConstrainerEnablerId, Id officeId) Adds an existing StepConstrainerEnabler to an Office.
boolean	canAssignStepConstrainerEnablers() Tests if this user can alter step constrainer enabler/office mappings.
boolean	canAssignStepConstrainerEnablersToOffice(Id officeId) Tests if this user can alter step constrainer enabler/office mappings.
IdList	getAssignableOfficeIds(Id officeId) Gets a list of office including and under the given office node in which any step constrainer enabler can be assigned.
IdList	getAssignableOfficeIdsForStepConstrainerEnabler(Id officeId, Id stepConstrainerEnablerId) Gets a list of office including and under the given office node in which a specific step constrainer enabler can be assigned.
void	unassignStepConstrainerEnablerFromOffice(Id stepConstrainerEnablerId, Id officeId) Removes a StepConstrainerEnabler 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

canAssignStepConstrainerEnablers

boolean canAssignStepConstrainerEnablers()

Tests if this user can alter step constrainer enabler/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.

canAssignStepConstrainerEnablersToOffice

boolean canAssignStepConstrainerEnablersToOffice(Id officeId)

Tests if this user can alter step constrainer enabler/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 enabler 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.

getAssignableOfficeIdsForStepConstrainerEnabler

IdList getAssignableOfficeIdsForStepConstrainerEnabler(Id officeId,
                                                     Id stepConstrainerEnablerId)
                                                       throws OperationFailedException

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

Parameters:

officeId - the Id of the Office

stepConstrainerEnablerId - the Id of the StepConstrainerEnabler

Returns:

list of assignable office Ids

Throws:

NullArgumentException - officeId or stepConstrainerEnablerId is null

OperationFailedException - unable to complete request

Compliance:

mandatory - This method must be implemented.

assignStepConstrainerEnablerToOffice

void assignStepConstrainerEnablerToOffice(Id stepConstrainerEnablerId,
                                        Id officeId)
                                          throws AlreadyExistsException,
                                                 NotFoundException,
                                                 OperationFailedException,
                                                 PermissionDeniedException

Adds an existing StepConstrainerEnabler to an Office.

Parameters:

stepConstrainerEnablerId - the Id of the StepConstrainerEnabler

officeId - the Id of the Office

Throws:

AlreadyExistsException - stepConstrainerEnablerId is already assigned to officeId

NotFoundException - stepConstrainerEnablerId or officeId not found

NullArgumentException - stepConstrainerEnablerId or officeId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

unassignStepConstrainerEnablerFromOffice

void unassignStepConstrainerEnablerFromOffice(Id stepConstrainerEnablerId,
                                            Id officeId)
                                              throws NotFoundException,
                                                     OperationFailedException,
                                                     PermissionDeniedException

Removes a StepConstrainerEnabler from an Office.

Parameters:

stepConstrainerEnablerId - the Id of the StepConstrainerEnabler

officeId - the Id of the Office

Throws:

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

NullArgumentException - stepConstrainerEnablerId or officeId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.