Method Detail

• getActionProcess

  public static VSActionTXProcess getActionProcess​(ITXProcess process)

  Retrieves the VS action process from the TXP process.

  Returns:

  The action process.

• getClientSessionGyro

  public IClientSessionGyro getClientSessionGyro()

  Gets the client session gyro that created the action process.

  Returns:

  The client session gyro instance, or null if it is disposed of.

• addTransactionContainer

  public boolean addTransactionContainer​(PropCnr transactionContainer)

  Creates a Gyro transaction for a property container. This is used in case a rollback is required.

  Normally the property containers are VirtualSpaces and NOT panels as they are normally rolled back due to the fact that they are tied to a VirtualSpace and will automatically reflect changes from it. So when the VirtualSpace is rolled back, the panels will be.

  But there might be times e.g. a panel or other non-VirtualSpace property container can use this feature depending on a specialized action actor. But be aware that this is a highly advanced feature.

  Parameters:

  transactionContainer - The property container to be used in automatic Gyro rollback of it in case of commit failure.

  Returns:

  true if the container was added successfully, false if it was already added before.

  Throws:

  java.lang.IllegalArgumentException - If the container is not virtualized, read-only or disposed of.

  java.lang.IllegalStateException - If the Gyro transactions already have started.

• addTransactionContainer

  public boolean addTransactionContainer​(PropCnr transactionContainer,
                                         IFocusEngine focusEngine)

  Creates a Gyro transaction for a property container. This is used in case a rollback is required.

  Normally the property containers are VirtualSpaces and NOT panels as they are normally rolled back due to the fact that they are tied to a VirtualSpace and will automatically reflect changes from it. So when the VirtualSpace is rolled back, the panels will be.

  But there might be times e.g. a panel or other non-VirtualSpace property container can use this feature depending on a specialized action actor. But be aware that this is a highly advanced feature.

  Parameters:

  transactionContainer - The property container to be used in automatic Gyro rollback of it in case of commit failure.

  focusEngine - Focus engine to use in conjunction with the Gyro transaction, or null for none. The VirtualSpace Focus Engine is already part of the standard transaction, so it cannot be specified.

  Returns:

  true if the container was added successfully, false if it was already added before.

  Throws:

  java.lang.IllegalArgumentException - If the container is not virtualized, read-only or disposed of. This exception is also thrown if the focus engine is not part of the same Application Session Gyro.

  java.lang.IllegalStateException - If the Gyro transactions already have started.

• getTXProces

  public ITXProcess getTXProces()

  Gets the TXProcess instance.

• getAppGyro

  public IAppSessionGyro getAppGyro()

  Gets the Application session Gyro engine.

• getAction

  public VSAction getAction()

  Gets the action associated with the process.

• getTrigger

  public GProp<?> getTrigger()

  Gets the trigger property.

  Returns:

  The trigger, or null for none.

• getWorker

  public Worker getWorker()

  Gets the worker executing this task.

  Returns:

  The worker instance, Application or Client Worker, null for separate thread (or execute direct in caller thread).