Overview | Package | Class | Use | Tree | Deprecated | Index | Help
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD

## org.jasig.portal
Class GuestUserPreferencesManagerWrapper

    java.lang.Object
      org.jasig.portal.GuestUserPreferencesManagerWrapper

All Implemented Interfaces:
  IUserPreferencesManager

    public class GuestUserPreferencesManagerWrapper

extends java.lang.Object
implements IUserPreferencesManager

A class that allows `GuestUserPreferencesManager` to be presented as `IUserpreferencesManager`.

Version:
  $Revision: 1.7 $
Author:
  Peter Kharchenko pkharchenko@interactivebusiness.com

Field Summary
`(package private) GuestUserPreferencesManager` | `gulm`
`(package private) java.lang.String` | `sessionId`

Constructor Summary
`GuestUserPreferencesManagerWrapper()`
`GuestUserPreferencesManagerWrapper(GuestUserPreferencesManager gulm, java.lang.String sessionId)` Creates a new `GuestUserpreferencesManagerWrapper` instance.

Method Summary
`void` | `finishedSession(javax.servlet.http.HttpSessionBindingEvent bindingEvent)`
`UserProfile` | `getCurrentProfile()` Returns current profile.
`IPerson` | `getPerson()` Returns current person object
`StructureStylesheetDescription` | `getStructureStylesheetDescription()` Returns current structure stylesheet description
`ThemeStylesheetDescription` | `getThemeStylesheetDescription()` Returns current theme stylesheet description
`IUserLayoutManager` | `getUserLayoutManager()` Returns `IUserLayoutManager` object for performing layout-related operations.
`UserPreferences` | `getUserPreferences()` Returns current user preferences.
`UserPreferences` | `getUserPreferencesCopy()` Returns a copy of the user preferences
`boolean` | `isUserAgentUnmapped()` Determine if the user agent associated with this session has been successfuly mapped to a profile
`void` | `processUserPreferencesParameters(javax.servlet.http.HttpServletRequest req)`
`void` | `setNewUserLayoutAndUserPreferences(IUserLayoutManager newLayout, UserPreferences newPreferences)`

Methods inherited from class java.lang.Object
`clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`

Field Detail

### sessionId

    java.lang.String sessionId

### gulm

    GuestUserPreferencesManager gulm

Constructor Detail

### GuestUserPreferencesManagerWrapper

    public GuestUserPreferencesManagerWrapper()

### GuestUserPreferencesManagerWrapper

    public GuestUserPreferencesManagerWrapper(GuestUserPreferencesManager gulm,
                                              java.lang.String sessionId)

  Creates a new `GuestUserpreferencesManagerWrapper` instance.

  Parameters:
    `gulm` - a `GuestUserpreferencesManager` value
    `sessionId` - a `String` value

Method Detail

### processUserPreferencesParameters

    public void processUserPreferencesParameters(javax.servlet.http.HttpServletRequest req)

  Specified by:
    `processUserPreferencesParameters` in interface `IUserPreferencesManager`

### getPerson

    public IPerson getPerson()

  Returns current person object

  Specified by:
    `getPerson` in interface `IUserPreferencesManager`
  Returns:
    current `IPerson`

### isUserAgentUnmapped

    public boolean isUserAgentUnmapped()

  Determine if the user agent associated with this session has been successfuly mapped to a profile

  Specified by:
    `isUserAgentUnmapped` in interface `IUserPreferencesManager`
  Returns:
    `true` if no mapping was found

### setNewUserLayoutAndUserPreferences

    public void setNewUserLayoutAndUserPreferences(IUserLayoutManager newLayout,
                                                   UserPreferences newPreferences)
                                            throws PortalException

  Specified by:
    `setNewUserLayoutAndUserPreferences` in interface `IUserPreferencesManager`
  Throws:
    `PortalException`

### getUserPreferencesCopy

    public UserPreferences getUserPreferencesCopy()

  Returns a copy of the user preferences

  Specified by:
    `getUserPreferencesCopy` in interface `IUserPreferencesManager`
  Returns:
    a copy of the `UserPreferences` object

### getCurrentProfile

    public UserProfile getCurrentProfile()

  Returns current profile.

  Specified by:
    `getCurrentProfile` in interface `IUserPreferencesManager`
  Returns:
    current `UserProfile`

### getThemeStylesheetDescription

    public ThemeStylesheetDescription getThemeStylesheetDescription()
                                                             throws java.lang.Exception

  Returns current theme stylesheet description

  Specified by:
    `getThemeStylesheetDescription` in interface `IUserPreferencesManager`
  Returns:
    current `ThemeStylesheetDescription`
  Throws:
    `java.lang.Exception`

### getStructureStylesheetDescription

    public StructureStylesheetDescription getStructureStylesheetDescription()
                                                                     throws java.lang.Exception

  Returns current structure stylesheet description

  Specified by:
    `getStructureStylesheetDescription` in interface `IUserPreferencesManager`
  Returns:
    current `StructureStylesheetDescription`
  Throws:
    `java.lang.Exception`

### getUserLayoutManager

    public IUserLayoutManager getUserLayoutManager()

  Description copied from interface: `IUserPreferencesManager`
  Returns `IUserLayoutManager` object for performing layout-related operations.

  Specified by:
    `getUserLayoutManager` in interface `IUserPreferencesManager`
  Returns:
    an `IUserLayoutManager` value

### getUserPreferences

    public UserPreferences getUserPreferences()

  Returns current user preferences.

  Specified by:
    `getUserPreferences` in interface `IUserPreferencesManager`
  Returns:
    current `UserPreferences`

### finishedSession

    public void finishedSession(javax.servlet.http.HttpSessionBindingEvent bindingEvent)

  Specified by:
    `finishedSession` in interface `IUserPreferencesManager`

Overview | Package | Class | Use | Tree | Deprecated | Index | Help
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD