com.ebasetech.xi.api
Interface CustomResource

All Superinterfaces:

Element, Resource, java.io.Serializable

public interface CustomResource
extends Resource

The CustomResource interface represents a Custom Resource.

Further documentation.

Since:

V4.4

Field Summary

static java.lang.String	COMMAND_CALL
static java.lang.String	COMMAND_DELETE
static java.lang.String	COMMAND_EXEC
static java.lang.String	COMMAND_FETCH
static java.lang.String	COMMAND_INSERT
static java.lang.String	COMMAND_PRINT
static java.lang.String	COMMAND_READ
static java.lang.String	COMMAND_UPDATE
static java.lang.String	COMMAND_WRITE

Method Summary

java.lang.String	execute(java.lang.String command) Invokes the execute(String) method on the Custom Resource passing command as argument.
java.lang.String	execute(java.lang.String command, java.lang.String binding) Invokes the execute(String) method on the Custom Resource passing command as argument.

Methods inherited from interface com.ebasetech.xi.api.Resource

isDebug, setDebug

Methods inherited from interface com.ebasetech.xi.api.Element

getElementName, getElementType

Field Detail

COMMAND_FETCH

static final java.lang.String COMMAND_FETCH

See Also:

Constant Field Values

COMMAND_DELETE

static final java.lang.String COMMAND_DELETE

See Also:

Constant Field Values

COMMAND_UPDATE

static final java.lang.String COMMAND_UPDATE

See Also:

Constant Field Values

COMMAND_INSERT

static final java.lang.String COMMAND_INSERT

See Also:

Constant Field Values

COMMAND_READ

static final java.lang.String COMMAND_READ

See Also:

Constant Field Values

COMMAND_WRITE

static final java.lang.String COMMAND_WRITE

See Also:

Constant Field Values

COMMAND_PRINT

static final java.lang.String COMMAND_PRINT

See Also:

Constant Field Values

COMMAND_EXEC

static final java.lang.String COMMAND_EXEC

See Also:

Constant Field Values

COMMAND_CALL

static final java.lang.String COMMAND_CALL

See Also:

Constant Field Values

Method Detail

execute

java.lang.String execute(java.lang.String command)
                         throws com.ebasetech.xi.exceptions.FormRuntimeException

Invokes the execute(String) method on the Custom Resource passing command as argument.

Further documentation.

Javascript example:

 var status = resources.CUSTOM_RESOURCE1.execute(CustomResource.COMMAND_READ);
 

Parameters:

command -

Returns:

status

Throws:

com.ebasetech.xi.exceptions.FormRuntimeException - if any error occurs during execution

Since:

V4.4

execute

java.lang.String execute(java.lang.String command,
                         java.lang.String binding)
                         throws com.ebasetech.xi.exceptions.FormRuntimeException

Invokes the execute(String) method on the Custom Resource passing command as argument. The binding can be obtained by the Custom Resource by issuing getBinding().

Further documentation.

Javascript example:

 var status = resources.CUSTOM_RESOURCE1.execute(CustomResource.COMMAND_READ, "Test");
 

Parameters:

command -

binding -

Returns:

status

Throws:

com.ebasetech.xi.exceptions.FormRuntimeException - if any error occurs during execution

Since:

V4.4