Interface ProcessProcessorEnablerOfficeAssignmentSession

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

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

  • Method Details

    • canAssignProcessProcessorEnablers

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

    • canAssignProcessProcessorEnablerToOffice

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

    • getAssignableOfficeIdsForProcessProcessorEnabler

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

    • assignProcessProcessorEnablerToOffice

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

    • unassignProcessProcessorEnablerFromOffice

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

    • reassignProcessProcessorEnablerToOffice

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