AttributesSQL (java-api 21.0.10 API)

java.lang.Object
- com.uc4.api.objects.AttributesSQL

All Implemented Interfaces:: IHostAttributes

public class AttributesSQL
extends java.lang.Object
implements IHostAttributes

Host attributes for SQL Jobs.

Constructor Summary

Constructors
Constructor and Description

AttributesSQL()

Constructors
Constructor and Description
`AttributesSQL()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`int`	`fieldCount()` Returns the number of fields in the host attributes.
`java.lang.String`	`getAccessFileName()` Returns the file name of the Microsoft Access database.
`java.lang.Character`	`getColumnSeparator()` Returns the character which is used to separate column values in the Job report.
`UC4ObjectName`	`getConnection()` Returns the name of the connection object.
`java.lang.String`	`getDatabaseName()` Returns the name of the database on the specified database server.
`java.lang.String`	`getDatabaseServer()` Returns the name and port of the database server.
`int`	`getMaxCharacters()` Returns the max.
`int`	`getMaxRows()` Returns the max.
`java.lang.Character`	`getSeparatorSubstitute()` Returns the substitute character that will be used to replace characters in the field value which are the same as the separator character.
`boolean`	`isAgentLog()`
`boolean`	`isRemoveCRLF()` Returns `true` if Carriage Return and Line Feed characters should be removed in the result set in the Job report.
`boolean`	`isReportDatabase()` Returns whether the Job report transfered to the database.
`boolean`	`isReportErrorOnly()` Returns `true` if the Job report will be stored only in case of Job interruption.
`boolean`	`isReportFile()` Returns `true` if the Job report is stored in the file system on the target system.
`boolean`	`isShowHeadLines()` Returns `true` if the column names of result sets should be displayed in the Automation Engine Job report.
`boolean`	`isShowNULLasEmptyString()` Returns `true` if `NULL` in result sets should be displays as an empty string in the UC4 Job Report.
`void`	`load(com.uc4.util.XMLDocument doc, org.w3c.dom.Element hostAttr)` Loads the host attributes.
`java.lang.String`	`name()` Returns the host attributes name.
`void`	`setAccessFileName(java.lang.String accessFileName)` Sets the file name of the Microsoft Access database.
`void`	`setAgentLog(boolean agentLog)` Sets the Agent Process Log for this SAP Job.
`void`	`setColumnSeparator(java.lang.Character columnSeparator)` Sets the character which is used to separate column values in the Job report.
`void`	`setConnection(UC4ObjectName connection)` Sets the connection object.
`void`	`setDatabaseName(java.lang.String databaseName)` Sets the name of the database.
`void`	`setDatabaseServer(java.lang.String databaseServer)` Sets the name of the database server.
`void`	`setMaxCharacters(int maxCharacters)` Sets the max.
`void`	`setMaxRows(int maxLines)` Sets the max.
`void`	`setRemoveCRLF(boolean removeCRLF)` Enables or disables the display of Carriage Return and Line Feed characters in result sets in the Job report.
`void`	`setReportDatabase(boolean reportDatabase)` Sets whether the Job report should be transfered to the database.
`void`	`setReportErrorOnly(boolean reportErrorOnly)` Sets whether the Job report should be stored only in case of Job interruption.
`void`	`setReportFile(boolean reportFile)` Sets whether the Job report should be stored in the file system on the target system.
`void`	`setSeparatorSubstitute(java.lang.Character separatorSubstitute)` Sets the substitute character that will be used to replace characters in the field value which are the same as the separator character.
`void`	`setShowHeadLines(boolean showHeadLines)` Enables or disables the display of column namens of result sets in the Automation Engine Job Report.
`void`	`setShowNULLasEmptyString(boolean showNULLasEmptyString)` Enables or disables the display of `NULL`-values in result sets in the Automation Engine Job report.
`void`	`store(com.uc4.util.XMLDocument doc, org.w3c.dom.Element objectElement)` Writes the host attributes back to the `XMLDocument`.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - AttributesSQL
```
public AttributesSQL()
```
- Method Detail
  - fieldCount
```
public int fieldCount()
```
    Description copied from interface: IHostAttributes
    
    Returns the number of fields in the host attributes.
    
    Specified by:
    
    fieldCount in interface IHostAttributes
    
    Returns:
    
    number of fields
  - load
```
public void load(com.uc4.util.XMLDocument doc,
                 org.w3c.dom.Element hostAttr)
