Package com.uc4.api

Class StatisticSearchItem

java.lang.Object

com.uc4.api.AbstractTask

com.uc4.api.StatisticSearchItem

All Implemented Interfaces:

HasAlias

public class StatisticSearchItem
extends AbstractTask

This class represents a row in the result of a statistics search.

Field Summary

Fields inherited from class com.uc4.api.AbstractTask

activationTime, alias, archiveKey1, archiveKey2, cauVersion, comment, endTime, host, intAccount, monitoredTask, name, objectName, parentRunID, periodDescription, platform, queue, remoteStatus, returnCode, rollback, runID, runtime, startTime, startType, state, stateIcon, stateWithinParent, statusCode, statusText, type, typeIcon, userId, version

Constructor Summary

Constructors

Constructor	Description
StatisticSearchItem(Element row, boolean logging, ConnectionAttributes session, com.uc4.util.XMLDocument doc)	Constructs a StatisticSearchItem from the speficied XML element.

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object obj)
String	getMessageText()	Returns the message text for HOST, USER and SERVER objects.
boolean	getModificationFlag()
String	getProcessId()
String	getState()	Returns the task status which has ended the object in a language independent format.
UC4UserName	getUser()	Deprecated. use getUserName() instead
int	hashCode()
String	toString()

Methods inherited from class com.uc4.api.AbstractTask

getActivationTime, getAlias, getArchive1, getArchive2, getArchiveKey1, getArchiveKey2, getCauVersion, getClient, getEndTime, getHost, getIntAccount, getName, getObjectName, getParentRunID, getPeriodDescription, getPlatform, getQueue, getRemoteStatus, getReturnCode, getRunID, getRuntime, getRuntimeInMillis, getStart, getStartTime, getStartType, getStateIcon, getStatus, getStatusCode, getStatusIcon, getStatusText, getTaskClient, getType, getTypeIcon, getUserId, getUserName, getVersion, hasComment, initObjectNameAndAlias, isMonitoredTask, isRollback, setUserInfo

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Details

StatisticSearchItem

public StatisticSearchItem(Element row,
 boolean logging,
 ConnectionAttributes session,
 com.uc4.util.XMLDocument doc)

Constructs a StatisticSearchItem from the speficied XML element.

Parameters:

row - Element

logging - Is logging

session - Session

doc - XML Document

Method Details

getMessageText

public String getMessageText()

Returns the message text for HOST, USER and SERVER objects. For all other object types this method returns null.

Returns:

String containing a message or null

getState

public String getState()

Returns the task status which has ended the object in a language independent format.

Returns:

Task status which has ended the object

getUser

@Deprecated
public UC4UserName getUser()

Deprecated.

use getUserName() instead

Returns the name and department of the user that has activated the object.

Returns:

user that has activated the object

getProcessId

public String getProcessId()

Returns:

the process ID of the task.

getModificationFlag

public boolean getModificationFlag()

Returns:

if a task has been modified

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 AbstractTask