com.smartsheet.api.models

Class UserModel

java.lang.Object

com.smartsheet.api.models.IdentifiableModel<Long>

com.smartsheet.api.models.UserModel

Direct Known Subclasses:

UserModelWithName, UserProfile

public abstract class UserModel
extends IdentifiableModel<Long>

Constructor Summary

Constructors

Constructor and Description
UserModel()

Method Summary

Modifier and Type	Method and Description
Boolean	getAdmin() Gets the admin flag which allows managing users and accounts.
List<AlternateEmail>	getAlternateEmails() Gets the list of alternateEmails
String	getCompany() Gets the user's company name
Date	getCustomWelcomeScreenViewed() Gets the customWelcomeScreenViewed date
String	getDepartment() Gets the user's department
String	getEmail() Gets the email address.
String	getFirstName() Gets the first name.
Boolean	getGroupAdmin()
Date	getLastLogin() Gets the lastLogin date
String	getLastName() Gets the last name.
Boolean	getLicensedSheetCreator() Gets the licensed sheet creator flag that allows creating and owning sheets.
String	getMobilePhone() Gets the user's mobile phone number
Image	getProfileImage() Gets the user's profile image
Boolean	getResourceViewer()
String	getRole() Gets the user's role
Integer	getSheetCount() Gets the sheetCount.
UserStatus	getStatus() Gets the status of the user (active, pending, declined).
String	getTitle() Gets the user's title
String	getWorkPhone() Gets the user's work phone number
UserModel	setAdmin(Boolean admin) Sets the admin flag which allows managing users and accounts.
UserModel	setAlternateEmails(List<AlternateEmail> alternateEmails) Sets the list of alternateEmails
UserModel	setCompany(String company) Sets the user's company name
UserModel	setCustomWelcomeScreenViewed(Date customWelcomeScreenViewed) Sets the customWelcomeScreenViewed date
UserModel	setDepartment(String department) Sets the user's department
UserModel	setEmail(String email) Sets the email address.
UserModel	setFirstName(String firstName) Sets the first name.
UserModel	setGroupAdmin(Boolean groupAdmin)
UserModel	setLastLogin(Date lastLogin) Sets the lastLogin date
UserModel	setLastName(String lastName) Sets the last name.
UserModel	setLicensedSheetCreator(Boolean licensedSheetCreator) Sets the licensed sheet creator flag that allows creating and owning sheets.
UserModel	setMobilePhone(String mobilePhone) Sets the user's mobile phone number
UserModel	setProfileImage(Image profileImage) Sets the user's profile image
UserModel	setResourceViewer(Boolean resourceViewer) Sets the resource manager flag.
UserModel	setRole(String role) Sets the user's role
UserModel	setSheetCount(Integer sheetCount) Sets the sheetCount
UserModel	setStatus(UserStatus status) Sets the status of the user.
UserModel	setTitle(String title) Sets the user's title
UserModel	setWorkPhone(String workPhone) Sets the user's work phone number

Methods inherited from class com.smartsheet.api.models.IdentifiableModel

equals, getId, hashCode, setId

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

UserModel

public UserModel()

Method Detail

getEmail

public String getEmail()

Gets the email address.

Returns:

the email address

setEmail

public UserModel setEmail(String email)

Sets the email address.

Parameters:

email - the new email address

getFirstName

public String getFirstName()

Gets the first name.

Returns:

the first name

setFirstName

public UserModel setFirstName(String firstName)

Sets the first name.

Parameters:

firstName - the new first name

getLastName

public String getLastName()

Gets the last name.

Returns:

the last name

setLastName

public UserModel setLastName(String lastName)

Sets the last name.

Parameters:

lastName - the new last name

getAdmin

public Boolean getAdmin()

Gets the admin flag which allows managing users and accounts.

Returns:

the admin

setAdmin

public UserModel setAdmin(Boolean admin)

Sets the admin flag which allows managing users and accounts.

Parameters:

admin - the new admin

getLicensedSheetCreator

