com.sap.tc.webdynpro.repository.api
Interface IWDVariant

public interface IWDVariant

API of a variant. The index of the predecessor positions is zero based.

Version:

$Id: //tc/WebDynproRuntime/630_VAL_REL/src/_webdynpro_runtime_repository/java/com/sap/tc/webdynpro/repository/api/IWDVariant.java#1 $

Field Summary

static java.lang.String

BASE_VARIANT_NAME name of the default base variant

Method Summary

void	addPredecessor(int index, IWDVariant variant) Adds a predecessor to the variant.
void	addPredecessor(IWDVariant variant) Adds a predecessor to the variant.
java.lang.String	getName() Returns the name of the variant.
int	indexOfPredecessor(IWDVariant variant) Returns the position of a predecessor.
java.util.Iterator	iteratePredecessors() Returns an iterator over the predecessors of the variant.
void	removePredecessor(IWDVariant variant) Removes a predecessor of the variant.

Field Detail

BASE_VARIANT_NAME

public static final java.lang.String BASE_VARIANT_NAME

name of the default base variant

Method Detail

getName

public java.lang.String getName()

Returns the name of the variant.

Returns:

the name of the variant

addPredecessor

public void addPredecessor(IWDVariant variant)

Adds a predecessor to the variant. The predecessor gets the lowest priority of all currently assigned predecessors.

Parameters:

variant - the variant to add as a predecessor

addPredecessor

public void addPredecessor(int index,
                           IWDVariant variant)

Adds a predecessor to the variant.

Parameters:

index - position in the predecessor list where the new predecessor is inserted

variant - the variant to add as a predecessor

removePredecessor

public void removePredecessor(IWDVariant variant)

Removes a predecessor of the variant.

Parameters:

variant - variant that should be no longer a predecessor

indexOfPredecessor

public int indexOfPredecessor(IWDVariant variant)

Returns the position of a predecessor.

Parameters:

variant - the predecessor for which the position will be returned

Returns:

the position of the predecessor in the list of predecessors

iteratePredecessors

public java.util.Iterator iteratePredecessors()

Returns an iterator over the predecessors of the variant.

Returns:

an iterator over the predecessors of the variant