com.sap.netweaver.bc.rf.common.context
Interface IAccessContext

[contained in: com.sap.netweaver.bc.rf.par - bc.rf.common_api.jar]

All Known Implementing Classes:

AccessContext

public interface IAccessContext

Interface describing the access context information the system needs to know, when working on resources.

Method Summary

IAccessContext	cloneContext() Clone access context.
long	getAllowedStaleDataTimespan() Get time the repository data may not be older than.
java.lang.Object	getClientDefinedProperty(java.lang.String name) Get a client defined property from the context.
java.lang.String	getClientId() Get id of the current client operating on the resouce.
java.util.Locale	getLocale() Get locale of the current user.
com.sap.netweaver.bc.rf.common.context.IUser	getUser() Get current user operating on the resouce.
void	setAllowedStaleDataTimespan(long allowedStaleDataTimespan) Set time the repository data may not be older than.
void	setClientDefinedProperty(java.lang.String name, java.lang.Object value) Set a client defined property in the context.
void	setClientId(java.lang.String clientId) Set id of the current client operating on the resouce.
void	setLocale(java.util.Locale locale) Set locale of the current user.
void	setUser(com.sap.netweaver.bc.rf.common.context.IUser user) Set current user operating on the resouce.

Method Detail

getClientId

public java.lang.String getClientId()

Get id of the current client operating on the resouce.

Returns:

id of the current client operating on the resouce

setClientId

public void setClientId(java.lang.String clientId)

Set id of the current client operating on the resouce.

Parameters:

clientId - id of the current client operating on the resouce

getUser

public com.sap.netweaver.bc.rf.common.context.IUser getUser()

Get current user operating on the resouce.

Returns:

current user operating on the resouce

setUser

public void setUser(com.sap.netweaver.bc.rf.common.context.IUser user)

Set current user operating on the resouce.

Parameters:

user - current user operating on the resouce

getLocale

public java.util.Locale getLocale()

Get locale of the current user.

Returns:

locale of the current user

setLocale

public void setLocale(java.util.Locale locale)

Set locale of the current user.

Parameters:

locale - locale of the current user

getAllowedStaleDataTimespan

public long getAllowedStaleDataTimespan()

Get time the repository data may not be older than.

Returns:

time the repository data may not be older than

setAllowedStaleDataTimespan

public void setAllowedStaleDataTimespan(long allowedStaleDataTimespan)

Set time the repository data may not be older than.

Parameters:

allowedStaleDataTimespan - The new allowedStaleDataTimespan value

getClientDefinedProperty

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

Get a client defined property from the context.

Parameters:

name - name of the client defined property

Returns:

value of the client defined property

setClientDefinedProperty

public void setClientDefinedProperty(java.lang.String name,
                                     java.lang.Object value)
                              throws RepositoryException

Set a client defined property in the context.

Parameters:

name - name of the client defined property

value - value of the client defined property

Throws:

RepositoryException - Exception raised in failure situation

cloneContext

public IAccessContext cloneContext()

Clone access context.

Returns:

cloned access context