ItemScriptObject (EQUELLA Script API)

com.tle.common.scripting.objects
Interface ItemScriptObject

Declaration:	public interface ItemScriptObject extends ScriptObject
All Superinterfaces:	`ScriptObject, java.io.Serializable`

Referenced by the 'items' variable in script

Fields Summary
static java.lang.String	DEFAULT_VARIABLE

Methods Summary
abstract ItemScriptType	getItem(java.lang.String uuid, int version) Gets an item with the supplied uuid and version, or returns null if no item with the supplied uuid and version can be found.
abstract ItemScriptType	getLatestVersionItem(java.lang.String uuid) Gets the latest version of the item (not necessarily the Live version) with the supplied uuid, or null if no item with supplied uuid can be found.
abstract ItemScriptType	getLiveItem(java.lang.String uuid) Gets the Live version of the item with the supplied uuid, or null if no item with supplied uuid can be found.

DEFAULT_VARIABLE

public static final java.lang.String DEFAULT_VARIABLE

See also:

Constants

getItem

public abstract ItemScriptType getItem(

java.lang.String uuid,
int version)

Gets an item with the supplied uuid and version, or returns null if no item with the supplied uuid and version can be found.

Parameters:
uuid	-	The UUID of the item to get
version	-	The version of the item to get

Returns:
The item object or null if not found.

getLatestVersionItem

public abstract ItemScriptType getLatestVersionItem(

java.lang.String uuid)

Gets the latest version of the item (not necessarily the Live version) with the supplied uuid, or null if no item with supplied uuid can be found.

Parameters:
uuid	-	The UUID of the item to get

Returns:
The item object or null if not found.

getLiveItem

public abstract ItemScriptType getLiveItem(

java.lang.String uuid)

Gets the Live version of the item with the supplied uuid, or null if no item with supplied uuid can be found.

Parameters:
uuid	-	The UUID of the item to get the Live version of

Returns:
The item object or null if not found.