Package com.redwood.scheduler.api.model

Interface LinkableMonitor

All Superinterfaces:

BusinessKeyObject, LinkableMonitorComp, Monitor, NamedRootObject, NamedRootObjectComp, Root, SchedulerEntity, SchedulerEntityComp

All Known Subinterfaces:

MonitorCheck, MonitorNode

public interface LinkableMonitor
extends LinkableMonitorComp, Monitor

Superclass for monitors that can be linked to.

Field Summary

Fields inherited from interface com.redwood.scheduler.api.model.SchedulerEntity

ACTION_AUDIT, ACTION_EXPORT, ACTION_READ, BEHAVIOR_DEPRECATED, BEHAVIOR_NONE, BEHAVIOR_SYSTEM

Method Summary

Modifier and Type	Method	Description
MonitorEvent	createMonitorEvent(EventDefinition newEventDefinition)	Create a new MonitorEvent linked to this object.
Long	getActualSeverity()	Get the value for ActualSeverity.
RWIterable<MonitorLink>	getLinkedMonitorLinks()	Get an RWIterable over a collection of LinkedMonitorLinks, the collection will be ordered by Name.
MonitorEvent	getMonitorEventByEventDefinition(EventDefinition eventDefinition)	Get the MonitorEvent by MonitorEvent.
RWIterable<MonitorEvent>	getMonitorEvents()	Get an RWIterable over an ordered collection of MonitorEvents.
String	getRemoteId()	Get the value for RemoteId.
String	getRemoteSystem()	Get the value for RemoteSystem.
void	setRemoteId(String newRemoteId)	Set the value for RemoteId.
void	setRemoteSystem(String newRemoteSystem)	Set the value for RemoteSystem.

Methods inherited from interface com.redwood.scheduler.api.model.BusinessKeyObject

getBusinessKey

Methods inherited from interface com.redwood.scheduler.api.model.Monitor

getFullPath, getParentMonitorNode, setParentMonitorNode

Methods inherited from interface com.redwood.scheduler.api.model.NamedRootObject

createObjectReference, getComment, getDescription, getLinkedObjectReferenceByLinkedObject, getLinkedObjectReferenceByName, getLinkedObjectReferences, getName, getSearchName, getSourceObjectReferences, isHidden, setComment, setDescription, setName

Methods inherited from interface com.redwood.scheduler.api.model.Root

getCreationTime, getLastModificationTime, getLastModifierSubject

Methods inherited from interface com.redwood.scheduler.api.model.SchedulerEntity

canPerform, createSubjectObjectPrivilegeGrant, deleteObject, getAuditTrail, getAuditTrailSize, getBehavior, getEffectiveBehavior, getErrorNameEN, getErrorNameKey, getLLPVersion, getLOV, getLOVSupport, getObjectType, getParentSchedulerEntities, getRuntime, getSubjectObjectPrivilegeGrantBySubject, getSubjectObjectPrivilegeGrants, getUniqueId, getUrl, getUrl, isCreated, isDeletable, isDeleted, isModifiable, isModified, isSelectVersioned, processRelatedObjects, processRelatedObjects, processRelatedObjects, refreshObject, resetObject, resetObject, resetValuesToDefault, selectForRead

Method Detail

getActualSeverity

Long getActualSeverity()

Get the value for ActualSeverity. (The Actual severity of the monitor, or -1 if it has not been set before.)

Returns:

the field

Throws:

com.redwood.scheduler.api.exception.ObjectNotAttachedToSessionException - This will be thrown if this method is called while the object is not attached to a session.

getRemoteId

String getRemoteId()

Get the value for RemoteId. (Unique identification of the job in the remote system)

Returns:

the field

Throws:

com.redwood.scheduler.api.exception.ObjectNotAttachedToSessionException - This will be thrown if this method is called while the object is not attached to a session.

getRemoteSystem

String getRemoteSystem()

Get the value for RemoteSystem. (Foreign subsystem that this monitor is defined in)

Returns:

the field

Throws:

com.redwood.scheduler.api.exception.ObjectNotAttachedToSessionException - This will be thrown if this method is called while the object is not attached to a session.

setRemoteId

void setRemoteId(String newRemoteId)

Set the value for RemoteId. (Unique identification of the job in the remote system) This value is optional.

Parameters:

newRemoteId - the new value for RemoteId.

Throws:

com.redwood.scheduler.api.exception.ObjectNotAttachedToSessionException - This will be thrown if this method is called while the object is not attached to a session.

setRemoteSystem

void setRemoteSystem(String newRemoteSystem)

Set the value for RemoteSystem. (Foreign subsystem that this monitor is defined in) This value is optional.

Parameters:

newRemoteSystem - the new value for RemoteSystem.

Throws:

com.redwood.scheduler.api.exception.ObjectNotAttachedToSessionException - This will be thrown if this method is called while the object is not attached to a session.

getMonitorEvents

RWIterable<MonitorEvent> getMonitorEvents()

Get an RWIterable over an ordered collection of MonitorEvents. If the collection is empty, an empty iterator will be returned, that is, this method will never return null. A list of Events that this Monitor raises, and under what conditions.

Specified by:

getMonitorEvents in interface LinkableMonitorComp

Returns:

An RWIterable over an ordered collection of MonitorEvent objects .

createMonitorEvent

MonitorEvent createMonitorEvent(EventDefinition newEventDefinition)

Create a new MonitorEvent linked to this object.

Parameters:

newEventDefinition - The other parent of the MonitorEventEventDefinition association.

Returns:

a new MonitorEvent.

getMonitorEventByEventDefinition

MonitorEvent getMonitorEventByEventDefinition(EventDefinition eventDefinition)

Get the MonitorEvent by MonitorEvent.

Parameters:

eventDefinition -

Returns:

the MonitorEvent, or null if it could not be found

getLinkedMonitorLinks

RWIterable<MonitorLink> getLinkedMonitorLinks()

Get an RWIterable over a collection of LinkedMonitorLinks, the collection will be ordered by Name. If the collection is empty, an empty iterator will be returned, that is, this method will never return null. To which LinkableMonitor Object does this MonitorLink point to?

Specified by:

getLinkedMonitorLinks in interface LinkableMonitorComp

Returns:

An RWIterable over a collection of MonitorLink objects , the collection will be ordered by Name.