com.sap.workspaces.module

Interface IModuleContext

public interface IModuleContext

Represents the runtime context associated with a specific module instance

Method Summary

Locale	getLocale() Returns the locale associated with the current request or user
IModuleID	getModuleID() Returns the identifier of the module instance with which the context is associated
IModuleRuntimeInfo	getModuleRuntimeInfo() Returns the runtime information of the module instance
String	getProperty(String propertyID) Returns the value of the specified configuration property, or null, if this property is not defined
String	getPropertyAttribute(String propertyID, String attributeID) Returns the value of the specified attribute or null if this attribute is not defined
String[]	getPropertyAttributeIDs(String propertyID) Returns an array of all attributes of the property
String[]	getPropertyIDs() Returns an array of all property IDs
com.sap.security.api.IUser	getUser() Returns the current user

Method Detail

getUser

com.sap.security.api.IUser getUser()

Returns the current user

Returns:

The current user

getLocale

Locale getLocale()

Returns the locale associated with the current request or user

Returns:

The Locale of the current request or user

getModuleID

IModuleID getModuleID()

Returns the identifier of the module instance with which the context is associated

Returns:

The identifier of the module instance

getModuleRuntimeInfo

IModuleRuntimeInfo getModuleRuntimeInfo()

Returns the runtime information of the module instance

Returns:

The runtime information of the module instance

getProperty

String getProperty(String propertyID)

Returns the value of the specified configuration property, or null, if this property is not defined

Parameters:

propertyID - the ID of the configuration property

Returns:

The string value of the configuration property or null

getPropertyAttribute

String getPropertyAttribute(String propertyID,
                            String attributeID)

Returns the value of the specified attribute or null if this attribute is not defined

Parameters:

propertyID - the ID of the configuration property

attributeID - the ID of the attribute

Returns:

value of the specified attribute, or null, if this attribute is not defined

getPropertyIDs

String[] getPropertyIDs()

Returns an array of all property IDs

Returns:

An array of all configuration property IDs

getPropertyAttributeIDs

String[] getPropertyAttributeIDs(String propertyID)

Returns an array of all attributes of the property

Parameters:

propertyID - the ID of the configuration property

Returns:

An array of all attribute IDs of the configuration property