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

Class DocumentReference

java.lang.Object

com.polarion.alm.shared.api.model.ModelEntityReferenceBase<Document,DocumentReference>

com.polarion.alm.shared.api.model.ModelObjectReferenceBase<Document,DocumentReference>

com.polarion.alm.shared.api.model.ModelObjectReferenceWithUpdatable<Document,UpdatableDocument,DocumentReference>

com.polarion.alm.shared.api.model.document.DocumentReference

All Implemented Interfaces:

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

public final class DocumentReference
extends ModelObjectReferenceWithUpdatable<Document,UpdatableDocument,DocumentReference>
implements HasPortalLink, HasNameAndSpaceReference, HasProjectId

Since:

3.9.0

See Also:

• Serialized Form

Constructor Summary

Constructors

Constructor	Description
DocumentReference(SpaceReference spaceReference, String name)
DocumentReference(SpaceReference spaceReference, String name, String requestedRevision, String actualRevision)

Method Summary

Modifier and Type	Method	Description
DocumentLinkBuilder	createLink(SharedContext context)	Creates portal link.
boolean	equals(Object obj)
static DocumentReference	fromModuleLocation(String projectId, String moduleLocation, String requestedRevision)
static DocumentReference	fromPath(String path)	The path is trimmed before parsing, so it can contain spaces at the start or end. The path can be obtained using toPath(), but this method works in more user friendly way by filling some missing parts with defaults.
static DocumentReference	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), but this method works in more user friendly way by filling some missing parts with defaults.
static DocumentReference	fromSpaceRelativePath(SpaceReference baseSpace, String path)	The path is trimmed before parsing, so it can contain spaces at the start or end. The path can be obtained using toSpaceRelativePath(SpaceReference), but this method works in more user friendly way by filling some missing parts with defaults.
DocumentReference	getCurrent()	Deprecated. See ModelObjectReference.getCurrent()
Document	getFromRevision(ReadOnlyTransaction transaction, String requestedRevision)	Returns the object from the specified revision.
DocumentReference	getWithRevision(String requestedRevision)	Deprecated. See ModelObjectReference.getWithRevision(String)
int	hashCode()
String	name()
String	projectId()	It is shortcut for ModelObjectReference.scope().Scope.projectId()
PrototypeEnum	prototype()
Scope	scope()
SpaceReference	spaceReference()
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 unique relative path identifying the referenced document relative to the given project or global scope, the ModelObjectReferenceBase.requestedRevision() and ModelObjectReferenceBase.actualRevision() are ignored. The fromRelativePath(String, String) can be used to get the reference from the returned path.
String	toSpaceRelativePath(SpaceReference baseSpace)	Returns unique string identifying the referenced document relative to the given space, the ModelObjectReferenceBase.requestedRevision() and ModelObjectReferenceBase.actualRevision() are ignored. The fromSpaceRelativePath(SpaceReference, 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, requestedRevision, toString

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Details

DocumentReference

public DocumentReference(@NotNull
 SpaceReference spaceReference,
 @NotNull
 String name,
 @Nullable
 String requestedRevision,
 @Nullable
 String actualRevision)

Throws:

IllegalArgumentException - when SpaceReference.projectId() is null or name is empty string

DocumentReference

public DocumentReference(@NotNull
 SpaceReference spaceReference,
 @NotNull
 String name)

Throws:

IllegalArgumentException - when SpaceReference.projectId() is null or name is empty string

Since:

3.9.1

Method Details

fromPath

@NotNull
public static DocumentReference fromPath(@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 toPath(), but this method works in more user friendly way by filling some missing parts with defaults.

fromSpaceRelativePath

@NotNull
public static DocumentReference fromSpaceRelativePath(@Nullable
 SpaceReference baseSpace,
 @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 toSpaceRelativePath(SpaceReference), but this method works in more user friendly way by filling some missing parts with defaults. The baseSpace used in both calls must be the same.

Parameters:

baseSpace - - when null, then this method works same as fromPath(String)

Since:

3.9.1

fromRelativePath

@NotNull
public static DocumentReference 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), but this method works in more user friendly way by filling some missing parts with defaults. The baseProjectId used in both calls must be the same.

Parameters:

baseProjectId - - null means global scope

Since:

3.9.1

fromModuleLocation

public static DocumentReference fromModuleLocation(@NotNull
 String projectId,
 @NotNull
 String moduleLocation,
 @Nullable
 String requestedRevision)

getFromRevision

@NotNull
public Document 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<Document,DocumentReference>

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 DocumentReference 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<Document,DocumentReference>

getWithRevision

@Deprecated
@NotNull
public DocumentReference 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<Document,DocumentReference>

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.

spaceReference

@NotNull
public SpaceReference spaceReference()

Specified by:

spaceReference in interface HasNameAndSpaceReference

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<Document,DocumentReference>

name

@NotNull
public String name()

Specified by:

name in interface HasNameAndSpaceReference

hashCode

public int hashCode()

Overrides:

hashCode in class ModelObjectReferenceBase<Document,DocumentReference>

equals

public boolean equals(Object obj)

Overrides:

equals in class ModelObjectReferenceBase<Document,DocumentReference>

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)

toSpaceRelativePath

@NotNull
public String toSpaceRelativePath(@Nullable
 SpaceReference baseSpace)

Returns unique string identifying the referenced document relative to the given space, the ModelObjectReferenceBase.requestedRevision() and ModelObjectReferenceBase.actualRevision() are ignored.

The fromSpaceRelativePath(SpaceReference, String) can be used to get the reference from the returned path. The baseSpace used in both calls must be the same.

Specified by:

toSpaceRelativePath in interface HasNameAndSpaceReference

Parameters:

baseSpace - - when null, then the returned path is same as from toPath().

Since:

3.9.1

toRelativePath

@NotNull
public String toRelativePath(@Nullable
 String baseProjectId)

Returns unique relative path identifying the referenced document relative to the given project or global scope, the ModelObjectReferenceBase.requestedRevision() and ModelObjectReferenceBase.actualRevision() are ignored.

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

scope

@NotNull
public Scope scope()

Specified by:

scope in interface ModelObjectReference

createLink

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