Class RichPageReference
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<RichPage,UpdatableRichPage,RichPageReference>
com.polarion.alm.shared.api.model.rp.RichPageReference
- All Implemented Interfaces:
com.google.gwt.user.client.rpc.IsSerializable
,HasProjectId
,HasRelativePath
,ModelEntityReference
,ModelObjectReference
,ReferenceWithUpdatable<UpdatableRichPage>
,HasNameAndSpaceReference
,HasPortalLink
,Serializable
public final class RichPageReference
extends ModelObjectReferenceWithUpdatable<RichPage,UpdatableRichPage,RichPageReference>
implements HasPortalLink, HasNameAndSpaceReference, HasProjectId
- Since:
- 3.9.0
- See Also:
-
Field Summary
Fields -
Constructor Summary
ConstructorsConstructorDescriptionRichPageReference
(SpaceReference spaceReference, String name) RichPageReference
(SpaceReference spaceReference, String name, String requestedRevision, String actualRevision) -
Method Summary
Modifier and TypeMethodDescriptioncreateLink
(SharedContext context) Creates portal link.boolean
static RichPageReference
The path is trimmed before parsing, so it can contain spaces at the start or end.
The path can be obtained usingtoPath()
, but this method works in more user friendly way by filling some missing parts with defaults.static RichPageReference
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 usingtoRelativePath(String)
, but this method works in more user friendly way by filling some missing parts with defaults.static RichPageReference
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 usingtoSpaceRelativePath(SpaceReference)
, but this method works in more user friendly way by filling some missing parts with defaults.Returns the reference to current revision of the object, in other words reference without requested revision and actual revision.getFromRevision
(ReadOnlyTransaction transaction, String revision) getWithRevision
(String requestedRevision) Returns the reference to the same object, but with differentModelObjectReference.requestedRevision()
, theModelObjectReference.actualRevision()
of the returned reference is null.int
hashCode()
boolean
boolean
boolean
name()
scope()
toPath()
Returns unique string identifying the referenced page, theModelObjectReferenceBase.requestedRevision()
andModelObjectReferenceBase.actualRevision()
are ignored.
ThefromPath(String)
can be used to get the reference from the returned path.toRelativePath
(String baseProjectId) Returns unique relative path identifying the referenced page relative to the given project or global scope, theModelObjectReferenceBase.requestedRevision()
andModelObjectReferenceBase.actualRevision()
are ignored.
ThefromRelativePath(String, String)
can be used to get the reference from the returned path.toSpaceRelativePath
(SpaceReference baseSpace) Returns unique path identifying the referenced page relative to the given project, theModelObjectReferenceBase.requestedRevision()
andModelObjectReferenceBase.actualRevision()
are ignored.
ThefromSpaceRelativePath(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, projectId, requestedRevision, toString
Methods inherited from interface com.polarion.alm.shared.api.model.HasProjectId
projectId
-
Field Details
-
HOME
Name of the Home page.- Since:
- 3.9.1
- See Also:
-
-
Constructor Details
-
Method Details
-
fromPath
The path is trimmed before parsing, so it can contain spaces at the start or end.
The path can be obtained usingtoPath()
, but this method works in more user friendly way by filling some missing parts with defaults. -
fromRelativePath
@NotNull public static RichPageReference 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 usingtoRelativePath(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
-
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 callingModelObjectReference.getWithRevision(String)
with null- Specified by:
getCurrent
in interfaceModelObjectReference
- Overrides:
getCurrent
in classModelObjectReferenceBase<RichPage,
RichPageReference>
-
getWithRevision
Description copied from interface:ModelObjectReference
Returns the reference to the same object, but with differentModelObjectReference.requestedRevision()
, theModelObjectReference.actualRevision()
of the returned reference is null.- Specified by:
getWithRevision
in interfaceModelObjectReference
- Specified by:
getWithRevision
in classModelObjectReferenceBase<RichPage,
RichPageReference> - See Also:
-
spaceReference
- Specified by:
spaceReference
in interfaceHasNameAndSpaceReference
-
name
- Specified by:
name
in interfaceHasNameAndSpaceReference
-
hashCode
public int hashCode()- Overrides:
hashCode
in classModelObjectReferenceBase<RichPage,
RichPageReference>
-
equals
- Overrides:
equals
in classModelObjectReferenceBase<RichPage,
RichPageReference>
-
scope
- Specified by:
scope
in interfaceModelObjectReference
-
toPath
Returns unique string identifying the referenced page, theModelObjectReferenceBase.requestedRevision()
andModelObjectReferenceBase.actualRevision()
are ignored.
ThefromPath(String)
can be used to get the reference from the returned path.- Specified by:
toPath
in interfaceModelEntityReference
- Specified by:
toPath
in interfaceModelObjectReference
- See Also:
-
toRelativePath
Returns unique relative path identifying the referenced page relative to the given project or global scope, theModelObjectReferenceBase.requestedRevision()
andModelObjectReferenceBase.actualRevision()
are ignored.
ThefromRelativePath(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 interfaceHasRelativePath
- Parameters:
baseProjectId
- - null means global scope- Since:
- 3.9.1
-
prototype
- Specified by:
prototype
in interfaceModelObjectReference
-
isRepositoryHomePage
public boolean isRepositoryHomePage()- Since:
- 3.10.1
-
isProjectHomePage
public boolean isProjectHomePage()- Since:
- 3.10.1
-
isSpaceHomePage
public boolean isSpaceHomePage()- Returns:
- true if page is Home page for any space, global or project, default or named
- Since:
- 3.10.1
-