Package de.elo.ix.client.plugin

Interface ScriptObjectFactory

All Superinterfaces:
AutoCloseable
public interface ScriptObjectFactory extends AutoCloseable

  • Method Details

    • throwException

      void throwException(String s) throws byps.RemoteException
      Throws an exception with given message. Throws an exception with code IXExceptionC.SCRIPT_ERROR.
      Parameters:
      s -
      Throws:
      byps.RemoteException

    • throwException

      void throwException(int code, String s) throws byps.RemoteException
      Throws an exception with the given code and message.
      Parameters:
      code - Exception code, one of the constants in IXExceptionC.
      s - Message
      Throws:
      byps.RemoteException

    • throwException

      void throwException(int code, String s, Throwable e) throws byps.RemoteException
      Throws an exception with the given code, message and cause.
      Parameters:
      code - Exception code, one of the constants in IXExceptionC.
      s - Message
      e - Cause
      Throws:
      byps.RemoteException

    • getIxConnect

      IXConnection getIxConnect()
      Get connection object for user attached to the given execution context. This function internally calls getIxConnect().
      Returns:
      IXConnection object.
      Throws:
      UncheckedRemoteException

    • getIxConnectAdmin

      IXConnection getIxConnectAdmin()
      Get connection object with administrator permissions. This function internally calls getIxConnectAdmin().
      Returns:
      IXConnection object.
      Throws:
      UncheckedRemoteException

    • getAccess

      Access getAccess()
      Get interface that provides functions for access checking.
      Returns:
      Utility interface.

    • getConvert

      Convert getConvert()
      Get interface that provides conversion functions for numeric and date values.
      Returns:
      Utility interface.

    • getSordUtil

      SordUtil getSordUtil()
      Get interface that provides helper functions to access Sord objects.
      Returns:
      Utility interface.

    • getInheritKeywording

      InheritKeywording getInheritKeywording()
      Get interface that provides helper functions to inherit keywording.
      Returns:
      Utility interface.

    • getSendMail

      SendMail getSendMail(String mailResource)
      Get interface to send mails.
      Parameters:
      mailResource - Mail resource as defined in Tomcat configuration.
      Returns:
      Utility interface.

    • getDBConnection

      DBConnection getDBConnection()
      Get DB connection for the current archive database. This function internally calls getDBConnection().
      Returns:
      DBConnection object.
      Throws:
      UncheckedRemoteException

    • getDBConnectionForDataSource

      DBConnection getDBConnectionForDataSource(String dataSource)
      Get DB connection for the given data source. The data source has to be declared in Tomcat's context.xml file. More information can be found at DBConnection This function internally calls getDBConnectionForDataSource(String).
      Parameters:
      dataSource - Data source name as defined in Tomcat configuration.
      Returns:
      DBConnection object.
      Throws:
      UncheckedRemoteException

    • getDBConnectionForSchema

      DBConnection getDBConnectionForSchema(String dataSource, String schemaName)

    • getResourceBundle

      ResourceBundle getResourceBundle()
      Get internal text resources of Indexserver.
      Returns:
      ResourceBundle object

    • close

      void close()
      Release resources. EIX-3883: close without Exception to avoid compiler warning "try".
      Specified by:
      close in interface AutoCloseable