psdi.iface.mos

Class MBOStAXStructure

java.lang.Object

psdi.iface.mos.StAXStructure

psdi.iface.mos.MBOStAXStructure

All Implemented Interfaces:

MosConstants

Direct Known Subclasses:

RESTMboStAXStructure

public class MBOStAXStructure
extends StAXStructure

Api for serializing Mbo/MboSet to xml. This api will only serialize the requested object and will not serialize the related Mbo/MboSet children.

Field Summary

Fields

Modifier and Type	Field and Description
protected java.util.Set	cols
protected boolean	considerNpCols
protected boolean	exclude
static int	INCRCONTINUE
static int	INCREND
static int	INCRSTART
static int	INCRSTARTEND
protected boolean	objectOnly
protected int	rsCount
protected int	rsStart
protected int	rsTotal

Fields inherited from class psdi.iface.mos.StAXStructure

binaryText, bo, dropNullCols, externalWriter, integrationLogger, INTEGRATIONLOGGER, localizedRep, oslcRequest, outputFactory, retainMbos, userInfo, useRowStamp, useScientificNotation, validateXMLText, writer

Fields inherited from interface psdi.iface.mos.MosConstants

ACTION, ACTIONADD, ACTIONADDUPDATE, ACTIONDELETE, ACTIONREPLACE, ACTIONUPDATE, ADAPTER_INSTALL, ADD, ADDATEND, BASELANGUAGE, BYPASS, COMPANYSETID_NAME, COMPLETE, CONFIGFILENAME, CREATIONDATETIME, DELETEFORINSERT, DEPLOYMENT_MANAGER, ENTERPRISE_SERVICE, ERRORTAG, ESCAPECHAR, EVENT, FILTERMBOKEY, INVOKE_CHANNEL, ITEMSETID_NAME, MAXIMO_NS_PREFIX, MAXIMOVERSION, MESSAGEID, MESSAGETYPE_CREATE, MESSAGETYPE_DELETE, MESSAGETYPE_INITIATE, MESSAGETYPE_INVOKE, MESSAGETYPE_MERGE, MESSAGETYPE_PATCH, MESSAGETYPE_PROCESS, MESSAGETYPE_PUBLISH, MESSAGETYPE_QUERY, MESSAGETYPE_RESPONSE, MESSAGETYPE_SYNC, MESSAGETYPE_UPDATE, MESSAGETYPE_WAKEUP, OBJECT_STRUCTURE_SERVICE, ORGID_NAME, OVERRIDEALWAYS, OVERRIDENULLONLY, PROCESS, SITEID_NAME, SKIP, SKIPMBO, SKIPMBOKEY, STANDARD_SERVICE, TRANSLANGUAGE, UPDATE, XSI_NS, XSI_NS_PREFIX

Constructor Summary

Constructors

Constructor and Description
MBOStAXStructure()
MBOStAXStructure(boolean dropNullCols)
MBOStAXStructure(boolean dropNullCols, boolean retainMbos)
MBOStAXStructure(boolean dropNullCols, boolean retainMbos, boolean objectOnly, boolean exclude, java.util.Set cols, boolean considerNpCols)

Method Summary

Modifier and Type	Method and Description
protected void	addObjectExtensibilityAttributes(MboRemote mbo)
protected void	addRootExtensibilityAttributes()
protected byte[]	createXML(MboIterator mboSet, int startIndex, int maxCount) Create the outbound XML.
protected byte[]	createXML(MboRemote mbo, boolean asSet)
protected MXLogger	getLogger()
void	serializeMboAsKeySet(javax.xml.stream.XMLStreamWriter writer, MboRemote mbo, int incrInd, java.lang.String[] keys)
void	serializeMboAsKeySet(javax.xml.stream.XMLStreamWriter writer, MboRemote mbo, int incrInd, java.lang.String[] keys, java.lang.String mosName)
protected void	setAdditionalData(MboRemote mbo)

Methods inherited from class psdi.iface.mos.StAXStructure

