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

Class TestRunReference

java.lang.Object

com.polarion.alm.shared.api.model.ModelEntityReferenceBase<TestRun,TestRunReference>

com.polarion.alm.shared.api.model.ModelObjectReferenceBase<TestRun,TestRunReference>

com.polarion.alm.shared.api.model.ModelObjectReferenceWithUpdatable<TestRun,UpdatableTestRun,TestRunReference>

com.polarion.alm.shared.api.model.tr.TestRunReference

All Implemented Interfaces:

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

public final class TestRunReference
extends ModelObjectReferenceWithUpdatable<TestRun,UpdatableTestRun,TestRunReference>
implements HasId, HasProjectId, HasPortalLink, HasRelativePath

Since:

3.9.0

See Also:

• Serialized Form

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
TestRunLinkBuilder	createLink(SharedContext context)	Creates portal link.
boolean	equals(Object obj)
static TestRunReference	fromPath(String path)	The path is trimmed before parsing, so it can contain spaces at the start or end. See toPath()
static TestRunReference	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).
TestRunReference	getCurrent()	Deprecated. See ModelObjectReference.getCurrent()
TestRun	getFromRevision(ReadOnlyTransaction transaction, String requestedRevision)	Returns the object from the specified revision.
TestRunReference	getWithRevision(String requestedRevision)	Deprecated. See ModelObjectReference.getWithRevision(String)
int	hashCode()
String	id()
PrototypeEnum	prototype()
Scope	scope()
String	toPath()	For now the testRuns are supported only in projects, so only the path in form of 'projectId/testRunId' is supported, but in the future also path starting with / will be supported for paths starting with project group path
String	toRelativePath(String baseProjectId)	Returns the id() if the baseProjectId is same as ModelObjectReferenceBase.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, projectId, requestedRevision, toString

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.polarion.alm.shared.api.model.HasProjectId

projectId

Constructor Details

TestRunReference

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

Throws:

IllegalArgumentException - when id is empty string

TestRunReference

public TestRunReference(@Nullable
 String projectId,
 @NotNull
 String id)

Throws:

IllegalArgumentException - when id is empty string

Since:

3.9.1

Method Details

fromPath

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

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

See toPath()

See Also:

• ModelObjectSelector.path(String)

fromRelativePath

@NotNull
public static TestRunReference 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.

Since:

3.9.1

getFromRevision

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

Description copied from interface: ModelObjectReference

Returns the object from the specified revision.

This method correctly handles objects (e.g. Documents) that were renamed or moved: it first resolves the object using the revision stored in this reference (ModelObjectReference.requestedRevision(), or ModelObjectReference.actualRevision() if ModelObjectReference.requestedRevision() is null), and then retrieves the object at the given requestedRevision revision.

If requestedRevision is null, returns the current (latest) revision of the object.

Specified by:

getFromRevision in interface ModelObjectReference

Overrides:

getFromRevision in class ModelObjectReferenceBase<TestRun,TestRunReference>

Parameters:

transaction - the read-only transaction

requestedRevision - the revision from which to get the object, or null for current (latest) revision

Returns:

the object at the specified revision

getCurrent

@Deprecated
@NotNull
public TestRunReference getCurrent()

Deprecated.

See ModelObjectReference.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 a shortcut for calling ModelObjectReference.getWithRevision(String) with null.

Note: The returned reference retains the current path (space and name) of the object. It does not correctly support objects (e.g. Documents) that were renamed or moved, because the path in the reference reflects the object's current location, not its location at any given revision. As a result, using this reference may fail to resolve the object if it has been renamed or moved.

Specified by:

getCurrent in interface ModelObjectReference

Overrides:

getCurrent in class ModelObjectReferenceBase<TestRun,TestRunReference>

getWithRevision

@Deprecated
@NotNull
public TestRunReference getWithRevision(@Nullable
 String requestedRevision)

Deprecated.

See ModelObjectReference.getWithRevision(String)

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.

Note: The returned reference retains the current path (space and name) of the object. It does not correctly support objects (e.g. Documents) that were renamed or moved, because the path in the reference reflects the object's current location, not its location at the specified revision. As a result, using this reference may fail to resolve the object if it has been renamed or moved.

Specified by:

getWithRevision in interface ModelObjectReference

Specified by:

getWithRevision in class ModelObjectReferenceBase<TestRun,TestRunReference>

Parameters:

requestedRevision - the revision to be set in the returned reference, or null for the current revision.

See Also:

• getCurrent() which is the shortcut for calling this method with null.

scope

@NotNull
public Scope scope()

Specified by:

scope in interface ModelObjectReference

id

@NotNull
public String id()

Specified by:

id in interface HasId

toPath

@NotNull
public String toPath()

For now the testRuns are supported only in projects, so only the path in form of 'projectId/testRunId' is supported, but in the future also path starting with / will be supported for paths starting with project group path

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 ModelObjectReferenceBase.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

hashCode

public int hashCode()

Overrides:

hashCode in class ModelObjectReferenceBase<TestRun,TestRunReference>

equals

public boolean equals(Object obj)

Overrides:

equals in class ModelObjectReferenceBase<TestRun,TestRunReference>

createLink

@NotNull
public TestRunLinkBuilder createLink(@NotNull
 SharedContext context)

Description copied from interface: HasPortalLink

Creates portal link.

Specified by:

createLink in interface HasPortalLink

prototype

@NotNull
public PrototypeEnum prototype()

Specified by:

prototype in interface ModelObjectReference