com.hpe.caf.worker.document.model

Interface Scripts

All Superinterfaces:

DocumentWorkerObject, Iterable<Script>

public interface Scripts
extends DocumentWorkerObject, Iterable<Script>

Represents the list of customization scripts which are attached to a task.

Method Summary

Modifier and Type	Method and Description
Script	add() Creates a new uninitialized customization script and appends it to the end of this list.
Script	add(int index) Creates a new uninitialized customization script and inserts it at the specified position in this list.
Script	get(int index) Retrieves the script at the specified position in this list.
Task	getTask() Returns the task that this list of scripts is associated with.
boolean	isEmpty() Returns true if there are no scripts in this list.
int	size() Returns the number of scripts in this list.
Stream<Script>	stream() Returns a sequential Stream with this list of scripts as its source.
void	uninstallAll() Uninstalls all of the scripts in this list.

Methods inherited from interface com.hpe.caf.worker.document.model.DocumentWorkerObject

getApplication

Methods inherited from interface java.lang.Iterable

forEach, iterator, spliterator

Method Detail

add

@Nonnull
Script add()

Creates a new uninitialized customization script and appends it to the end of this list. The newly created script is not installed and it is not loaded, so it can be adjusted without having to first unload it.

Returns:

the newly created script

add

@Nonnull
Script add(int index)

Creates a new uninitialized customization script and inserts it at the specified position in this list. The newly created script is not installed and it is not loaded, so it can be adjusted without having to first unload it.

Parameters:

index - index at which the newly created script is to be inserted

Returns:

the newly created script

get

@Nonnull
Script get(int index)

Retrieves the script at the specified position in this list.

Parameters:

index - index of the script to return

Returns:

the script at the specified position in this list

Throws:

IndexOutOfBoundsException - if the index is out of range (index < 0 || index >= size())

getTask

@Nonnull
Task getTask()

Returns the task that this list of scripts is associated with.

Returns:

the task that this list of scripts is associated with

isEmpty

boolean isEmpty()

Returns true if there are no scripts in this list.

Returns:

true if there are no scripts in this list

size

int size()

Returns the number of scripts in this list.

Returns:

the number of scripts in this list

stream

@Nonnull
Stream<Script> stream()

Returns a sequential Stream with this list of scripts as its source.

Returns:

a sequential Stream over the list of scripts

uninstallAll

void uninstallAll()

Uninstalls all of the scripts in this list.

This is equivalent to calling uninstall() for each of the scripts in the list.