com.appiancorp.suiteapi.personalization

Class UserProfile

java.lang.Object

com.appiancorp.suiteapi.personalization.UserBase

com.appiancorp.suiteapi.personalization.User

com.appiancorp.suiteapi.personalization.UserProfile

All Implemented Interfaces:

com.appiancorp.asl3.servicefw.connect.ASLIdentity, LocalStringId, java.io.Serializable

Direct Known Subclasses:

UserSearch

public class UserProfile
extends User

This represents the full User profile object. It includes additional properties such as email, phone, and address info.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.Integer	SORT_BY_ADDRESS1
static java.lang.Integer	SORT_BY_ADDRESS2
static java.lang.Integer	SORT_BY_ADDRESS3
static java.lang.Integer	SORT_BY_CITY
static java.lang.Integer	SORT_BY_COUNTRY
static java.lang.Integer	SORT_BY_CREATED
static java.lang.Integer	SORT_BY_CUSTOMFIELD1
static java.lang.Integer	SORT_BY_CUSTOMFIELD10
static java.lang.Integer	SORT_BY_CUSTOMFIELD2
static java.lang.Integer	SORT_BY_CUSTOMFIELD3
static java.lang.Integer	SORT_BY_CUSTOMFIELD4
static java.lang.Integer	SORT_BY_CUSTOMFIELD5
static java.lang.Integer	SORT_BY_CUSTOMFIELD6
static java.lang.Integer	SORT_BY_CUSTOMFIELD7
static java.lang.Integer	SORT_BY_CUSTOMFIELD8
static java.lang.Integer	SORT_BY_CUSTOMFIELD9
static java.lang.Integer	SORT_BY_LASTMODIFIED
static java.lang.Integer	SORT_BY_PHONEHOME
static java.lang.Integer	SORT_BY_PHONEMOBILE
static java.lang.Integer	SORT_BY_PHONEOFFICE
static java.lang.Integer	SORT_BY_PROVINCE
static java.lang.Integer	SORT_BY_STATE
static java.lang.Integer	SORT_BY_SUPERVISORNAME
static java.lang.Integer	SORT_BY_TITLE_ID
static java.lang.Integer	SORT_BY_TITLENAME
static java.lang.Integer	SORT_BY_ZIPCODE
static java.lang.Long	USER_TYPE_BASIC the Ids for the user types: basic and system administrator, that can be set in the userTypeId field.
static java.lang.Long	USER_TYPE_SYS_ADMIN

Fields inherited from class com.appiancorp.suiteapi.personalization.User

SORT_BY_ID, SORT_BY_PASSWORD, SORT_BY_USERNAME, USER_ROLE_ADMINISTRATOR, USER_ROLE_CREATOR, USER_ROLE_MEMBER, USER_ROLE_VIEWER

Fields inherited from class com.appiancorp.suiteapi.personalization.UserBase

SORT_BY_DISPLAYNAME, SORT_BY_EMAIL, SORT_BY_FIRSTNAME, SORT_BY_LASTNAME, SORT_BY_MIDDLENAME, SORT_BY_SOCIALSECURITYNUMBER, STATUS_ACTIVE, STATUS_DEACTIVATED

Constructor Summary

Constructors

Constructor and Description
UserProfile()

Method Summary

Modifier and Type	Method and Description
java.lang.String	getAddress1()
java.lang.String	getAddress2()
java.lang.String	getAddress3()
java.lang.String	getBlurb() Returns the User's blurb text
java.lang.String	getCity()
java.lang.String	getConfirmPassword() Deprecated. Since 6.0.2, use User.getUserPassword()
java.lang.String	getCountry()
java.sql.Timestamp	getCreated()
java.lang.String	getCustomField1()
java.lang.String	getCustomField10()
java.lang.String	getCustomField2()
java.lang.String	getCustomField3()
java.lang.String	getCustomField4()
java.lang.String	getCustomField5()
java.lang.String	getCustomField6()
java.lang.String	getCustomField7()
java.lang.String	getCustomField8()
java.lang.String	getCustomField9()
java.sql.Timestamp	getLastModified()
java.util.Locale	getLocale()
java.lang.String	getPhoneHome()
java.lang.String	getPhoneMobile()
java.lang.String	getPhoneOffice()
java.lang.Integer	getProcessModelerPreferredView()
java.lang.String	getProvince()
java.lang.String	getState()
java.lang.String	getSupervisorName()
java.util.TimeZone	getTimeZone()
java.lang.Long	getTitleId()
java.lang.String	getTitleName()
java.lang.Long	getUserTypeId()
java.lang.String	getUserTypeName()
java.lang.String	getZipCode()
void	setAddress1(java.lang.String address1_)
void	setAddress2(java.lang.String address2_)
void	setAddress3(java.lang.String address3_)
void	setBlurb(java.lang.String blurb) Sets the User's blurb text
void	setCity(java.lang.String city_)
void	setConfirmPassword(java.lang.String confirmPassword_) Deprecated. Since 6.0.2, use #setUserPassword(String)
void	setCountry(java.lang.String country_)
void	setCreated(java.sql.Timestamp created_)
void	setCustomField1(java.lang.String customField1_)
void	setCustomField10(java.lang.String customField10_)
void	setCustomField2(java.lang.String customField2_)
void	setCustomField3(java.lang.String customField3_)
void	setCustomField4(java.lang.String customField4_)
void	setCustomField5(java.lang.String customField5_)
void	setCustomField6(java.lang.String customField6_)
void	setCustomField7(java.lang.String customField7_)
void	setCustomField8(java.lang.String customField8_)
void	setCustomField9(java.lang.String customField9_)
void	setLastModified(java.sql.Timestamp lastModified_)
void	setLocale(java.util.Locale locale_)
void	setPhoneHome(java.lang.String phoneHome_)
void	setPhoneMobile(java.lang.String phoneMobile_)
void	setPhoneOffice(java.lang.String phoneOffice_)
void	setProcessModelerPreferredView(java.lang.Integer processModelerPreferredView_)
void	setProvince(java.lang.String province_)
void	setState(java.lang.String state_)
void	setSupervisorName(java.lang.String supervisorName_)
void	setTimeZone(java.util.TimeZone timeZone_)
void	setTitleId(java.lang.Long titleId_)
void	setTitleName(java.lang.String titleName_)
void	setUserTypeId(java.lang.Long userTypeId_)
void	setUserTypeName(java.lang.String userTypeName_)
void	setZipCode(java.lang.String zipcode_)
java.lang.String	toString()

