Package com.kloudville.idm

Class user

java.lang.Object

com.kloudville.data.object.DataObject

com.kloudville.idm.identity

com.kloudville.idm.user

public class user
extends identity

User

Field Summary

Fields

Modifier and Type	Field	Description
String	contact
String	contactId	Contact profile
String	email	Email
String	firstName	First name
int	forgotAttempts
String	formattedName	Formatted name
Date	lastLogin
String	lastName	Last name
Date	lastUpdated	Restrictions: Mandatory: true
String	location	Organization location
int	loginAttempts
String	mobilePhone	Mobile phone
String	organization	Organization
String	phoneNumber	Work phone
String	status	Status
String	terms	Restrictions: maxlength: 128

Fields inherited from class com.kloudville.idm.identity

active, id

Constructor Summary

Constructors

Constructor	Description
user()

Method Summary

Modifier and Type	Method	Description
String	getContactId()	returns ID of the contact associated with this user
String	getEmail()	returns user's email address
String	getMobilePhone()	returns user's mobile phone number
String	getOrganizationId()	returns ID of organization this user belongs to
String	getStatus()	returns user's availability status
static user	getUser(String userId)	retrieves user by ID
String	getUserId()	returns user's ID
String	getUserIdFQ()	returns fully qualified ID of this user in form realm:userID
String	getUserLanguage()	returns this user's language preference or default system language if there is no preference
Collection	getUserRoles()	Retrieves this user's roles.
Collection	getUserTeams()	Retrieves all teams this user belongs to.
boolean	hasRole(String role)	checks whether this user has a specified role
boolean	isActive()	checks whether this user is active
boolean	isAvailble()	checks whether this user is available

Methods inherited from class com.kloudville.data.object.DataObject

clearModified, compareDates, copy, formatDecimal, formatDecimalField, getAnyValue, getAnyValueNames, getChildLabel, getDefinition, getDisplayName, getEnumValue, getEnumValueArray, getEnumValueByCode, getEnumValueByIndex, getExtension, getExtensionDefinition, getFormattedMessage, getLastUpdated, getObjectId, getObjectIds, getParent, getText, getTopParent, has, hasChild, hasValue, htmlToText, isDeleted, isError, isModified, isNewObject, mapFrom, mapTo, setAnyValue, setDeleted, setFormattedValue, setNewObject, setObjectId, setText, toJSON, toXML, validate, valToXML

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

firstName

public String firstName

First name

        Restrictions:
                Mandatory: true
                maxlength: 64

lastName

public String lastName

Last name

        Restrictions:
                Mandatory: true
                maxlength: 64

formattedName

public String formattedName

Formatted name

        Restrictions:
                maxlength: 64

status

public String status

Status

        Restrictions:
                maxlength: 16
                enumeration: AVAILABLE (Available)
                enumeration: BUSY (Busy)
                enumeration: OFFWORK (Off Work)

email

public String email

Email

        Restrictions:
                Mandatory: true
                maxlength: 254
                pattern: [A-Za-z0-9._%+-]+@[A-Za-z0-9.-]+\.[A-Za-z]{2,4}

phoneNumber

public String phoneNumber

Work phone

        Restrictions:
                minlength: 7
                maxlength: 32

mobilePhone

public String mobilePhone

Mobile phone

        Restrictions:
                minlength: 7
                maxlength: 32

location

public String location

Organization location

        Restrictions:
                maxlength: 36

organization

public String organization

Organization

        Restrictions:
                maxlength: 36

contactId

public String contactId

Contact profile

        Restrictions:
                maxlength: 36

contact

public String contact

forgotAttempts

public int forgotAttempts

loginAttempts

public int loginAttempts

lastLogin

public Date lastLogin

terms

public String terms

        Restrictions:
                maxlength: 128

lastUpdated

public Date lastUpdated

        Restrictions:
                Mandatory: true

Constructor Details

user

public user()

Method Details

getUserLanguage

public String getUserLanguage()

returns this user's language preference or default system language if there is no preference

getContactId

public String getContactId()

returns ID of the contact associated with this user

isActive

public boolean isActive()

checks whether this user is active

getStatus

public String getStatus()

returns user's availability status

getUserRoles

public Collection getUserRoles()

Retrieves this user's roles. Returns a list of role IDs.

getOrganizationId

public String getOrganizationId()

returns ID of organization this user belongs to

getUserIdFQ

public String getUserIdFQ()

returns fully qualified ID of this user in form realm:userID

hasRole

public boolean hasRole(String role)

checks whether this user has a specified role

getMobilePhone

public String getMobilePhone()

returns user's mobile phone number

getEmail

public String getEmail()

returns user's email address

getUserTeams

public Collection getUserTeams()

Retrieves all teams this user belongs to. Returns a list of team IDs.

getUserId

public String getUserId()

returns user's ID

isAvailble

public boolean isAvailble()

checks whether this user is available

getUser

public static user getUser(String userId)

retrieves user by ID