ModeEvent.java

package com.esri.geoevent.solutions.transport.irc.jerklib.events.modes;


import java.util.List;

import com.esri.geoevent.solutions.transport.irc.jerklib.Channel;
import com.esri.geoevent.solutions.transport.irc.jerklib.events.IRCEvent;

/**
 * Event fired when mode changes for us(UserMode) or Channel(ChannelMode)
 *  
 * @author mohadib
 */
public interface ModeEvent extends IRCEvent
{
		enum ModeType
		{
			USER,
			CHANNEL
		}
		
		
		/**
		 * Indicates if this is a user mode or channel mode event
		 * @return the ModeType 
		 */
		public ModeType getModeType();

    /**
     * Gets the list of mode adjustments generated 
     * @return List of mode adjustments
     */
    public List<ModeAdjustment> getModeAdjustments();

    /**
     * Gets who set the mode
     *
     * @return who set the mode
     */
    public String setBy();


    /**
     * If mode event adjusted a Channel mode
     * then the Channel effected will be returned
     *
     * @return Channel
     * @see Channel
     */
    public Channel getChannel();
}