Package com.polarion.alm.tracker.workflow

Interface ICallContext<T extends IWorkflowObject>

Type Parameters:
T - type of the target object, see getTarget()
public interface ICallContext<T extends IWorkflowObject>
Handles the context data used for workflow functions, conditions and validators.
Author:
dobisekm

  • Method Details

    • getTrackerService

      @NotNull ITrackerService getTrackerService()
      Returns the tracker service.
      Returns:
      the ITrackerService object representing the tracker service

    • getTarget

      @NotNull T getTarget()
      Returns the object, on which the workflow is executed.
      Returns:
      the IWorkflowObject representing the target of the workflow
      Since:
      3.8.1

    • getWorkItem

      @NotNull @Deprecated IWorkItem getWorkItem()
      Deprecated.
      use getTarget()
      Returns the work item.
      Returns:
      the IWorkItem object representing the work item

    • getActionId

      @NotNull String getActionId()
      Returns the native action id.
      Returns:
      the String object representing the native action id
      See Also:

    • getTargetStatusId

      @NotNull String getTargetStatusId()
      Returns the target status id.
      Returns:
      the target status id.
      Since:
      3.8.2

    • getModifiedObjects

      @NotNull Collection<IPObject> getModifiedObjects()
      Returns all objects that were marked as modified. The result will contain the objects included by calling prepareObjectForModification(IPObject) and the work item associated with this context.
      Returns:
      a Collection object containing the IPObjects that were marked as modified.

    • prepareObjectForModification

      @NotNull <S extends IPObject> S prepareObjectForModification(@NotNull S object)
      Returns a IPObject that can be modified in a workflow operation.

      This method is used to keep track of objects modified during the workflow operation and to ensure, that all workflow functions do modify the same instance of object.

      The result of getTarget() is already modification-ready and doesn't have to be passed through this method.

      Parameters:
      object - a IPObject object to get a instance prepared for modification for
      Returns:
      the IPObject object that is prepared to be modified