Package com.redwood.scheduler.api.model

Interface Monitor

All Superinterfaces:

BusinessKeyObject, NamedRootObject, NamedRootObjectComp, Root, SchedulerEntity, SchedulerEntityComp

All Known Subinterfaces:

LinkableMonitor, MonitorCheck, MonitorLink, MonitorNode

public interface Monitor
extends NamedRootObject, BusinessKeyObject

Alert monitors show a hierarchical user-defined view of the status of the system The alert system shows a hierarchical view of the wellness of the system. At the top level, it shows a single value reflecting the overall status. The alerts come from both internal monitoring of the scheduler and external systems such as SAP CCMS, HP OpenView and others. This also works in the other direction: third part system monitoring tools can be fed with the data in the scheduler alert monitors.

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
String	getFullPath()	Query full path to this monitor.
MonitorNode	getParentMonitorNode()	Get the ParentMonitorNode.
void	setParentMonitorNode(MonitorNode newParentMonitorNode)	Set the value for ParentMonitorNode.

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

getBusinessKey

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

getFullPath

String getFullPath()

Query full path to this monitor. This builds the full monitor path that points to this entry by traversing the parent links.

Returns:

String containing the full monitor path to this entry. Each monitor is seperated by the '/' character.

getParentMonitorNode

MonitorNode getParentMonitorNode()

Get the ParentMonitorNode.

Returns:

ParentMonitorNode

Throws:

com.redwood.scheduler.api.exception.ObjectDeletedException - If this method is called when the object has been marked for deletion.

com.redwood.scheduler.api.exception.ObjectNotAttachedToSessionException - If this method is called when the object has been removed from it's session.

setParentMonitorNode

void setParentMonitorNode(MonitorNode newParentMonitorNode)

Set the value for ParentMonitorNode. This value is optional.

Parameters:

newParentMonitorNode - is the object to set ParentMonitorNode to. The children of this monitor node.