|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object blackboard.data.BbObject blackboard.data.user.UserInfo blackboard.data.user.User
public class User
0
The User
class is a representation of a user within the Bb
Course Management System.
Nested Class Summary | |
---|---|
static class |
User.EducationLevel
Enumeration to capture standard education level. |
static class |
User.Gender
Enumeration for reflecting user's gender |
static class |
User.InstRole
Deprecated. |
static class |
User.SystemRole
An enumeration for System Roles assigned to users in the system. |
Field Summary | |
---|---|
protected AttributePermission |
_getAuthInfo
|
protected AttributePermission |
_getCardNumber
|
protected AttributePermission |
_setAuthInfo
|
protected AttributePermission |
_setCardNumber
|
static DataType |
DATA_TYPE
Object data type constant, used in finding loaders and persisters |
static DataType |
USER_DATA_TYPE
Deprecated. Use the constant DATA_TYPE instead |
Fields inherited from class blackboard.data.user.UserInfo |
---|
_getPersonalInfo, _setPersonalInfo |
Fields inherited from class blackboard.data.BbObject |
---|
_bbAttributes |
Constructor Summary | |
---|---|
User()
Creates an instance of User with default property values. |
Method Summary | |
---|---|
java.lang.String |
getBatchUid()
Returns the batch uid associated with this User . |
java.util.Calendar |
getBirthDate()
Returns the birth date of this User . |
java.lang.String |
getCardNumber()
Returns a String representing the encrypted BbCard number for this User . |
java.lang.String |
getCDRomDriveMac()
Returns the CDRomDriveMac of this User object. |
java.lang.String |
getCDRomDrivePC()
Returns the CDRomDrivePC of this User object. |
Id |
getDataSourceId()
Returns the data source Id of this User . |
DataType |
getDataType()
Returns the DataType identifier for this object. |
Id |
getDomainId()
Deprecated. This field no longer exists as of Bb6 and should not be used. |
User.EducationLevel |
getEducationLevel()
Returns the education level of this User object
Requires AttributePermission with name "user.personalinfo", actions "get". |
User.Gender |
getGender()
Returns the gender of this User object. |
User.InstRole |
getInstitutionRole()
Deprecated. Use getPortalRoleId() instead |
boolean |
getIsAvailable()
Returns the availability flag for this User . |
boolean |
getIsInfoPublic()
Returns the is info public flag for this User . |
java.util.Calendar |
getLastLoginDate()
Returns the last login date of this User . |
java.lang.String |
getLocale()
Returns the locale of this User object. |
java.lang.String |
getPassword()
Returns the password of this User object. |
PortalRole |
getPortalRole()
Returns the PortalRole object, representing the primary institution role associated with this User . |
Id |
getPortalRoleId()
Returns the primary institution role Id of this User . |
Registry |
getRegistry()
Returns the Registry associated with this User . |
java.lang.String |
getSettings()
Returns the settings of this User object. |
boolean |
getShowAddContactInfo()
Returns the show additional contact info flag for this User . |
boolean |
getShowAddressInfo()
Returns the show address info flag for this User . |
boolean |
getShowEmailInfo()
Returns the show email flag for this User . |
boolean |
getShowWorkInfo()
Returns the show work info flag for this User . |
java.lang.String |
getStudentId()
Returns the student id of this User object
Requires AttributePermission with name "user.personalinfo", actions "get". |
User.SystemRole |
getSystemRole()
Returns the system role (the administrative user role in the gui) for this User . |
java.lang.String |
getUserName()
Returns the username of this User object. |
void |
setBatchUid(java.lang.String strBatchUid)
Sets the batch uid associated with this User . |
void |
setBirthDate(java.util.Calendar cBirthDate)
Sets the birth date for this User . |
void |
setCardNumber(java.lang.String cardNumber)
Sets the String representing the encrypted BbCard number for this User . |
void |
setCDRomDriveMac(java.lang.String strCDRomDriveMac)
Sets the CDRomDriveMac value for this User object. |
void |
setCDRomDrivePC(java.lang.String strCDRomDrivePC)
Sets the CDRomDrivePC value for this User object. |
void |
setDataSourceId(Id iDataSourceId)
Sets the data source Id value for this User . |
void |
setDomainId(Id iDomainId)
Deprecated. This field no longer exists as of Bb6 and should not be used. |
void |
setEducationLevel(User.EducationLevel eEducationLevel)
Sets the education level value for this User object
Requires AttributePermission with name "user.personalinfo", actions "set". |
void |
setGender(User.Gender eGender)
Sets the gender value for this User object. |
void |
setInstitutionRole(User.InstRole eInstRole)
Deprecated. Use setPortalRoleId(Id portalRoleId) instead |
void |
setIsAvailable(boolean bIsAvailable)
Sets the availability flag for this User . |
void |
setIsInfoPublic(boolean bIsInfoPublic)
Sets the is info public flag for this User . |
void |
setLastLoginDate(java.util.Calendar cLastLoginDate)
Sets the last login date for this User . |
void |
setLocale(java.lang.String strLocale)
Sets the locale value for this User object. |
void |
setPassword(java.lang.String strPassword)
Sets the password value for this User object. |
void |
setPortalRole(PortalRole role)
Sets the PortalRole object, representing the primary institution role associated with this User . |
void |
setPortalRoleId(Id iPortalRoleId)
Sets the primary institution role Id value for this User . |
void |
setRegistry(Registry reg)
Sets the Registry associated with this User . |
void |
setSettings(java.lang.String strSettings)
Sets the settings value for this User object. |
void |
setShowAddContactInfo(boolean bShowAddContactInfo)
Sets the show additional contact infor flag for this User . |
void |
setShowAddressInfo(boolean bShowAddressInfo)
Sets the show address info flag for this User . |
void |
setShowEmailInfo(boolean bShowEmailInfo)
Sets the show email flag for this User . |
void |
setShowWorkInfo(boolean bShowWorkInfo)
Sets the availability flag for this User . |
void |
setStudentId(java.lang.String strStudentId)
Sets the student id value for this User object. |
void |
setSystemRole(User.SystemRole eSystemRole)
Sets the system role (the administrative user role in the gui) for this User . |
void |
setUserName(java.lang.String strUserName)
Sets the username value for this User object. |
Methods inherited from class blackboard.data.user.UserInfo |
---|
getBusinessFax, getBusinessPhone1, getBusinessPhone2, getCity, getCompany, getCountry, getDepartment, getEmailAddress, getFamilyName, getGivenName, getHomeFax, getHomePhone1, getHomePhone2, getJobTitle, getMiddleName, getMobilePhone, getState, getStreet1, getStreet2, getTitle, getWebPage, getZipCode, setBusinessFax, setBusinessPhone1, setBusinessPhone2, setCity, setCompany, setCountry, setDepartment, setEmailAddress, setFamilyName, setGivenName, setHomeFax, setHomePhone1, setHomePhone2, setJobTitle, setMiddleName, setMobilePhone, setState, setStreet1, setStreet2, setTitle, setWebPage, setZipCode |
Methods inherited from class blackboard.data.BbObject |
---|
clone, getBbAttributes, getCreatedDate, getId, getModifiedDate, persist, setCreatedDate, setId, setModifiedDate, toString, validate |
Methods inherited from class java.lang.Object |
---|
equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Field Detail |
---|
public static final DataType DATA_TYPE
public static final DataType USER_DATA_TYPE
DATA_TYPE
insteadprotected AttributePermission _getAuthInfo
protected AttributePermission _setAuthInfo
protected AttributePermission _getCardNumber
protected AttributePermission _setCardNumber
Constructor Detail |
---|
public User()
User
with default property values.
Method Detail |
---|
public Id getDataSourceId()
Id
of this User
. Requires
AttributePermission with name "user.personalinfo", actions "get".
Id
value for this userpublic void setDataSourceId(Id iDataSourceId)
Id
value for this User
. Requires
AttributePermission with name "user.personalinfo", actions "set".
iDataSourceId
- a data source Id
value to use for this userpublic Id getDomainId()
public void setDomainId(Id iDomainId)
public User.InstRole getInstitutionRole()
User
. Requires
AttributePermission with name "user.personalinfo", actions "get".
User.InstRole
User.InstRole
public void setInstitutionRole(User.InstRole eInstRole)
User
. Requires
AttributePermission with name "user.personalinfo", actions "set".
eInstRole
- a valid role value as defined in User.InstRole
User.InstRole
public Id getPortalRoleId()
Id
of this User
. Requires
AttributePermission with name "user.personalinfo", actions "get".
Id
value for this userpublic void setPortalRoleId(Id iPortalRoleId)
Id
value for this User
. Requires
AttributePermission with name "user.personalinfo", actions "set".
iPortalRoleId
- a PortalRole Id
value to use for this userpublic java.lang.String getBatchUid()
User
. The batch
uid value is used by the integration component to uniquely mark records for
automatic updating/processing through the bridge. Requires
AttributePermission with name "user.personalinfo", actions "read".
User
as a String
public void setBatchUid(java.lang.String strBatchUid)
User
. Setting this
value is not necessary when creating a User for persisting to the database
since either the database persister or the database will set this value. Requires
AttributePermission with name "user.personalinfo", actions "set".
strBatchUid
- a String
containing the batch uid for this
User
public java.lang.String getUserName()
User
object. Code that calls this
method must have AttributePermission with name "user.authinfo", actions "read".
String
representing the username of this userpublic void setUserName(java.lang.String strUserName)
User
object. Username values
are case-insensitive and always stored in lowercase form. If the provided
username is not all lowercase, it will be made so upon setting within this
object.
strUserName
- a String
with the username for this userpublic java.lang.String getPassword()
User
object. Code that calls this
method must have AttributePermission with name "user.authinfo", actions "get".
Note that the password will be an MD5 hash; if external authentication is used,
this value will not reflect the actual password.
String
representing the password of this userpublic void setPassword(java.lang.String strPassword)
User
object. Code that calls this
method must have AttributePermission with name "user.authinfo", actions "set".
The password should be MD5 hashed. This can be done by using
LicenseUtil.getHashValue()
.
strPassword
- a String
with the password for this userpublic boolean getIsInfoPublic()
User
. This value is
used to determine whether or not user contact information should be displayed
within the user directory or other places where lists of users are displayed.
This particular flag acts as a master switch for the show methods within
User
(getShowWorkInfo()
, getShowEmailInfo()
, etc.).
If this value is true then the show methods control the granularity of the
information displayed. If this value is false, then no information will be
displayed regardless of the values for the show methods.
Requires AttributePermission with name "user.personalinfo", actions "get".
public void setIsInfoPublic(boolean bIsInfoPublic)
User
. This value is
used to determine whether or not user contact information should be displayed
within the user directory or other places where lists of users are displayed.
This particular flag acts as a master switch for the show methods within
User
(getShowWorkInfo()
, getShowEmailInfo()
, etc.).
If this value is true then the show methods control the granularity of the
information displayed. If this value is false, then no information will be
displayed regardless of the values for the show methods.
Requires AttributePermission with name "user.personalinfo", actions "set".
bIsInfoPublic
- true if this user's informaiton is public, false otherwise.public boolean getShowWorkInfo()
User
. This flag controls
whether work related information (company, job title, work phone, work fax) are
displayed within the user directory or other places where lists of users are
displayed. The setting of this value has no effect if the is info public flag
is set to false (see getIsInfoPublic()
).
Requires AttributePermission with name "user.personalinfo", actions "get".
public void setShowWorkInfo(boolean bShowWorkInfo)
User
. This flag controls
whether work related information (company, job title, work phone, work fax) are
displayed within the user directory or other places where lists of users are
displayed. The setting of this value has no effect if the is info public flag
is set to false (see getIsInfoPublic()
).
Requires AttributePermission with name "user.personalinfo", actions "set".
bShowWorkInfo
- true if this user's work information should be displayed,
false otherwise.public boolean getShowEmailInfo()
User
. This flag controls
whether the user's email address is displayed within the user directory or
other places where lists of users are displayed. The setting of this value
has no effect if the is info public flag is set to false (see getIsInfoPublic()
).
Requires AttributePermission with name "user.personalinfo", actions "get".
public void setShowEmailInfo(boolean bShowEmailInfo)
User
. This flag controls
whether the user's email address is displayed within the user directory or
other places where lists of users are displayed. The setting of this value
has no effect if the is info public flag is set to false (see getIsInfoPublic()
).
Requires AttributePermission with name "user.personalinfo", actions "set".
bShowEmailInfo
- true if this user's email address should be displayed,
false otherwise.public boolean getShowAddressInfo()
User
. This flag
controls whether address information (street, city, state, zip code, country)
are displayed within the user directory or other places where lists of users
are displayed. The setting of this value has no effect if the is info public
flag is set to false (see getIsInfoPublic()
).
Requires AttributePermission with name "user.personalinfo", actions "get".
public void setShowAddressInfo(boolean bShowAddressInfo)
User
. This flag
controls whether address information (street, city, state, zip code, country)
are displayed within the user directory or other places where lists of users
are displayed. The setting of this value has no effect if the is info public
flag is set to false (see getIsInfoPublic()
).
Requires AttributePermission with name "user.personalinfo", actions "set".
bShowAddressInfo
- true if this user's address information should be
displayed, false otherwise.public boolean getShowAddContactInfo()
User
.
This flag controls whether additional contact information (home phone, work
phone, web site address) are displayed within the user directory or other
places where lists of users are displayed. The setting of this value has
no effect if the is info public flag is set to false (see getIsInfoPublic()
).
Requires AttributePermission with name "user.personalinfo", actions "get".
public void setShowAddContactInfo(boolean bShowAddContactInfo)
User
.
This flag controls whether additional contact information (home phone, work
phone, web site address) are displayed within the user directory or other
places where lists of users are displayed. The setting of this value has
no effect if the is info public flag is set to false (see getIsInfoPublic()
).
Requires AttributePermission with name "user.personalinfo", actions "set".
bShowAddContactInfo
- true if this user's additional contact information
should be displayed, false otherwise.public boolean getIsAvailable()
User
.
Requires AttributePermission with name "user.personalinfo", actions "get".
getIsAvailable
in interface Available
public void setIsAvailable(boolean bIsAvailable)
User
.
Requires AttributePermission with name "user.personalinfo", actions "set".
setIsAvailable
in interface Available
bIsAvailable
- true if this user is to be made available, false otherwise.public User.SystemRole getSystemRole()
User
.
Requires AttributePermission with name "user.personalinfo", actions "set".
User.SystemRole
User.SystemRole
public void setSystemRole(User.SystemRole eSystemRole)
User
.
Requires AttributePermission with name "user.personalinfo", actions "set".
eSystemRole
- a valid role value as defined in User.SystemRole
User.SystemRole
public User.Gender getGender()
User
object.
Requires AttributePermission with name "user.personalinfo", actions "get".
User.Gender
User.Gender
public void setGender(User.Gender eGender)
User
object.
Requires AttributePermission with name "user.personalinfo", actions "set".
eGender
- a valid gender value as defined in User.Gender
User.Gender
public User.EducationLevel getEducationLevel()
User
object
Requires AttributePermission with name "user.personalinfo", actions "get".
User.EducationLevel
User.EducationLevel
public void setEducationLevel(User.EducationLevel eEducationLevel)
User
object
Requires AttributePermission with name "user.personalinfo", actions "set".
eEducationLevel
- a valid education level value as defined in User.EducationLevel
User.EducationLevel
public java.util.Calendar getBirthDate()
User
.
Requires AttributePermission with name "user.personalinfo", actions "get".
Calendar
representing the birth date of this userpublic void setBirthDate(java.util.Calendar cBirthDate)
User
.
Requires AttributePermission with name "user.personalinfo", actions "set".
cBirthDate
- a Calendar
to use for the birth date of this userpublic java.util.Calendar getLastLoginDate()
User
.
Requires AttributePermission with name "user.authinfo", actions "get".
Calendar
representing the last login date of this userpublic void setLastLoginDate(java.util.Calendar cLastLoginDate)
User
.
Requires AttributePermission with name "user.authinfo", actions "set".
cBirthDate
- a Calendar
to use for the last login date of this userpublic java.lang.String getStudentId()
User
object
Requires AttributePermission with name "user.personalinfo", actions "get".
String
representing the student id of this userpublic void setStudentId(java.lang.String strStudentId)
User
object.
Requires AttributePermission with name "user.personalinfo", actions "set".
strStudentId
- a String
with the student id for this userpublic java.lang.String getSettings()
User
object.
Requires AttributePermission with name "user.personalinfo", actions "get".
String
representing the settings of this userpublic void setSettings(java.lang.String strSettings)
User
object.
Requires AttributePermission with name "user.personalinfo", actions "set".
strSettings
- a String
with the settings for this userpublic java.lang.String getLocale()
User
object.
Requires AttributePermission with name "user.personalinfo", actions "get".
String
representing the locale of this userpublic void setLocale(java.lang.String strLocale)
User
object.
Requires AttributePermission with name "user.personalinfo", actions "set".
strSettings
- a String
with the locale for this userpublic java.lang.String getCDRomDriveMac()
User
object.
Requires AttributePermission with name "user.personalinfo", actions "get".
String
representing the settings of this userpublic void setCDRomDriveMac(java.lang.String strCDRomDriveMac)
User
object.
Requires AttributePermission with name "user.personalinfo", actions "set".
strCDRomDriveMac
- a String
with the settings for this userpublic java.lang.String getCDRomDrivePC()
User
object.
Requires AttributePermission with name "user.personalinfo", actions "get".
String
representing the settings of this userpublic void setCDRomDrivePC(java.lang.String strCDRomDrivePC)
User
object.
Requires AttributePermission with name "user.personalinfo", actions "set".
strCDRomDrivePC
- a String
with the settings for this userpublic Registry getRegistry()
Registry
associated with this User
.
User
was loaded using a "heavy" load method. Accessing this
value when it has not been loaded is an error.
Requires AttributePermission with name "user.personalinfo", actions "get".
Registry
value for this userpublic void setRegistry(Registry reg)
Registry
associated with this User
. The
Registry
provided should only contain UserRegistryEntry
values.
Requires AttributePermission with name "user.personalinfo", actions "set".
reg
- a Registry
value to use for this userpublic PortalRole getPortalRole()
PortalRole
object, representing the primary institution role associated with this User
.
User
was loaded using a "heavy" load method. Accessing this
value when it has not been loaded is an error.
Requires AttributePermission with name "user.personalinfo", actions "get".
PortalRole
value for this userpublic void setPortalRole(PortalRole role)
PortalRole
object, representing the primary institution role associated with this User
.
Requires AttributePermission with name "user.personalinfo", actions "set".
role
- a PortalRole
value to use for this userpublic java.lang.String getCardNumber()
String
representing the encrypted BbCard number for this User
.
Requires AttributePermission with name "user.cardnumber", actions "get".
String
enrypted card number value for this userpublic void setCardNumber(java.lang.String cardNumber)
String
representing the encrypted BbCard number for this User
.
Requires AttributePermission with name "user.cardnumber", actions "set".
role
- a String
value to use for this userpublic DataType getDataType()
DataType
identifier for this object. Can be used to
uniquely identify the "type" of this data object.
getDataType
in interface IBbObject
getDataType
in class BbObject
DataType
for this object
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |