SymUser

java.lang.Object
- org.symphonyoss.symphony.clients.model.SymUser

public class SymUser
extends java.lang.Object

Model describing Symphony User

Constructor Summary

Constructors
Constructor and Description

SymUser()

Constructors
Constructor and Description
`SymUser()`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`equals(java.lang.Object o)`
`java.util.List<SymAvatar>`	`getAvatars()` Retrieves the avatars of a Symphony User.
`java.lang.String`	`getCompany()` Retrieves the company of a Symphony User.
`java.util.Date`	`getCreatedDate()` Retrieves the creation date of a Symphony User.
`java.lang.String`	`getDepartment()` Retrieves the department name of a Symphony User.
`java.lang.String`	`getDisplayName()` Retrieves the display/pretty name of a Symphony User.
`java.lang.String`	`getEmailAddress()` Retrieves the email address of a Symphony User.
`org.symphonyoss.symphony.pod.model.FeatureList`	`getFeatures()` Retrieves the `FeatureList` of a Symphony User.
`java.lang.String`	`getFirstName()` Retrieves the first name of a Symphony User.
`java.lang.Long`	`getId()` Retrieves the id of a Symphony User.
`java.util.Date`	`getLastLoginDate()` Retrieves the last login date of a Symphony User.
`java.lang.String`	`getLastName()` Retrieves the last name of a Symphony User.
`java.lang.String`	`getLocation()` Retrieves the location of a Symphony User.
`java.util.Set<java.lang.String>`	`getRoles()` Retrieves a set of roles of a Symphony User.
`java.lang.String`	`getTitle()` Retrieves the title of a Symphony User..
`java.lang.String`	`getUsername()` Retrieves the username of a Symphony User.
`int`	`hashCode()`
`boolean`	`isActive()` Checks whether a Symphony User is active.
`void`	`setActive(boolean active)` Sets the active status of a Symphony User.
`void`	`setAvatars(java.util.List<SymAvatar> avatars)` Sets the avatars of a Synphony User.
`void`	`setCompany(java.lang.String company)` Sets the company of a Symphony User.
`void`	`setCreatedDate(java.util.Date createdDate)` Sets the creation date of a Symphony User.
`void`	`setDepartment(java.lang.String department)` Sets the department name of a Symphony User.
`void`	`setDisplayName(java.lang.String displayName)` Sets the display name of a Symphony User.
`void`	`setEmailAddress(java.lang.String emailAddress)` Sets the email address for a Symphony User.
`void`	`setFeatures(org.symphonyoss.symphony.pod.model.FeatureList features)` The `FeatureList` to set for a Symphony User.
`void`	`setFirstName(java.lang.String firstName)` Sets the first name for a Symphony User.
`void`	`setId(java.lang.Long id)` Sets the id for a Symphony User.
`void`	`setLastLoginDate(java.util.Date lastLoginDate)` Sets the last login date of a Symphony User.
`void`	`setLastName(java.lang.String lastName)` Sets the last name of a Symphony User.
`void`	`setLocation(java.lang.String location)` Sets the location of a Symphony User.
`void`	`setRoles(java.util.Set<java.lang.String> roles)` Sets the roles of a Symphony User.
`void`	`setTitle(java.lang.String title)` Sets the title of a Symphony User.
`void`	`setUsername(java.lang.String username)` Sets the username of a Symphony User.
`static SymUser`	`toSymUser(org.symphonyoss.symphony.pod.model.UserDetail userDetail)` This method takes a `UserDetail` and converts it into `SymUser`.
`static SymUser`	`toSymUser(org.symphonyoss.symphony.pod.model.UserV2 user)` This method converts a `UserV2` to a `SymUser`.
`static SymUser`	`toSymUser(org.symphonyoss.symphony.agent.model.V4User user)` This method converts a `V4User` to a `SymUser`.
`static org.symphonyoss.symphony.pod.model.UserAttributes`	`toUserAttributes(SymUser symUser)` This method takes a SymUser and converts it into UserAttributes.
`static org.symphonyoss.symphony.pod.model.UserV2`	`toUserV2(SymUser symUser)` The method convert a `SymUser` to a `UserV2`.

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - SymUser
```
public SymUser()
```
- Method Detail
  - getId
