Package com.uc4.api.objects

Class DatabaseEventValue

java.lang.Object
com.uc4.api.objects.DatabaseEventValue
public class DatabaseEventValue extends Object
Represents a value in the database event.

  • Constructor Details

    • DatabaseEventValue

      public DatabaseEventValue(com.uc4.util.XMLDocument doc, Element dbEvent, String elementPrefix)
      Internal use only.
      Parameters:
      doc - XML Document
      dbEvent - DB Event
      elementPrefix - prefix

  • Method Details

    • store

      protected void store(com.uc4.util.XMLDocument doc, Element request)

    • setSourceStatic

      public void setSourceStatic(String value)
      Sets the Source of this DatabaseEventValue to a static value.
      Parameters:
      value - Static value

    • getStaticValue

      public String getStaticValue()
      Returns:
      Static value

    • setSourceVariable

      @Deprecated public void setSourceVariable(UC4ObjectName variableName, UC4ObjectName variableKeyword)
      Deprecated.
      : variableKeyowrd type changed from UC4ObjectName to String.
      Sets the Source of this DatabaseEventValue to the content of a variable.
      Parameters:
      variableName - Name of the Variable Object
      variableKeyword - Name of the Keyword inside the Variable

    • setSourceVariable

      public void setSourceVariable(UC4ObjectName variableName, String variableKeyword)
      Sets the Source of this DatabaseEventValue to the content of a variable.
      Parameters:
      variableName - Name of the Variable Object
      variableKeyword - Name of the Keyword inside the Variable

    • getVariableName

      public UC4ObjectName getVariableName()
      Returns:
      Name of the Variable Object

    • getVariableKeyword

      @Deprecated public UC4ObjectName getVariableKeyword()
      Deprecated.
      : variableKeyowrd type changed from UC4ObjectName to String.
      Returns:
      Keyword in the Variable Object

    • getVarKeyword

      public String getVarKeyword()
      Returns:
      Keyword in the Variable Object

    • setSourceQuery

      public void setSourceQuery(String sqlStatement, UC4HostName agentName, UC4ObjectName loginObject, String server, String database, String accessFile)
      Sets the Source of this DatabaseEventValue to an SQL Query.
      Parameters:
      sqlStatement - SQL Statement (typically a select)
      agentName - Name of the SQL Agent
      loginObject - Name of the Login Object
      server - Hostname or IP Address of the Database Server
      database - Database name
      accessFile - Name of the Micorosoft Access File, an empty String should be passed if not used

    • getSqlStatement

      public String getSqlStatement()
      Returns:
      Content of the SQL Query Statement

    • getAgentName

      public UC4HostName getAgentName()
      Returns:
      Name of the SQL Agent

    • getLoginObject

      public UC4ObjectName getLoginObject()
      Returns:
      Name of the LOGIN Object

    • getServer

      public String getServer()
      Returns:
      Host name of the database server

    • getDatabase

      public String getDatabase()
      Returns:
      Name of the database

    • getAccessFile

      public String getAccessFile()
      Returns:
      File name of the Database if Microsoft Access is used.

    • isSourceQuery

      public boolean isSourceQuery()
      Returns:
      True if this source is set to an SQL Query, false otherwise

    • isSourceStatic

      public boolean isSourceStatic()
      Returns:
      True if this source is set to a static value, false otherwise

    • isSourceVariable

      public boolean isSourceVariable()
      Returns:
      True if this source is set to a variable value, false otherwise