Package com.polarion.alm.tracker.model.scripting

Interface IScriptManager

public interface IScriptManager

Since:

3.24.10

Method Summary

Modifier and Type	Method	Description
IScript	createScript(String projectId)	Creates a Script in the given project or at repository root if null.
IScript	createScript(String projectId, String type)	Creates a Script with a selected type.
IScript	getScript(String projectId, String id)	Returns a Script.
IScript	getScript(String projectId, String id, String revision)	Returns a Script at the given revision.
IScript	getScriptByReference(String projectId, String referenceName)	Returns the Script with the specified reference name.

Method Details

createScript

@NotNull
IScript createScript(@Nullable
 String projectId)

Creates a Script in the given project or at repository root if null.

The Script is not saved. Users must call IPObject.save() manually.

createScript

@NotNull
IScript createScript(@Nullable
 String projectId,
 @NotNull
 String type)

Creates a Script with a selected type. Type must be supported or IllegalArgumentException will be thrown.

The Script is not saved. Users must call IPObject.save() manually.

getScript

@NotNull
IScript getScript(@Nullable
 String projectId,
 @NotNull
 String id)

Returns a Script. The object may be unresolvable.

getScript

@NotNull
IScript getScript(@Nullable
 String projectId,
 @NotNull
 String id,
 @Nullable
 String revision)

Returns a Script at the given revision. The object may be unresolvable.

getScriptByReference

@Nullable
IScript getScriptByReference(@Nullable
 String projectId,
 @NotNull
 String referenceName)

Returns the Script with the specified reference name. If there is no script with the specified reference name within the scope, it returns null.

Throws:

UserFriendlyRuntimeException - when multiple scripts share the same reference name within the scope