ch.ecma.csta.binding
Class CSTACommonArguments

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

All Implemented Interfaces:

java.io.Serializable

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

Class CSTACommonArguments.

Version:

$Revision: 1.2 $ $Date: 2004/01/06 20:36:40 $

See Also:

Serialized Form

Constructor Summary

CSTACommonArguments()

Method Summary

boolean	equals(java.lang.Object obj) Note: hashCode() has not been overriden
CSTAPrivateData	getPrivateData() Returns the value of field 'privateData'.
CSTASecurityData	getSecurity() Returns the value of field 'security'.
java.lang.Object	getSinglePrivateData() Retrieves private data.
boolean	isValid() Method isValid
void	marshal(org.xml.sax.ContentHandler handler) Method marshal
void	marshal(java.io.Writer out) Method marshal
static CSTACommonArguments	newSinglePrivateData(ch.ecma.csta.CastorObject singlePrivateData) Creates an instance of CSTACommonArguments with the specified object as the private data object (equivalent to creating CSTACommonArguments and calling setSinglePrivateData).
void	setPrivateData(CSTAPrivateData privateData) Sets the value of field 'privateData'.
void	setSecurity(CSTASecurityData security) Sets the value of field 'security'.
void	setSinglePrivateData(ch.ecma.csta.CastorObject singlePrivateData) Sets the private data with a single object.
static CSTACommonArguments	unmarshalCSTACommonArguments(java.io.Reader reader) Method unmarshalCSTACommonArguments
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

CSTACommonArguments

public CSTACommonArguments()

Method Detail

newSinglePrivateData

public static CSTACommonArguments newSinglePrivateData(ch.ecma.csta.CastorObject singlePrivateData)

Creates an instance of CSTACommonArguments with the specified object as the private data object (equivalent to creating CSTACommonArguments and calling setSinglePrivateData).

Parameters:

singlePrivateData - the CastorObject to use for private data

Returns:

the CSTACommonArguments instance

setSinglePrivateData

public void setSinglePrivateData(ch.ecma.csta.CastorObject singlePrivateData)

Sets the private data with a single object. Replaces any private data previously set. If more than one object is required then you will have to use the more cumbersome setPrivateData method.

Parameters:

singlePrivateData - the CastorObject to use for private data

getSinglePrivateData

public java.lang.Object getSinglePrivateData()

Retrieves private data. Assumes that exactly one object has been placed in the private data. If there is no private data, null is returned. If more than one object has been set (first object is returned), you will have to use the more cumbersome getPrivateData method.

Returns:

the first (only) private data object

equals

public boolean equals(java.lang.Object obj)

Note: hashCode() has not been overriden

Overrides:

equals in class ch.ecma.csta.CastorObject

Parameters:

obj -

getPrivateData

public CSTAPrivateData getPrivateData()

Returns the value of field 'privateData'.

Returns:

the value of field 'privateData'.

getSecurity

public CSTASecurityData getSecurity()

Returns the value of field 'security'.

Returns:

the value of field 'security'.

isValid

public boolean isValid()

Method isValid

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

setPrivateData

public void setPrivateData(CSTAPrivateData privateData)

Sets the value of field 'privateData'.

Parameters:

privateData - the value of field 'privateData'.

setSecurity

public void setSecurity(CSTASecurityData security)

Sets the value of field 'security'.

Parameters:

security - the value of field 'security'.

unmarshalCSTACommonArguments

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

Method unmarshalCSTACommonArguments

Parameters:

reader -

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