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

Class WorkItemReference

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<WorkItem,UpdatableWorkItem,WorkItemReference>

com.polarion.alm.shared.api.model.wi.WorkItemReference

All Implemented Interfaces:

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

public final class WorkItemReference
extends ModelObjectReferenceWithUpdatable<WorkItem,UpdatableWorkItem,WorkItemReference>
implements HasId, HasProjectId, HasPortalLink, HasRelativePath

Since:

3.9.0

See Also:

• Serialized Form

Constructor Summary

Constructors

Constructor	Description
WorkItemReference(String projectId, String id)
WorkItemReference(String projectId, String id, String requestedRevision, String actualRevision)

Method Summary

Modifier and Type	Method	Description
WorkItemLinkBuilder	createLink(SharedContext context)	Creates portal link.
boolean	equals(Object obj)
static WorkItemReference	fromPath(String path)	The path is trimmed before parsing, so it can contain spaces at the start or end.
static WorkItemReference	fromRelativePath(String baseProjectId, String path)	The path is trimmed before parsing, so it can contain spaces at the start or end. The path can be obtained using toRelativePath(String).
WorkItemReference	getCurrent()	Returns the reference to current revision of the object, in other words reference without requested revision and actual revision.
WorkItem	getFromRevision(ReadOnlyTransaction transaction, String requestedRevision)
WorkItemReference	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()
String	projectId()	It is shortcut for ModelObjectReference.scope().Scope.projectId()
PrototypeEnum	prototype()
Scope	scope()
String	toPath()	Returns 'projectId/wiId'
String	toRelativePath(String baseProjectId)	Returns the id() if the baseProjectId is same as projectId() otherwise returns the same value as toPath(). The fromRelativePath(String, String) can be used to get the reference from the returned path.

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, requestedRevision, toString

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Details

WorkItemReference

public WorkItemReference(@NotNull
 String projectId,
 @NotNull
 String id,
 @Nullable
 String requestedRevision,
 @Nullable
 String actualRevision)

Throws:

IllegalArgumentException - when projectId or id is empty string

WorkItemReference

public WorkItemReference(@NotNull
 String projectId,
 @NotNull
 String id)

Throws:

IllegalArgumentException - when projectId or id is empty string

Since:

3.9.1

Method Details

fromPath

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

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

Throws:

IllegalArgumentException - when path does not contain '/' character or when it is at the start or end.

See Also:

• toPath()
• ModelObjectSelector.path(String)

fromRelativePath

@NotNull
public static WorkItemReference fromRelativePath(@Nullable
 String baseProjectId,
 @NotNull
 String path)

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

The path can be obtained using toRelativePath(String). The baseProjectId used in both calls must be the same.

Throws:

IllegalArgumentException - in same conditions as fromPath(String) when baseProjectId is null, otherwise when path start or ends with '/' characters

Since:

3.9.1

projectId

@NotNull
public String projectId()

Description copied from interface: ModelObjectReference

It is shortcut for ModelObjectReference.scope().Scope.projectId()

Specified by:

projectId in interface HasProjectId

Specified by:

projectId in interface ModelObjectReference

Overrides:

projectId in class ModelObjectReferenceBase<WorkItem,WorkItemReference>

id

@NotNull
public String id()

Specified by:

id in interface HasId

toPath

@NotNull
public String toPath()

Returns 'projectId/wiId'

Specified by:

toPath in interface ModelEntityReference

Specified by:

toPath in interface ModelObjectReference

See Also:

• fromPath(String)
• ModelObjectSelector.path(String)

toRelativePath

@NotNull
public String toRelativePath(@Nullable
 String baseProjectId)

Returns the id() if the baseProjectId is same as projectId() otherwise returns the same value as toPath().

The fromRelativePath(String, String) can be used to get the reference from the returned path. The baseProjectId used in both calls must be the same.

Specified by:

toRelativePath in interface HasRelativePath

Parameters:

baseProjectId - - null means global scope

Since:

3.9.1

scope

@NotNull
public Scope scope()

Specified by:

scope in interface ModelObjectReference

getFromRevision

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

Specified by:

getFromRevision in interface ModelObjectReference

Specified by:

getFromRevision in class ModelObjectReferenceBase<WorkItem,WorkItemReference>

requestedRevision - - null means current revision

getCurrent

@NotNull
public WorkItemReference 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<WorkItem,WorkItemReference>

getWithRevision

@NotNull
public WorkItemReference 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<WorkItem,WorkItemReference>

See Also:

• which is shortcut for calling this method with null

createLink

@NotNull
public WorkItemLinkBuilder createLink(@NotNull
 SharedContext context)

Description copied from interface: HasPortalLink

Creates portal link.

Specified by:

createLink in interface HasPortalLink

hashCode

public int hashCode()

Overrides:

hashCode in class ModelObjectReferenceBase<WorkItem,WorkItemReference>

equals

public boolean equals(@Nullable
 Object obj)

Overrides:

equals in class ModelObjectReferenceBase<WorkItem,WorkItemReference>

prototype

@NotNull
public PrototypeEnum prototype()

Specified by:

prototype in interface ModelObjectReference