ch.ecma.csta.binding
Class ForwardingEvent

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

All Implemented Interfaces:

java.io.Serializable

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

Indicates that the Forwarding feature has been changed for a device.

The supported parameters for the ForwardingEvent are:

ForwardingEvent Supported Parameters
monitorCrossRefID	Mandatory	Associates the event to an established monitor.
device	Mandatory	Indicates the device where the forwarding feature was changed.
forwardStatus	Mandatory	Indicates the status of the forwarding type. The complete set of possible values is: FALSE - the forwarding type is deactivated TRUE - the forwarding type is active
forwardTo	Optional	Specifies the destination to which calls are forwarded. It shall be provided for user specified settings and it is optional for switching function default settings (see Functional Requirement #3).

CSTA Functional Requirements:

1. Only a single forwardingType parameter is provided per Forwarding event. If multiple forwarding types are changed for the same device, the switching function provides multiple Forwarding events.
2. This event is only generated when forwarding status is changed, not when forwarding occurs.
3. [AVAYA QUALIFIED] This product supports user specified settings - individual forwarding type/forwarding destination combinations that can be activated/deactivated one at a time.
4. Not applicable as it pertains to forwardDefault parameter which not supported.
5. Not applicable as it pertains to ringCount parameter which not supported.

Version:

$Revision$ $Date$

See Also:

Serialized Form

Constructor Summary

ForwardingEvent()

Method Summary

boolean	equals(java.lang.Object obj) Note: hashCode() has not been overriden
SubjectDeviceID	getDevice() Returns the value of field 'device'.
CSTACommonArguments	getExtensions() Returns the value of field 'extensions'.
ForwardDefault	getForwardDefault() Returns the value of field 'forwardDefault'.
ForwardingType	getForwardingType() Returns the value of field 'forwardingType'.
java.lang.Boolean	getForwardStatus() Returns the value of field 'forwardStatus'.
DeviceID	getForwardTo() Returns the value of field 'forwardTo'.
java.lang.String	getMonitorCrossRefID() Returns the value of field 'monitorCrossRefID'.
java.lang.Short	getRingCount() Returns the value of field 'ringCount'.
boolean	isValid() Method isValid
void	marshal(org.xml.sax.ContentHandler handler) Method marshal
void	marshal(java.io.Writer out) Method marshal
void	setDevice(SubjectDeviceID device) Sets the value of field 'device'.
void	setExtensions(CSTACommonArguments extensions) Sets the value of field 'extensions'.
void	setForwardDefault(ForwardDefault forwardDefault) Sets the value of field 'forwardDefault'.
void	setForwardingType(ForwardingType forwardingType) Sets the value of field 'forwardingType'.
void	setForwardStatus(java.lang.Boolean forwardStatus) Sets the value of field 'forwardStatus'.
void	setForwardTo(DeviceID forwardTo) Sets the value of field 'forwardTo'.
void	setMonitorCrossRefID(java.lang.String monitorCrossRefID) Sets the value of field 'monitorCrossRefID'.
void	setRingCount(java.lang.Short ringCount) Sets the value of field 'ringCount'.
static ForwardingEvent	unmarshalForwardingEvent(java.io.Reader reader) Method unmarshalForwardingEvent
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

ForwardingEvent

public ForwardingEvent()

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

getDevice

public SubjectDeviceID getDevice()

Returns the value of field 'device'.

Returns:

SubjectDeviceID

getExtensions

public CSTACommonArguments getExtensions()

Returns the value of field 'extensions'.

Returns:

CSTACommonArguments

getForwardDefault

public ForwardDefault getForwardDefault()

Returns the value of field 'forwardDefault'.

Returns:

ForwardDefault

getForwardStatus

public java.lang.Boolean getForwardStatus()

Returns the value of field 'forwardStatus'.

Returns:

Boolean

getForwardTo

public DeviceID getForwardTo()

Returns the value of field 'forwardTo'.

Returns:

DeviceID

getForwardingType

public ForwardingType getForwardingType()

Returns the value of field 'forwardingType'.

Returns:

ForwardingType

getMonitorCrossRefID

public java.lang.String getMonitorCrossRefID()

Returns the value of field 'monitorCrossRefID'.

Returns:

String

getRingCount

public java.lang.Short getRingCount()

Returns the value of field 'ringCount'.

Returns:

Short

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

setDevice

public void setDevice(SubjectDeviceID device)

Sets the value of field 'device'.

Parameters:

device - the value of field 'device'.

setExtensions

public void setExtensions(CSTACommonArguments extensions)

Sets the value of field 'extensions'.

Parameters:

extensions - the value of field 'extensions'.

setForwardDefault

public void setForwardDefault(ForwardDefault forwardDefault)

Sets the value of field 'forwardDefault'.

Parameters:

forwardDefault - the value of field 'forwardDefault'.

setForwardStatus

public void setForwardStatus(java.lang.Boolean forwardStatus)

Sets the value of field 'forwardStatus'.

Parameters:

forwardStatus - the value of field 'forwardStatus'.

setForwardTo

public void setForwardTo(DeviceID forwardTo)

Sets the value of field 'forwardTo'.

Parameters:

forwardTo - the value of field 'forwardTo'.

setForwardingType

public void setForwardingType(ForwardingType forwardingType)

Sets the value of field 'forwardingType'.

Parameters:

forwardingType - the value of field 'forwardingType'.

setMonitorCrossRefID

public void setMonitorCrossRefID(java.lang.String monitorCrossRefID)

Sets the value of field 'monitorCrossRefID'.

Parameters:

monitorCrossRefID - the value of field 'monitorCrossRefID'.

setRingCount

public void setRingCount(java.lang.Short ringCount)

Sets the value of field 'ringCount'.

Parameters:

ringCount - the value of field 'ringCount'.

unmarshalForwardingEvent

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

Method unmarshalForwardingEvent

Parameters:

reader -

Returns:

ForwardingEvent

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