Package de.xima.fc.dao.user

Class ExternalUserRef

java.lang.Object

de.xima.fc.dao.user.ExternalUserRef

All Implemented Interfaces:

IExternalUserRef, Serializable

public class ExternalUserRef
extends Object
implements IExternalUserRef

Represents a reference to an external user.

See Also:

Serialized Form

Method Summary

Modifier and Type	Method	Description
String	buildFullExternalRefString()	Returns the full reference string for the external user reference.
static ExternalUserRef	forExternalInbox(String externalRefId)	Creates a new ExternalUserRef instance for a user reference of an external inbox.
static ExternalUserRef	fromFormRecordAccess(FormRecordAccess access)	Creates a new ExternalUserRef instance for a form record access.
String	getExternalRefId()	Returns the external reference ID.
EExternalUserRefType	getType()	Returns the type of external user reference.

Methods inherited from class java.lang.Object

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

Method Detail

forExternalInbox

public static ExternalUserRef forExternalInbox(String externalRefId)

Creates a new ExternalUserRef instance for a user reference of an external inbox.

Parameters:

externalRefId - the string representation of the external user reference

Returns:

a new ExternalUserRef instance, or null if externalRefId is blank

fromFormRecordAccess

public static ExternalUserRef fromFormRecordAccess(FormRecordAccess access)

Creates a new ExternalUserRef instance for a form record access.

Parameters:

access - the form record access

Returns:

a new ExternalUserRef instance, or null if access is null or the external reference ID is blank

buildFullExternalRefString

public String buildFullExternalRefString()

Description copied from interface: IExternalUserRef

Returns the full reference string for the external user reference.

Specified by:

buildFullExternalRefString in interface IExternalUserRef

Returns:

the full reference string

getExternalRefId

public String getExternalRefId()

Description copied from interface: IExternalUserRef

Returns the external reference ID.

Specified by:

getExternalRefId in interface IExternalUserRef

Returns:

the external reference ID

getType

public EExternalUserRefType getType()

Description copied from interface: IExternalUserRef

Returns the type of external user reference.

Specified by:

getType in interface IExternalUserRef

Returns:

the type of external user reference