public class CSUserContent extends CSItemContent
CSUser
object.CSUser
,
Serialized FormConstructor and Description |
---|
CSUserContent()
Creates an empty
CSUserContent object. |
Modifier and Type | Method and Description |
---|---|
boolean |
equals(java.lang.Object obj)
Determines whether the data contained in this
CSUserContent object is the same as that contained
within the one supplied. |
java.lang.Boolean |
getAcceptMailings()
Gets the flag that indicates whether the user would like to receive mailings.
|
int |
getAccountUserID()
Gets the user's account ID (only set for login users).
|
java.util.Date |
getCreated()
Get the date the user was created.
|
java.lang.String |
getDescription()
Gets the user's description.
|
java.lang.Boolean |
getDisabled()
Flag that indicates whether the site user account is disabled or not.
|
java.lang.String |
getDisplayUserName()
Gets the user's display name.
|
java.lang.String |
getEmail()
Gets the user's email.
|
int |
getFailedLinkAttempts()
Get the number of times the user has tried to link a new login to an account.
|
int |
getFailedLoginAttempts()
Returns the number of failed login attempts since the last successful
login.
|
java.lang.String |
getHint()
Deprecated.
password hints are not supported from 10.0.7.0.
|
java.util.Date |
getlastFailedLink()
Get the Date and Time of the Last failed attempt to link a new login to an account.
|
java.util.Date |
getLastFailedLogin()
Returns the date time when the user last failed to log in
(incorrect password, etc).
|
java.util.Date |
getLastSuccessfulLogin()
Returns the date time when the user last successfully logged in.
|
java.lang.String |
getPassword()
Gets the user's password.
|
boolean |
getPasswordCaseSensitive()
Returns a flag that indicates whether the site user's password was hashed in a case sensitive manner, false otherwise
|
java.lang.String |
getPrefUserName()
Gets the user's preferred name.
|
java.lang.String |
getProviderName()
Gets the name of the provider used to create the user.
|
java.lang.String |
getProviderType()
Gets the type of provider used to create the user.
|
int |
getUserID()
Gets the ID of the user.
|
java.lang.String |
getUserName()
Gets the name of the user.
|
CSUserProfile |
getUserProfile()
Returns a
CSUserProfile instance corresponding to the user's user profile object
after performing a get if the detail level was set to ALL_PLUS_RELATED and the user had
a user profile. |
void |
setAcceptMailings(boolean bAcceptMailings)
Specifies whether the user would like to receive mailings.
|
void |
setAccountUserID(int accountUserID)
Sets the user's account ID (only set for login users).
|
void |
setCreated(java.util.Date created)
Set the date the user was created.
|
void |
setDescription(java.lang.String strDescription)
Sets the description for the user.
|
void |
setDisabled(boolean disabled)
Specifies whether the site user account is disabled or not.
|
void |
setDisplayUserName(java.lang.String displayUserName)
Sets the user's display name.
|
void |
setEmail(java.lang.String email)
Sets the user's email.
|
void |
setFailedLinkAttempts(int failedLinkAttempts)
Set the number of times the user has tried to link a new login to an account
|
void |
setFailedLoginAttempts(int failedLoginAttempts)
Sets the number of failed login attempts since the last successful
login.
|
void |
setHint(java.lang.String strHint)
Deprecated.
password hints are not supported from 10.0.7.0.
|
void |
setLastFailedLink(java.util.Date lastFailedLink)
Set the Date and Time of the Last failed attempt to link a new login to an account.
|
void |
setLastFailedLogin(java.util.Date lastFailedLogin)
Sets the date time when the user last failed to log in
(incorrect password, etc).
|
void |
setLastSuccessfulLogin(java.util.Date lastSuccessfulLogin)
Sets the date time when the user last successfully logged in.
|
void |
setPassword(java.lang.String strPassword)
Sets the user's password.
|
void |
setPasswordCaseSensitive(boolean passwordCaseSensitive)
Sets a flag that indicates whether the site user's password was hashed in a case sensitive manner, false otherwise
|
void |
setPrefUserName(java.lang.String preferredUserName)
Sets the user's preferred name.
|
void |
setProviderName(java.lang.String strProviderName)
Sets the name of the provider used to create the user.
|
void |
setProviderType(java.lang.String providerType)
Sets the type of provider used to create the user.
|
void |
setUserID(int nUserID)
Sets the ID of the user.
|
void |
setUserName(java.lang.String strUserName)
Sets the name of the user.
|
void |
setUserProfile(CSUserProfile userProfileContent)
Sets the CSUserProfile object.
|
java.lang.String |
toString()
Outputs the contents of this
CSUserContent object to a String object in a
user-friendly format. |
clone, getID, setID, unset
public void setUserID(int nUserID)
nUserID
- the numeric identifier of the user.public int getUserID()
public void setUserName(java.lang.String strUserName)
strUserName
- the user's name.public java.lang.String getUserName()
public void setDescription(java.lang.String strDescription)
strDescription
- the user's description.public java.lang.String getDescription()
public java.util.Date getCreated()
public void setCreated(java.util.Date created)
created
- the date the user was createdpublic void setPassword(java.lang.String strPassword)
strPassword
- the user's password.public java.lang.String getPassword()
public void setHint(java.lang.String strHint)
strHint
- the user's password hint.public java.lang.String getHint()
public java.lang.String getProviderName()
public void setProviderName(java.lang.String strProviderName)
strProviderName
- The name of the provider used to create the user.public void setProviderType(java.lang.String providerType)
providerType
- The type of provider used to create the user.public java.lang.String getProviderType()
public void setPrefUserName(java.lang.String preferredUserName)
preferredUserName
- The user's preferred name.public java.lang.String getPrefUserName()
public void setDisplayUserName(java.lang.String displayUserName)
displayUserName
- The user's preferred name.public java.lang.String getDisplayUserName()
public void setEmail(java.lang.String email)
email
- The user's email.public java.lang.String getEmail()
public void setAccountUserID(int accountUserID)
accountUserID
- The user's account IDpublic int getAccountUserID()
public void setAcceptMailings(boolean bAcceptMailings)
bAcceptMailings
- true
if the user wants to receive mailings, false
otherwise.public java.lang.Boolean getAcceptMailings()
true
if the user would like to receive mailings, false
otherwise.public java.lang.Boolean getDisabled()
public void setDisabled(boolean disabled)
disabled
- true if the site user account should be disabled, false otherwise.public int getFailedLoginAttempts()
public void setFailedLoginAttempts(int failedLoginAttempts)
failedLoginAttempts
- The number of failed login attempts since the last successful login.public java.util.Date getLastSuccessfulLogin()
public void setLastSuccessfulLogin(java.util.Date lastSuccessfulLogin)
lastSuccessfulLogin
- The date time when the user last successfully logged in.public java.util.Date getlastFailedLink()
public void setLastFailedLink(java.util.Date lastFailedLink)
lastFailedLink
- the m_lastFailedLink to setpublic int getFailedLinkAttempts()
public void setFailedLinkAttempts(int failedLinkAttempts)
failedLinkAttempts
- the m_failedLinkAttempts to setpublic java.util.Date getLastFailedLogin()
public void setLastFailedLogin(java.util.Date lastFailedLogin)
lastFailedLogin
- The date time when the user last failed to log inpublic void setUserProfile(CSUserProfile userProfileContent)
userProfileContent
- The CSUserProfile object to set.public CSUserProfile getUserProfile()
CSUserProfile
instance corresponding to the user's user profile object
after performing a get if the detail level was set to ALL_PLUS_RELATED and the user had
a user profile.
Returns null if the detail level was set to ALL_PLUS_RELATED and the user did not have a
UserProfile.CSUserProfile
object loaded if the detail level is set to ALL_PLUS_RELATED
and the user had a user profile, otherwise null.public boolean getPasswordCaseSensitive()
public void setPasswordCaseSensitive(boolean passwordCaseSensitive)
passwordCaseSensitive
- true if the site user's password was hashed in a case sensitive manner, false otherwisepublic java.lang.String toString()
CSUserContent
object to a String
object in a
user-friendly format.toString
in class CSItemContent
String
containing the user-friendly output.public boolean equals(java.lang.Object obj)
CSUserContent
object is the same as that contained
within the one supplied. Note that the key data used for searching is not tested for equality.equals
in class CSItemContent
obj
- the CSUserContent
to be tested for equality.true
if the data matches, false
otherwise.Copyright © 2022 Goss Interactive Ltd. All Rights Reserved.