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

Class ProjectReference

java.lang.Object

com.polarion.alm.shared.api.model.ModelEntityReferenceBase<Project,ProjectReference>

com.polarion.alm.shared.api.model.ModelObjectReferenceBase<Project,ProjectReference>

com.polarion.alm.shared.api.model.ModelObjectReferenceWithUpdatable<Project,UpdatableProject,ProjectReference>

com.polarion.alm.shared.api.model.project.ProjectReference

All Implemented Interfaces:

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

public final class ProjectReference
extends ModelObjectReferenceWithUpdatable<Project,UpdatableProject,ProjectReference>
implements HasPortalLink, HasId

Since:

3.9.0

See Also:

• Serialized Form

Constructor Summary

Constructors

Constructor	Description
ProjectReference(String id)
ProjectReference(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 ProjectReference	fromPath(String path)	The path is trimmed before parsing, so it can contain spaces at the start or end.
ProjectReference	getCurrent()	Deprecated. See ModelObjectReference.getCurrent()
Project	getFromRevision(ReadOnlyTransaction transaction, String requestedRevision)	Returns the object from the specified revision.
ProjectReference	getWithRevision(String requestedRevision)	Deprecated. See ModelObjectReference.getWithRevision(String)
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

ProjectReference

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

Throws:

IllegalArgumentException - when id is empty string

ProjectReference

public ProjectReference(@NotNull
 String id)

Throws:

IllegalArgumentException - when id is empty string

Since:

3.9.1

Method Details

fromPath

@NotNull
public static ProjectReference 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()

getFromRevision

@NotNull
public Project 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<Project,ProjectReference>

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 ProjectReference 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<Project,ProjectReference>

getWithRevision

@Deprecated
@NotNull
public ProjectReference 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<Project,ProjectReference>

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()

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:

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

hashCode

public int hashCode()

Overrides:

hashCode in class ModelObjectReferenceBase<Project,ProjectReference>

equals

public boolean equals(Object obj)

Overrides:

equals in class ModelObjectReferenceBase<Project,ProjectReference>

createLink

@NotNull
public PortalLink 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