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

Class BaselineCollectionReference

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<BaselineCollection,UpdatableBaselineCollection,BaselineCollectionReference>

com.polarion.alm.shared.api.model.baselinecollection.BaselineCollectionReference

All Implemented Interfaces:

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

public class BaselineCollectionReference
extends ModelObjectReferenceWithUpdatable<BaselineCollection,UpdatableBaselineCollection,BaselineCollectionReference>
implements HasId, HasProjectId, HasRelativePath, HasPortalLink

Since:

3.20.1

See Also:

• Serialized Form

Constructor Summary

Constructors

Constructor	Description
BaselineCollectionReference(String projectId, String id)
BaselineCollectionReference(String projectId, 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 BaselineCollectionReference	fromPath(String path)	The path is trimmed before parsing, so it can contain spaces at the start or end.
static BaselineCollectionReference	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).
BaselineCollection	getFromRevision(ReadOnlyTransaction transaction, String requestedRevision)
BaselineCollectionReference	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 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.
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, getCurrent, getOriginal, requestedRevision, toString

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Details

BaselineCollectionReference

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

Throws:

IllegalArgumentException - when projectId or id is empty string

BaselineCollectionReference

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

Throws:

IllegalArgumentException - when projectId or id is empty string

Method Details

fromPath

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

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

See toPath().

Throws:

IllegalArgumentException - in same conditions as WorkItemReference.fromPath(String)

See Also:

• ModelObjectSelector.path(String)

fromRelativePath

@NotNull
public static BaselineCollectionReference 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 WorkItemReference.fromRelativePath(String, String)

getFromRevision

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

Specified by:

getFromRevision in interface ModelObjectReference

Specified by:

getFromRevision in class ModelObjectReferenceBase<BaselineCollection,BaselineCollectionReference>

requestedRevision - - null means current revision

id

@NotNull
public String id()

Specified by:

id in interface HasId

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<BaselineCollection,BaselineCollectionReference>

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:

• 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

prototype

@NotNull
public PrototypeEnum prototype()

Specified by:

prototype in interface ModelObjectReference

scope

@NotNull
public Scope scope()

Specified by:

scope in interface ModelObjectReference

getWithRevision

@NotNull
public BaselineCollectionReference 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<BaselineCollection,BaselineCollectionReference>

See Also:

• which is shortcut for calling this method with null

hashCode

public int hashCode()

Overrides:

hashCode in class ModelObjectReferenceBase<BaselineCollection,BaselineCollectionReference>

equals

public boolean equals(Object obj)

Overrides:

equals in class ModelObjectReferenceBase<BaselineCollection,BaselineCollectionReference>

createLink

@NotNull
public PortalLink createLink(@NotNull
 SharedContext context)

Description copied from interface: HasPortalLink

Creates portal link.

Specified by:

createLink in interface HasPortalLink