uPortal 2.4.1
API Documentation

org.jasig.portal.channels.UserPreferences
Class CUserPreferences

java.lang.Object
  extended byorg.jasig.portal.channels.UserPreferences.CUserPreferences
All Implemented Interfaces:
IChannel, IPrivileged, IPrivilegedChannel

public class CUserPreferences
extends java.lang.Object
implements IPrivilegedChannel

CUserPreferences manages User Layout, user preferences and profiles.

Version:
$Revision: 1.42.2.1 $
Author:
Peter Kharchenko, pkharchenko@unicon.net, Ken Weiner, kweiner@unicon.net

Field Summary
static int MANAGE_PREFERENCES
           
static int MANAGE_PROFILES
           
 
Constructor Summary
CUserPreferences()
           
 
Method Summary
 ChannelRuntimeProperties getRuntimeProperties()
          Returns channel runtime properties
 void receiveEvent(PortalEvent ev)
          Processes layout-level events coming from the portal
 void renderXML(org.xml.sax.ContentHandler out)
          Output channel content to the portal
 void setPortalControlStructures(PortalControlStructures pcs)
          Passes portal control structure to the channel.
 void setRuntimeData(ChannelRuntimeData rd)
          CUserPreferences listens for an HttpRequestParameter "userPreferencesAction" and based on its value changes state between profile management and layout/stylesheet preferences.
 void setStaticData(ChannelStaticData sd)
          Receive static channel data from the portal
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

MANAGE_PREFERENCES

public static final int MANAGE_PREFERENCES
See Also:
Constant Field Values

MANAGE_PROFILES

public static final int MANAGE_PROFILES
See Also:
Constant Field Values
Constructor Detail

CUserPreferences

public CUserPreferences()
                 throws PortalException
Method Detail

setPortalControlStructures

public void setPortalControlStructures(PortalControlStructures pcs)
                                throws PortalException
Description copied from interface: IPrivileged
Passes portal control structure to the channel.

Specified by:
setPortalControlStructures in interface IPrivileged
Throws:
PortalException
See Also:
PortalControlStructures

getRuntimeProperties

public ChannelRuntimeProperties getRuntimeProperties()
Returns channel runtime properties

Specified by:
getRuntimeProperties in interface IChannel
Returns:
handle to runtime properties
See Also:
ChannelRuntimeProperties

receiveEvent

public void receiveEvent(PortalEvent ev)
Processes layout-level events coming from the portal

Specified by:
receiveEvent in interface IChannel
Parameters:
ev - a portal layout event
See Also:
PortalEvent

setStaticData

public void setStaticData(ChannelStaticData sd)
                   throws PortalException
Receive static channel data from the portal

Specified by:
setStaticData in interface IChannel
Parameters:
sd - static channel data
Throws:
PortalException
See Also:
ChannelStaticData

setRuntimeData

public void setRuntimeData(ChannelRuntimeData rd)
                    throws PortalException
CUserPreferences listens for an HttpRequestParameter "userPreferencesAction" and based on its value changes state between profile management and layout/stylesheet preferences.

Specified by:
setRuntimeData in interface IChannel
Parameters:
rd - handle to channel runtime data
Throws:
PortalException
See Also:
ChannelRuntimeData

renderXML

public void renderXML(org.xml.sax.ContentHandler out)
               throws PortalException
Output channel content to the portal

Specified by:
renderXML in interface IChannel
Parameters:
out - a sax document handler
Throws:
PortalException

uPortal 2.4.1
API Documentation