001/*
002 * CDDL HEADER START
003 *
004 * The contents of this file are subject to the terms of the
005 * Common Development and Distribution License, Version 1.0 only
006 * (the "License").  You may not use this file except in compliance
007 * with the License.
008 *
009 * You can obtain a copy of the license at
010 * docs/licenses/cddl.txt
011 * or http://www.opensource.org/licenses/cddl1.php.
012 * See the License for the specific language governing permissions
013 * and limitations under the License.
014 *
015 * When distributing Covered Code, include this CDDL HEADER in each
016 * file and include the License file at
017 * docs/licenses/cddl.txt.  If applicable,
018 * add the following below this CDDL HEADER, with the fields enclosed
019 * by brackets "[]" replaced with your own identifying information:
020 *      Portions Copyright [yyyy] [name of copyright owner]
021 *
022 * CDDL HEADER END
023 *
024 *
025 *      Copyright 2014-2021 Ping Identity Corporation
026 */
027package com.unboundid.directory.sdk.common.types;
028
029
030
031
032/**
033 * This interface may be used to interact with an alert type that may cause the
034 * server to be classified as unavailable.
035 */
036public interface UnavailableAlertType
037{
038  /**
039   * Retrieves the alert type name for this unavailable alert type.
040   *
041   * @return  The alert type name for this unavailable alert type.
042   */
043  String getAlertTypeName();
044
045
046
047  /**
048   * Retrieves the OID for this unavailable alert type.
049   *
050   * @return  The OID for this unavailable alert type.
051   */
052  String getAlertTypeOID();
053
054
055
056  /**
057   * Retrieves the severity for this unavailable alert type.
058   *
059   * @return  The severity for this unavailable alert type.
060   */
061  AlertSeverity getAlertSeverity();
062
063
064
065  /**
066   * Indicates that the condition that triggered this unavailable alert type has
067   * been resolved and should no longer cause the server to be considered
068   * unavailable.
069   */
070  void setResolved();
071}