```
public java.lang.Long getId()
```
    Retrieves the id of a Symphony User.
    
    Returns:
    
    id the id of the Symphony User.
  - setId
```
public void setId(java.lang.Long id)
```
    Sets the id for a Symphony User.
    
    Parameters:
    
    id - the id to set for the Symphony User
  - getEmailAddress
```
public java.lang.String getEmailAddress()
```
    Retrieves the email address of a Symphony User.
    
    Returns:
    
    emailAddress the email address of a Symphony User.
  - setEmailAddress
```
public void setEmailAddress(java.lang.String emailAddress)
```
    Sets the email address for a Symphony User.
    
    Parameters:
    
    emailAddress - the email address to set for a Symphony User.
  - getFirstName
```
public java.lang.String getFirstName()
```
    Retrieves the first name of a Symphony User.
    
    Returns:
    
    firstName the first name of a Symphony User.
  - setFirstName
```
public void setFirstName(java.lang.String firstName)
```
    Sets the first name for a Symphony User.
    
    Parameters:
    
    firstName - the first name to set for a Symphony User.
  - getLastName
```
public java.lang.String getLastName()
```
    Retrieves the last name of a Symphony User.
    
    Returns:
    
    lastName the last name of a Symphony User.
  - setLastName
```
public void setLastName(java.lang.String lastName)
```
    Sets the last name of a Symphony User.
    
    Parameters:
    
    lastName - the last name to set for a Symphony User.
  - getDisplayName
```
public java.lang.String getDisplayName()
```
    Retrieves the display/pretty name of a Symphony User.
    
    Returns:
    
    displayName the display name of a Symphony User.
  - setDisplayName
```
public void setDisplayName(java.lang.String displayName)
```
    Sets the display name of a Symphony User.
    
    Parameters:
    
    displayName - the display name to set for a Symphony User.
  - getDepartment
```
public java.lang.String getDepartment()
```
    Retrieves the department name of a Symphony User.
    
    Returns:
    
    departmentName the department name of a Symphony User.
  - setDepartment
```
public void setDepartment(java.lang.String department)
```
    Sets the department name of a Symphony User.
    
    Parameters:
    
    department - the department name to set for a Symphony User.
  - getTitle
```
public java.lang.String getTitle()
```
    Retrieves the title of a Symphony User..
    
    Returns:
    
    title the title of a Symphony User.
  - setTitle
```
public void setTitle(java.lang.String title)
```
    Sets the title of a Symphony User.
    
    Parameters:
    
    title - the title to set for a Symphony User.
  - getCompany
```
public java.lang.String getCompany()
```
    Retrieves the company of a Symphony User.
    
    Returns:
    
    company the company of a Symphony User.
  - setCompany
```
public void setCompany(java.lang.String company)
```
    Sets the company of a Symphony User.
    
    Parameters:
    
    company - the company to set for a Symphony User.
  - getUsername
```
public java.lang.String getUsername()
```
    Retrieves the username of a Symphony User.
    
    Returns:
    
    username the username of a Symphony User.
  - setUsername
```
public void setUsername(java.lang.String username)
```
    Sets the username of a Symphony User.
    
    Parameters:
    
    username - the username to set for a Symphony User.
  - getLocation
```
public java.lang.String getLocation()
```
    Retrieves the location of a Symphony User.
    
    Returns:
    
    location the location of a Symphony User.
  - setLocation
```
public void setLocation(java.lang.String location)
```
    Sets the location of a Symphony User.
    
    Parameters:
    
    location - the location to set for a Symphony User.
  - getAvatars
```
public java.util.List<SymAvatar> getAvatars()
```
    Retrieves the avatars of a Symphony User.
    
    Returns:
    
    avatars the avatars of a Symphony User.
  - setAvatars
```
public void setAvatars(java.util.List<SymAvatar> avatars)
```
    Sets the avatars of a Synphony User.
    
    Parameters:
    
    avatars - the avatars to set for a Symphony User.
  - getLastLoginDate
```
public java.util.Date getLastLoginDate()
```
    Retrieves the last login date of a Symphony User.
    
    Returns:
    
    lastLoginDate the last login date of a Symphony User.
  - setLastLoginDate