addExtensibilityAttributes, init, initSerialization, isGLCompRequired, isMaxValueRequired, isRequiresChangeIndicator, isUseRowStamp, isUseTotalCount, isValidateXMLText, serializeMbo, serializeMbo, serializeMboArray, serializeMboArray, serializeMboArray, serializeMboAsSet, serializeMboAsSet, serializeMboIterator, serializeMboIterator, serializeMboIterator, serializeMboList, serializeMboList, serializeMboList, serializeMboSet, serializeMboSet, serializeMboSet, setAllowBinaryText, setDefaultNS, setJsonRequest, setLocalizedRep, setMboColumnElement, setUseRowStamp, setXSINS, useMboValueForSendersysid, writeCharacters, writeDefaultNS, writeXSINS

Methods inherited from class java.lang.Object

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

Field Detail

cols

protected java.util.Set cols

exclude

protected boolean exclude

considerNpCols

protected boolean considerNpCols

rsStart

protected int rsStart

rsCount

protected int rsCount

rsTotal

protected int rsTotal

INCRSTART

public static final int INCRSTART

See Also:

Constant Field Values

INCRCONTINUE

public static final int INCRCONTINUE

See Also:

Constant Field Values

INCREND

public static final int INCREND

See Also:

Constant Field Values

INCRSTARTEND

public static final int INCRSTARTEND

See Also:

Constant Field Values

objectOnly

protected boolean objectOnly

Constructor Detail

MBOStAXStructure

public MBOStAXStructure()

MBOStAXStructure

public MBOStAXStructure(boolean dropNullCols)

Parameters:

dropNullCols -

MBOStAXStructure

public MBOStAXStructure(boolean dropNullCols,
                        boolean retainMbos)

Parameters:

dropNullCols -

MBOStAXStructure

public MBOStAXStructure(boolean dropNullCols,
                        boolean retainMbos,
                        boolean objectOnly,
                        boolean exclude,
                        java.util.Set cols,
                        boolean considerNpCols)

Method Detail

serializeMboAsKeySet

public void serializeMboAsKeySet(javax.xml.stream.XMLStreamWriter writer,
                                 MboRemote mbo,
                                 int incrInd,
                                 java.lang.String[] keys)
                          throws MXException,
                                 java.rmi.RemoteException

Parameters:

writer -

mbo -

incrInd -

keys -

Throws:

MXException

java.rmi.RemoteException

serializeMboAsKeySet

public void serializeMboAsKeySet(javax.xml.stream.XMLStreamWriter writer,
                                 MboRemote mbo,
                                 int incrInd,
                                 java.lang.String[] keys,
                                 java.lang.String mosName)
                          throws MXException,
                                 java.rmi.RemoteException

Parameters:

writer -

mbo -

incrInd -

keys -

Throws:

MXException

java.rmi.RemoteException

createXML

protected byte[] createXML(MboRemote mbo,
                           boolean asSet)
                    throws MXException,
                           java.rmi.RemoteException

Specified by:

createXML in class StAXStructure

Parameters:

mbo - the Mbo to serialize

asSet - if set to true will serialize this Mbo as a MboSet with one Mbo.

Returns:

the resultant XML document as bytes

Throws:

MXException

java.rmi.RemoteException

createXML

protected byte[] createXML(MboIterator mboSet,
                           int startIndex,
                           int maxCount)
                    throws MXException,
                           java.rmi.RemoteException

Create the outbound XML. This method should be used by Data Export / WebServices response (when there can be multiple records in outbound XML)

Specified by:

createXML in class StAXStructure

Parameters:

mboSet - mboSet

startIndex - the start index of the mboSet

maxCount - the maximum number of records to be sent out

Returns:

the resultant XML document as bytes

Throws:

MXException - MAXIMO exception

java.rmi.RemoteException - Remote exception

getLogger

protected MXLogger getLogger()

addObjectExtensibilityAttributes

protected void addObjectExtensibilityAttributes(MboRemote mbo)
                                         throws java.rmi.RemoteException,
                                                MXException,
                                                javax.xml.stream.XMLStreamException

Throws:

java.rmi.RemoteException

MXException

javax.xml.stream.XMLStreamException

addRootExtensibilityAttributes

protected void addRootExtensibilityAttributes()
                                       throws java.rmi.RemoteException,
                                              MXException,
                                              javax.xml.stream.XMLStreamException

Throws:

java.rmi.RemoteException

MXException

javax.xml.stream.XMLStreamException

setAdditionalData

protected void setAdditionalData(MboRemote mbo)
                          throws MXException,
                                 java.rmi.RemoteException

Throws:

MXException

java.rmi.RemoteException