com.sapportals.wcm.repository
Interface IResourceContext

public interface IResourceContext

The context that contains information for all repository operations belonging to one request, session, etc.

Version:

$Revision: #5 $

Field Summary

static java.lang.String

NO_KEYWORD_SUBSTITUTION

Method Summary

java.util.Locale	getLocale() Get the locale for that context.
java.lang.Object	getObjectValue(java.lang.String name) Returns the value for the specified name
com.sapportals.portal.security.usermanagement.IUser	getUser() Get the current user for that context.
java.lang.String	getValue(java.lang.String name) Returns the value for the specified name
java.util.HashMap	getValues() Returns the internal properties map as is without copying them to be used and possible modified from outside.
void	setLocale(java.util.Locale locale) Set the locale for that context.
void	setObjectValue(java.lang.String name, java.lang.Object value) Add/update a name/value pair
void	setUser(com.sapportals.portal.security.usermanagement.IUser user) Set the current user for that context.
void	setValue(java.lang.String name, java.lang.String value) Add/update a name/value pair
void	setValues(java.util.HashMap properties) Takes and sets the properties as is without copying them to be used and possibly modified as internal properties map.

Field Detail

NO_KEYWORD_SUBSTITUTION

public static final java.lang.String NO_KEYWORD_SUBSTITUTION

Method Detail

getLocale

public java.util.Locale getLocale()

Get the locale for that context.

Returns:

Locale the locale to use.

See Also:

Locale

getObjectValue

public java.lang.Object getObjectValue(java.lang.String name)

Returns the value for the specified name

Parameters:

name - TBD: Description of the incoming method parameter

Returns:

The result object or null if the name was not found

getUser

public com.sapportals.portal.security.usermanagement.IUser getUser()

Get the current user for that context.

Returns:

IUser the user.

getValue

public java.lang.String getValue(java.lang.String name)

Returns the value for the specified name

Parameters:

name - TBD: Description of the incoming method parameter

Returns:

The value or null if the name was not found

getValues

public java.util.HashMap getValues()

Returns the internal properties map as is without copying them to be used and possible modified from outside.

Returns:

properties

setLocale

public void setLocale(java.util.Locale locale)

Set the locale for that context.

Parameters:

locale - locale to be set

See Also:

Locale

setObjectValue

public void setObjectValue(java.lang.String name,
                           java.lang.Object value)
                    throws com.sapportals.wcm.repository.ResourceException

Add/update a name/value pair

Parameters:

name - A unique name

value - An object

Throws:

com.sapportals.wcm.repository.ResourceException - If the name paramater is invalid

setUser

public void setUser(com.sapportals.portal.security.usermanagement.IUser user)

Set the current user for that context.

Parameters:

user - user to be set

setValue

public void setValue(java.lang.String name,
                     java.lang.String value)
              throws com.sapportals.wcm.repository.ResourceException

Add/update a name/value pair

Parameters:

name - A unique name

value - The value

Throws:

com.sapportals.wcm.repository.ResourceException - If the name paramater is invalid

setValues

public void setValues(java.util.HashMap properties)

Takes and sets the properties as is without copying them to be used and possibly modified as internal properties map.

Parameters:

properties - properties