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:
-
Constructor Summary
ConstructorDescriptionUserReference
(String id) UserReference
(String id, String requestedRevision, String actualRevision) -
Method Summary
Modifier and TypeMethodDescriptioncreateLink
(SharedContext context) Creates portal link.boolean
static UserReference
The path is trimmed before parsing, so it can contain spaces at the start or end.Returns the reference to current revision of the object, in other words reference without requested revision and actual revision.getFromRevision
(ReadOnlyTransaction transaction, String requestedRevision) getWithRevision
(String requestedRevision) Returns the reference to the same object, but with differentModelObjectReference.requestedRevision()
, theModelObjectReference.actualRevision()
of the returned reference is null.int
hashCode()
id()
scope()
toPath()
Returns type specific unique identification path of the object, for example for Work Items in project it is 'projectId/workItemId', theModelObjectReference.requestedRevision()
andModelObjectReference.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
-
Constructor Details
-
UserReference
public UserReference(@NotNull String id, @Nullable String requestedRevision, @Nullable String actualRevision) - Throws:
IllegalArgumentException
- when id is empty string
-
UserReference
- Throws:
IllegalArgumentException
- when id is empty string- Since:
- 3.9.1
-
-
Method Details
-
fromPath
The path is trimmed before parsing, so it can contain spaces at the start or end.- Throws:
IllegalArgumentException
- when path is empty string SeetoPath()
-
id
-
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 callingModelObjectReference.getWithRevision(String)
with null- Specified by:
getCurrent
in interfaceModelObjectReference
- Overrides:
getCurrent
in classModelObjectReferenceBase<User,
UserReference>
-
getWithRevision
Description copied from interface:ModelObjectReference
Returns the reference to the same object, but with differentModelObjectReference.requestedRevision()
, theModelObjectReference.actualRevision()
of the returned reference is null.- Specified by:
getWithRevision
in interfaceModelObjectReference
- Specified by:
getWithRevision
in classModelObjectReferenceBase<User,
UserReference> - See Also:
-
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', theModelObjectReference.requestedRevision()
andModelObjectReference.actualRevision()
are ignored.- Specified by:
toPath
in interfaceModelEntityReference
- Specified by:
toPath
in interfaceModelObjectReference
- See Also:
-
prototype
- Specified by:
prototype
in interfaceModelObjectReference
-
scope
- Specified by:
scope
in interfaceModelObjectReference
-
equals
- Overrides:
equals
in classModelObjectReferenceBase<User,
UserReference>
-
hashCode
public int hashCode()- Overrides:
hashCode
in classModelObjectReferenceBase<User,
UserReference>
-