Package com.uc4.api.objects

Class UC4Object

java.lang.Object
com.uc4.api.objects.UC4Object
Direct Known Subclasses:
AgentAssignment, Calendar, Client, Cockpit, CodeTable, ConsoleEvent, Dashboard, DatabaseConnection, DatabaseEvent, Documentation, FileEvent, FileTransfer, Group, Host, HostGroup, Include, Job, JobPlan, Login, Notification, OutputFilter, Period, PromptSet, PSRemoteTaskManager, Queue, RAConnection, RASolution, RuleEvent, SAPConnection, SAPQueueManager, Schedule, Script, Server, ServiceLevelObjective, Storage, Stylesheet, Sync, TimeEvent, TimeZone, User, UserGroup, Variable, WorkflowIF, WorkflowLoop, XRequest
public abstract class UC4Object extends Object
This is the base class of all the Automation Engine objects.

  • Constructor Details

    • UC4Object

      public UC4Object()

  • Method Details

    • getName

      public String getName()
      Returns the name of the object.
      Returns:
      name

    • getIdnr

      public String getIdnr()
      Returns the ID of the object.
      Returns:
      ID

    • getObjectClient

      public int getObjectClient()
      Returns the client where the object is located.
      Returns:
      client

    • getType

      public String getType()
      Returns the type of the object, for example JOBP, VARA or SCRI.
      Returns:
      type

    • docu

      public DocuContainer docu()
      This method provides access to the text and structured documentation of an object.
      Returns:
      Documentation

    • getAccess

      public String getAccess()
      Returns if this object is opened read only.
      Returns:
      String containing the access field

    • getModCount

      public int getModCount()
      Returns the modification count of the object.
      Returns:
      modification count

    • isExecutable

      public abstract boolean isExecutable()
      Returns true if this Object can be executed.
      Returns:
      true if the Object can be executed, false if not.

    • validate

      public void validate() throws InvalidObjectException
      Validates the object. If the object is not valid an InvalidObjectException is thrown.
      Throws:
      InvalidObjectException - If the object is not valid

    • load

      public void load(com.uc4.util.XMLDocument doc, ConnectionAttributes session)
      Fills the object from a XML document.
      Parameters:
      doc - XML Document
      session - Session information

    • store

      public void store(com.uc4.util.XMLDocument doc, Element request, ConnectionAttributes sessionInfo, boolean override)
      Fills the XML document with the values from the object.
      Parameters:
      doc - XML document
      request - Request element
      sessionInfo - Information about the current session
      override - Override existing object

    • isOldVersion

      public boolean isOldVersion()
      Returns true if the opened object is actually an older version of an object.
      Returns:
      true if the opened object is actually an older version of an object.