planetj.dataengine.security
Interface IUser

All Superinterfaces:

java.security.Principal

All Known Subinterfaces:

IDEUser

All Known Implementing Classes:

DEUser, SignOnReceipt

public interface IUser

extends java.security.Principal

Method Summary

java.lang.Object	getDisplayValueByUsageId(int usageId) Get a display value from this user for the given usage id.
java.lang.String	getFirstName() Gets the name for this user, which should uniquely identify the user in the current context.
java.lang.String	getLastName() Gets the name for this user, which should uniquely identify the user in the current context.
int	getOwnerId()
Row	getPropertiesRow() Get a Row containing properties for the current user.
java.util.Map	getReplacementLibraries()
int	getSecurityLevel()
java.lang.String	getSystemAlias() Gets the system alias of this user's personal connection pool, or null if no such pool exists
int	getThemeId() Get the id of the theme for this user
java.lang.Object	getUserDisplayValue(java.lang.String key) Gets the display value from the user for the specified key
java.lang.String	getUserMode() Gets the MODE of the user.
java.lang.String	getUserName() Gets the name for this user, which should uniquely identify the user in the current context.
java.lang.Object	getUserSQLValue(java.lang.String key) Gets the value of the specified user field as an Object for use as an SQL parameter
java.lang.Object	getUserValue(java.lang.String key) Gets the value of the specified user field as an Object
java.lang.Object	getValueByUsageId(int usageId) Get a value from this user for the given usage id.
boolean	hasSecurityLevel() Method that can be used to determine if the user has a security level.
boolean	isAdmin()
boolean	isPJAdmin() Check to see if this user is a PlanetJ Administrator.
void	setPropertiesRow(Row row) Set the given Row as the user's properties Row.
void	setUserMode(java.lang.String pMode) Sets the MODE of this user
void	setUserValue(java.lang.String key, java.lang.Object value) sets the value of the specified user field as an Object

Methods inherited from interface java.security.Principal

equals, getName, hashCode, toString

Method Detail

getDisplayValueByUsageId

public java.lang.Object getDisplayValueByUsageId(int usageId)
                                          throws CMException

Get a display value from this user for the given usage id.

Throws:

CMException

getFirstName

public java.lang.String getFirstName()

Gets the name for this user, which should uniquely identify the user in the current context.

getLastName

public java.lang.String getLastName()

Gets the name for this user, which should uniquely identify the user in the current context.

getOwnerId

public int getOwnerId()

getPropertiesRow

public Row getPropertiesRow()

Get a Row containing properties for the current user.

Returns:

getReplacementLibraries

public java.util.Map getReplacementLibraries()

getSecurityLevel

public int getSecurityLevel()

getUserMode

public java.lang.String getUserMode()

Gets the MODE of the user. This has to do with usability. NOVICE, ADVANCED

getThemeId

public int getThemeId()

Get the id of the theme for this user

getUserDisplayValue

public java.lang.Object getUserDisplayValue(java.lang.String key)

Gets the display value from the user for the specified key

getUserName

public java.lang.String getUserName()

Gets the name for this user, which should uniquely identify the user in the current context.

getUserSQLValue

public java.lang.Object getUserSQLValue(java.lang.String key)
                                 throws CMException

Gets the value of the specified user field as an Object for use as an SQL parameter

Throws:

CMException

getUserValue

public java.lang.Object getUserValue(java.lang.String key)

Gets the value of the specified user field as an Object

getValueByUsageId

public java.lang.Object getValueByUsageId(int usageId)
                                   throws CMException

Get a value from this user for the given usage id.

Throws:

CMException

isAdmin

public boolean isAdmin()

isPJAdmin

public boolean isPJAdmin()

Check to see if this user is a PlanetJ Administrator.

Returns:

setPropertiesRow

public void setPropertiesRow(Row row)

Set the given Row as the user's properties Row.

Parameters:

row -

getSystemAlias

public java.lang.String getSystemAlias()

Gets the system alias of this user's personal connection pool, or null if no such pool exists

hasSecurityLevel

public boolean hasSecurityLevel()

Method that can be used to determine if the user has a security level.

Returns:

true if the user has a security level; false otherwise

setUserMode

public void setUserMode(java.lang.String pMode)

Sets the MODE of this user

setUserValue

public void setUserValue(java.lang.String key,
                         java.lang.Object value)
                  throws CMException

sets the value of the specified user field as an Object

Throws:

CMException