```
public void setLastLoginDate(java.util.Date lastLoginDate)
```
    Sets the last login date of a Symphony User.
    
    Parameters:
    
    lastLoginDate - the last login date to set for a Symphony User.
  - getCreatedDate
```
public java.util.Date getCreatedDate()
```
    Retrieves the creation date of a Symphony User.
    
    Returns:
    
    createdDate the creation date of a Symphony User.
  - setCreatedDate
```
public void setCreatedDate(java.util.Date createdDate)
```
    Sets the creation date of a Symphony User.
    
    Parameters:
    
    createdDate - the creation date to set for a Symphony User.
  - isActive
```
public boolean isActive()
```
    Checks whether a Symphony User is active.
    
    Returns:
    
    active true if the Symphony User is active, false if otherwise.
  - setActive
```
public void setActive(boolean active)
```
    Sets the active status of a Symphony User.
    
    Parameters:
    
    active - the active status to set for a Symphony User. Set to true if user is active, false if otherwise.
  - getRoles
```
public java.util.Set<java.lang.String> getRoles()
```
    Retrieves a set of roles of a Symphony User.
    
    Returns:
    
    roles the set of roles of a Symphony User.
  - setRoles
```
public void setRoles(java.util.Set<java.lang.String> roles)
```
    Sets the roles of a Symphony User.
    
    Parameters:
    
    roles - the set of roles to set for a Symphony User.
  - getFeatures
```
public org.symphonyoss.symphony.pod.model.FeatureList getFeatures()
```
    Retrieves the FeatureList of a Symphony User.
    
    Returns:
    
    the features, e.g. isExternalAccessEnabled
  - setFeatures
```
public void setFeatures(org.symphonyoss.symphony.pod.model.FeatureList features)
```
    The FeatureList to set for a Symphony User.
    
    Parameters:
    
    features - the features to set for a Symphony User.
  - toUserV2
```
public static org.symphonyoss.symphony.pod.model.UserV2 toUserV2(SymUser symUser)
```
    The method convert a SymUser to a UserV2.
    
    Parameters:
    
    symUser - the SymUser to convert from.
    
    Returns:
    
    userV2 the UserV2 generated from the SymUser.
  - toSymUser
```
public static SymUser toSymUser(org.symphonyoss.symphony.pod.model.UserV2 user)
```
    This method converts a UserV2 to a SymUser.
    
    Parameters:
    
    user - the UserV2 to convert from.
    
    Returns:
    
    symUser the SymUser generated from the UserV2.
  - toSymUser
```
public static SymUser toSymUser(org.symphonyoss.symphony.agent.model.V4User user)
```
    This method converts a V4User to a SymUser.
    
    Parameters:
    
    user - the V4User to convert from.
    
    Returns:
    
    symUser the SymUser generated from UserDetail.
  - toSymUser
```
public static SymUser toSymUser(org.symphonyoss.symphony.pod.model.UserDetail userDetail)
```
    This method takes a UserDetail and converts it into SymUser. NOTE: Avatars and Company are not exposed by UserDetail and so are not set as part of this implementation
    
    Parameters:
    
    userDetail - User detail
    
    Returns:
    
    symUser User object
  - toUserAttributes
```
public static org.symphonyoss.symphony.pod.model.UserAttributes toUserAttributes(SymUser symUser)
```
    This method takes a SymUser and converts it into UserAttributes. NOTE: department is not part of SymUser and needs to be implemented and so is set to null
    
    Parameters:
    
    symUser - User object
    
    Returns:
    
    userAttributes User attributes
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class java.lang.Object
  - equals
```
public boolean equals(java.lang.Object o)
```
    Overrides:
    
    equals in class java.lang.Object

Class SymUser

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

SymUser

Method Detail

getId

setId

getEmailAddress

setEmailAddress

getFirstName

setFirstName

getLastName

setLastName

getDisplayName

setDisplayName

getDepartment

setDepartment

getTitle

setTitle

getCompany

setCompany

getUsername

setUsername

getLocation

setLocation

getAvatars

setAvatars

getLastLoginDate

setLastLoginDate

getCreatedDate

setCreatedDate

isActive

setActive

getRoles

setRoles

getFeatures

setFeatures

toUserV2

toSymUser

toSymUser

toSymUser

toUserAttributes

hashCode

equals