Package com.collabnet.ce.soap60.webservices.docman

Class DocumentReviewSoapListMarshaler

java.lang.Object

com.collabnet.ce.soap60.marshaling.AbstractStatelessSoapMarshaler

com.collabnet.ce.soap60.marshaling.AbstractSoapMarshaler

com.collabnet.ce.soap60.webservices.docman.DocumentReviewSoapListMarshaler

All Implemented Interfaces:

SoapMarshaler

public class DocumentReviewSoapListMarshaler
extends AbstractSoapMarshaler

Marshaler class for DocumentSoapList.

Method Summary

Modifier and Type	Method	Description
static SoapMarshaler	getInstance()	Returns the singleton class instance.
static DocumentReviewSoapList	marshalDocumentReviewList(com.collabnet.ctf.document.service.DocumentService docman, com.vasoftware.sf.server.types.UserSessionKey sessionKey, com.vasoftware.sf.server.services.docman.CreatedReviewList createdReviewList)	Converts a list of outstanding reviews to a SOAP compatible list.
static DocumentReviewSoapList	marshalDocumentReviewList(com.collabnet.ctf.document.service.DocumentService docman, com.vasoftware.sf.server.types.UserSessionKey sessionKey, com.vasoftware.sf.server.services.docman.DocumentReviewList documentReviewList)	Converts a list of document reviews to a SOAP compatible list.
static DocumentReviewSoapList	marshalDocumentReviewList(com.collabnet.ctf.document.service.DocumentService docman, com.vasoftware.sf.server.types.UserSessionKey sessionKey, com.vasoftware.sf.server.services.docman.OutstandingReviewList outstandingReviewList)	Converts a list of outstanding reviews to a SOAP compatible list.
protected void	protectedRmiToSoap(Object soapObject, Object rmiObject)	Unmarshals data from an rmi object to a given SOAP object.
protected void	protectedSoapToRmi(Object soapObject, Object rmiObject)	Marshals data from a soap object to a given rmi object.
Object	rmiToSoap(Object rmiObject)	Unmarshals an object used by RMI APIs to a SOAP object
Object	soapToRmi(Object soapObject)	Converts a SOAP object to an object type required by RMI APIs.

Methods inherited from class com.collabnet.ce.soap60.marshaling.AbstractSoapMarshaler

getCoreService

Methods inherited from class com.collabnet.ce.soap60.marshaling.AbstractStatelessSoapMarshaler

isStateless

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

getInstance

public static SoapMarshaler getInstance()

Returns the singleton class instance.

Returns:

Singleton class instance.

soapToRmi

public Object soapToRmi(Object soapObject)
                 throws SoapMarshalingException

Description copied from interface: SoapMarshaler

Converts a SOAP object to an object type required by RMI APIs.

Parameters:

soapObject - SOAP object to marshal.

Returns:

Object required by RMI APIs.

Throws:

SoapMarshalingException - when an error is encountered during marshaling.

See Also:

SoapMarshaler.soapToRmi(java.lang.Object)

protectedSoapToRmi

protected void protectedSoapToRmi(Object soapObject,
                                  Object rmiObject)
                           throws SoapMarshalingException

Description copied from class: AbstractSoapMarshaler

Marshals data from a soap object to a given rmi object. This protected method is primarily used by marshaler classes to marshal members from a super-class marshaler.

Overrides:

protectedSoapToRmi in class AbstractSoapMarshaler

Parameters:

soapObject - SOAP object.

rmiObject - RMI object.

Throws:

SoapMarshalingException - when an error is encountered during marshaling.

See Also:

SoapMarshaler.soapToRmi(java.lang.Object)

rmiToSoap

public Object rmiToSoap(Object rmiObject)
                 throws SoapMarshalingException

Description copied from interface: SoapMarshaler

Unmarshals an object used by RMI APIs to a SOAP object

Parameters:

rmiObject - Object used by RMI apis.

Returns:

Unmarshaled SOAP object.

Throws:

SoapMarshalingException - when an error is encountered during unmarshaling.

See Also:

SoapMarshaler.rmiToSoap(java.lang.Object)

protectedRmiToSoap

protected void protectedRmiToSoap(Object soapObject,
                                  Object rmiObject)
                           throws SoapMarshalingException

Description copied from class: AbstractSoapMarshaler

Unmarshals data from an rmi object to a given SOAP object. This protected method is primarily used by the marshaler classes to unmarshal members from a super-class marshaler.

Overrides:

protectedRmiToSoap in class AbstractSoapMarshaler

Parameters:

soapObject - SOAP object.

rmiObject - RMI object.

Throws:

SoapMarshalingException - when an error is encountered during marshaling.

See Also:

SoapMarshaler.rmiToSoap(java.lang.Object)

marshalDocumentReviewList

public static DocumentReviewSoapList marshalDocumentReviewList(com.collabnet.ctf.document.service.DocumentService docman,
                                                               com.vasoftware.sf.server.types.UserSessionKey sessionKey,
                                                               com.vasoftware.sf.server.services.docman.DocumentReviewList documentReviewList)
                                                        throws SystemFault

Converts a list of document reviews to a SOAP compatible list.

Parameters:

docman - Document manager handle.

sessionKey - User session key.

documentReviewList - Document review list (RMI).

Returns:

Document review SOAP list.

Throws:

SystemFault - when a system level error is encountered.

marshalDocumentReviewList

public static DocumentReviewSoapList marshalDocumentReviewList(com.collabnet.ctf.document.service.DocumentService docman,
                                                               com.vasoftware.sf.server.types.UserSessionKey sessionKey,
                                                               com.vasoftware.sf.server.services.docman.OutstandingReviewList outstandingReviewList)
                                                        throws SystemFault

Converts a list of outstanding reviews to a SOAP compatible list.

Parameters:

docman - Document manager handle.

sessionKey - User session key.

outstandingReviewList - Document review list (RMI).

Returns:

Document review SOAP list.

Throws:

SystemFault - when a system level error is encountered.

marshalDocumentReviewList

public static DocumentReviewSoapList marshalDocumentReviewList(com.collabnet.ctf.document.service.DocumentService docman,
                                                               com.vasoftware.sf.server.types.UserSessionKey sessionKey,
                                                               com.vasoftware.sf.server.services.docman.CreatedReviewList createdReviewList)
                                                        throws SystemFault

Converts a list of outstanding reviews to a SOAP compatible list.

Parameters:

docman - Document manager handle.

sessionKey - User session key.

createdReviewList - Document review list (RMI).

Returns:

Document review SOAP list.

Throws:

SystemFault - when a system level error is encountered.