org.eclipse.kapua.service.user

Interface User

All Superinterfaces:

KapuaEntity, KapuaNamedEntity, KapuaSerializable, KapuaUpdatableEntity, Serializable

public interface User
extends KapuaNamedEntity

User entity

Since:

1.0

Field Summary

Fields

Modifier and Type	Field and Description
static String	TYPE

Method Summary

Modifier and Type	Method and Description
String	getDisplayName() Return the display name (may be a friendly username to show in the UI)
String	getEmail() Get the user email
Date	getExpirationDate()
String	getExternalId() Get the external ID
String	getPhoneNumber() Get the phone number
UserStatus	getStatus() Return the user status
default String	getType()
UserType	getUserType() Get the user type
void	setDisplayName(String displayName) Set the display name
void	setEmail(String email) Set the user email
void	setExpirationDate(Date expirationDate)
void	setExternalId(String externalId) Set the external ID
void	setPhoneNumber(String phoneNumber) Set the phone number
void	setStatus(UserStatus status) Get the user status
void	setUserType(UserType userType) Set the user type

Methods inherited from interface org.eclipse.kapua.model.KapuaNamedEntity

getName, setName

Methods inherited from interface org.eclipse.kapua.model.KapuaUpdatableEntity

getEntityAttributes, getEntityProperties, getModifiedBy, getModifiedOn, getOptlock, setEntityAttributes, setEntityProperties, setOptlock

Methods inherited from interface org.eclipse.kapua.model.KapuaEntity

getCreatedBy, getCreatedOn, getId, getScopeId, setId, setScopeId

Field Detail

TYPE

static final String TYPE

See Also:

Constant Field Values

Method Detail

getType

default String getType()

Specified by:

getType in interface KapuaEntity

getStatus

UserStatus getStatus()

Return the user status

Returns:

setStatus

void setStatus(UserStatus status)

Get the user status

Parameters:

status -

getDisplayName

String getDisplayName()

Return the display name (may be a friendly username to show in the UI)

Returns:

setDisplayName

void setDisplayName(String displayName)

Set the display name

Parameters:

displayName -

getEmail

String getEmail()

Get the user email

Returns:

setEmail

void setEmail(String email)

Set the user email

Parameters:

email -

getPhoneNumber

String getPhoneNumber()

Get the phone number

Returns:

setPhoneNumber

void setPhoneNumber(String phoneNumber)

Set the phone number

Parameters:

phoneNumber -

getUserType

UserType getUserType()

Get the user type

Returns:

setUserType

void setUserType(UserType userType)

Set the user type

getExternalId

String getExternalId()

Get the external ID

Returns:

setExternalId

void setExternalId(String externalId)

Set the external ID

Parameters:

externalId -

getExpirationDate

Date getExpirationDate()

setExpirationDate

void setExpirationDate(Date expirationDate)