Methods inherited from class com.appiancorp.suiteapi.personalization.User

getId, getIdentifier, getIdentity, getPassword, getPasswordModified, getStringId, getUsernames, getUserPassword, getUuid, isTemporaryPassword, isUserLocked, setId, setPassword, setPasswordModified, setStringId, setTemporaryPassword, setUserLocked, setUserPassword, setUuid

Methods inherited from class com.appiancorp.suiteapi.personalization.UserBase

getDisplayName, getEmail, getFavorite, getFirstName, getLastName, getMiddleName, getSocialSecurityNumber, getStatus, getUsername, setDisplayName, setEmail, setFavorite, setFirstName, setLastName, setMiddleName, setSocialSecurityNumber, setStatus, setUsername

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

SORT_BY_PHONEOFFICE

public static final java.lang.Integer SORT_BY_PHONEOFFICE

SORT_BY_PHONEMOBILE

public static final java.lang.Integer SORT_BY_PHONEMOBILE

SORT_BY_PHONEHOME

public static final java.lang.Integer SORT_BY_PHONEHOME

SORT_BY_ADDRESS1

public static final java.lang.Integer SORT_BY_ADDRESS1

SORT_BY_ADDRESS2

public static final java.lang.Integer SORT_BY_ADDRESS2

SORT_BY_ADDRESS3

public static final java.lang.Integer SORT_BY_ADDRESS3

SORT_BY_CITY

public static final java.lang.Integer SORT_BY_CITY

SORT_BY_STATE

public static final java.lang.Integer SORT_BY_STATE

SORT_BY_PROVINCE

public static final java.lang.Integer SORT_BY_PROVINCE

SORT_BY_ZIPCODE

public static final java.lang.Integer SORT_BY_ZIPCODE

SORT_BY_COUNTRY

public static final java.lang.Integer SORT_BY_COUNTRY

SORT_BY_TITLE_ID

public static final java.lang.Integer SORT_BY_TITLE_ID

SORT_BY_TITLENAME

public static final java.lang.Integer SORT_BY_TITLENAME

SORT_BY_SUPERVISORNAME

public static final java.lang.Integer SORT_BY_SUPERVISORNAME

SORT_BY_CREATED

public static final java.lang.Integer SORT_BY_CREATED

SORT_BY_LASTMODIFIED

public static final java.lang.Integer SORT_BY_LASTMODIFIED

SORT_BY_CUSTOMFIELD1

public static final java.lang.Integer SORT_BY_CUSTOMFIELD1

SORT_BY_CUSTOMFIELD2

public static final java.lang.Integer SORT_BY_CUSTOMFIELD2

SORT_BY_CUSTOMFIELD3

public static final java.lang.Integer SORT_BY_CUSTOMFIELD3

SORT_BY_CUSTOMFIELD4

public static final java.lang.Integer SORT_BY_CUSTOMFIELD4

SORT_BY_CUSTOMFIELD5

public static final java.lang.Integer SORT_BY_CUSTOMFIELD5

SORT_BY_CUSTOMFIELD6

public static final java.lang.Integer SORT_BY_CUSTOMFIELD6

SORT_BY_CUSTOMFIELD7

public static final java.lang.Integer SORT_BY_CUSTOMFIELD7

SORT_BY_CUSTOMFIELD8

public static final java.lang.Integer SORT_BY_CUSTOMFIELD8

SORT_BY_CUSTOMFIELD9

public static final java.lang.Integer SORT_BY_CUSTOMFIELD9