```
    Description copied from interface: IHostAttributes
    
    Loads the host attributes.
    
    Specified by:
    
    load in interface IHostAttributes
    
    Parameters:
    
    doc - XML Document containing the Job
    
    hostAttr - Element which contains host attributes
  - getDatabaseServer
```
public java.lang.String getDatabaseServer()
```
    Returns the name and port of the database server.
    
    Returns:
    
    String containing the database server name.
  - setDatabaseServer
```
public void setDatabaseServer(java.lang.String databaseServer)
```
    Sets the name of the database server. Server and port are seperated by a colon. For example uc4srv01:50000. The length of the parameter must not exceed 100 characters. Provide an empty string if a Microsoft Access database will be used.
    
    Parameters:
    
    databaseServer - String containing the name and port of the database server
  - getDatabaseName
```
public java.lang.String getDatabaseName()
```
    Returns the name of the database on the specified database server.
    
    Returns:
    
    String containing the name of the database.
  - setDatabaseName
```
public void setDatabaseName(java.lang.String databaseName)
```
    Sets the name of the database. The length of the parameter must not exceed 100 characters. Provide an empty string if a Microsoft Access database will be used.
    
    Parameters:
    
    databaseName - String containing the name of the database
  - getAccessFileName
```
public java.lang.String getAccessFileName()
```
    Returns the file name of the Microsoft Access database.
    
    Returns:
    
    String containing the file name of the Microsoft Access database
  - setAccessFileName
```
public void setAccessFileName(java.lang.String accessFileName)
```
    Sets the file name of the Microsoft Access database.
    
    Parameters:
    
    accessFileName - Full path to the MDB
  - isShowHeadLines
```
public boolean isShowHeadLines()
```
    Returns true if the column names of result sets should be displayed in the Automation Engine Job report.
    
    Returns:
    
    True if column names will be displayed in the Job Report
  - setShowHeadLines
```
public void setShowHeadLines(boolean showHeadLines)
```
    Enables or disables the display of column namens of result sets in the Automation Engine Job Report.
    
    Parameters:
    
    showHeadLines - True if column names will be displayed in the Job Report, false otherwise
  - isShowNULLasEmptyString
```
public boolean isShowNULLasEmptyString()
```
    Returns true if NULL in result sets should be displays as an empty string in the UC4 Job Report.
    
    Returns:
    
    True if NULL is displayed as an empty string, false otherwise
  - setShowNULLasEmptyString
```
public void setShowNULLasEmptyString(boolean showNULLasEmptyString)
```
    Enables or disables the display of NULL-values in result sets in the Automation Engine Job report.
    
    Parameters:
    
    showNULLasEmptyString - True if NULL should not be shown in the Job report, false otherwise
  - getMaxRows
```
public int getMaxRows()
```
    Returns the max. number of rows in a result set.
    
    Returns:
    
    max. Number of rows
  - setMaxRows
```
public void setMaxRows(int maxLines)
```
    Sets the max. number of rows in a result set in the Automation Engine Job report.
    if a result set has more than maxLines rows only the first maxLines rows are shown in the Job report. To disable the row-limit set the parameter maxLines to 0. Valid number range: 0-9999
    
    Parameters:
    
    maxLines - Max number of rows
  - getMaxCharacters
```
public int getMaxCharacters()
```
    Returns the max. number of characters per column.
    
    Returns:
    
    Max. Number of characters.
  - setMaxCharacters
```
public void setMaxCharacters(int maxCharacters)
```
    Sets the max. number of characeters for a text column in a result set.
    If a column in a result set has more than maxCharacters characters only the first maxCharacters are shown in the Job report. * Valid number range: 0-9999
    
    Parameters:
    
    maxCharacters - max. Number of characters per column
  - isRemoveCRLF
```
public boolean isRemoveCRLF()
```
    Returns true if Carriage Return and Line Feed characters should be removed in the result set in the Job report.
    
    Returns:
    
    true if CR and LR characters are removed in the Job report
  - setRemoveCRLF
```
public void setRemoveCRLF(boolean removeCRLF)
```
    Enables or disables the display of Carriage Return and Line Feed characters in result sets in the Job report.
    
    Parameters:
    
    removeCRLF - true if CR and LR characters should removed from result sets
  - getSeparatorSubstitute
```
public java.lang.Character getSeparatorSubstitute()
```
    Returns the substitute character that will be used to replace characters in the field value which are the same as the separator character.
    
    Returns:
    
    Separator substitute character
  - setSeparatorSubstitute
```
public void setSeparatorSubstitute(java.lang.Character separatorSubstitute)
```
    Sets the substitute character that will be used to replace characters in the field value which are the same as the separator character.
    
    Parameters:
    
    separatorSubstitute - substitute character
  - getColumnSeparator
```
public java.lang.Character getColumnSeparator()
```
    Returns the character which is used to separate column values in the Job report.
    
    Returns:
    
    Separator character
  - setColumnSeparator
```
public void setColumnSeparator(java.lang.Character columnSeparator)
```
    Sets the character which is used to separate column values in the Job report.
    
    Parameters:
    
    columnSeparator - Separator character
  - name
```
public java.lang.String name()
```
    Description copied from interface: IHostAttributes
    
    Returns the host attributes name.
    
    Specified by:
    
    name in interface IHostAttributes
    
    Returns:
    
    name
  - store
```
public void store(com.uc4.util.XMLDocument doc,
                  org.w3c.dom.Element objectElement)