public Boolean getLicensedSheetCreator()

Gets the licensed sheet creator flag that allows creating and owning sheets.

Returns:

the licensed sheet creator

setLicensedSheetCreator

public UserModel setLicensedSheetCreator(Boolean licensedSheetCreator)

Sets the licensed sheet creator flag that allows creating and owning sheets.

Parameters:

licensedSheetCreator - the new licensed sheet creator

getStatus

public UserStatus getStatus()

Gets the status of the user (active, pending, declined).

Returns:

the status

setStatus

public UserModel setStatus(UserStatus status)

Sets the status of the user.

Parameters:

status - the new status

getResourceViewer

public Boolean getResourceViewer()

Returns:

the flag indicating if someone is a resource manager

setResourceViewer

public UserModel setResourceViewer(Boolean resourceViewer)

Sets the resource manager flag.

Parameters:

resourceViewer - the flag

getGroupAdmin

public Boolean getGroupAdmin()

Returns:

the flag indicating if the user is able to administer group.

setGroupAdmin

public UserModel setGroupAdmin(Boolean groupAdmin)

Parameters:

groupAdmin - sets the flag that indicates if someone is a groupAdmin

getAlternateEmails

public List<AlternateEmail> getAlternateEmails()

Gets the list of alternateEmails

Returns:

the list of alternateEmails

setAlternateEmails

public UserModel setAlternateEmails(List<AlternateEmail> alternateEmails)

Sets the list of alternateEmails

Parameters:

alternateEmails - the new list of alternateEmails

Returns:

the UserModel

getSheetCount

public Integer getSheetCount()

Gets the sheetCount.

Returns:

sheetCount

setSheetCount

public UserModel setSheetCount(Integer sheetCount)

Sets the sheetCount

Parameters:

sheetCount - the new sheetCount

Returns:

the UserModel

getLastLogin

public Date getLastLogin()

Gets the lastLogin date

Returns:

the lastLogin date

setLastLogin

public UserModel setLastLogin(Date lastLogin)

Sets the lastLogin date

Parameters:

lastLogin - the new lastLogin date

Returns:

the UserModel

getCustomWelcomeScreenViewed

public Date getCustomWelcomeScreenViewed()

Gets the customWelcomeScreenViewed date

Returns:

the customerWelcomeScreenViewed date

setCustomWelcomeScreenViewed

public UserModel setCustomWelcomeScreenViewed(Date customWelcomeScreenViewed)

Sets the customWelcomeScreenViewed date

Parameters:

customWelcomeScreenViewed - the new customWelcomeScreenViewed date

Returns:

the UserModel

getCompany

public String getCompany()

Gets the user's company name

Returns:

the company name

setCompany

public UserModel setCompany(String company)

Sets the user's company name

Parameters:

company - the company name

getDepartment

public String getDepartment()

Gets the user's department

Returns:

the department

setDepartment

public UserModel setDepartment(String department)

Sets the user's department

Parameters:

department - the department

getMobilePhone

public String getMobilePhone()

Gets the user's mobile phone number

Returns:

the phone number

setMobilePhone

public UserModel setMobilePhone(String mobilePhone)

Sets the user's mobile phone number

Parameters:

mobilePhone - the phone number

getProfileImage

public Image getProfileImage()

Gets the user's profile image

Returns:

the Image

setProfileImage

public UserModel setProfileImage(Image profileImage)

Sets the user's profile image

Parameters:

profileImage - the Image

getRole

public String getRole()

Gets the user's role

Returns:

the role

setRole

public UserModel setRole(String role)

Sets the user's role

Parameters:

role - the role

getTitle

public String getTitle()

Gets the user's title

Returns:

the title

setTitle

public UserModel setTitle(String title)

Sets the user's title

Parameters:

title - the title

getWorkPhone

public String getWorkPhone()

Gets the user's work phone number

Returns:

the phone number

setWorkPhone

public UserModel setWorkPhone(String workPhone)

Sets the user's work phone number

Parameters:

workPhone - the phone number