Package com.uc4.api

Class FolderListItem

java.lang.Object
com.uc4.api.FolderListItem
All Implemented Interfaces:
ITransportable
public final class FolderListItem extends Object implements ITransportable
This class represents one object in a folder.

  • Constructor Details

    • FolderListItem

      public FolderListItem(ConnectionAttributes session, Element row, String folderID)
      Constructs a FolderListItem from the specified element. Internal use only.
      Parameters:
      session - Session time zone
      row - Element representing a row in the folder list
      folderID - ID of the folder

  • Method Details

    • isLink

      public boolean isLink()
      Returns whether the object is a link.
      Returns:
      True if the object is only a link

    • getSubType

      public String getSubType()
      Returns the subtype of the object if available.
      Returns:
      Sub type of Events, Variables or an empty String, never null

    • getPlatform

      public String getPlatform()
      Returns the platform of the object or an empty String if a platform is not defined for the object.
      Returns:
      Platform or an empty String

    • getDateModified

      public DateTime getDateModified()
      Returns the date of the last modification.
      Returns:
      Last modification date

    • getArchive1

      public String getArchive1()
      Returns the first archive key of this object.
      Returns:
      Archive Key 1

    • getObjectType

      public String getObjectType()
      Returns the language independent type of the Object.
      Specified by:
      getObjectType in interface ITransportable
      Returns:
      Type of the object

    • getArchive2

      public String getArchive2()
      Returns the seconds archive key of this object.
      Returns:
      Archive Key 2

    • getId

      public String getId()
      Returns the ID of this object.
      Specified by:
      getId in interface ITransportable
      Returns:
      ID

    • getName

      public String getName()
      Returns the name of this object.
      Specified by:
      getName in interface ITransportable
      Returns:
      Name

    • isOpen

      public boolean isOpen()
      Returns true if the object is open and therefore locked for changes. The method getOpenedBy returns the name of the Automation Engine user.
      Returns:
      True if this object is open

    • getOpenedBy

      public String getOpenedBy()
      Returns the name of the Automation Engine user who has opened the object.
      Returns:
      Name of the Automation Engine User who opened the object

    • getTitle

      public String getTitle()
      Returns the title of this Automation Engine Object.
      Returns:
      Title

    • getType

      public String getType()
      Returns the type of this Automation Engine Object.
      Returns:
      Type

    • getVersion

      public int getVersion()
      Returns the Version of this Automation Engine object.
      Returns:
      Integer containing the version

    • equals

      public boolean equals(Object obj)
      Overrides:
      equals in class Object

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object

    • toString

      public String toString()
      Overrides:
      toString in class Object

    • getFolderID

      public String getFolderID()
      Returns the Folder ID.
      Specified by:
      getFolderID in interface ITransportable
      Returns:
      FolderID