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

Class PlanReference

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<Plan,UpdatablePlan,PlanReference>

com.polarion.alm.shared.api.model.plan.PlanReference

All Implemented Interfaces:

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

public final class PlanReference
extends ModelObjectReferenceWithUpdatable<Plan,UpdatablePlan,PlanReference>
implements HasId, HasProjectId, HasPortalLink, HasRelativePath

Since:

3.9.0

See Also:

• Serialized Form

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
PlanLinkBuilder	createLink(SharedContext context)	Creates portal link.
boolean	equals(Object obj)
static PlanReference	fromPath(String path)	The path is trimmed before parsing, so it can contain spaces at the start or end. See toPath()
static PlanReference	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).
PlanReference	getCurrent()	Returns the reference to current revision of the object, in other words reference without requested revision and actual revision.
Plan	getFromRevision(ReadOnlyTransaction transaction, String revision)
PlanReference	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()	For now the plans are supported only in projects, so only the path in form of 'projectId/planId' 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

PlanReference

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

Throws:

IllegalArgumentException - when id is empty string

PlanReference

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

Since:

3.9.1

Method Details

fromPath

@NotNull
public static PlanReference 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 PlanReference 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 Plan getFromRevision(@NotNull
 ReadOnlyTransaction transaction,
 @Nullable
 String revision)

Specified by:

getFromRevision in interface ModelObjectReference

Specified by:

getFromRevision in class ModelObjectReferenceBase<Plan,PlanReference>

revision - - null means current revision

getCurrent

@NotNull
public PlanReference 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<Plan,PlanReference>

getWithRevision

@NotNull
public PlanReference 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<Plan,PlanReference>

See Also:

• which is 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 plans are supported only in projects, so only the path in form of 'projectId/planId' 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<Plan,PlanReference>

equals

public boolean equals(Object obj)

Overrides:

equals in class ModelObjectReferenceBase<Plan,PlanReference>

createLink

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