com.sapportals.wcm.service.scheduler

Interface ISequence

public interface ISequence

Specifies a sequence of scheduler entries. This is an additional order relation to perfom scheduler tasks at a certain time only after a previous sequenced task was performed before.

Each scheduler entry has to be unique in this sequence. Copyright (c)2003 SAP AG

Method Summary

ISchedulerEntry	add(int index, ISchedulerEntry entry) Inserts a scheduler entry to the sequence at position index.
ISchedulerEntry	add(ISchedulerEntry entry) Appends a scheduler entry to the end of the sequence.
void	clear() Removes all of the elements from this sequence.
boolean	contains(ISchedulerEntry entry) Returns true if this sequence contains the specified entry.
ISchedulerEntry	get(int index) Returns the entry at the specified position in this sequence.
String	getID() Get the unique id of the sequence.
boolean	isEmpty() Returns true if this sequence contains no entries.
boolean	remove(ISchedulerEntry entry) Removes an entry from the sequence.
int	size() Returns the number of entries in this sequence.
ISchedulerEntry[]	toArray() Converts the entries of this sequence to an array in the proper order.

Method Detail

getID

String getID()

Get the unique id of the sequence.

Returns:

a String with the entry's id.

add

ISchedulerEntry add(ISchedulerEntry entry)
                    throws WcmException

Appends a scheduler entry to the end of the sequence. The scheduler entry must not be added before, otherwise an exception will be raised.

Parameters:

entry - A scheduler entry

Returns:

the added scheduler entry

Throws:

WcmException - If adding fails.

add

ISchedulerEntry add(int index,
                    ISchedulerEntry entry)
                    throws WcmException

Inserts a scheduler entry to the sequence at position index. The scheduler entry must not be added before, otherwise an exception will be raised.

Parameters:

index - The position of the entry in the sequence.

entry - A scheduler entry

Returns:

the added scheduler entry

Throws:

WcmException - If adding fails.

remove

boolean remove(ISchedulerEntry entry)
               throws WcmException

Removes an entry from the sequence. If this sequence does not contain the entry, it is unchanged.

Parameters:

entry - The entry to remove.

Returns:

true if this list contained the specified element.

Throws:

WcmException

clear

void clear()
           throws WcmException

Removes all of the elements from this sequence. This sequence will be empty after this call returns (unless it throws an exception).

Throws:

WcmException

toArray

ISchedulerEntry[] toArray()

Converts the entries of this sequence to an array in the proper order.

Returns:

an array of scheduler entries

size

int size()

Returns the number of entries in this sequence.

Returns:

the number of entries in this sequence.

isEmpty

boolean isEmpty()

Returns true if this sequence contains no entries.

Returns:

true if this sequence contains no entries.

get

ISchedulerEntry get(int index)

Returns the entry at the specified position in this sequence.

Parameters:

index - of element to return.

Returns:

the element at the specified position in this list.

contains

boolean contains(ISchedulerEntry entry)

Returns true if this sequence contains the specified entry. More formally, returns true if and only if this sequence contains exactly one entry e such that (entry==null ? e==null : entry.equals(e)).

Parameters:

entry - entry whose presence in this sequence is to be tested.

Returns:

true if this list contains the specified element.

Access Rights

This class can be accessed from:

SC	DC	Public Part	ACH
[sap.com] KMC-CM	[sap.com] tc/km/frwk	api	EP-KM-CM
[sap.com] KMC-WPC	[sap.com] tc/kmc/wpc/wpcfacade	api	EP-PIN-WPC-WCM