Interface ProcessEnablerOfficeAssignmentSession

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

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

  • Method Details

    • canAssignProcessEnablers

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

    • canAssignProcessEnablersToOffice

      boolean canAssignProcessEnablersToOffice(Id officeId)
      Tests if this user can alter process 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 offices including and under the given office node in which any process 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.

    • getAssignableOfficeIdsForProcessEnabler

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

    • assignProcessEnablerToOffice

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

    • unassignProcessEnablerFromOffice

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

    • reassignProcessEnablerToOffice

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