Interface StepProcessorOfficeAssignmentSession

All Superinterfaces:
AutoCloseable, Closeable, OsidSession, OsidSession
public interface StepProcessorOfficeAssignmentSession extends OsidSession

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

  • Method Details

    • canAssignStepProcessors

      boolean canAssignStepProcessors()
      Tests if this user can alter step processor/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.

    • canAssignStepProcessorsToOffice

      boolean canAssignStepProcessorsToOffice(Id officeId)
      Tests if this user can alter step processor/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 processor 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.

    • getAssignableOfficeIdsForStepProcessor

      IdList getAssignableOfficeIdsForStepProcessor(Id officeId, Id stepProcessorId) throws OperationFailedException
      Gets a list of office including and under the given office node in which a specific step processor can be assigned.
      Parameters:
      officeId - the Id of the Office
      stepProcessorId - the Id of the StepProcessor
      Returns:
      list of assignable office Ids
      Throws:
      NullArgumentException - officeId or stepProcessorId is null
      OperationFailedException - unable to complete request
      Compliance:
      mandatory - This method must be implemented.

    • assignStepProcessorToOffice

      void assignStepProcessorToOffice(Id stepProcessorId, Id officeId) throws AlreadyExistsException, NotFoundException, OperationFailedException, PermissionDeniedException
      Adds an existing StepProcessor to an Office .
      Parameters:
      stepProcessorId - the Id of the StepProcessor
      officeId - the Id of the Office
      Throws:
      AlreadyExistsException - stepProcessorId is already assigned to officeId
      NotFoundException - stepProcessorId or officeId not found
      NullArgumentException - stepProcessorId or officeId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • unassignStepProcessorFromOffice

      void unassignStepProcessorFromOffice(Id stepProcessorId, Id officeId) throws NotFoundException, OperationFailedException, PermissionDeniedException
      Removes a StepProcessor from an Office .
      Parameters:
      stepProcessorId - the Id of the StepProcessor
      officeId - the Id of the Office
      Throws:
      NotFoundException - stepProcessorId or officeId not found or stepProcessorId not assigned to officeId
      NullArgumentException - stepProcessorId or officeId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • reassignStepProcessorToOffice

      void reassignStepProcessorToOffice(Id stepProcessorId, Id fromOfficeId, Id toOfficeId) throws AlreadyExistsException, NotFoundException, OperationFailedException, PermissionDeniedException
      Moves a StepProcessor from one Office to another. Mappings to other Offices are unaffected.
      Parameters:
      stepProcessorId - the Id of the StepProcessor
      fromOfficeId - the Id of the current Office
      toOfficeId - the Id of the destination Office
      Throws:
      AlreadyExistsException - stepProcessorId already assigned to toOfficeId
      NotFoundException - stepProcessorId, fromOfficeId , or toOfficeId not found or stepProcessorId not mapped to fromOfficeId
      NullArgumentException - stepProcessorId, fromOfficeId , or toOfficeId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.