org.eclipse.kapua.service.user

Interface User

All Superinterfaces:

KapuaEntity, KapuaNamedEntity, KapuaSerializable, KapuaUpdatableEntity, Serializable

public interface User
extends KapuaNamedEntity

User KapuaEntity definition

Since:

1.0.0

Field Summary

Fields

Modifier and Type	Field and Description
static String	TYPE

Method Summary

Modifier and Type	Method and Description
String	getDisplayName() Gets the display name (may be a friendlier name)
String	getEmail() Gets the email
Date	getExpirationDate() Gets the expiration date
String	getExternalId() Gets the external id.
String	getPhoneNumber() Gets the phone number
UserStatus	getStatus() Gets the UserStatus
default String	getType()
UserType	getUserType() Gets the UserType
void	setDisplayName(String displayName) Sets the display name (may be a friendlier name)
void	setEmail(String email) Sets the user email
void	setExpirationDate(Date expirationDate) Sets the expiration date
void	setExternalId(String externalId) Sets the external id.
void	setPhoneNumber(String phoneNumber) Sets the phone number
void	setStatus(UserStatus status) Sets the UserStatus
void	setUserType(UserType userType) Sets the user type

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

getDescription, getName, setDescription, 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()

Gets the UserStatus

Returns:

the UserStatus

Since:

1.0.0

setStatus

void setStatus(UserStatus status)

Sets the UserStatus

Parameters:

status - the UserStatus

Since:

1.0.0

getDisplayName

String getDisplayName()

Gets the display name (may be a friendlier name)

Returns:

the display name (may be a friendlier name)

Since:

1.0.0

setDisplayName

void setDisplayName(String displayName)

Sets the display name (may be a friendlier name)

Parameters:

displayName - the display name (may be a friendlier name)

Since:

1.0.0

getEmail

String getEmail()

Gets the email

Returns:

the email

Since:

1.0.0

setEmail

void setEmail(String email)

Sets the user email

Parameters:

email - the user email

Since:

1.0.0

getPhoneNumber

String getPhoneNumber()

Gets the phone number

Returns:

the phone number

Since:

1.0.0

setPhoneNumber

void setPhoneNumber(String phoneNumber)

Sets the phone number

Parameters:

phoneNumber - the phone number

Since:

1.0.0

getUserType

UserType getUserType()

Gets the UserType

Returns:

the UserType

Since:

1.0.0

setUserType

void setUserType(UserType userType)

Sets the user type

Parameters:

userType - the UserType

Since:

1.0.0

getExternalId

String getExternalId()

Gets the external id.

This field is used to store external SSO identity bound to this User

Returns:

the external id.

Since:

1.0.0

setExternalId

void setExternalId(String externalId)

Sets the external id.

This field is used to store external SSO identity bound to this User

Parameters:

externalId - the external id.

Since:

1.0.0

getExpirationDate

Date getExpirationDate()

Gets the expiration date

Returns:

the expiration date

Since:

1.0.0

setExpirationDate

void setExpirationDate(Date expirationDate)

Sets the expiration date

Parameters:

expirationDate - the expiration date

Since:

1.0.0