IActionInstance

getTransactionInstance (): ITransactioninstance

Returns the transaction instance to which the action belongs.

getTransactionName (): String

Returns name of the transaction.

getUser (): User

Returns user running the transaction.

getLocalServiceConnection (): LocalServiceConnection

Provides a service connection.

createRemoteServiceConnection(String, boolean): RemoteServiceConnection

Creates a remote connection to the server.

createRemoteServiceConnection(String, boolean): RemoteServiceConnection

Creates a remote connection to the server.

getAccompanimentData (String): IAccompanimentData

Gets the accompaniment data for this action.

setAccompanimentData (IAccompanimentData, boolean): boolean

Sets the accompaniment data for this action.

containsAccompanimentData (String): boolean

Checks whether accompaniment data exists with the attribute name passed.

setActionResults (String, $value$): boolean

Set the value for an action variable.

getActionVariable(String): VariantData

Set the value of an action variable.

containsActionVariable(String): boolean

Checks whether the action variable exists for this action.

getActionVariableMap(): Map<String, VariantData>

Sends map of name value pairs of action variables.

getFullyQualifiedVariable (String): VariantData

Gets value of variable which is provided along with ist XPath.

IAccompanimentData

dispose (): void

Disconnect the server connection.

getUniqueId (): String

Returns the unique guid.

<Named>.getName (): String

<Named>.cloneNamed (): Named

IReferenceDocumentGenerator

generate

Called when the user calls the Generate Sample operation. The return from this method indicates if the operation was successful (true) or not (false).

clear

Called when the user calls the Clear Sample operation

showGenerationDialog

Typically called after the configuration dialog is closed. This allows for better interaction than requiring the user to close the dialog and select Generate Sample.

IActionConfiguration

getStaticInputs (): List <String>

List of input names that are declared statically.

getStaticInput(String): VariantData

Returns value of a static input.

setStaticInput (String, VariantData): void

Sets value for a static input.

getActionType(): String

Returns the type of action. For eg., Tracer, webservice and so on.

getHelpFile(): String

Returns the helpfile location.

getServiceConnection(): ServiceConnection

Returns the service connection used in http calls.

getDynamicInputNames(): List<String>

List of input names that are declared dynamically.

getDynamicOutputNames(): List<String>

List of output names that are declared dynamically.

getDynamicValue (String): VariantData

Returns value for the dynamic variable.

setDynamicValue (String, VariantData, Boolean): void

Sets the value for dynamic variable.

removeDynamicValue (String name): void

Removes the dynamic variable from the action.

flushDynamicValues(): void

Clears all dynamic values.

getAccompanimentDataNames(String): List<String>

Gets the list of all the accompaniment data aliases by the GUID.

lookupConfiguration (String): IActionConfiguration

Gets the action‘s configuration by action name.

getVariables(): ActionObjects

Gets the variables viewable by this action.

IConfigurationDialog

Initialize (ActionConfiguration, CommonLocalizer): void

Initializes the dialog.

showDialog (Window): ActionDialogResult

Shows the configuration dialog.

loadlinks (ActionConfiguration, CommonLocalizer)

Loads the initial links.

IAdminInstance

getConnection(String name,RemoteConnectionType type): Map<String, String>

Returns the connection properties for this connection.

getCredential(String aliasName): NamedVariantData

The name and password are returned as part of NamedVariantData by passing an alias.

getLocalizedString(String language, String project, String key): String

Returns the localized string based on parameters passed.

The system searches for the key in the language specific bundle and generic bundle. If the key is not found in the language specific bundle and generic bundle, then the key selects the translation defined in the Localization screen.