ch.ecma.csta.binding
Class SnapshotCall

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

All Implemented Interfaces:

java.io.Serializable

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

Provides information about the devices participating in a specified call. The information provided includes device identifiers, their connections in the call, and local connection states of the devices in the call as well as call related information. The ConnectionID should be discovered using SnapshotDevice.

The single parameter (snapshotObject) is a ConnectionID indicating the call to be queried.

Negative Acknowledgements:

• operation:invalidConnectionID - Sent if the ConnectionID in the request is not valid. The call may have ended.
• 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

SnapshotCall()

Method Summary

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

SnapshotCall

public SnapshotCall()

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 ConnectionID getSnapshotObject()

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

Returns:

ConnectionID

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(ConnectionID snapshotObject)

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

Parameters:

snapshotObject - the value of field 'snapshotObject'.

unmarshalSnapshotCall

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

Method unmarshalSnapshotCall

Parameters:

reader -

Returns:

SnapshotCall

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