org.bonitasoft.engine.identity

Class CustomUserInfo

java.lang.Object

org.bonitasoft.engine.identity.CustomUserInfo

All Implemented Interfaces:

Serializable, BonitaObject

public class CustomUserInfo
extends Object
implements BonitaObject

Aggregate information of CustomUserInfoDefinition and CustomUserInfoValue

Since:

6.3

Author:

Vincent Elcrin

See Also:

CustomUserInfoDefinition, CustomUserInfoValue, Serialized Form

Constructor Summary

Constructors

Constructor and Description
CustomUserInfo(long userId, CustomUserInfoDefinition definition, CustomUserInfoValue value) Creates an instance of CustomUserInfo based given information

Method Summary

Modifier and Type	Method and Description
CustomUserInfoDefinition	getDefinition() Retrieves the CustomUserInfoDefinition
long	getUserId() Retrieves the User identifier
String	getValue() Retrieves a String representing the Custom User Information value.

Methods inherited from class java.lang.Object

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

Constructor Detail

CustomUserInfo

public CustomUserInfo(long userId,
                      CustomUserInfoDefinition definition,
                      CustomUserInfoValue value)

Creates an instance of CustomUserInfo based given information

Parameters:

userId - the User identifier

definition - the CustomUserInfoDefinition

value - the CustomUserInfoValue

See Also:

User, CustomUserInfoDefinition, CustomUserInfoValue

Method Detail

getDefinition

public CustomUserInfoDefinition getDefinition()

Retrieves the CustomUserInfoDefinition

Returns:

the CustomUserInfoDefinition

Since:

6.3

See Also:

CustomUserInfoDefinition

getUserId

public long getUserId()

Retrieves the User identifier

Returns:

the User identifier

Since:

6.3

See Also:

User

getValue

public String getValue()

Retrieves a String representing the Custom User Information value. This is the value of CustomUserInfoValue.getValue() of the CustomUserInfoValue related to this CustomUserInfo. If there is not related CustomUserInfoValue, this method will return null.

Returns:

a String representing the Custom User Information value.

Since:

6.3