/**
* Insert other messages
*
* @param session - the Equation standard session
* @param screenSetId - screen set Id
* @param scrnNo - the screen number
* @param fieldName - the field name
* @param sequence - sequence
* @param fieldData - the field data
* @param messageText - the message text in DSEPMS format
* @param firstLevelText - text to be appended to the start of messageText
* @param secondLevelText - text to be appended to the end of messageText
* @return the message severity
* @throws EQException
*/
public int insertOtherMessage(
EquationStandardSession session,
int screenSetId,
int scrnNo,
String fieldName,
int sequence,
FieldData fieldData,
String messageText,
String firstLevelText,
String secondLevelText)
throws EQException {
// retrieve the message
EQMessage eqMessage = session.getMessage(messageText);
// add the message
otherMessages.insertMessage(
screenSetId, scrnNo, fieldName, sequence, eqMessage, firstLevelText, secondLevelText);
// add the error message to the field
if (fieldData != null) {
fieldData
.getFunctionMessages()
.insertMessage(
screenSetId, scrnNo, fieldName, sequence, eqMessage, firstLevelText, secondLevelText);
}
return otherMessages.getMsgSev();
}
/**
* Insert messages to the other messages
*
* @param screenSetId - screen set id
* @param scrnNo - screen no
* @param ksmId - KSM id
* @param msgSev - message severity
* @param msgText - message text
* @param firstLevelText - text to be appended to the start of messageText
* @param secondLevelText - text to be appended to the end of messageText
* @return
*/
public int insertOtherMessage(
int screenSetId,
int scrnNo,
String ksmId,
String msgSev,
String msgText,
String firstLevelText,
String secondLevelText) {
EQMessage eqMessage = new EQMessage(ksmId, msgSev, msgText, "");
otherMessages.insertMessage(
screenSetId, scrnNo, "", 1, eqMessage, firstLevelText, secondLevelText);
return Toolbox.parseInt(msgSev, FunctionMessages.MSG_ERROR);
}
/**
* Generate a message only if the message has not been overridden and has the same severity or
* worse than the existing messages
*
* @param fms - function messages to add the the new message
* @param screenSetId - screen set Id
* @param scrnNo - the screen where the message occurred
* @param fieldName - the field that generated the message
* @param sequence - sequence number
* @param fieldData - the field data
* @param eqMessage - the Equation message
* @param firstLevelText - text to be appended to the start of messageText
* @param secondLevelText - text to be appended to the end of messageText
* @param ignoreMessages - the message severity to ignore. All equal/lower message severity will
* be ignored
* @return the function message added
*/
public FunctionMessage generateMessage(
FunctionMessages fms,
int screenSetId,
int scrnNo,
String fieldName,
int sequence,
FieldData fieldData,
EQMessage eqMessage,
String firstLevelText,
String secondLevelText,
int ignoreMessages) {
// message to be ignored?
if (Toolbox.parseInt(eqMessage.getSeverity(), FunctionMessages.MSG_ERROR) <= ignoreMessages) {
return null;
}
// is the message already existing?
eqMessage = chkMessage(screenSetId, scrnNo, fieldName, sequence, fieldData, eqMessage);
if (eqMessage == null) {
return null;
}
// is the message already exists in the list?
if (fms.chkMessageExists(screenSetId, scrnNo, fieldName, sequence, eqMessage.getDsepms())) {
return null;
}
// add the message
FunctionMessage fm =
fms.insertMessage(
screenSetId, scrnNo, fieldName, sequence, eqMessage, firstLevelText, secondLevelText);
if (fm == null) {
return null;
}
// add the error message to the field
if (fieldData != null) {
fieldData
.getFunctionMessages()
.insertMessage(
screenSetId, scrnNo, fieldName, sequence, eqMessage, firstLevelText, secondLevelText);
}
// message severity
return fm;
}
/**
* Override the first warning
*
* @param authorisor - the supervisor id who has overriden the warning
* @return true - if warning has been overridden
*/
public boolean overrideFirstWarning(String authorisor) {
// ensure there are message to be overridden
if (functionMessages.getMessages().size() <= 0
|| functionMessages.getMsgSev() != FunctionMessages.MSG_WARN) {
return false;
}
FunctionMessage fm = functionMessages.getMessages().get(0);
FunctionMessage fm2 =
overWarnMessages.insertMessage(
fm.getScreenSetId(),
fm.getScrnNo(),
fm.getFieldName(),
fm.getSequence(),
fm.getEqMessage(),
fm.getFirstLevelText(),
fm.getSecondLevelText());
fm2.setAuthorisor(authorisor);
return true;
}