com.sap.netweaver.bc.uwl

Class UWLContext

java.lang.Object
  extended bycom.sap.netweaver.bc.uwl.UWLContext
All Implemented Interfaces:
Cloneable

public final class UWLContext
extends Object
implements Cloneable

The UWLContext class contains all the portal specific parameters like user, locale, PortalComponentRequest, ETC.


Constructor Summary
UWLContext()
          This is the default constructor.
 
Method Summary
 Object clone()
           
 String getAppContext()
           
 String getConfigurationGroup()
           
 Locale getLocale()
           
 IMonitor getMonitor()
           
 Object getOriginRequest()
           
 IUWLSession getSession()
          Returns the session.
 TimeZone getTimeZone()
           
 IUser getUser()
           
 String getUserId()
           
 String getUserName()
          Returns users login id
 boolean isBackEndConnectionsAllowed()
           
 void setAllowBackEndConnections(boolean b)
          set whether connections to the backend are okey or not.
 void setAppContext(String appContext)
           
 void setConfigurationGroup(String confGroup)
           
 void setLocale(Locale locale)
          Sets the locale.
 void setMonitor(IMonitor monitor)
           
 void setOriginRequest(Object portalRequest)
          Sets the portalRequest or HttpServletRequest.
 void setSession(IUWLSession session)
          Sets the session.
 void setUser(IUser user)
          Sets the user.
 
Methods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

UWLContext

public UWLContext()
This is the default constructor. This does not do anything!

Method Detail

getUser

public IUser getUser()
Returns:
IUser one of the portal parameters.

getLocale

public Locale getLocale()
Returns:
Locale the locale of the user.

getTimeZone

public TimeZone getTimeZone()
Returns:
gets TimeZone from the attached User

getOriginRequest

public Object getOriginRequest()
Returns:
Object the portal request.

setLocale

public void setLocale(Locale locale)
Sets the locale.

Parameters:
locale - The locale to set

setOriginRequest

public void setOriginRequest(Object portalRequest)
Sets the portalRequest or HttpServletRequest.

Parameters:
portalRequest - The portalRequest to set

setUser

public void setUser(IUser user)
Sets the user.

Parameters:
user - The user to set

getSession

public IUWLSession getSession()
Returns the session.

Returns:
IUWLSession

setSession

public void setSession(IUWLSession session)
Sets the session.

Parameters:
session - The session to set

getUserId

public String getUserId()
Returns:
String the user ID.

getUserName

public String getUserName()
Returns users login id

Returns:

getAppContext

public String getAppContext()
Returns:
String application context. This can be up to ten characters long. It works like the name space concept.

setAppContext

public void setAppContext(String appContext)
Parameters:
appContext - the application context.

getConfigurationGroup

public String getConfigurationGroup()
Returns:
String configuration group for this user context

setConfigurationGroup

public void setConfigurationGroup(String confGroup)
Parameters:
confGroup - - configuration group for this user context

getMonitor

public IMonitor getMonitor()
Returns:

setMonitor

public void setMonitor(IMonitor monitor)
Parameters:
monitor -

isBackEndConnectionsAllowed

public boolean isBackEndConnectionsAllowed()
Returns:
true if connections to back end are allowed by default true.

setAllowBackEndConnections

public void setAllowBackEndConnections(boolean b)
set whether connections to the backend are okey or not.

Parameters:
b -
See Also:
Item.isIncomplete()

clone

public Object clone()
             throws CloneNotSupportedException
Throws:
CloneNotSupportedException


Copyright 2006 SAP AG Complete Copyright Notice