Class UserRef

java.lang.Object

de.xima.fc.dao.user.UserRef

All Implemented Interfaces:

IUserData, IUserRef, IUserRefWithData, Serializable

public final class UserRef
extends Object
implements IUserRefWithData

DTO for a user reference.

Since:

8.4.0

Author:

XIMA MEDIA GmbH

See Also:

• Serialized Form

Method Summary

Modifier and Type	Method	Description
static UserRef	forAccess(FormRecordAccess access)
static UserRef	forData(String universalReferenceId, UUID profileUuid)
static UserRef	forData(String universalReferenceId, UUID profileUuid, Map<String, Serializable> attributes, IUserRefExtension filterExtension)
static UserRef	forSubmission(FormRecordSubmission submission)
static UserRef	forUser(IUser user)
Serializable	getAttribute(String key)
@NotNull Map<String, Serializable>	getAttributes()
static Map<String, Serializable>	getAttributes(IUser user)
static Map<String, Serializable>	getAttributes(IUser user, UUID clientUuid)
IUserRefExtension	getExtension()
UUID	getProfileUuid()
String	getUniversalReferenceId()
int	hashCode()

Methods inherited from class Object

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

Methods inherited from interface IUserRef

getAuthenticationClientName

Method Details

forData

public static UserRef forData(String universalReferenceId,
 UUID profileUuid)

forData

public static UserRef forData(String universalReferenceId,
 UUID profileUuid,
 Map<String, Serializable> attributes,
 IUserRefExtension filterExtension)

forAccess

public static UserRef forAccess(FormRecordAccess access)

forSubmission

public static UserRef forSubmission(FormRecordSubmission submission)

forUser

public static UserRef forUser(IUser user)

getAttribute

public Serializable getAttribute(String key)

Specified by:

getAttribute in interface IUserData

Returns:

The attribute with the given key. May be null if the user has no such attribute.

getAttributes

@NotNull
public @NotNull Map<String, Serializable> getAttributes()

Specified by:

getAttributes in interface IUserData

getProfileUuid

@Nullable
public UUID getProfileUuid()

Specified by:

getProfileUuid in interface IUserRef

Returns:

The UUID of the formcycle profile. May be null if the user has no profile.

getUniversalReferenceId

public String getUniversalReferenceId()

Specified by:

getUniversalReferenceId in interface IUserRef

Returns:

The universal reference ID of the user.

getExtension

@Nullable
public IUserRefExtension getExtension()

Specified by:

getExtension in interface IUserRef

Returns:

the user ref extensions or null if there are none. This value will be loaded lazy

hashCode

public int hashCode()

Overrides:

hashCode in class Object

getAttributes

public static Map<String, Serializable> getAttributes(IUser user)

getAttributes

public static Map<String, Serializable> getAttributes(IUser user,
 UUID clientUuid)