Interface StepProcessorEnablerOfficeAssignmentSession

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

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

  • Method Details

    • canAssignStepProcessorEnablers

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

    • canAssignStepProcessorEnablersToOffice

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

    • getAssignableOfficeIdsForStepProcessorEnabler

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

    • assignStepProcessorEnablerToOffice

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

    • unassignStepProcessorEnablerFromOffice

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

    • reassignStepProcessorEnablerToOffice

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