```
    Description copied from interface: IHostAttributes
    
    Writes the host attributes back to the XMLDocument.
    
    Specified by:
    
    store in interface IHostAttributes
    
    Parameters:
    
    doc - Document
    
    objectElement - ObjectElement
  - isAgentLog
```
public boolean isAgentLog()
```
    Returns:
    
    True if the Agent Process Log should be transfered
  - setAgentLog
```
public void setAgentLog(boolean agentLog)
```
    Sets the Agent Process Log for this SAP Job.
    
    Parameters:
    
    agentLog - true if the Log should be transfered
  - isReportDatabase
```
public boolean isReportDatabase()
```
    Returns whether the Job report transfered to the database.
    
    Returns:
    
    true if the Job report is transfered to the database false otherwise
  - setReportDatabase
```
public void setReportDatabase(boolean reportDatabase)
```
    Sets whether the Job report should be transfered to the database.
    
    Parameters:
    
    reportDatabase - true if the job report should be transfered to the database false otherwise
  - isReportErrorOnly
```
public boolean isReportErrorOnly()
```
    Returns true if the Job report will be stored only in case of Job interruption. This function is only available when "Database" and/or "File" have been selected.
    
    Returns:
    
    true if the job report is stored only in case of Job interruption
  - setReportErrorOnly
```
public void setReportErrorOnly(boolean reportErrorOnly)
```
    Sets whether the Job report should be stored only in case of Job interruption. This function is only available when "Database" and/or "File" have been selected.
    
    Parameters:
    
    reportErrorOnly - true if the job report should be stored only in case of Job interruption
  - isReportFile
```
public boolean isReportFile()
```
    Returns true if the Job report is stored in the file system on the target system.
    
    Returns:
    
    true if the job report is stored in the file system.
  - setReportFile
```
public void setReportFile(boolean reportFile)
```
    Sets whether the Job report should be stored in the file system on the target system.
    
    Parameters:
    
    reportFile - true if the job report should be stored in the file system
  - getConnection
```
public UC4ObjectName getConnection()
```
    Returns the name of the connection object.
    
    Returns:
    
    Name of the connection object
  - setConnection
```
public void setConnection(UC4ObjectName connection)
```
    Sets the connection object.
    
    Parameters:
    
    connection - Name of the connection object

Class AttributesSQL

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

AttributesSQL

Method Detail

fieldCount

load

getDatabaseServer

setDatabaseServer

getDatabaseName

setDatabaseName

getAccessFileName

setAccessFileName

isShowHeadLines

setShowHeadLines

isShowNULLasEmptyString

setShowNULLasEmptyString

getMaxRows

setMaxRows

getMaxCharacters

setMaxCharacters

isRemoveCRLF

setRemoveCRLF

getSeparatorSubstitute

setSeparatorSubstitute

getColumnSeparator

setColumnSeparator

name

store

isAgentLog

setAgentLog

isReportDatabase

setReportDatabase

isReportErrorOnly

setReportErrorOnly

isReportFile

setReportFile

getConnection

setConnection