Package com.uc4.api.objects

Class AttributesSiebel

java.lang.Object

com.uc4.api.objects.AttributesSiebel

All Implemented Interfaces:

IHostAttributes

public class AttributesSiebel
extends java.lang.Object
implements IHostAttributes

Host attributes for Siebel Jobs.

Constructor Summary

Constructors

Constructor	Description
AttributesSiebel()

Method Summary

Modifier and Type	Method	Description
int	fieldCount()	Returns the number of fields in the host attributes.
java.lang.String	getEnterpriseServer()	Returns the name of the Enterprise Server.
java.lang.String	getGatewayServer()	Returns the network address of the Siebel Gateway computer.
java.lang.String	getLanguage()	Returns the login language.
java.lang.String	getSiebelServer()	Returns the name of the Siebel Server.
boolean	isCompression()	Returns true if compression is enabled.
boolean	isEncryption()	Returns true if encryption is enabled.
boolean	isReportDatabase()	Returns whether the Job report transfered to the Automation Engine 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.
void	load(com.uc4.util.XMLDocument doc, org.w3c.dom.Element hostAttr, ConnectionAttributes info)	Loads the host attributes.
java.lang.String	name()	Returns the host attributes name.
void	setCompression(boolean compression)	Sets if the compression should be enabled or not.
void	setEncryption(boolean encryption)	Sets if the encryption should be enabled or not.
void	setEnterpriseServer(java.lang.String enterpriseServer)	Sets the name of the Enterprise Server.
void	setGatewayServer(java.lang.String gatewayServer)	Sets the Network address of the Siebel Gateway computer.
void	setLanguage(java.lang.String language)	Sets the siebel login language.
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	setSiebelServer(java.lang.String siebelServer)	Sets the name of the Siebel Server.
void	store(com.uc4.util.XMLDocument doc, org.w3c.dom.Element objectElement, ConnectionAttributes info)	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

AttributesSiebel

public AttributesSiebel()

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,
                 ConnectionAttributes info)

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

info - Session details

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,
                  ConnectionAttributes info)

Description copied from interface: IHostAttributes

Writes the host attributes back to the XMLDocument.

Specified by:

store in interface IHostAttributes

Parameters:

doc - Document

objectElement - ObjectElement

info - Session details

isEncryption

public boolean isEncryption()

Returns true if encryption is enabled.

Returns:

Encryption

setEncryption

public void setEncryption(boolean encryption)

Sets if the encryption should be enabled or not.

Parameters:

encryption - Encryption

isCompression

public boolean isCompression()

Returns true if compression is enabled.

Returns:

Compression

setCompression

public void setCompression(boolean compression)

Sets if the compression should be enabled or not.

Parameters:

compression - Compression

getLanguage

public java.lang.String getLanguage()

Returns the login language.

Returns:

Language

setLanguage

public void setLanguage(java.lang.String language)

Sets the siebel login language. The default value is ENU. A maximum of 3 characters is allowed for language

Parameters:

language - Language

getSiebelServer

public java.lang.String getSiebelServer()

Returns the name of the Siebel Server.

Returns:

Siebel Server

setSiebelServer

public void setSiebelServer(java.lang.String siebelServer)

Sets the name of the Siebel Server.

Parameters:

siebelServer - Siebel Server

getEnterpriseServer

public java.lang.String getEnterpriseServer()

Returns the name of the Enterprise Server.

Returns:

Enterprise Server

setEnterpriseServer

public void setEnterpriseServer(java.lang.String enterpriseServer)

Sets the name of the Enterprise Server.

Parameters:

enterpriseServer - Enterprise Server

getGatewayServer

public java.lang.String getGatewayServer()

Returns the network address of the Siebel Gateway computer.

Returns:

Gateway Server

setGatewayServer

public void setGatewayServer(java.lang.String gatewayServer)

Sets the Network address of the Siebel Gateway computer. A maximum of 128 characters is allowed for gatewayServer.

Parameters:

gatewayServer - Gateway Server

isReportDatabase

public boolean isReportDatabase()

Returns whether the Job report transfered to the Automation Engine 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