/*******************************************************************************
* This file is part of OpenNMS(R).
*
* Copyright (C) 2009-2011 The OpenNMS Group, Inc.
* OpenNMS(R) is Copyright (C) 1999-2011 The OpenNMS Group, Inc.
*
* OpenNMS(R) is a registered trademark of The OpenNMS Group, Inc.
*
* OpenNMS(R) is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published
* by the Free Software Foundation, either version 3 of the License,
* or (at your option) any later version.
*
* OpenNMS(R) is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with OpenNMS(R). If not, see:
* http://www.gnu.org/licenses/
*
* For more information contact:
* OpenNMS(R) Licensing <license@opennms.org>
* http://www.opennms.org/
* http://www.opennms.com/
*******************************************************************************/
package org.opennms.web.notification;
import java.util.HashMap;
import java.util.Map;
import org.springframework.util.Assert;
/**
* Convenience class to determine what sort of notices to include in a
* query.
*
* @author ranger
* @version $Id: $
* @since 1.8.1
*/
public enum AcknowledgeType {
ACKNOWLEDGED("ack"), UNACKNOWLEDGED("unack"), BOTH("both");
/** Constant <code>s_ackTypesString</code> */
private static final Map<String, AcknowledgeType> s_ackTypesString;
private String m_shortName;
static {
s_ackTypesString = new HashMap<String, AcknowledgeType>();
for (AcknowledgeType ackType : AcknowledgeType.values()) {
s_ackTypesString.put(ackType.getShortName(), ackType);
}
}
private AcknowledgeType(String shortName) {
m_shortName = shortName;
}
/**
* <p>toString</p>
*
* @return a {@link java.lang.String} object.
*/
public String toString() {
return "AcknowledgeType." + getName();
}
/**
* <p>getName</p>
*
* @return a {@link java.lang.String} object.
*/
public String getName() {
return name();
}
/**
* <p>getShortName</p>
*
* @return a {@link java.lang.String} object.
*/
public String getShortName() {
return m_shortName;
}
/**
* Convenience method for getting the SQL <em>ORDER BY</em> clause related
* this sort style.
*
* @return a {@link java.lang.String} object.
*/
protected String getAcknowledgeTypeClause() {
switch (this) {
case ACKNOWLEDGED:
return " RESPONDTIME IS NOT NULL";
case UNACKNOWLEDGED:
return " RESPONDTIME IS NULL";
case BOTH:
return " (RESPONDTIME IS NULL OR RESPONDTIME IS NOT NULL)";
default:
throw new IllegalArgumentException("Cannot get clause for AcknowledgeType " + this);
}
}
/**
* <p>getAcknowledgeType</p>
*
* @param ackTypeString a {@link java.lang.String} object.
* @return a {@link org.opennms.web.notification.AcknowledgeType} object.
*/
public static AcknowledgeType getAcknowledgeType(String ackTypeString) {
Assert.notNull(ackTypeString, "Cannot take null parameters.");
return s_ackTypesString.get(ackTypeString.toLowerCase());
}
}