4.1.0.610 20071213

ch.ecma.csta.binding
Class PartiallyInServiceEvent

java.lang.Object
  extended by ch.ecma.csta.CastorObject
      extended by ch.ecma.csta.binding.PartiallyInServiceEvent
All Implemented Interfaces:
java.io.Serializable

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

Not supported.

Indicates that a device is "partially in service". This means that part of the device can no longer be able to accept calls and some categories of CSTA service requests.

This might occur, for example, for a CSTA group device when one or more members of a group device are in In Service while one or more members of a group device are Out of Service.

For an illustration of this service, see ECMA 269, section 23.1.4.

The Completed Event could be caused by the followings:

CSTA Functional Requirements: 1. When a device becomes partially in service, existing monitors are not removed (e.g., existing MonitorCrossRefIDs remain valid). However: a. Event flows over an existing monitor may be reduces (or even completely stopped except for the Back In Service event). b. Some CSTA services may not be allowed for a partially in service device. 2. When a partially in services device becomes in service, a Back In Service event is generated. 3. When a partially in service device becomes out of service, an Out of Service event is generated.

Version:
$Revision$ $Date$
See Also:
Serialized Form

Constructor Summary
PartiallyInServiceEvent()
           
 
Method Summary
 boolean equals(java.lang.Object obj)
          Note: hashCode() has not been overriden
 EventCause getCause()
          Returns the value of field 'cause'.
 SubjectDeviceID getDevice()
          Returns the value of field 'device'.
 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 setCause(EventCause cause)
          Sets the value of field 'cause'.
 void setDevice(SubjectDeviceID device)
          Sets the value of field 'device'.
 void setExtensions(CSTACommonArguments extensions)
          Sets the value of field 'extensions'.
 void setMonitorCrossRefID(java.lang.String monitorCrossRefID)
          Sets the value of field 'monitorCrossRefID'.
static PartiallyInServiceEvent unmarshalPartiallyInServiceEvent(java.io.Reader reader)
          Method unmarshalPartiallyInServiceEvent
 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

PartiallyInServiceEvent

public PartiallyInServiceEvent()
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

getCause

public EventCause getCause()
Returns the value of field 'cause'.

Returns:
EventCause

getDevice

public SubjectDeviceID getDevice()
Returns the value of field 'device'. The field 'device' has the following description:

Indicates the device that gone partially in service.

Returns:
SubjectDeviceID

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

setCause

public void setCause(EventCause cause)
Sets the value of field 'cause'.

Parameters:
cause - the value of field 'cause'.

setDevice

public void setDevice(SubjectDeviceID device)
Sets the value of field 'device'. The field 'device' has the following description:

Indicates the device that gone partially in service.

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'.

setMonitorCrossRefID

public void setMonitorCrossRefID(java.lang.String monitorCrossRefID)
Sets the value of field 'monitorCrossRefID'.

Parameters:
monitorCrossRefID - the value of field 'monitorCrossRefID'.

unmarshalPartiallyInServiceEvent

public static PartiallyInServiceEvent unmarshalPartiallyInServiceEvent(java.io.Reader reader)
                                                                throws org.exolab.castor.xml.MarshalException,
                                                                       org.exolab.castor.xml.ValidationException
Method unmarshalPartiallyInServiceEvent

Parameters:
reader -
Returns:
PartiallyInServiceEvent
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

4.1.0.610 20071213

Copyright 2004 Avaya Inc All Rights Reserved.