org.opennms.integration.api.v1.ticketing.Ticket Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of api Show documentation
The newest version!
/*******************************************************************************
 * This file is part of OpenNMS(R).
 *
 * Copyright (C) 2019 The OpenNMS Group, Inc.
 * OpenNMS(R) is Copyright (C) 1999-2019 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 Affero 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 Affero General Public License for more details.
 *
 * You should have received a copy of the GNU Affero General Public License
 * along with OpenNMS(R).  If not, see:
 *      http://www.gnu.org/licenses/
 *
 * For more information contact:
 *     OpenNMS(R) Licensing 
 *     http://www.opennms.org/
 *     http://www.opennms.com/
 *******************************************************************************/

package org.opennms.integration.api.v1.ticketing;

import java.net.InetAddress;
import java.util.Map;

import org.opennms.integration.api.v1.annotations.Model;

/**
 * Encapsulates Ticket fields that may be set by OpenNMS or the registered @{@link TicketingPlugin} implementation.
 * 
 * @see "The provided model implementation can be found in the class ImmutableTicket"
 * @since 1.0.0
 */
@Model
public interface Ticket {

    enum State {
        /**
         * Ticket is considered to be in an Open State.
         */
        OPEN,
        /**
         * Ticket is considered to be in a Canceled State.
         */
        CANCELLED,
        /**
         * Ticket is considered to be in an Closed State.
         */
        CLOSED
    }

    Integer getAlarmId();

    Map getAttributes();

    String getDetails();

    String getId();

    InetAddress getIpAddress();

    Integer getNodeId();

    State getState();

    String getSummary();

    String getUser();


}