public class AttributesSAP extends java.lang.Object implements IHostAttributes
Constructor and Description |
---|
AttributesSAP() |
Modifier and Type | Method and Description |
---|---|
int |
fieldCount()
Returns the number of fields in the host attributes.
|
char |
getDeliver()
Returns the report send status:
|
char |
getJobClass()
Returns the selected Job class.
|
java.lang.String |
getJobName()
Returns the Job name.
|
java.lang.String |
getLanguage()
Returns the selected language.
|
char |
getSapAddressType()
Returns the type of address.
|
java.lang.String |
getSapRecipent()
Returns the receiver of a spool list.
|
char |
getStatusByMail()
Returns the report status by mail:
|
java.lang.String |
getTargetSystem()
Returns the target system in SAP.
|
boolean |
isAgentLog() |
boolean |
isApplicationLog() |
boolean |
isAsSoonAsPossible()
Returns
true if the SAP system should attempt to start the Job as soon as possible. |
boolean |
isBlindCopy()
Returns
true if the recipient gets a blind copy which cannot be read by anyone else. |
boolean |
isCopy()
Returns
true if the recipient should get a copy for information. |
boolean |
isDeleteJob()
Returns
true if the Job in SAP should be deleted after execution. |
boolean |
isExpress()
Returns
true if express sending is selected. |
boolean |
isImmediately()
Returns
true if the SAP system should attempt to start the Job immediately. |
boolean |
isJavaStatistics() |
boolean |
isNoDeleteOnError()
Returns
true if the Job should not be delete in SAP when an error occurs. |
boolean |
isNoForwarding()
Returns
true if the recipient is not allowed to forward the document to other users. |
boolean |
isNoPrint()
Returns
true if the attribute 'No Printing' is set. |
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. |
boolean |
isSpoolDirectory() |
boolean |
isStatistics() |
boolean |
isStepList() |
boolean |
isUseLoginObject()
Returns true if login object is used instead of login information in connection object.
|
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 |
setAgentLog(boolean agentLog)
Sets the Agent Process Log for this SAP Job.
|
void |
setApplicationLog(boolean applicationLog)
Sets the Agent Process Log for this SAP Job.
|
void |
setAsSoonAsPossible()
The system attempts to start the Job as soon as possible.
|
void |
setBlindCopy(boolean blindCopy)
Sets if the recipient gets a blind copy which cannot be read by anyone else.
|
void |
setCopy(boolean copy)
Sets if the recipient should get a copy for information.
|
void |
setDeleteJob(boolean deleteJob)
Sets if the Job in SAP should be deleted after execution.
|
void |
setDeliver(char deliver)
Sets the report send status:
|
void |
setExpress(boolean express)
Sets express sending.
|
void |
setImmediately()
The system attempts to start the Job immediately.
|
void |
setJavaStatistics(boolean javaStatistics)
Sets the Java Statistics Report for this SAP Job.
|
void |
setJobClass(char jobClass)
Specifies with which priority the Job in SAP should be handled.
|
void |
setJobName(java.lang.String jobName)
Sets the name for the Job in SAP.
|
void |
setLanguage(java.lang.String language)
Sets the language.
|
void |
setNoDeleteOnError(boolean noDeleteOnError)
If set the Job is not deleted in SAP when an error occurs.
|
void |
setNoForwarding(boolean noForwarding)
If set the recipient is not allowed to forward the document to other users.
|
void |
setNoPrint(boolean noPrinting)
Enables or disables the send attribute 'No Printing'.
|
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 |
setSapAddressType(char sapAddressType)
Sets the type of address.
|
void |
setSapRecipent(java.lang.String sapRecipent)
Sets the receiver of a spool list.
|
void |
setSpoolDirectory(boolean spoolDirectory)
Sets the Spool Directory Log for this SAP Job.
|
void |
setStatistics(boolean statistics)
Enables or disables an additional report for the statistics of the SAP Job.
|
void |
setStatusByMail(char statusByMail)
Sets the report status by mail:
|
void |
setStepList(boolean stepList)
Enables or disables an additional report for the step list of the SAP Job.
|
void |
setTargetSystem(java.lang.String targetSystem)
Sets the target system in SAP.
|
void |
setUseLoginObject(boolean useLoginObject)
Set whether the Job will use the login object instead of login information in connection object.
|
void |
store(com.uc4.util.XMLDocument doc,
org.w3c.dom.Element objectElement)
Writes the host attributes back to the
XMLDocument . |
public int fieldCount()
IHostAttributes
fieldCount
in interface IHostAttributes
public void load(com.uc4.util.XMLDocument doc, org.w3c.dom.Element hostAttr)
IHostAttributes
load
in interface IHostAttributes
doc
- XML Document containing the JobhostAttr
- Element which contains host attributespublic java.lang.String name()
IHostAttributes
name
in interface IHostAttributes
public void store(com.uc4.util.XMLDocument doc, org.w3c.dom.Element objectElement)
IHostAttributes
XMLDocument
.store
in interface IHostAttributes
doc
- DocumentobjectElement
- ObjectElementpublic boolean isAgentLog()
public void setAgentLog(boolean agentLog)
agentLog
- true if the Log should be transferedpublic boolean isApplicationLog()
public void setApplicationLog(boolean applicationLog)
applicationLog
- True if the SAP Application Log should be transfered as an additional reportpublic boolean isJavaStatistics()
public void setJavaStatistics(boolean javaStatistics)
javaStatistics
- True if the Java statistics should be transfered as an additional reportpublic boolean isSpoolDirectory()
public void setSpoolDirectory(boolean spoolDirectory)
spoolDirectory
- True if the Spool Directory Log should be transfered as an additional reportpublic boolean isStepList()
public void setStepList(boolean stepList)
stepList
- True if the step list should be added as a report to this Job.public boolean isStatistics()
public void setStatistics(boolean statistics)
statistics
- True if the statistics should be added as a report to this Job.public boolean isNoForwarding()
true
if the recipient is not allowed to forward the document to other users.public void setNoForwarding(boolean noForwarding)
noForwarding
- No forwardingpublic boolean isNoPrint()
true
if the attribute 'No Printing' is set.public void setNoPrint(boolean noPrinting)
noPrinting
- No printingpublic char getDeliver()
' ' ... Use default 'A' ... Always 'E' ... Error case 'N' ... Never
public void setDeliver(char deliver)
' ' ... Use default 'A' ... Always 'E' ... Error case 'N' ... Never
deliver
- Deliver statepublic char getStatusByMail()
' ' ... Use default 'A' ... Always 'E' ... Error case 'N' ... Never
public void setStatusByMail(char statusByMail)
' ' ... Use default 'A' ... Always 'E' ... Error case 'N' ... Never
statusByMail
- report status by mailpublic boolean isBlindCopy()
true
if the recipient gets a blind copy which cannot be read by anyone else.public void setBlindCopy(boolean blindCopy)
blindCopy
- Blind Copypublic boolean isCopy()
true
if the recipient should get a copy for information.public void setCopy(boolean copy)
copy
- Copypublic boolean isExpress()
true
if express sending is selected.public void setExpress(boolean express)
express
- Expresspublic char getSapAddressType()
' ' ... Name 'P' ... Private distribution list 'C' ... Shared distribution list 'O' ... SAPoffice user 'B' ... SAP user 'U' ... Internet address 'X' ... X.400 address 'R' ... SAP user in another SAP System 'A' ... External address 'F' ... Fax number 'D' ... X.500 Address 'L' ... Telex number 'H' ... Organizational unit/position 'J' ... SAP object 'G' ... Organization object/ID 'K' ... Pager/SMS '9' ... Others
public void setSapAddressType(char sapAddressType)
' ' ... Name 'P' ... Private distribution list 'C' ... Shared distribution list 'O' ... SAPoffice user 'B' ... SAP user 'U' ... Internet address 'X' ... X.400 address 'R' ... SAP user in another SAP System 'A' ... External address 'F' ... Fax number 'D' ... X.500 Address 'L' ... Telex number 'H' ... Organizational unit/position 'J' ... SAP object 'G' ... Organization object/ID 'K' ... Pager/SMS '9' ... Others
sapAddressType
- Type of addresspublic java.lang.String getSapRecipent()
public void setSapRecipent(java.lang.String sapRecipent)
sapRecipent
sapRecipent
- Receiverpublic boolean isImmediately()
true
if the SAP system should attempt to start the Job immediately.public void setImmediately()
public boolean isAsSoonAsPossible()
true
if the SAP system should attempt to start the Job as soon as possible.public void setAsSoonAsPossible()
public boolean isNoDeleteOnError()
true
if the Job should not be delete in SAP when an error occurs.public void setNoDeleteOnError(boolean noDeleteOnError)
noDeleteOnError
- Delete Job not on errorpublic boolean isDeleteJob()
true
if the Job in SAP should be deleted after execution.public void setDeleteJob(boolean deleteJob)
deleteJob
- Delete job after completion in CCMSpublic java.lang.String getTargetSystem()
public void setTargetSystem(java.lang.String targetSystem)
targetSystem
.targetSystem
- Target systempublic char getJobClass()
public void setJobClass(char jobClass)
jobClass
- Job classpublic java.lang.String getJobName()
public void setJobName(java.lang.String jobName)
jobName
- Job namepublic java.lang.String getLanguage()
public void setLanguage(java.lang.String language)
language
must be a valid two-letter code as defined by ISO-639.language
- Languagepublic boolean isReportDatabase()
true
if the Job report is transfered to the database false
otherwisepublic void setReportDatabase(boolean reportDatabase)
reportDatabase
- true
if the job report should be transfered
to the database false
otherwisepublic boolean isReportErrorOnly()
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.true
if the job report is stored only in case of Job interruptionpublic void setReportErrorOnly(boolean reportErrorOnly)
reportErrorOnly
- true
if the job report should be stored
only in case of Job interruptionpublic boolean isReportFile()
true
if the Job report is stored in the file system
on the target system.true
if the job report is stored in the file system.public void setReportFile(boolean reportFile)
reportFile
- true
if the job report should be stored in the file systempublic boolean isUseLoginObject()
true
if login object is usedpublic void setUseLoginObject(boolean useLoginObject)
useLoginObject
- the useLoginObject to set