com.uc4.communication.requests

Class GetAgentGroupMonitorProperties

java.lang.Object

com.uc4.communication.requests.XMLRequest

com.uc4.communication.requests.GetAgentGroupMonitorProperties

public class GetAgentGroupMonitorProperties
extends XMLRequest

This class is used to get AgentGroup options of a RunID.

Constructor Summary

Constructors

Constructor and Description
GetAgentGroupMonitorProperties(int runID) Creates a request to read the AgentGroup monitor.

Method Summary

Modifier and Type	Method and Description
java.lang.String	getHostGroupType() Returns the Job type of all hosts in this HostGroup.
int	getMaxParallelJobs() Returns the maximum number of parallel tasks when the execution mode is set to ALL.
int	getRunId() Returns the same value that has been set in the constructor.
boolean	isExecuteLoadDependent()
boolean	isExecuteOnAllHosts()
boolean	isExecuteOnAnyHost()
boolean	isExecuteOnFirstHost()
boolean	isExecuteOnNextHost()

Methods inherited from class com.uc4.communication.requests.XMLRequest

getAllMessageBoxes, getMessageBox, getRequestID, handleResponse, send

Methods inherited from class java.lang.Object

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

Constructor Detail

GetAgentGroupMonitorProperties

public GetAgentGroupMonitorProperties(int runID)

Creates a request to read the AgentGroup monitor.

Parameters:

runID - RunID of the HOSTG object.

Method Detail

getRunId

public int getRunId()

Returns the same value that has been set in the constructor.

Returns:

RunID of the task, never 0

getHostGroupType

public java.lang.String getHostGroupType()

Returns the Job type of all hosts in this HostGroup.

Returns:

Job type

getMaxParallelJobs

public int getMaxParallelJobs()

Returns the maximum number of parallel tasks when the execution mode is set to ALL.

Returns:

Parallel tasks

isExecuteOnAllHosts

public boolean isExecuteOnAllHosts()

Returns:

True if a task will be executed on all hosts of this HostGroup

isExecuteOnFirstHost

public boolean isExecuteOnFirstHost()

Returns:

True if a task will run on the first active host in this HostGroup

isExecuteOnNextHost

public boolean isExecuteOnNextHost()

Returns:

True if the execution mode is set to NEXT

isExecuteLoadDependent

public boolean isExecuteLoadDependent()

Returns:

True if the execution mode is set to LOAD_DEPENDENT

isExecuteOnAnyHost

public boolean isExecuteOnAnyHost()

Returns:

Returns true if the task should execute on any host