Package com.uc4.api.objects

Class OutputScan

  • public class OutputScan
extends java.lang.Object
    This class represents the Output-Scan tab in AE-Object definitions.

    • Nested Class Summary

      Nested Classes 
      Modifier and Type Class Description
      static class  OutputScan.Inherit
      Inherit setting.

    • Constructor Summary

      Constructors 
      Modifier Constructor Description
      protected OutputScan​(com.uc4.util.XMLDocument doc)
      Constructs a OutputScan using the specified XML document

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      java.util.List<OutputScanFilter> filterList()
      Access to the list of Output-Scan filters.
      UC4HostName getHost()
      Returns the name of the Agent which is used for external file scans.
      OutputScan.Inherit getInherit()
      Returns an enum which describes if the scan should affect child jobs.
      UC4ObjectName getLogin()
      Returns the name of the login object which is used for external file scans.
      void setHost​(UC4HostName host)
      Sets the name of the Agent which is used for external file scans.
      void setInherit​(OutputScan.Inherit inherit)
      Sets an enum which describes if the scan should affect child jobs.
      void setLogin​(UC4ObjectName login)
      Sets the login object for the specified host.
      protected void store​(com.uc4.util.XMLDocument doc, org.w3c.dom.Element request)
      Stores data of this object under the request element.

      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    • Constructor Detail

      • OutputScan

        protected OutputScan​(com.uc4.util.XMLDocument doc)
        Constructs a OutputScan using the specified XML document
        Parameters:
        doc - XML Document

    • Method Detail

      • store

        protected void store​(com.uc4.util.XMLDocument doc,
                     org.w3c.dom.Element request)
        Stores data of this object under the request element.
        Parameters:
        doc - XML Document
        request - root element, the header is stored in children elements of request

      • getInherit

        public OutputScan.Inherit getInherit()
        Returns an enum which describes if the scan should affect child jobs.
        Returns:
        Inherit scan to reports of child jobs

      • setInherit

        public void setInherit​(OutputScan.Inherit inherit)
        Sets an enum which describes if the scan should affect child jobs.
        Parameters:
        inherit - Inherit scan to reports of child jobs

      • getHost

        public UC4HostName getHost()
        Returns the name of the Agent which is used for external file scans.
        Returns:
        Name of the UC4 HOST object

      • setHost

        public void setHost​(UC4HostName host)
        Sets the name of the Agent which is used for external file scans. The parameter host can be null or an empty UC4HostName instance if no host should be set in this Output-Scan definition
        Parameters:
        host - Name of the HOST object or null

      • getLogin

        public UC4ObjectName getLogin()
        Returns the name of the login object which is used for external file scans.
        Returns:
        Login Object

      • filterList

        public java.util.List<OutputScanFilter> filterList()
        Access to the list of Output-Scan filters. The return value may be modified by the methods of the List interface.
        Returns:
        Output-Scan filter

      • setLogin

        public void setLogin​(UC4ObjectName login)
        Sets the login object for the specified host.
        Parameters:
        login - Name of an existing login Object