Hyperic HQ Plugin API v. 4.4.0.2

org.hyperic.hq.escalation.server.session
Class EscalationAlertType

java.lang.Object
  extended by org.hyperic.util.HypericEnum
      extended by org.hyperic.hq.escalation.server.session.EscalationAlertType
All Implemented Interfaces:
java.io.Serializable, JSON
Direct Known Subclasses:
ClassicEscalationAlertType, GalertEscalationAlertType

public abstract class EscalationAlertType
extends HypericEnum

This is a dynamic enumeration. Other subsystems wishing to specify their own alert type into the escalation manager must create a subclass of this enumeration with a unique code.

See Also:
Serialized Form

Constructor Summary
protected EscalationAlertType(int code, java.lang.String desc, java.lang.String localeProp, java.util.ResourceBundle bundle)
           
 
Method Summary
protected abstract  void changeAlertState(Escalatable esc, AuthzSubject who, EscalationStateChange newState)
          Change the state of an alert.
protected  boolean escalationInUse(Escalation escalation)
          Returns true if the escalation is in use.
static EscalationAlertType findByCode(int code)
           
protected abstract  PerformsEscalations findDefinition(java.lang.Integer defId)
          Find an alert definition (or something that performs escalations) given its id.
protected abstract  Escalatable findEscalatable(java.lang.Integer alertId)
          Find an escalatable (alert) given its ID.
static java.util.List getAll()
           
protected abstract  java.lang.String getLastFixedNote(PerformsEscalations def)
          Return the note from the last alert instance where the alert was fixed.
protected abstract  java.util.Collection getPerformersOfEscalation(Escalation escalation)
          Returns a Collection of PerformsEscalations, which are using the passed escalation.
protected abstract  void logActionDetails(Escalatable esc, Action action, java.lang.String detail, AuthzSubject subject)
          Log the result of the execution of an action.
protected abstract  void setEscalation(java.lang.Integer defId, Escalation escalation)
          Set the escalation for something which can ..
 
Methods inherited from class org.hyperic.util.HypericEnum
findByCode, findByDescription, getAll, getByCode, getCode, getDescription, getJsonName, getValue, toJSON, toString
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

EscalationAlertType

protected EscalationAlertType(int code,
                              java.lang.String desc,
                              java.lang.String localeProp,
                              java.util.ResourceBundle bundle)
Method Detail

findByCode

public static EscalationAlertType findByCode(int code)

findEscalatable

protected abstract Escalatable findEscalatable(java.lang.Integer alertId)
Find an escalatable (alert) given its ID.


findDefinition

protected abstract PerformsEscalations findDefinition(java.lang.Integer defId)
Find an alert definition (or something that performs escalations) given its id.


setEscalation

protected abstract void setEscalation(java.lang.Integer defId,
                                      Escalation escalation)
Set the escalation for something which can .. have escalations.. ;-)

Parameters:
defId - ID of the definition to set the escalation for

changeAlertState

protected abstract void changeAlertState(Escalatable esc,
                                         AuthzSubject who,
                                         EscalationStateChange newState)
Change the state of an alert. This method should simply change the state, log it & not much else.

Parameters:
esc - The escalatable (alert) to change state of
who - Person changing the state
newState - New state

logActionDetails

protected abstract void logActionDetails(Escalatable esc,
                                         Action action,
                                         java.lang.String detail,
                                         AuthzSubject subject)
Log the result of the execution of an action. The escalation system executes actions as part of the escalation chain. Each action spits out some result text. This method should put that result text into the subsytem's log objects.


getLastFixedNote

protected abstract java.lang.String getLastFixedNote(PerformsEscalations def)
Return the note from the last alert instance where the alert was fixed.


getPerformersOfEscalation

protected abstract java.util.Collection getPerformersOfEscalation(Escalation escalation)
Returns a Collection of PerformsEscalations, which are using the passed escalation.


escalationInUse

protected boolean escalationInUse(Escalation escalation)
Returns true if the escalation is in use.


getAll

public static java.util.List getAll()

Hyperic HQ Plugin API v. 4.4.0.2

Copyright © 2004-2006 Hyperic, Inc. support@hyperic.net, All Rights Reserved.