com.iizix.ws.actionactor

Class WebServiceActionActor

java.lang.Object

com.iizix.ws.actionactor.WebServiceActionActor

All Implemented Interfaces:

IActionActor<WebServiceActionActor.Settings>

Direct Known Subclasses:

EditorWebServiceActionActor

public class WebServiceActionActor
extends Object
implements IActionActor<WebServiceActionActor.Settings>

The Web Service transaction Action Actor.

Author:

Christopher Mindus

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	WebServiceActionActor.Settings Settings property container.

Constructor Summary

Constructors

Constructor and Description
WebServiceActionActor(VSAction action, WebServiceActionActor.Settings settings) Creates a new instance.

Method Summary

Modifier and Type	Method and Description
boolean	doesModifyVirtualSpace() Checks if the VirtualSpace is modified by the Action Actor.
String	getDefaultDescription() Gets a description of the Action Actor to be used for the Designer or logging.
String	getDescription() Gets a description of the Action Actor to be used for the Designer or logging.
String	getEnabledState(IAppSessionGyro appGyro, VSAction action) Checks if the runnable is enabled for the current VirtualSpace.
VSAction	getVSAction() Gets the VS Action that issued the Web Service transaction.
AbstractActionActorTXPNode<WebServiceActionActor.Settings>	newTXPNode(VSActionTXProcess actionProcess, VSAction action, WebServiceActionActor.Settings settings) Creates a new TXP Node instance to be used for a TXP process.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.iizix.actionactor.IActionActor

delegateNewTXPNode

Constructor Detail

WebServiceActionActor

public WebServiceActionActor(VSAction action,
                             WebServiceActionActor.Settings settings)

Creates a new instance.

Parameters:

action - The action initiator.

settings - The settings to use, null in the Designer instance.

Method Detail

newTXPNode

public AbstractActionActorTXPNode<WebServiceActionActor.Settings> newTXPNode(VSActionTXProcess actionProcess,
                                                                             VSAction action,
                                                                             WebServiceActionActor.Settings settings)
                                                                      throws ClassNotFoundException,
                                                                             ActionActorException

Creates a new TXP Node instance to be used for a TXP process.

Specified by:

newTXPNode in interface IActionActor<WebServiceActionActor.Settings>

Parameters:

actionProcess - The action process.

action - The VirtualSpace Action instance that initiates the actor.

settings - The settings for the action actor implementation.

Returns:

A new TXP node implementation ready to be added to a TXP process.

Throws:

ClassNotFoundException - If the Action Actor class is not found.

ActionActorException - If a new node could not be created.

getDefaultDescription

public String getDefaultDescription()

Gets a description of the Action Actor to be used for the Designer or logging.

Specified by:

getDefaultDescription in interface IActionActor<WebServiceActionActor.Settings>

Returns:

A short description.

getDescription

public String getDescription()

Gets a description of the Action Actor to be used for the Designer or logging.

Specified by:

getDescription in interface IActionActor<WebServiceActionActor.Settings>

Returns:

A short description.

getEnabledState

public String getEnabledState(IAppSessionGyro appGyro,
                              VSAction action)

Checks if the runnable is enabled for the current VirtualSpace. This method is checked to see if the action is enabled and also in the Designer.

Specified by:

getEnabledState in interface IActionActor<WebServiceActionActor.Settings>

Parameters:

appGyro - The application session gyro instance.

action - The action calling the action actor.

Returns:

null If enabled, otherwise an message why it's not enabled.

doesModifyVirtualSpace

public boolean doesModifyVirtualSpace()

Checks if the VirtualSpace is modified by the Action Actor.

Specified by:

doesModifyVirtualSpace in interface IActionActor<WebServiceActionActor.Settings>

Returns:

true if any field in the VS is modified (excludes focus). For Web Service Action actor this is always true.

getVSAction

public VSAction getVSAction()

Gets the VS Action that issued the Web Service transaction.

Returns:

The action that triggered the transaction.