ch.ecma.csta.binding
Class SuspendDataCollection

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

All Implemented Interfaces:

java.io.Serializable

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

This request has been deprecated.

Suspends a specified data collection but does not destroy the data collection.

CSTA Functional Requirements:

1. The sender informs its peer that the data collection should be suspended, but not destroyed. The ResumeDataCollection service may then be used to resume the flow of data on the data collection.
2. This service allows the consumer of the data collection to start and stop the flow of data. It is expected that no flow control of the data that has been suspended will occur. That is, if a data collection is suspended the consumer is not provided with the data between the time the data collection was suspended and the time it was resumed.

Version:

$Revision$ $Date$

See Also:

Serialized Form

Constructor Summary

SuspendDataCollection()

Method Summary

boolean	equals(java.lang.Object obj) Note: hashCode() has not been overriden
java.lang.String	getDcollCrossRefID() Returns the value of field 'dcollCrossRefID'.
CSTACommonArguments	getExtensions() Returns the value of field 'extensions'.
boolean	isValid() Method isValid
void	marshal(org.xml.sax.ContentHandler handler) Method marshal
void	marshal(java.io.Writer out) Method marshal
void	setDcollCrossRefID(java.lang.String dcollCrossRefID) Sets the value of field 'dcollCrossRefID'.
void	setExtensions(CSTACommonArguments extensions) Sets the value of field 'extensions'.
static SuspendDataCollection	unmarshalSuspendDataCollection(java.io.Reader reader) Method unmarshalSuspendDataCollection
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

SuspendDataCollection

public SuspendDataCollection()

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

getDcollCrossRefID

public java.lang.String getDcollCrossRefID()

Returns the value of field 'dcollCrossRefID'.

Returns:

String

getExtensions

public CSTACommonArguments getExtensions()

Returns the value of field 'extensions'.

Returns:

CSTACommonArguments

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

setDcollCrossRefID

public void setDcollCrossRefID(java.lang.String dcollCrossRefID)

Sets the value of field 'dcollCrossRefID'.

Parameters:

dcollCrossRefID - the value of field 'dcollCrossRefID'.

setExtensions

public void setExtensions(CSTACommonArguments extensions)

Sets the value of field 'extensions'.

Parameters:

extensions - the value of field 'extensions'.

unmarshalSuspendDataCollection

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

Method unmarshalSuspendDataCollection

Parameters:

reader -

Returns:

SuspendDataCollection

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