ch.ecma.csta.binding
Class MonitorStop

java.lang.Object
  ch.ecma.csta.CastorObject
      ch.ecma.csta.binding.MonitorStop

All Implemented Interfaces:

java.io.Serializable

public class MonitorStop
extends ch.ecma.csta.CastorObject
implements java.io.Serializable

Terminates an existing monitor.

The Monitor Stop service is used to cancel a previously initiated MonitorStart service. The Monitor Stop service can be issued by a function to terminate or signal the termination of a corresponding Monitor Start service.

A positive acknowledgement to the service request indicates that the Cross Reference ID used by the Monitor Start service has become invalid.

Monitoring Requirements: Once a request has been acknowledged, event reports are no longer sent.

CSTA Functional Requirements:

1. This service can be sent to the function that requested a monitor to report that the monitor has been terminated.
2. The switching function may issue a Monitor Stop service when it can no longer provide information. Examples of when this may occur are:
   • For monitors on calls that have ended (call monitoring).
   • For load management reasons.
   • If the monitor object leaves the switching sub-domain (via configuration, for example).

p /> The MonitorStop request has these parameters:

MonitorStop Request Parameters
monitorCrossRefID	Mandatory	Specifies the monitorCrossRefID provided in the original Monitor Start service positive acknowledgement.
extensions	Not used

Version:

$Revision$ $Date$

See Also:

Serialized Form

Constructor Summary

MonitorStop()

Method Summary

boolean	equals(java.lang.Object obj) Note: hashCode() has not been overriden
CSTACommonArguments	getExtensions() Returns the value of field 'extensions'.
java.lang.String	getMonitorCrossRefID() Returns the value of field 'monitorCrossRefID'.
boolean	isValid() Method isValid
void	marshal(org.xml.sax.ContentHandler handler) Method marshal
void	marshal(java.io.Writer out) Method marshal
void	setExtensions(CSTACommonArguments extensions) Sets the value of field 'extensions'.
void	setMonitorCrossRefID(java.lang.String monitorCrossRefID) Sets the value of field 'monitorCrossRefID'.
static MonitorStop	unmarshalMonitorStop(java.io.Reader reader) Method unmarshalMonitorStop
void	validate() Method validate

Methods inherited from class ch.ecma.csta.CastorObject

getOldSessionID, hashCode, setOldSessionID, toString

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

MonitorStop

public MonitorStop()

Method Detail

equals

public boolean equals(java.lang.Object obj)

Note: hashCode() has not been overriden

Overrides:

equals in class ch.ecma.csta.CastorObject

Parameters:

obj -

Returns:

boolean

getExtensions

public CSTACommonArguments getExtensions()

Returns the value of field 'extensions'.

Returns:

CSTACommonArguments

getMonitorCrossRefID

public java.lang.String getMonitorCrossRefID()

Returns the value of field 'monitorCrossRefID'.

Returns:

String

isValid

public boolean isValid()

Method isValid

Returns:

boolean

marshal

public void marshal(java.io.Writer out)
             throws org.exolab.castor.xml.MarshalException,
                    org.exolab.castor.xml.ValidationException

Method marshal

Parameters:

out -

Throws:

org.exolab.castor.xml.MarshalException

org.exolab.castor.xml.ValidationException

marshal

public void marshal(org.xml.sax.ContentHandler handler)
             throws java.io.IOException,
                    org.exolab.castor.xml.MarshalException,
                    org.exolab.castor.xml.ValidationException

Method marshal

Parameters:

handler -

Throws:

java.io.IOException

org.exolab.castor.xml.MarshalException

org.exolab.castor.xml.ValidationException

setExtensions

public void setExtensions(CSTACommonArguments extensions)

Sets the value of field 'extensions'.

Parameters:

extensions - the value of field 'extensions'.

setMonitorCrossRefID

public void setMonitorCrossRefID(java.lang.String monitorCrossRefID)

Sets the value of field 'monitorCrossRefID'.

Parameters:

monitorCrossRefID - the value of field 'monitorCrossRefID'.

unmarshalMonitorStop

public static MonitorStop unmarshalMonitorStop(java.io.Reader reader)
                                        throws org.exolab.castor.xml.MarshalException,
                                               org.exolab.castor.xml.ValidationException

Method unmarshalMonitorStop

Parameters:

reader -

Returns:

MonitorStop

Throws:

org.exolab.castor.xml.MarshalException

org.exolab.castor.xml.ValidationException

validate

public void validate()
              throws org.exolab.castor.xml.ValidationException

Method validate

Throws:

org.exolab.castor.xml.ValidationException