Package com.polarion.alm.shared.api.model.user

Class UserReference

java.lang.Object

com.polarion.alm.shared.api.model.ModelEntityReferenceBase<T,R>

com.polarion.alm.shared.api.model.ModelObjectReferenceBase<T,R>

com.polarion.alm.shared.api.model.ModelObjectReferenceWithUpdatable<User,UpdatableUser,UserReference>

com.polarion.alm.shared.api.model.user.UserReference

All Implemented Interfaces:

com.google.gwt.user.client.rpc.IsSerializable, HasId, ModelEntityReference, ModelObjectReference, ReferenceWithUpdatable<UpdatableUser>, HasPortalLink, Serializable

public final class UserReference
extends ModelObjectReferenceWithUpdatable<User,UpdatableUser,UserReference>
implements HasId, HasPortalLink

Since:

3.9.0

See Also:

• Serialized Form

Constructor Summary

Constructors

Constructor	Description
UserReference(String id)
UserReference(String id, String requestedRevision, String actualRevision)

Method Summary

Modifier and Type	Method	Description
PortalLink	createLink(SharedContext context)	Creates portal link.
boolean	equals(Object obj)
static UserReference	fromPath(String path)	The path is trimmed before parsing, so it can contain spaces at the start or end.
UserReference	getCurrent()	Returns the reference to current revision of the object, in other words reference without requested revision and actual revision.
User	getFromRevision(ReadOnlyTransaction transaction, String requestedRevision)
UserReference	getWithRevision(String requestedRevision)	Returns the reference to the same object, but with different ModelObjectReference.requestedRevision(), the ModelObjectReference.actualRevision() of the returned reference is null.
int	hashCode()
String	id()
PrototypeEnum	prototype()
Scope	scope()
String	toPath()	Returns type specific unique identification path of the object, for example for Work Items in project it is 'projectId/workItemId', the ModelObjectReference.requestedRevision() and ModelObjectReference.actualRevision() are ignored.

Methods inherited from class com.polarion.alm.shared.api.model.ModelObjectReferenceWithUpdatable

getUpdatable

Methods inherited from class com.polarion.alm.shared.api.model.ModelObjectReferenceBase

actualRevision, get, getCurrent, getOriginal, projectId, requestedRevision, toString

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Details

UserReference

public UserReference(@NotNull
 String id,
 @Nullable
 String requestedRevision,
 @Nullable
 String actualRevision)

Throws:

IllegalArgumentException - when id is empty string

UserReference

public UserReference(@NotNull
 String id)

Throws:

IllegalArgumentException - when id is empty string

Since:

3.9.1

Method Details

fromPath

@NotNull
public static UserReference fromPath(@NotNull
 String path)

The path is trimmed before parsing, so it can contain spaces at the start or end.

Throws:

IllegalArgumentException - when path is empty string See toPath()

id

@NotNull
public String id()

Specified by:

id in interface HasId

getFromRevision

@NotNull
public User getFromRevision(@NotNull
 ReadOnlyTransaction transaction,
 @Nullable
 String requestedRevision)

Specified by:

getFromRevision in interface ModelObjectReference

Specified by:

getFromRevision in class ModelObjectReferenceBase<User,UserReference>

requestedRevision - - null means current revision

getCurrent

@NotNull
public UserReference getCurrent()

Description copied from interface: ModelObjectReference

Returns the reference to current revision of the object, in other words reference without requested revision and actual revision. It is shortcut for calling ModelObjectReference.getWithRevision(String) with null

Specified by:

getCurrent in interface ModelObjectReference

Overrides:

getCurrent in class ModelObjectReferenceBase<User,UserReference>

getWithRevision

@NotNull
public UserReference getWithRevision(@Nullable
 String requestedRevision)

Description copied from interface: ModelObjectReference

Returns the reference to the same object, but with different ModelObjectReference.requestedRevision(), the ModelObjectReference.actualRevision() of the returned reference is null.

Specified by:

getWithRevision in interface ModelObjectReference

Specified by:

getWithRevision in class ModelObjectReferenceBase<User,UserReference>

See Also:

• which is shortcut for calling this method with null

toPath

@NotNull
public String toPath()

Description copied from interface: ModelObjectReference

Returns type specific unique identification path of the object, for example for Work Items in project it is 'projectId/workItemId', the ModelObjectReference.requestedRevision() and ModelObjectReference.actualRevision() are ignored.

Specified by:

toPath in interface ModelEntityReference

Specified by:

toPath in interface ModelObjectReference

See Also:

• ModelObjectSelector.path(String)

prototype

@NotNull
public PrototypeEnum prototype()

Specified by:

prototype in interface ModelObjectReference

scope

@NotNull
public Scope scope()

Specified by:

scope in interface ModelObjectReference

createLink

@NotNull
public PortalLink createLink(@NotNull
 SharedContext context)

Description copied from interface: HasPortalLink

Creates portal link.

Specified by:

createLink in interface HasPortalLink

equals

public boolean equals(Object obj)

Overrides:

equals in class ModelObjectReferenceBase<User,UserReference>

hashCode

public int hashCode()

Overrides:

hashCode in class ModelObjectReferenceBase<User,UserReference>