project35.soa.alerts
Class Alert

java.lang.Object
  extended by project35.soa.alerts.Alert
Direct Known Subclasses:
SystemErrorAlert, SystemWarningAlert

public class Alert
extends java.lang.Object

a collection of matching criteria that are associated with an intent such as an error, warning, request for more information or an information bulletin. Each matching criteria is a collection of field value combinations on the same form


Copyright (c) 2008 Kevin Garwood for Project35. The original code was developed by Kevin Garwood for the University of Manchester. Revisions have been made for Project35, a project that is independent of that institution. This code is licensed under the Academic Free License version 3.0. The code attribution for the original code is included here:

Copyright (c) Kevin Garwood and University of Manchester 2007. All rights reserved. Licensed under the Academic Free License version 3.0. For more information on the terms and conditions, please see the file "LICENSE" that is included in this distribution.


Version:
1.0
Author:
Kevin Garwood (kgarwood@users.sourceforge.net)

Constructor Summary
Alert()
           
 
Method Summary
 AlertActionType getAlertType()
          Get the value of alertType.
 java.lang.String getAuthor()
          Get the value of author.
 java.lang.String getBundleName()
          returns the Alert Bundle which contains this alert
 java.lang.String getEmailAddress()
          Get the value of emailAddress.
 java.lang.String getInstitution()
          Get the value of institution.
 MatchingCriteria getMatchingCriteria()
          Get the value of matchingCriteria.
 java.lang.String getMessage()
          Get the value of message.
 java.lang.String getName()
          Get the value of name.
 java.lang.String getRecordClassContext()
          Get the value of recordClassContext.
 boolean matches(RecordModel recordModel)
           
 void setAlertType(AlertActionType alertType)
          Set the value of alertType.
 void setAuthor(java.lang.String author)
          Set the value of author.
 void setBundleName(java.lang.String bundleName)
           
 void setEmailAddress(java.lang.String emailAddress)
          Set the value of emailAddress.
 void setInstitution(java.lang.String institution)
          Set the value of institution.
 void setMatchingCriteria(MatchingCriteria matchingCriteria)
          Set the value of matchingCriteria.
 void setMessage(java.lang.String message)
          Set the value of message.
 void setName(java.lang.String name)
          Set the value of name.
 void setRecordClassContext(java.lang.String recordClassContext)
          Set the value of the record class context.
 boolean supportsRecordClassName(java.lang.String recordClassName)
          determines if this alert applies to a given record type
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

Alert

public Alert()
Method Detail

supportsRecordClassName

public boolean supportsRecordClassName(java.lang.String recordClassName)
determines if this alert applies to a given record type

Parameters:
recordClassName - a record type defined in the data model

getBundleName

public java.lang.String getBundleName()
returns the Alert Bundle which contains this alert


getName

public java.lang.String getName()
Get the value of name.

Returns:
value of name.

getAlertType

public AlertActionType getAlertType()
Get the value of alertType.

Returns:
value of alertType.

getRecordClassContext

public java.lang.String getRecordClassContext()
Get the value of recordClassContext.

Returns:
value of recordClassContext.

getMessage

public java.lang.String getMessage()
Get the value of message.

Returns:
value of message.

getAuthor

public java.lang.String getAuthor()
Get the value of author.

Returns:
value of author.

getInstitution

public java.lang.String getInstitution()
Get the value of institution.

Returns:
value of institution.

getEmailAddress

public java.lang.String getEmailAddress()
Get the value of emailAddress.

Returns:
value of emailAddress.

getMatchingCriteria

public MatchingCriteria getMatchingCriteria()
Get the value of matchingCriteria.

Returns:
value of matchingCriteria.

matches

public boolean matches(RecordModel recordModel)

setBundleName

public void setBundleName(java.lang.String bundleName)

setName

public void setName(java.lang.String name)
Set the value of name.

Parameters:
name - Value to assign to name.

setRecordClassContext

public void setRecordClassContext(java.lang.String recordClassContext)
Set the value of the record class context. This value is usually the name of a record class name found in the XML Schema. However, it could also be a path into an XML document. for example, the value could be: "laboratory_result" or "patient_record\laboratory_result".

Parameters:
recordClassContext - Value to assign to recordType.

setAlertType

public void setAlertType(AlertActionType alertType)
Set the value of alertType.

Parameters:
alertType - Value to assign to alertType.

setMessage

public void setMessage(java.lang.String message)
Set the value of message.

Parameters:
message - Value to assign to message.

setAuthor

public void setAuthor(java.lang.String author)
Set the value of author.

Parameters:
author - Value to assign to author.

setInstitution

public void setInstitution(java.lang.String institution)
Set the value of institution.

Parameters:
institution - Value to assign to institution.

setEmailAddress

public void setEmailAddress(java.lang.String emailAddress)
Set the value of emailAddress.

Parameters:
emailAddress - Value to assign to emailAddress.

setMatchingCriteria

public void setMatchingCriteria(MatchingCriteria matchingCriteria)
Set the value of matchingCriteria.

Parameters:
matchingCriteria - Value to assign to matchingCriteria.