raccoon.api.eai.uitest
Interface IUnitPlayer

All Known Implementing Classes:

FilePublisher, TibrvPlayer

public interface IUnitPlayer

The Unit player for non-regression testing.

Since:

Raccoon v0.7

Version:

$Id: IUnitPlayer.java,v 1.1 2004/08/08 20:25:56 crouvrais Exp $

Author:

Cedric ROUVRAIS

Field Summary

static java.lang.String	PLAYER_CHANNEL The string representing the property player channels.
static java.lang.String	REPEAT The string constant related to the repeat property.
static int	REPEAT_INFINITE This player should play the sequence indefinitly.
static int	REPEAT_ONCE This player should play the sequence only once.

Method Summary

void	addPlayerChannel(ComponentFile pRecordingChannel) Adds a new player channel to the list of current playing channels.
java.util.ArrayList	getPlayerChannels() The list of channels on which the messages are being sent.
int	getRepeat() The number of times this unit player must repeat the specified sequence.
void	run() Publishes all the sequenced messages.
void	setPlayerChannels(java.util.ArrayList pPlayerChannels) Sets the channels to which the events are to be sent.
void	setRepeat(int pRepeat) Defines the number of times this player should repeat the sequence.

Field Detail

PLAYER_CHANNEL

static final java.lang.String PLAYER_CHANNEL

The string representing the property player channels.

REPEAT_ONCE

static final int REPEAT_ONCE

This player should play the sequence only once.

See Also:

Constant Field Values

REPEAT_INFINITE

static final int REPEAT_INFINITE

This player should play the sequence indefinitly.

See Also:

Constant Field Values

REPEAT

static final java.lang.String REPEAT

The string constant related to the repeat property.

See Also:

Constant Field Values

Method Detail

getRepeat

int getRepeat()

The number of times this unit player must repeat the specified sequence.

Returns:

the number of repetitions.

setRepeat

void setRepeat(int pRepeat)
               throws RaccoonException,
                      java.lang.IllegalArgumentException

Defines the number of times this player should repeat the sequence.

Parameters:

pRepeat - the number of times this player should repeat the sequence, zero for infinite.

Throws:

RaccoonException - if this component is already running: the component can't be changed. Error code is ErrorCodes.COMPONENT_INITIALISED

java.lang.IllegalArgumentException - if the parameter is null, the message is obtained via MsgHelper.formatNullParamter(java.lang.String, java.lang.Class)

setPlayerChannels

void setPlayerChannels(java.util.ArrayList pPlayerChannels)
                       throws RaccoonException,
                              java.lang.IllegalArgumentException

Sets the channels to which the events are to be sent.

Parameters:

pPlayerChannels - the channels.

Throws:

RaccoonException - if this component is already running: the component can't be changed. Error code is ErrorCodes.COMPONENT_INITIALISED

java.lang.IllegalArgumentException - if the parameter is null, the message is obtained via MsgHelper.formatNullParamter(java.lang.String, java.lang.Class)

getPlayerChannels

java.util.ArrayList getPlayerChannels()

The list of channels on which the messages are being sent.

Returns:

an ArrayList of ComponentFile

addPlayerChannel

void addPlayerChannel(ComponentFile pRecordingChannel)
                      throws RaccoonException,
                             java.lang.IllegalArgumentException

Adds a new player channel to the list of current playing channels.

Parameters:

pRecordingChannel - the new playing channel to add.

Throws:

RaccoonException - if this component is already running: the component can't be changed. Error code is ErrorCodes.COMPONENT_INITIALISED

java.lang.IllegalArgumentException - if the parameter is null, the message is obtained via MsgHelper.formatNullParamter(java.lang.String, java.lang.Class)

run

void run()
         throws RaccoonException

Publishes all the sequenced messages.

Throws:

RaccoonException - if the publication is interrupted.