de.janrufmonitor.framework.monitor
Interface IMonitor

public interface IMonitor

This interface must be implemented by a monitor object. A monitor can observe different media types, e.g., the CAPI line or a network line. It reports the information to a monitor listener object.

Author:

Thilo Brandt

Method Summary

String[]	getDescription() Get a textual description of the monitor implementation, e.g.
String	getID() Gets a unique ID of the monitor object.
boolean	isAvailable() Availability status of the monitor.
boolean	isStarted() Status of the monitor.
void	reject(short cause) Rejects a call.
void	release() Releases the monitor.
void	setListener(IMonitorListener jml) Sets the monitor listener object to report to.
void	start() Starts the monitor for a certain line.
void	stop() Stops the monitor for a certain line.

Method Detail

start

void start()

Starts the monitor for a certain line.

stop

void stop()

Stops the monitor for a certain line.

setListener

void setListener(IMonitorListener jml)

Sets the monitor listener object to report to.

Parameters:

jml - the monitor listener

reject

void reject(short cause)

Rejects a call.

Parameters:

cause - the cause for rejection.

release

void release()

Releases the monitor.

isStarted

boolean isStarted()

Status of the monitor.

Returns:

true if started, false if not.

isAvailable

boolean isAvailable()

Availability status of the monitor.

Returns:

true if avaiable, false if not.

getDescription

String[] getDescription()

Get a textual description of the monitor implementation, e.g. a CAPI information object.

Returns:

textual information

getID

String getID()

Gets a unique ID of the monitor object.

Returns:

textual information