uPortal 2.4.1
API Documentation

org.jasig.portal.security
Interface IPerson

All Superinterfaces:
IAdditionalDescriptor, IBasicEntity, java.io.Serializable
All Known Implementing Classes:
PersonImpl, RestrictedPerson

public interface IPerson
extends IAdditionalDescriptor, IBasicEntity, java.io.Serializable

Version:
$Revision: 1.12 $
Author:
Bernie Durfee, bdurfee@interactivebusiness.com

Field Summary
static java.lang.String USERNAME
           
 
Method Summary
 java.lang.Object getAttribute(java.lang.String key)
          Gets an attribute associated with the user
 java.util.Enumeration getAttributeNames()
          Returns the names of all of the attributes stored for the user
 java.util.Enumeration getAttributes()
          Gets all of the attributes associated with the user
 java.lang.Object[] getAttributeValues(java.lang.String key)
          Gets multiple values of an attribute associated with the user
 java.lang.String getFullName()
          Gets the full name of the user
 int getID()
          Gets the ID of the user
 ISecurityContext getSecurityContext()
          Gets the security context object associated with the user
 boolean isGuest()
          Checks to see if this user is considered a guest
 void setAttribute(java.lang.String key, java.lang.Object value)
          Associates an attribute with the user
 void setFullName(java.lang.String sFullName)
          Sets the full name of the user
 void setID(int sID)
          Sets the ID of the user
 void setSecurityContext(ISecurityContext securityContext)
          Associates a security context object with the user
 
Methods inherited from interface org.jasig.portal.IBasicEntity
getEntityIdentifier
 

Field Detail

USERNAME

public static final java.lang.String USERNAME
See Also:
Constant Field Values
Method Detail

setID

public void setID(int sID)
Sets the ID of the user

Parameters:
sID -

getID

public int getID()
Gets the ID of the user

Returns:
ID of the user

setFullName

public void setFullName(java.lang.String sFullName)
Sets the full name of the user

Parameters:
sFullName -

getFullName

public java.lang.String getFullName()
Gets the full name of the user

Returns:
full name of the user

getAttribute

public java.lang.Object getAttribute(java.lang.String key)
Gets an attribute associated with the user

Parameters:
key -
Returns:
attribute associated with the user

getAttributeValues

public java.lang.Object[] getAttributeValues(java.lang.String key)
Gets multiple values of an attribute associated with the user

Parameters:
key -
Returns:
attributes associated with the user

setAttribute

public void setAttribute(java.lang.String key,
                         java.lang.Object value)
Associates an attribute with the user

Parameters:
key -
value -

getAttributes

public java.util.Enumeration getAttributes()
Gets all of the attributes associated with the user

Returns:
all of the attributes associated with the user

getAttributeNames

public java.util.Enumeration getAttributeNames()
Returns the names of all of the attributes stored for the user

Returns:
names of all of the attributes stored for the user

setSecurityContext

public void setSecurityContext(ISecurityContext securityContext)
Associates a security context object with the user

Parameters:
securityContext -

getSecurityContext

public ISecurityContext getSecurityContext()
Gets the security context object associated with the user

Returns:
security context object associated with the user

isGuest

public boolean isGuest()
Checks to see if this user is considered a guest

Returns:
true if user is considered a guest

uPortal 2.4.1
API Documentation