com.highdeal.hci

Interface MessageListener

All Known Subinterfaces:

ClientMessageListener

public interface MessageListener

This Java interface defines a communication listener in your client application; This listener is notified when an operation is completed, when the current operation notifies progress, and when a message (message envelope) is completed.

Implementation in Your Client Application

You use this interface to implement asynchronous communications with the SAP CC system via the HCI technical interface.

See Also:

MessageSender.asyncSend(MessageEnvelope, ClientMessageListener)

Field Summary

Fields

Modifier and Type	Field and Description
static int	STOPPABLE_STATUS 1: Stoppable operation status constant
static int	UNBREAKABLE_STATUS 2: Unbreakable operation status constant

Method Summary

Modifier and Type	Method and Description
void	envelopeCompleted() Invoked when a message is completed.
void	envelopeStopped() Invoked when a message is stopped.
void	operationCompleted(int op) Invoked when an operation is completed.
void	operationStopped(int op) Invoked when an operation is stopped.
void	progressReceived(int op, int current, int max) Invoked when the current operation notifies progress.
void	statusChangeReceived(int op, int status) Invoked when the current operation notifies a status change.
void	statusChangeReceived(int op, int subOp, int status) Invoked when the current operation notifies a status change.

Field Detail

STOPPABLE_STATUS

static final int STOPPABLE_STATUS

1: Stoppable operation status constant

See Also:

Constant Field Values

UNBREAKABLE_STATUS

static final int UNBREAKABLE_STATUS

2: Unbreakable operation status constant

See Also:

Constant Field Values

Method Detail

operationCompleted

void operationCompleted(int op)

Invoked when an operation is completed.

Parameters:

op - The operation rank in the message (starting from 0)

operationStopped

void operationStopped(int op)

Invoked when an operation is stopped.

Parameters:

op - The operation rank in the message (starting from 0)

progressReceived

void progressReceived(int op,
                      int current,
                      int max)

Invoked when the current operation notifies progress.

Parameters:

op - The operation rank in the message (starting from 0)

current - The progress of the operation

max - The maximum for the progress of this operation, or -1 if maximum cannot be determined

statusChangeReceived

void statusChangeReceived(int op,
                          int status)

Invoked when the current operation notifies a status change.

For example, during the execution the operation status can change from a cancellable operation status to a stoppable operation status.

The available statuses are:

• STOPPABLE_STATUS
• UNBREAKABLE_STATUS

Parameters:

op - The operation rank in the message (starting from 0)

status - The current status of the operation

statusChangeReceived

void statusChangeReceived(int op,
                          int subOp,
                          int status)

Invoked when the current operation notifies a status change.

For example, during the execution the operation status can change from a cancellable operation status to a stoppable operation status.

The available statuses are:

• STOPPABLE_STATUS
• UNBREAKABLE_STATUS

Parameters:

op - The operation rank in the message (starting from 0)

subOp - The subscription sub operation rank in the operation (starting from 0)

status - The current status of the operation

envelopeCompleted

void envelopeCompleted()

Invoked when a message is completed.

envelopeStopped

void envelopeStopped()

Invoked when a message is stopped.