Interface ProcessOfficeAssignmentSession

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

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

  • Method Details

    • canAssignProcesses

      boolean canAssignProcesses()
      Tests if this user can alter process/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.

    • canAssignProcessesToOffice

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

    • getAssignableOfficeIdsForProcess

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

    • assignProcessToOffice

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

    • unassignProcessFromOffice

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

    • reassignProcessToOffice

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