Package com.collabnet.ce.soap60.webservices.tracker

# Class Artifact2SoapDOMarshaler

java.lang.Object
com.collabnet.ce.soap60.marshaling.AbstractStatelessSoapMarshaler
com.collabnet.ce.soap60.webservices.cemain.ObjectSoapDOMarshaler
com.collabnet.ce.soap60.webservices.cemain.ItemSoapDOMarshaler
com.collabnet.ce.soap60.webservices.tracker.Artifact2SoapDOMarshaler

All Implemented Interfaces:
  `SoapMarshaler`

public class Artifact2SoapDOMarshaler extends ItemSoapDOMarshaler
Marshaler class for Artifact2SoapDO.

Since:
  8.0

- ## Method Summary

  Modifier and Type
  Method
  Description
  `static Artifact2SoapDOMarshaler`
  `getInstance(com.vasoftware.sf.server.types.UserSessionKey sessionKey)`
  Returns the singleton class instance.
  `boolean`
  `isStateless()`
  Determines if this marshaller is stateless/cacheable.
  `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.
  `Object`
  `updateRmiObjectWithSoapObject(Object soapObject, Object rmiObject)`
  Updates an existing RMI object with a SOAP object

  ### Methods inherited from class com.collabnet.ce.soap60.webservices.cemain.ItemSoapDOMarshaler

  `getInstance`

  ### Methods inherited from class com.collabnet.ce.soap60.webservices.cemain.ObjectSoapDOMarshaler

  `getCoreService`

  ### Methods inherited from class java.lang.Object

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

- ## Method Details

  - ### getInstance

    public static Artifact2SoapDOMarshaler getInstance(com.vasoftware.sf.server.types.UserSessionKey sessionKey)
    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.
    Specified by:
      `soapToRmi` in interface `SoapMarshaler`
    Overrides:
      `soapToRmi` in class `ItemSoapDOMarshaler`
    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: `ObjectSoapDOMarshaler`
    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 `ItemSoapDOMarshaler`
    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
    Specified by:
      `rmiToSoap` in interface `SoapMarshaler`
    Overrides:
      `rmiToSoap` in class `ItemSoapDOMarshaler`
    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)`

  - ### updateRmiObjectWithSoapObject

    public Object updateRmiObjectWithSoapObject(Object soapObject, Object rmiObject) throws SoapMarshalingException
    Updates an existing RMI object with a SOAP object
    Parameters:
      `soapObject` - soap object that is used for (partial update)
      `rmiObject` - rmiObject that should be updated
    Returns:
      updated RMI object
    Throws:
      `SoapMarshalingException`

  - ### protectedRmiToSoap

    protected void protectedRmiToSoap(Object soapObject, Object rmiObject) throws SoapMarshalingException
    Description copied from class: `ObjectSoapDOMarshaler`
    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 `ItemSoapDOMarshaler`
    Parameters:
      `soapObject` - SOAP object.
      `rmiObject` - RMI object.
    Throws:
      `SoapMarshalingException` - when an error is encountered during marshaling.
    See Also:
      - `SoapMarshaler.rmiToSoap(java.lang.Object)`

  - ### isStateless

    public boolean isStateless()
    Description copied from interface: `SoapMarshaler`
    Determines if this marshaller is stateless/cacheable.
    Specified by:
      `isStateless` in interface `SoapMarshaler`
    Overrides:
      `isStateless` in class `AbstractStatelessSoapMarshaler`
    Returns:
      true if the the marshaller is stateless
    See Also:
      - `SoapMarshaler.isStateless()`