ch.ecma.csta.binding
Class SnapshotDevice

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

All Implemented Interfaces:

java.io.Serializable

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

Provides information about calls associated with a given device. The information provided identifies each call the device is participating in and the local connection state of the device in that call. The ConnectionIDs found in the response are useful as parameters to SnapshotCall and SingleStepConferenceCall requests.

The single parameter (snapshotObject) is a DeviceID indicating the device to be queried. The DeviceID can be either a third party device ID (representing an extension not controlled by this application) or a first party device ID (representing an extension controlled by this application). In either case, the DeviceID should be obtained using DeviceServices.

Negative Acknowledgements:

• operation:invalidDeviceID - Sent if the DeviceID in the request is not valid. The device must be registered.
• operation:privilegeViolationSpecifiedDevice - Sent if the user does not have sufficient privileges to monitor the given device.
• operation:generic - Sent if a logic error occurred in the code.
• unspecified - Sent if an implementation specific error occurred.

Version:

$Revision$ $Date$

See Also:

Serialized Form

Constructor Summary

SnapshotDevice()

Method Summary

boolean	equals(java.lang.Object obj) Note: hashCode() has not been overriden
CSTACommonArguments	getExtensions() Returns the value of field 'extensions'.
DeviceID	getSnapshotObject() Returns the value of field 'snapshotObject'.
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	setSnapshotObject(DeviceID snapshotObject) Sets the value of field 'snapshotObject'.
static SnapshotDevice	unmarshalSnapshotDevice(java.io.Reader reader) Method unmarshalSnapshotDevice
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

SnapshotDevice

public SnapshotDevice()

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

getSnapshotObject

public DeviceID getSnapshotObject()

Returns the value of field 'snapshotObject'. The field 'snapshotObject' has the following description: A DeviceID indicating the device to be queried.

Returns:

DeviceID

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

setSnapshotObject

public void setSnapshotObject(DeviceID snapshotObject)

Sets the value of field 'snapshotObject'. The field 'snapshotObject' has the following description: A DeviceID indicating the device to be queried.

Parameters:

snapshotObject - the value of field 'snapshotObject'.

unmarshalSnapshotDevice

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

Method unmarshalSnapshotDevice

Parameters:

reader -

Returns:

SnapshotDevice

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