Package 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

    Fields
    Modifier and Type Field Description
    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

    Modifier and Type Method Description
    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.Element

    getElementName, getElementType

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

    isDebug, setDebug

  • Field Details

  • Method Details

    • 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