SORT_BY_CUSTOMFIELD10

public static final java.lang.Integer SORT_BY_CUSTOMFIELD10

USER_TYPE_BASIC

public static final java.lang.Long USER_TYPE_BASIC

the Ids for the user types: basic and system administrator, that can be set in the userTypeId field. Basic and System Administrator will be returned in the userTypeName field respectively.

USER_TYPE_SYS_ADMIN

public static final java.lang.Long USER_TYPE_SYS_ADMIN

Constructor Detail

UserProfile

public UserProfile()

Method Detail

setPhoneOffice

public void setPhoneOffice(java.lang.String phoneOffice_)

getPhoneOffice

public java.lang.String getPhoneOffice()

setPhoneMobile

public void setPhoneMobile(java.lang.String phoneMobile_)

getPhoneMobile

public java.lang.String getPhoneMobile()

setPhoneHome

public void setPhoneHome(java.lang.String phoneHome_)

getPhoneHome

public java.lang.String getPhoneHome()

setAddress1

public void setAddress1(java.lang.String address1_)

getAddress1

public java.lang.String getAddress1()

setAddress2

public void setAddress2(java.lang.String address2_)

getAddress2

public java.lang.String getAddress2()

setAddress3

public void setAddress3(java.lang.String address3_)

getAddress3

public java.lang.String getAddress3()

setCity

public void setCity(java.lang.String city_)

getCity

public java.lang.String getCity()

setState

public void setState(java.lang.String state_)

getState

public java.lang.String getState()

setProvince

public void setProvince(java.lang.String province_)

getProvince

public java.lang.String getProvince()

setZipCode

public void setZipCode(java.lang.String zipcode_)

getZipCode

public java.lang.String getZipCode()

setCountry

public void setCountry(java.lang.String country_)

getCountry

public java.lang.String getCountry()

getLocale

public java.util.Locale getLocale()

setLocale

public void setLocale(java.util.Locale locale_)

getTimeZone

public java.util.TimeZone getTimeZone()

setTimeZone

public void setTimeZone(java.util.TimeZone timeZone_)

setConfirmPassword

@Deprecated
public void setConfirmPassword(java.lang.String confirmPassword_)

Deprecated. Since 6.0.2, use #setUserPassword(String)

getConfirmPassword

@Deprecated
 @Transient
public java.lang.String getConfirmPassword()

Deprecated. Since 6.0.2, use User.getUserPassword()

setUserTypeId

public void setUserTypeId(java.lang.Long userTypeId_)

getUserTypeId

public java.lang.Long getUserTypeId()

setUserTypeName

public void setUserTypeName(java.lang.String userTypeName_)

getUserTypeName

public java.lang.String getUserTypeName()

setTitleId

public void setTitleId(java.lang.Long titleId_)

getTitleId

public java.lang.Long getTitleId()

setTitleName

public void setTitleName(java.lang.String titleName_)

getTitleName

public java.lang.String getTitleName()

setSupervisorName

public void setSupervisorName(java.lang.String supervisorName_)

getSupervisorName

public java.lang.String getSupervisorName()

setCreated

public void setCreated(java.sql.Timestamp created_)

getCreated

public java.sql.Timestamp getCreated()

setLastModified

public void setLastModified(java.sql.Timestamp lastModified_)

getLastModified

public java.sql.Timestamp getLastModified()

setCustomField1

public void setCustomField1(java.lang.String customField1_)

getCustomField1

public java.lang.String getCustomField1()

setCustomField2

public void setCustomField2(java.lang.String customField2_)

getCustomField2

public java.lang.String getCustomField2()

setCustomField3

public void setCustomField3(java.lang.String customField3_)

getCustomField3

public java.lang.String getCustomField3()

setCustomField4

public void setCustomField4(java.lang.String customField4_)

getCustomField4

public java.lang.String getCustomField4()

setCustomField5

public void setCustomField5(java.lang.String customField5_)

getCustomField5

public java.lang.String getCustomField5()

setCustomField6

public void setCustomField6(java.lang.String customField6_)

getCustomField6

public java.lang.String getCustomField6()

setCustomField7

public void setCustomField7(java.lang.String customField7_)

getCustomField7

public java.lang.String getCustomField7()

setCustomField8

public void setCustomField8(java.lang.String customField8_)

getCustomField8

public java.lang.String getCustomField8()

setCustomField9

public void setCustomField9(java.lang.String customField9_)

getCustomField9

public java.lang.String getCustomField9()

setCustomField10

public void setCustomField10(java.lang.String customField10_)

getCustomField10

public java.lang.String getCustomField10()

getProcessModelerPreferredView

public java.lang.Integer getProcessModelerPreferredView()

setProcessModelerPreferredView

public void setProcessModelerPreferredView(java.lang.Integer processModelerPreferredView_)

getBlurb

public java.lang.String getBlurb()

Returns the User's blurb text

Returns:

the User's blurb text

setBlurb

public void setBlurb(java.lang.String blurb)

Sets the User's blurb text

Parameters:

blurb -

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object