Package com.uc4.api.objects

Class AttributesSAP

java.lang.Object
com.uc4.api.objects.AttributesSAP
All Implemented Interfaces:
IHostAttributes
public class AttributesSAP extends Object implements IHostAttributes
Host attributes for SAP Jobs.

  • Constructor Summary

    Constructors
    Constructor
    Description
    AttributesSAP()
     

  • Method Summary

    Modifier and Type
    Method
    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.
    String
    getJobName()
    Returns the Job name.
    String
    getLanguage()
    Returns the selected language.
    char
    getSapAddressType()
    Returns the type of address.
    String
    getSapRecipent()
    Returns the receiver of a spool list.
    char
    getStatusByMail()
    Returns the report status by mail:
    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
    isTypeABAP()
    Returns true if the SAP type is of ABAP
    boolean
    isTypeJava()
    Returns true if the SAP type is of Java
    boolean
    isTypePI()
    Returns true if the SAP type is of PI
    boolean
    isUseLoginObject()
    Returns true if login object is used instead of login information in connection object.
    void
    load(com.uc4.util.XMLDocument doc, Element hostAttr, ConnectionAttributes info)
    Loads the host attributes.
    String
    name()
    Returns the host attributes name.
    OCVPanel
    ocvValues()
    This method provides access to the SAP_JAVA Job definition values.
    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(String jobName)
    Sets the name for the Job in SAP.
    void
    setLanguage(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(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(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, 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 Details

    • AttributesSAP

      public AttributesSAP()

  • Method Details

    • 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, 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

    • ocvValues

      public OCVPanel ocvValues()
      This method provides access to the SAP_JAVA Job definition values.
      Returns:
      Values or null if this Job is not an SAP_JAVA Job.

    • name

      public 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, 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

    • 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

    • isApplicationLog

      public boolean isApplicationLog()
      Returns:
      True if the SAP Application Log should be transfered as an additional report

    • setApplicationLog

      public void setApplicationLog(boolean applicationLog)
      Sets the Agent Process Log for this SAP Job.
      Parameters:
      applicationLog - True if the SAP Application Log should be transfered as an additional report

    • isJavaStatistics

      public boolean isJavaStatistics()
      Returns:
      True if the Java Statistics should be transfered as an additional report

    • setJavaStatistics

      public void setJavaStatistics(boolean javaStatistics)
      Sets the Java Statistics Report for this SAP Job.
      Parameters:
      javaStatistics - True if the Java statistics should be transfered as an additional report

    • isSpoolDirectory

      public boolean isSpoolDirectory()
      Returns:
      True if the Spool Directory should be transfered as an additional report

    • setSpoolDirectory

      public void setSpoolDirectory(boolean spoolDirectory)
      Sets the Spool Directory Log for this SAP Job.
      Parameters:
      spoolDirectory - True if the Spool Directory Log should be transfered as an additional report

    • isStepList

      public boolean isStepList()
      Returns:
      True if the Step List should be transfered as an additional report

    • setStepList

      public void setStepList(boolean stepList)
      Enables or disables an additional report for the step list of the SAP Job.
      Parameters:
      stepList - True if the step list should be added as a report to this Job.

    • isStatistics

      public boolean isStatistics()
      Returns:
      True if the statistics of the SAP Job should be added as an addtional report to this Job.

    • setStatistics

      public void setStatistics(boolean statistics)
      Enables or disables an additional report for the statistics of the SAP Job.
      Parameters:
      statistics - True if the statistics should be added as a report to this Job.

    • isNoForwarding

      public boolean isNoForwarding()
      Returns true if the recipient is not allowed to forward the document to other users.
      Returns:
      No forwarding

    • setNoForwarding

      public void setNoForwarding(boolean noForwarding)
      If set the recipient is not allowed to forward the document to other users.
      Parameters:
      noForwarding - No forwarding

    • isNoPrint

      public boolean isNoPrint()
      Returns true if the attribute 'No Printing' is set.
      Returns:
      No printing

    • setNoPrint

      public void setNoPrint(boolean noPrinting)
      Enables or disables the send attribute 'No Printing'.
      Parameters:
      noPrinting - No printing

    • getDeliver

      public char getDeliver()
      Returns the report send status: 
       ' ' ... Use default
 'A' ... Always
 'E' ... Error case
 'N' ... Never
      Returns:
      Report send status

    • setDeliver

      public void setDeliver(char deliver)
      Sets the report send status: 
       ' ' ... Use default
 'A' ... Always
 'E' ... Error case
 'N' ... Never
      Parameters:
      deliver - Deliver state

    • getStatusByMail

      public char getStatusByMail()
      Returns the report status by mail: 
       ' ' ... Use default
 'A' ... Always
 'E' ... Error case
 'N' ... Never
      Returns:
      Report status by mail

    • setStatusByMail

      public void setStatusByMail(char statusByMail)
      Sets the report status by mail: 
       ' ' ... Use default
 'A' ... Always
 'E' ... Error case
 'N' ... Never
      Parameters:
      statusByMail - report status by mail

    • isBlindCopy

      public boolean isBlindCopy()
      Returns true if the recipient gets a blind copy which cannot be read by anyone else.
      Returns:
      Blind Copy

    • setBlindCopy

      public void setBlindCopy(boolean blindCopy)
      Sets if the recipient gets a blind copy which cannot be read by anyone else.
      Parameters:
      blindCopy - Blind Copy

    • isCopy

      public boolean isCopy()
      Returns true if the recipient should get a copy for information.
      Returns:
      Copy

    • setCopy

      public void setCopy(boolean copy)
      Sets if the recipient should get a copy for information.
      Parameters:
      copy - Copy

    • isExpress

      public boolean isExpress()
      Returns true if express sending is selected.
      Returns:
      Express

    • setExpress

      public void setExpress(boolean express)
      Sets express sending.
      Parameters:
      express - Express

    • getSapAddressType

      public char getSapAddressType()
      Returns the type of address. 
       ' ' ... 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
      Returns:
      Type of address.

    • setSapAddressType

      public void setSapAddressType(char sapAddressType)
      Sets the type of address. 
       ' ' ... 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
      Parameters:
      sapAddressType - Type of address

    • getSapRecipent

      public String getSapRecipent()
      Returns the receiver of a spool list.
      Returns:
      Receiver

    • setSapRecipent

      public void setSapRecipent(String sapRecipent)
      Sets the receiver of a spool list. A maximum of 241 characters is allowed for sapRecipent
      Parameters:
      sapRecipent - Receiver

    • isImmediately

      public boolean isImmediately()
      Returns true if the SAP system should attempt to start the Job immediately.
      Returns:
      Start Immediately

    • setImmediately

      public void setImmediately()
      The system attempts to start the Job immediately. The Job is aborted if a SAP background task (Type BTC) is not available. This is only possible when using XBP Interface.

    • isAsSoonAsPossible

      public boolean isAsSoonAsPossible()
      Returns true if the SAP system should attempt to start the Job as soon as possible.
      Returns:
      Start as soon as possible

    • setAsSoonAsPossible

      public void setAsSoonAsPossible()
      The system attempts to start the Job as soon as possible. If no SAP background task is free, the Job is scheduled in the SAP System. With the SBB interface, the option "as soon as possible" is used.

    • isNoDeleteOnError

      public boolean isNoDeleteOnError()
      Returns true if the Job should not be delete in SAP when an error occurs.
      Returns:
      Delete Job not on error

    • setNoDeleteOnError

      public void setNoDeleteOnError(boolean noDeleteOnError)
      If set the Job is not deleted in SAP when an error occurs.
      Parameters:
      noDeleteOnError - Delete Job not on error

    • isDeleteJob

      public boolean isDeleteJob()
      Returns true if the Job in SAP should be deleted after execution.
      Returns:
      Delete job after completion in CCMS

    • setDeleteJob

      public void setDeleteJob(boolean deleteJob)
      Sets if the Job in SAP should be deleted after execution.
      Parameters:
      deleteJob - Delete job after completion in CCMS

    • getTargetSystem

      public String getTargetSystem()
      Returns the target system in SAP.
      Returns:
      Target system

    • setTargetSystem

      public void setTargetSystem(String targetSystem)
      Sets the target system in SAP. This parameter is optional. The name of an SAP Server in the form "host name_system ID_system Nr". Example: "host31_T40_00". This SAP Server must contain work processes for batch processing. It is recommended by the SAP not to use these parameters because the "Workload Balance" for batch processes will not be in effect. Maximum 32 characters are allowed for targetSystem.
      Parameters:
      targetSystem - Target system

    • getJobClass

      public char getJobClass()
      Returns the selected Job class.
      Returns:
      Job class

    • setJobClass

      public void setJobClass(char jobClass)
      Specifies with which priority the Job in SAP should be handled. Valid values are 'A','B','C',' '
      Parameters:
      jobClass - Job class

    • getJobName

      public String getJobName()
      Returns the Job name.
      Returns:
      Job name

    • setJobName

      public void setJobName(String jobName)
      Sets the name for the Job in SAP. This parameter is optional.
      Parameters:
      jobName - Job name

    • getLanguage

      public String getLanguage()
      Returns the selected language.
      Returns:
      Language

    • setLanguage

      public void setLanguage(String language)
      Sets the language. The parameter language must be a Empty or two letter code as defined by ISO-639.
      Parameters:
      language - Language

    • 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

    • isUseLoginObject

      public boolean isUseLoginObject()
      Returns true if login object is used instead of login information in connection object.
      Returns:
      true if login object is used

    • setUseLoginObject

      public void setUseLoginObject(boolean useLoginObject)
      Set whether the Job will use the login object instead of login information in connection object.
      Parameters:
      useLoginObject - the useLoginObject to set

    • isTypeABAP

      public boolean isTypeABAP()
      Returns true if the SAP type is of ABAP
      Returns:
      true if the type is of ABAP

    • isTypePI

      public boolean isTypePI()
      Returns true if the SAP type is of PI
      Returns:
      true if the type is of PI

    • isTypeJava

      public boolean isTypeJava()
      Returns true if the SAP type is of Java
      Returns:
      true if the type is of Java