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

Class ScriptReference

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<Script,UpdatableScript,ScriptReference>

com.polarion.alm.shared.api.model.scripting.ScriptReference

All Implemented Interfaces:

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

public class ScriptReference
extends ModelObjectReferenceWithUpdatable<Script,UpdatableScript,ScriptReference>
implements HasId, HasPortalLink

Since:

3.24.10

See Also:

• Serialized Form

Constructor Summary

Constructors

Constructor	Description
ScriptReference(String id)
ScriptReference(String projectId, String id)
ScriptReference(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 ScriptReference	fromPath(String path)
Script	getFromRevision(ReadOnlyTransaction transaction, String requestedRevision)
ScriptReference	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.

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

ScriptReference

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

ScriptReference

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

ScriptReference

public ScriptReference(@NotNull
 String id)

Method Details

prototype

@NotNull
public PrototypeEnum prototype()

Specified by:

prototype in interface ModelObjectReference

scope

@NotNull
public Scope scope()

Specified by:

scope in interface ModelObjectReference

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)

getFromRevision

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

Specified by:

getFromRevision in interface ModelObjectReference

Specified by:

getFromRevision in class ModelObjectReferenceBase<Script,ScriptReference>

requestedRevision - - null means current revision

getWithRevision

@NotNull
public ScriptReference 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<Script,ScriptReference>

See Also:

• which is shortcut for calling this method with null

id

@NotNull
public String id()

Specified by:

id in interface HasId

projectId

@Nullable
public String projectId()

Description copied from interface: ModelObjectReference

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

Specified by:

projectId in interface ModelObjectReference

Overrides:

projectId in class ModelObjectReferenceBase<Script,ScriptReference>

fromPath

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

hashCode

public int hashCode()

Overrides:

hashCode in class ModelObjectReferenceBase<Script,ScriptReference>

equals

public boolean equals(Object obj)

Overrides:

equals in class ModelObjectReferenceBase<Script,ScriptReference>

createLink

@NotNull
public PortalLink createLink(@NotNull
 SharedContext context)

Description copied from interface: HasPortalLink

Creates portal link.

Specified by:

createLink in interface HasPortalLink