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

Interface ModelObjectReference

All Superinterfaces:

com.google.gwt.user.client.rpc.IsSerializable, ModelEntityReference, Serializable

All Known Implementing Classes:

BaselineCollectionReference, BaselineReference, CategoryReference, DocumentReference, ModelObjectReferenceBase, ModelObjectReferenceWithUpdatable, PlanReference, ProjectReference, RichPageReference, TestRunReference, TimePointReference, UserGroupReference, UserReference, WikiPageReference, WorkItemReference

public interface ModelObjectReference
extends ModelEntityReference, com.google.gwt.user.client.rpc.IsSerializable, Serializable

Since:

3.9.0

Method Summary

Modifier and Type	Method	Description
String	actualRevision()	Returns the revision from which the object was actually read even when the requestedRevision() was null.
ModelObject	get(ReadOnlyTransaction transaction)	Returns the object from requestedRevision(), if requested revision is null it returns current object, same as getCurrent(ReadOnlyTransaction).
ModelObjectReference	getCurrent()	Returns the reference to current revision of the object, in other words reference without requested revision and actual revision.
ModelObject	getCurrent(ReadOnlyTransaction transaction)	Returns the current object ignoring both requestedRevision() and actualRevision().
ModelObject	getFromRevision(ReadOnlyTransaction transaction, String requestedRevision)
ModelObject	getOriginal(ReadOnlyTransaction transaction)	Returns the object from requestedRevision() or actualRevision() if either of them is not null (checked in this order), otherwise returns the current object same as by calling getCurrent(ReadOnlyTransaction).
ModelObjectReference	getWithRevision(String requestedRevision)	Returns the reference to the same object, but with different requestedRevision(), the actualRevision() of the returned reference is null.
String	projectId()	It is shortcut for scope().Scope.projectId()
PrototypeEnum	prototype()
String	requestedRevision()
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 requestedRevision() and actualRevision() are ignored.

Method Details

get

@NotNull
ModelObject get(@NotNull
 ReadOnlyTransaction transaction)

Returns the object from requestedRevision(), if requested revision is null it returns current object, same as getCurrent(ReadOnlyTransaction). The actualRevision() is ignored by this method.

Specified by:

get in interface ModelEntityReference

See Also:

• get(ReadOnlyTransaction)

getCurrent

@NotNull
ModelObject getCurrent(@NotNull
 ReadOnlyTransaction transaction)

Returns the current object ignoring both requestedRevision() and actualRevision().

getOriginal

@NotNull
ModelObject getOriginal(@NotNull
 ReadOnlyTransaction transaction)

Returns the object from requestedRevision() or actualRevision() if either of them is not null (checked in this order), otherwise returns the current object same as by calling getCurrent(ReadOnlyTransaction).

getFromRevision

@NotNull
ModelObject getFromRevision(@NotNull
 ReadOnlyTransaction transaction,
 @Nullable
 String requestedRevision)

Parameters:

transaction -

requestedRevision - - null means current revision

actualRevision

@Nullable
String actualRevision()

Returns the revision from which the object was actually read even when the requestedRevision() was null. This value does not have impact in Object.hashCode() and Object.equals(Object) methods.
Never returns empty string or string containing only white space characters.

requestedRevision

@Nullable
String requestedRevision()

Returns:

revision which was requested by user. Never returns empty string or string containing only white space characters.

getWithRevision

@NotNull
ModelObjectReference getWithRevision(@Nullable
 String requestedRevision)

Returns the reference to the same object, but with different requestedRevision(), the actualRevision() of the returned reference is null.

See Also:

• which is shortcut for calling this method with null

getCurrent

@NotNull
ModelObjectReference getCurrent()

Returns the reference to current revision of the object, in other words reference without requested revision and actual revision. It is shortcut for calling getWithRevision(String) with null

prototype

@NotNull
PrototypeEnum prototype()

scope

@NotNull
Scope scope()

toPath

@NotNull
String toPath()

Returns type specific unique identification path of the object, for example for Work Items in project it is 'projectId/workItemId', the requestedRevision() and actualRevision() are ignored.

Specified by:

toPath in interface ModelEntityReference

See Also:

• ModelObjectSelector.path(String)

projectId

@Nullable
String projectId()

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

Since:

3.9.2