Package com.uc4.api.objects

Class EventAttributes

java.lang.Object

com.uc4.api.objects.EventAttributes

public class EventAttributes
extends java.lang.Object

Attributes of this event object.

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	EventAttributes(com.uc4.util.XMLDocument doc)

Method Summary

Modifier and Type	Method	Description
DeactivateCondition	getDeactivate()	Returns the deactivate condition for this Job.
ExtendedReports	getExtendedReports()	Returns the setting for extended reports.
java.lang.String	getIntAccount()	Returns the internal account assigned to this Job.
int	getPriority()	Priority with which this Job should be executed in UC4.
UC4ObjectName	getQueue()	Returns the Queue Object.
UC4ObjectName	getStartType()	Returns the start type of this Job.
UC4TimezoneName	getTimezone()	Returns the TimeZone that is to be used.
boolean	isGenerateAtRuntime()	Returns true if the Job should not be generated at activation time but rather at runtime.
MaxParallel	maxParallel()	Returns settings for parallel tasks.
void	setDeactivate(DeactivateCondition deactivate)	Sets the deactivate condition for this Job.
void	setExtendedReports(ExtendedReports extendedReports)	Sets the option for extended reports.
void	setGenerateAtRuntime(boolean value)	Sets or clears the Generate at runtime check box.
void	setIntAccount(java.lang.String intAccount)	Sets the internal account, max.
void	setPriority(int priority)	Priority with which this Job should be executed in UC4.
void	setQueue(UC4ObjectName queue)	Sets the Queue that will be used when this object is executed.
void	setStartType(UC4ObjectName startType)	Sets the start type of this Job.
void	setTimezone(UC4TimezoneName timezone)	Sets the TimeZone for this job.
protected void	store(com.uc4.util.XMLDocument doc, org.w3c.dom.Element request)

Methods inherited from class java.lang.Object

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

Constructor Detail

EventAttributes

protected EventAttributes(com.uc4.util.XMLDocument doc)

Method Detail

store

protected void store(com.uc4.util.XMLDocument doc,
                     org.w3c.dom.Element request)

getQueue

public UC4ObjectName getQueue()

Returns the Queue Object.

Returns:

Name of the Queue Object

setQueue

public void setQueue(UC4ObjectName queue)

Sets the Queue that will be used when this object is executed.

Parameters:

queue - Name of the Queue Object

getStartType

public UC4ObjectName getStartType()

Returns the start type of this Job.

Returns:

Start type

setStartType

public void setStartType(UC4ObjectName startType)

Sets the start type of this Job.

Parameters:

startType - Start type

getIntAccount

public java.lang.String getIntAccount()

Returns the internal account assigned to this Job.

Returns:

Internal account

setIntAccount

public void setIntAccount(java.lang.String intAccount)

Sets the internal account, max. 20 characters.

Parameters:

intAccount - internal account

isGenerateAtRuntime

public boolean isGenerateAtRuntime()

Returns true if the Job should not be generated at activation time but rather at runtime.

Returns:

true if the Generate at runtime check box is selected

setGenerateAtRuntime

public void setGenerateAtRuntime(boolean value)

Sets or clears the Generate at runtime check box. if value is true the check box is set.

Parameters:

value - Generate at runtime

getPriority

public int getPriority()

Priority with which this Job should be executed in UC4. Permitted values: 0 to 255
Default: 0
1 stands for highest, 255 for lowest priority. If 0 is chosen, the priority defined in the UC_CLIENT_SETTINGS variables with TASK_PRIORITY for local clients is used. If no default priority is set or if no variable is present in the local clients, then 200 is assigned as the valid priority.

Returns:

priority

setPriority

public void setPriority(int priority)

Priority with which this Job should be executed in UC4. Permitted values: 0 to 255
Default: 0
1 stands for highest, 255 for lowest priority. If 0 is chosen, the priority defined in the UC_CLIENT_SETTINGS variables with TASK_PRIORITY for local clients is used. If no default priority is set or if no variable is present in the local clients, then 200 is assigned as the valid priority.

Parameters:

priority - Priority

maxParallel

public MaxParallel maxParallel()

Returns settings for parallel tasks.

Returns:

parallel task settings

getTimezone

public UC4TimezoneName getTimezone()

Returns the TimeZone that is to be used.

Returns:

TimeZone

setTimezone

public void setTimezone(UC4TimezoneName timezone)

Sets the TimeZone for this job.

Parameters:

timezone - TimeZone

getDeactivate

public DeactivateCondition getDeactivate()

Returns the deactivate condition for this Job.

Returns:

Deactivate condition

setDeactivate

public void setDeactivate(DeactivateCondition deactivate)

Sets the deactivate condition for this Job.

Parameters:

deactivate - Deactivate condition

getExtendedReports

public ExtendedReports getExtendedReports()

Returns the setting for extended reports.

Returns:

Extended reports.

setExtendedReports

public void setExtendedReports(ExtendedReports extendedReports)

Sets the option for extended reports.

Parameters:

extendedReports - Extended reports.