oracle.panama.model
Interface Alert

All Superinterfaces:

Link, ModelObject, Service, XMLObject

public interface Alert

extends Link

A Job is a service to be automatically executed (time interval specification).

Field Summary

Type	Field
static int	TYPEID The type id of this class.
static java.lang.String	TYPENAME The constant class type identifier.

Fields inherited from interface oracle.panama.model.Service

CATEGORY_MASTER, CATEGORY_SERVICE, CATEGORY_USER_HOME

Method Summary

Type	Method
void	addAddress(AlertAddress address) Adds a new address to the list of addresses to send the result to.
AlertAddress[]	getAddresses() Returns the list of addresses to send the result to.
java.lang.String	getInterval() Gets the interval.
java.util.Date	getNext() Gets the next time to run.
boolean	isScheduled() Check if this job really is scheduled.
void	removeAddress(AlertAddress address) Removes an address from the list of addresses to send the result to.
void	setAddresses(AlertAddress[] addresses) Sets the list of addresses to send the result to.
void	setInterval(java.lang.String interval) Sets the interval property (String) value.
void	setNext(java.util.Date next) Set the next execution time and date.

Methods inherited from interface oracle.panama.model.Link

getAsyncAddress, getAsyncArguments, getAsyncName, getInputArguments, getLanguage, getLastService, getMergedInputArguments, getMergedOutputArguments, getNextService, getOutputArguments, getParameterDelimiter, getServiceHelpText, isAsyncEnabled, setAsyncAddress, setAsyncArguments, setAsyncName, setInputArguments, setOutputArguments, setParameterDelimiter, setServiceHelpText

Methods inherited from interface oracle.panama.model.Service

getAreaId, getCategory, getCost, getDescription, getGroups, getParent, getPrimaryAudio, getPrimaryImage, getSecondaryAudio, getSecondaryImage, getSequenceNo, getShortName, getTransformer, getURL, getURLPathParameter, getUserOwner, invoke, isValid, isViewCustomizable, isVisible, removeAllGroups, setAreaId, setCategory, setCost, setDescription, setGroups, setParent, setPrimaryAudio, setPrimaryImage, setSecondaryAudio, setSecondaryImage, setSequenceNo, setShortName, setUserOwner, setValid, setViewCustomizable, setVisible

Methods inherited from interface oracle.panama.model.ModelObject

delete, getCreatedDate, getId, getLastModifiedDate, getName, getTypeId, getTypeName, isSystem, setName, setSystem, undoAll

Methods inherited from interface oracle.panama.model.XMLObject

setXML, toXML

Field Detail

TYPENAME

public static final java.lang.String TYPENAME

The constant class type identifier.

TYPEID

public static final int TYPEID

The type id of this class.

Method Detail

getNext

public java.util.Date getNext()

Gets the next time to run.

Returns:

the next time this job will be executed.

setNext

public void setNext(java.util.Date next)

Set the next execution time and date.

This date is when the Job will be invoked again. Note: The interval specification is used to calculate the next value each time the job is executed. But this calculated value can always be overriden by an explicit call to this method.

The time portion (hour, minute, second) of the date is valid when the system decides the exact time of day to execute this job.

If a job fails then it will be stopped, and it has to be triggered to start running again by a new call of this method again.

Parameters:

next - the new next date.

See Also:

getNext(), setInterval(java.lang.String)

getInterval

public java.lang.String getInterval()

Gets the interval.

Returns:

the interval specificartion.

See Also:

setInterval(java.lang.String)

setInterval

public void setInterval(java.lang.String interval)

Sets the interval property (String) value. The interval can specified by usage of the format "[#]", where the keywords are:

• H - Hours
• D - Days
• M - Months
• Y - Years
• WE - Weekdays
• WD - Weekends

Example:

Execute the job each weekday: "WE".

Execute the job each monday: Set the next date to a monday and specify the interval to "7D".

Parameters:

interval - the new value for the property.

Throws:

PanamaRuntimeException - if the format is invalid.

See Also:

getInterval(), setNext(java.util.Date)

isScheduled

public boolean isScheduled()

Check if this job really is scheduled.

Returns:

true if the job is scheduled otherwise false.

getAddresses

public AlertAddress[] getAddresses()

Returns the list of addresses to send the result to.

Returns:

AlertAddress[]

See Also:

#setAddress

setAddresses

public void setAddresses(AlertAddress[] addresses)

Sets the list of addresses to send the result to.

Parameters:

addresses - to send the result to.

See Also:

getAddresses()

addAddress

public void addAddress(AlertAddress address)

Adds a new address to the list of addresses to send the result to.

Parameters:

address - the new address

See Also:

removeAddress(oracle.panama.model.AlertAddress)

removeAddress

public void removeAddress(AlertAddress address)

Removes an address from the list of addresses to send the result to.

Parameters:

address - to be removed

See Also:

removeAddress(oracle.panama.model.AlertAddress)