org.openwms.tms.TransportServiceEvent.java Source code

Introduction

Here is the source code for org.openwms.tms.TransportServiceEvent.java

Source

/*
 * openwms.org, the Open Warehouse Management System.
 * Copyright (C) 2014 Heiko Scherrer
 *
 * This file is part of openwms.org.
 *
 * openwms.org 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 2 of the
 * License, or (at your option) any later version.
 *
 * openwms.org 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 this software. If not, write to the Free Software
 * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
 * 02110-1301 USA, or see the FSF site: http://www.fsf.org.
 */
package org.openwms.tms;

import java.io.Serializable;

import org.springframework.context.ApplicationEvent;

/**
 * A TransportServiceEvent.
 *
 * @author <a href="mailto:russelltina@users.sourceforge.net">Tina Russell</a>
 * @since 1.0
 */
public final class TransportServiceEvent<T extends TransportServiceEvent.TYPE> extends ApplicationEvent
        implements Serializable {

    private TYPE type;

    /**
     * All possible types of this event.
     *
     * @author <a href="mailto:russelltina@users.sourceforge.net">Tina Russell</a>
     * @since 0.1
     */
    public enum TYPE {

        /** A TransportOrder has been created. */
        TRANSPORT_CREATED,

        /** TransportOrder has been initialized. */
        INITIALIZED,

        /** TransportOrder has been started. */
        STARTED,

        /** A TransportOrder was interrupted. */
        TRANSPORT_INTERRUPTED,

        /** A TransportOrder was set on failure. */
        TRANSPORT_ONFAILURE,

        /** A TransportOrder was canceled. */
        TRANSPORT_CANCELED,

        /** A TransportOrder was finished. */
        TRANSPORT_FINISHED
    }

    /**
     * Create a new RootApplicationEvent.
     *
     * @param source Event source
     */
    public TransportServiceEvent(Object source) {
        super(source);
    }

    /**
     * Create a new TransportServiceEvent.
     *
     * @param source Event source
     * @param type Event type
     */
    public TransportServiceEvent(Object source, TYPE type) {
        super(source);
        this.type = type;
    }

    /**
     * Return the type of event.
     *
     * @return The event type
     */
    public TYPE getType() {
        return type;
    }
}