Interface StepProcessorAdminSession

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

This session creates and removes step processors. The data for create and update is provided via the StepProcessorForm.

  • Method Details

    • getOfficeId

      Id getOfficeId()
      Gets the Office Id associated with this session.
      Returns:
      the Office Id associated with this session
      Compliance:
      mandatory - This method must be implemented.

    • getOffice

      Office getOffice() throws OperationFailedException, PermissionDeniedException
      Gets the Office associated with this session.
      Returns:
      the office
      Throws:
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • canCreateStepProcessor

      boolean canCreateStepProcessor()
      Tests if this user can create step processors. A return of true does not guarantee successful authorization. A return of false indicates that it is known creating a StepProcessor will result in a PERMISSION_DENIED. This is intended as a hint to an application that may opt not to offer create operations to an unauthorized user.
      Returns:
      false if StepProcessor creation is not authorized, true otherwise
      Compliance:
      mandatory - This method must be implemented.

    • canCreateStepProcessorWithRecordTypes

      boolean canCreateStepProcessorWithRecordTypes(Type[] stepProcessorRecordTypes)
      Tests if this user can create a single StepProcessor using the desired record types. While WorkflowRulesManager.getStepProcessorRecordTypes() can be used to examine which records are supported, this method tests which record(s) are required for creating a specific StepProcessor. Providing an empty array tests if a StepProcessor can be created with no records.
      Parameters:
      stepProcessorRecordTypes - array of step processor record types
      Returns:
      true if StepProcessor creation using the specified record Types is supported, false otherwise
      Throws:
      NullArgumentException - stepProcessorRecordTypes is null
      Compliance:
      mandatory - This method must be implemented.

    • getStepProcessorFormForCreate

      StepProcessorForm getStepProcessorFormForCreate(Type[] stepProcessorRecordTypes) throws OperationFailedException, PermissionDeniedException
      Gets the step processor form for creating new step processors. A new form should be requested for each create transaction.
      Parameters:
      stepProcessorRecordTypes - array of step processor record types
      Returns:
      the step processor form
      Throws:
      NullArgumentException - stepProcessorRecordTypes is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      UnsupportedException - unable to get form for requested record types
      Compliance:
      mandatory - This method must be implemented.

    • createStepProcessor

      StepProcessor createStepProcessor(StepProcessorForm stepProcessorForm) throws OperationFailedException, PermissionDeniedException
      Creates a new StepProcessor.
      Parameters:
      stepProcessorForm - the form for this StepProcessor
      Returns:
      the new StepProcessor
      Throws:
      IllegalStateException - stepProcessorForm already used in a create transaction
      InvalidArgumentException - one or more of the form elements is invalid
      NullArgumentException - stepProcessorForm is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      UnsupportedException - stepProcessorForm did not originate from getStepProcessorFormForCreate()
      Compliance:
      mandatory - This method must be implemented.

    • canUpdateStepProcessors

      boolean canUpdateStepProcessors()
      Tests if this user can update step processors. A return of true does not guarantee successful authorization. A return of false indicates that it is known updating a StepProcessor will result in a PERMISSION_DENIED. This is intended as a hint to an application that may opt not to offer update operations to an unauthorized user.
      Returns:
      false if StepProcessor modification is not authorized, true otherwise
      Compliance:
      mandatory - This method must be implemented.

    • getStepProcessorFormForUpdate

      StepProcessorForm getStepProcessorFormForUpdate(Id stepProcessorId) throws NotFoundException, OperationFailedException, PermissionDeniedException
      Gets the step processor form for updating an existing step processor. A new step processor form should be requested for each update transaction.
      Parameters:
      stepProcessorId - the Id of the StepProcessor
      Returns:
      the step processor form
      Throws:
      NotFoundException - stepProcessorId is not found
      NullArgumentException - stepProcessorId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • updateStepProcessor

      void updateStepProcessor(StepProcessorForm stepProcessorForm) throws OperationFailedException, PermissionDeniedException
      Updates an existing step processor.
      Parameters:
      stepProcessorForm - the form containing the elements to be updated
      Throws:
      IllegalStateException - stepProcessorForm already used in an update transaction
      InvalidArgumentException - the form contains an invalid value
      NullArgumentException - stepProcessorForm is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      UnsupportedException - stepProcessorForm did not originate from getStepProcessorFormForUpdate()
      Compliance:
      mandatory - This method must be implemented.

    • canDeleteStepProcessors

      boolean canDeleteStepProcessors()
      Tests if this user can delete step processors. A return of true does not guarantee successful authorization. A return of false indicates that it is known deleting a StepProcessor will result in a PERMISSION_DENIED. This is intended as a hint to an application that may opt not to offer delete operations to an unauthorized user.
      Returns:
      false if StepProcessor deletion is not authorized, true otherwise
      Compliance:
      mandatory - This method must be implemented.

    • deleteStepProcessor

      void deleteStepProcessor(Id stepProcessorId) throws NotFoundException, OperationFailedException, PermissionDeniedException
      Deletes a StepProcessor.
      Parameters:
      stepProcessorId - the Id of the StepProcessor to remove
      Throws:
      NotFoundException - stepProcessorId not found
      NullArgumentException - stepProcessorId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • canManageStepProcessorAliases

      boolean canManageStepProcessorAliases()
      Tests if this user can manage Id aliases for step processors. A return of true does not guarantee successful authorization. A return of false indicates that it is known changing an alias will result in a PERMISSION_DENIED. This is intended as a hint to an application that may opt not to offer alias operations to an unauthorized user.
      Returns:
      false if StepProcessor aliasing is not authorized, true otherwise
      Compliance:
      mandatory - This method must be implemented.

    • aliasStepProcessor

      void aliasStepProcessor(Id stepProcessorId, Id aliasId) throws AlreadyExistsException, NotFoundException, OperationFailedException, PermissionDeniedException
      Adds a Id to a StepProcessor for the purpose of creating compatibility. The primary Id of the StepProcessor is determined by the provider. The new Id performs as an alias to the primary Id. If the alias is a pointer to another step processor. it is reassigned to the given step processor Id.
      Parameters:
      stepProcessorId - the Id of a StepProcessor
      aliasId - the alias Id
      Throws:
      AlreadyExistsException - aliasId is already assigned
      NotFoundException - stepProcessorId not found
      NullArgumentException - stepProcessorId or aliasId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.