com.uc4.api

Class FolderListItem

java.lang.Object

com.uc4.api.FolderListItem

All Implemented Interfaces:

ITransportable

public final class FolderListItem
extends java.lang.Object
implements ITransportable

This class represents one object in a folder.

Constructor Summary

Constructors

Constructor and Description
FolderListItem(ConnectionAttributes session, org.w3c.dom.Element row, java.lang.String folderID) Constructs a FolderListItem from the specified element.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	equals(java.lang.Object obj)
java.lang.String	getArchive1() Returns the first archive key of this object.
java.lang.String	getArchive2() Returns the seconds archive key of this object.
DateTime	getDateModified() Returns the date of the last modification.
java.lang.String	getFolderID() Returns the Folder ID.
java.lang.String	getId() Returns the ID of this object.
java.lang.String	getName() Returns the name of this object.
java.lang.String	getObjectType() Returns the language independent type of the Object.
java.lang.String	getOpenedBy() Returns the name of the Automation Engine user who has opened the object.
java.lang.String	getPlatform() Returns the platform of the object or an empty String if a platform is not defined for the object.
java.lang.String	getSubType() Returns the subtype of the object if available.
java.lang.String	getTitle() Returns the title of this Automation Engine Object.
java.lang.String	getType() Returns the type of this Automation Engine Object.
int	getVersion() Returns the Version of this Automation Engine object.
int	hashCode()
boolean	isLink() Returns whether the object is a link.
boolean	isOpen() Returns true if the object is open and therefore locked for changes.
java.lang.String	toString()

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

FolderListItem

public FolderListItem(ConnectionAttributes session,
              org.w3c.dom.Element row,
              java.lang.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 Detail

isLink

public boolean isLink()

Returns whether the object is a link.

Returns:

True if the object is only a link

getSubType

public java.lang.String getSubType()

Returns the subtype of the object if available.

Returns:

Sub type of Events, Variables or an empty String, never null

getPlatform

public java.lang.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 java.lang.String getArchive1()

Returns the first archive key of this object.

Returns:

Archive Key 1

getObjectType

public java.lang.String getObjectType()

Returns the language independent type of the Object.

Specified by:

getObjectType in interface ITransportable

Returns:

Type of the object

getArchive2

public java.lang.String getArchive2()

Returns the seconds archive key of this object.

Returns:

Archive Key 2

getId

public java.lang.String getId()

Returns the ID of this object.

Specified by:

getId in interface ITransportable

Returns:

ID

getName

public java.lang.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 java.lang.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 java.lang.String getTitle()

Returns the title of this Automation Engine Object.

Returns:

Title

getType

public java.lang.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(java.lang.Object obj)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

getFolderID

public java.lang.String getFolderID()

Returns the Folder ID.

Specified by:

getFolderID in interface ITransportable

Returns:

FolderID