org.jasig.portal
Class PortalEvent

java.lang.Object
  org.jasig.portal.PortalEvent

Deprecated. All IChannel implementations should be migrated to portlets

@Deprecated
public class PortalEvent
extends Object

Events which may be arguments to the IChannel receiveEvent() method.

Version:

$Revision: 19776 $ $Date: 2010-01-14 16:17:21 -0600 (Thu, 14 Jan 2010) $

Author:

Peter Kharchenko pkharchenko@interactivebusiness.com", andrew.petro@yale.edu

Field Summary

static PortalEvent	ABOUT_BUTTON Deprecated. The layout-generated event that is sent to a channel when the user actuates its about control.
static int	ABOUT_BUTTON_EVENT Deprecated.
static PortalEvent	DETACH_BUTTON Deprecated. The layout-generated event that is sent to a channel when the user actuates its detach control.
static int	DETACH_BUTTON_EVENT Deprecated.
static PortalEvent	EDIT_BUTTON Deprecated. The layout-generated event that is sent to a channel when the user actuates its edit control.
static int	EDIT_BUTTON_EVENT Deprecated.
static PortalEvent	HELP_BUTTON Deprecated. The layout-generated event that is sent to a channel when the user actuates its help control.
static int	HELP_BUTTON_EVENT Deprecated.
static PortalEvent	MAXIMIZE Deprecated. The layout-generated event that is sent to a channel when the user actuates its maximize control.
static int	MAXIMIZE_EVENT Deprecated.
static PortalEvent	MINIMIZE Deprecated. The layout-generated event that is sent to a channel when the user actuates its minimize control.
static int	MINIMIZE_EVENT Deprecated.
static PortalEvent	NORMAL Deprecated. The layout-generated event that is sent to a channel when the user actuates its maximize control.
static int	NORMAL_EVENT Deprecated.
static int	SESSION_DONE Deprecated.
static PortalEvent	SESSION_DONE_EVENT Deprecated. The framework-generated event that is broadcast to channels that were used for a user session which is now ending.
static int	UNSUBSCRIBE Deprecated.
static PortalEvent	UNSUBSCRIBE_EVENT Deprecated. The framework-generated event that is sent to a channel when the user unsubscribes from that channel.

Method Summary

boolean	equals(Object other) Deprecated. Two PortalEvents are equal if they have the same eventNumber.
String	getEventName() Deprecated. Get a String representing this event.
int	getEventNumber() Deprecated. Get an integer representing this event.
PortalEventSource	getSource() Deprecated. Get the source type of this event.
String	toString() Deprecated.

Methods inherited from class java.lang.Object

clone, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

SESSION_DONE

public static final int SESSION_DONE

Deprecated.

See Also:

Constant Field Values

UNSUBSCRIBE

public static final int UNSUBSCRIBE

Deprecated.

See Also:

Constant Field Values

EDIT_BUTTON_EVENT

public static final int EDIT_BUTTON_EVENT

Deprecated.

See Also:

Constant Field Values

HELP_BUTTON_EVENT

public static final int HELP_BUTTON_EVENT

Deprecated.

See Also:

Constant Field Values

ABOUT_BUTTON_EVENT

public static final int ABOUT_BUTTON_EVENT

Deprecated.

See Also:

Constant Field Values

DETACH_BUTTON_EVENT

public static final int DETACH_BUTTON_EVENT

Deprecated.

See Also:

Constant Field Values

MINIMIZE_EVENT

public static final int MINIMIZE_EVENT

Deprecated.

See Also:

Constant Field Values

MAXIMIZE_EVENT

public static final int MAXIMIZE_EVENT

Deprecated.

See Also:

Constant Field Values

NORMAL_EVENT

public static final int NORMAL_EVENT

Deprecated.

See Also:

Constant Field Values

SESSION_DONE_EVENT

public static final PortalEvent SESSION_DONE_EVENT

Deprecated.

The framework-generated event that is broadcast to channels that were used for a user session which is now ending. Typical usage is to trigger state cleanup in channels that are not user-session-scoped.

UNSUBSCRIBE_EVENT

public static final PortalEvent UNSUBSCRIBE_EVENT

Deprecated.

The framework-generated event that is sent to a channel when the user unsubscribes from that channel.

EDIT_BUTTON

public static final PortalEvent EDIT_BUTTON

Deprecated.

The layout-generated event that is sent to a channel when the user actuates its edit control.

HELP_BUTTON

public static final PortalEvent HELP_BUTTON

Deprecated.

The layout-generated event that is sent to a channel when the user actuates its help control.

ABOUT_BUTTON

public static final PortalEvent ABOUT_BUTTON

Deprecated.

The layout-generated event that is sent to a channel when the user actuates its about control.

DETACH_BUTTON

public static final PortalEvent DETACH_BUTTON

Deprecated.

The layout-generated event that is sent to a channel when the user actuates its detach control.

MINIMIZE

public static final PortalEvent MINIMIZE

Deprecated.

The layout-generated event that is sent to a channel when the user actuates its minimize control.

NORMAL

public static final PortalEvent NORMAL

Deprecated.

The layout-generated event that is sent to a channel when the user actuates its maximize control.

MAXIMIZE

public static final PortalEvent MAXIMIZE

Deprecated.

The layout-generated event that is sent to a channel when the user actuates its maximize control.

Method Detail

getEventName

public String getEventName()

Deprecated.

Get a String representing this event.

Returns:

a String representing this event.

getEventNumber

public int getEventNumber()

Deprecated.

Get an integer representing this event.

Returns:

an integer representing this event.

getSource

public PortalEventSource getSource()

Deprecated.

Get the source type of this event.

Returns:

the source type of this event.

equals

public boolean equals(Object other)

Deprecated.

Two PortalEvents are equal if they have the same eventNumber.

Overrides:

equals in class Object

Parameters:

other - - another object

Returns:

true if other is a PortalEvent with the same eventNumber, false otherwise

toString

public String toString()

Deprecated.

Overrides:

toString in class Object