com.uc4.api

Class ForecastItem

java.lang.Object

com.uc4.api.ForecastItem

public final class ForecastItem
extends java.lang.Object

This class represents a single row in the Forecast list.

Constructor Summary

Constructors

Constructor and Description
ForecastItem(ConnectionAttributes session, org.w3c.dom.Element row) Creates a ForecastItem using the specified DOM Element.

Method Summary

Modifier and Type	Method and Description
DateTime	getEstimatedEnd()
java.lang.String	getId()
java.lang.String	getLastMessage()
DateTime	getLogicalStart()
java.lang.String	getName()
java.lang.String	getObjectType()
java.lang.String	getPlatform() Returns the platform of the Automation Engine Object or an empty String if a platform is not defined.
java.lang.String	getRuntime()
java.lang.String	getState()
java.lang.String	getStatusText() Returns a description of the status.
java.lang.String	getUser()
java.lang.String	toString()

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

ForecastItem

public ForecastItem(ConnectionAttributes session,
                    org.w3c.dom.Element row)

Creates a ForecastItem using the specified DOM Element. Internal use only

Parameters:

session - Session time zone

row - Element

Method Detail

getPlatform

public java.lang.String getPlatform()

Returns the platform of the Automation Engine Object or an empty String if a platform is not defined.

Returns:

Platform or an empty String

getId

public java.lang.String getId()

Returns:

ID of the entry

getLogicalStart

public DateTime getLogicalStart()

Returns:

Logical start date and time

getName

public java.lang.String getName()

Returns:

Name of the object

getUser

public java.lang.String getUser()

Returns:

Server ID and department

getEstimatedEnd

public DateTime getEstimatedEnd()

Returns:

Estimated end date and time

getStatusText

public java.lang.String getStatusText()

Returns a description of the status. This return value depends on the logon language.

Returns:

description for task status. Possible return values are described in the status: AbstractTask.getStatusCode()

getState

public java.lang.String getState()

Returns:

Short form of the expected object status

getObjectType

public java.lang.String getObjectType()

Returns:

Type of the object

getRuntime

public java.lang.String getRuntime()

Returns:

Expected runtime

getLastMessage

public java.lang.String getLastMessage()

Returns:

Last message

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object