psdi.iface.mos

Class MOSStAXStructure

java.lang.Object

psdi.iface.mos.StAXStructure

psdi.iface.mos.MOSStAXStructure

All Implemented Interfaces:

MosConstants

Direct Known Subclasses:

RESTOSStAXStructure

public class MOSStAXStructure
extends StAXStructure

The XML serialization class for Object Structures.

Author:

Anamitra

Field Summary

Fields

Modifier and Type	Field and Description
static int	WRITE_ALL
static int	WRITE_KEYS
static int	WRITE_SKIP

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
MOSStAXStructure(java.util.Map<java.lang.String,?> defnMetaData, java.lang.String mosName, boolean retainMbos, boolean updatesOnly)
MOSStAXStructure(java.util.Map<java.lang.String,?> defnMetaData, java.lang.String mosName, boolean event, boolean retainMbos, java.lang.String operationName, boolean response, boolean updatesOnly)
MOSStAXStructure(java.util.Map<java.lang.String,?> defnMetaData, java.lang.String mosName, boolean event, java.lang.String operationName, boolean response)
MOSStAXStructure(java.lang.String defClassName, java.util.Map<java.lang.String,?> defnMetaData, java.lang.String mosName, boolean event, boolean retainMbos, boolean ignoreActions, java.lang.String operationName, boolean response, boolean updatesOnly)
MOSStAXStructure(java.lang.String defClassName, java.util.Map<java.lang.String,?> defnMetaData, java.lang.String mosName, boolean event, boolean retainMbos, boolean ignoreActions, java.lang.String operationName, boolean response, boolean updatesOnly, java.lang.String inputAction)
MOSStAXStructure(java.lang.String defClassName, java.util.Map<java.lang.String,?> defnMetaData, java.lang.String mosName, boolean event, boolean retainMbos, boolean ignoreActions, java.lang.String operationName, boolean response, boolean updatesOnly, java.lang.String inputAction, boolean dropNullCols)
MOSStAXStructure(java.lang.String defClassName, java.util.Map<java.lang.String,?> defnMetaData, java.lang.String mosName, boolean event, boolean retainMbos, java.lang.String operationName, boolean response, boolean updatesOnly)
MOSStAXStructure(java.lang.String defClassName, java.util.Map<java.lang.String,?> defnMetaData, java.lang.String mosName, boolean event, java.lang.String operationName, boolean response)

Method Summary

Modifier and Type	Method and Description
boolean	evaluateMboXmlType()
MosDefinitionImpl	getMosDefinitionImpl()
int	getSerializedMboCount()
java.util.List<MboRemote>	getUsedMboList()
boolean	isAllowSkipRows()
void	setAllowEmptyXML(boolean emptyXML)
void	setAllowSkipRows(boolean allowSkipRows)
void	setEvaluateMboXmlType(boolean evaluateXMLType)
void	setInitialResolvedCount(int initialResolvedCount)
void	setProcessAsSelfRefRelName(java.lang.String relName, boolean allowSelfRefDup)
void	setResolvedStartCount(int resolvedStartCount)
void	setResolvedTotalCount(int resolvedTotalCount)
void	setResourceProperties(java.util.Map<java.lang.String,OslcResourceProperty> resourceProperties)
void	setTotalCount(java.lang.Integer totCount)

Methods inherited from class psdi.iface.mos.StAXStructure

isUseRowStamp, serializeMbo, serializeMbo, serializeMboArray, serializeMboArray, serializeMboArray, serializeMboAsSet, serializeMboAsSet, serializeMboIterator, serializeMboIterator, serializeMboIterator, serializeMboList, serializeMboList, serializeMboList, serializeMboSet, serializeMboSet, serializeMboSet, setAllowBinaryText, setUseRowStamp

Methods inherited from class java.lang.Object

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

Field Detail

WRITE_ALL

public static final int WRITE_ALL

See Also:

Constant Field Values

WRITE_SKIP

public static final int WRITE_SKIP

See Also:

Constant Field Values

WRITE_KEYS

public static final int WRITE_KEYS

See Also:

Constant Field Values

Constructor Detail

MOSStAXStructure

public MOSStAXStructure(java.util.Map<java.lang.String,?> defnMetaData,
                        java.lang.String mosName,
                        boolean event,
                        boolean retainMbos,
                        java.lang.String operationName,
                        boolean response,
                        boolean updatesOnly)
                 throws MXException

Parameters:

defnMetaData - the Metadata for serialization

mosName - the object structure name

event - true implies that this request for serialization is based on an Mbo event

retainMbos - if set to true will not discard the Mbos that are being serialized.

operationName - the operation name

response - true if serilization needs to be done for response of the operation

updatesOnly - send only updated fields out if set to true.

Throws:

MXException

MOSStAXStructure

public MOSStAXStructure(java.lang.String defClassName,
                        java.util.Map<java.lang.String,?> defnMetaData,
                        java.lang.String mosName,
                        boolean event,
                        boolean retainMbos,
                        java.lang.String operationName,
                        boolean response,
                        boolean updatesOnly)
                 throws MXException

Parameters:

defClassName - the object structure defintion class name. This is the call back class for OS xml creation.

defnMetaData - the Metadata for serialization

mosName - the object structure name

event - true implies that this request for serialization is based on an Mbo event

retainMbos - if set to true will not discard the Mbos that are being serialized.

operationName - the operation name

response - true if serilization needs to be done for response of the operation

updatesOnly - send only updated fields out if set to true.

Throws:

MXException

MOSStAXStructure

public MOSStAXStructure(java.lang.String defClassName,
                        java.util.Map<java.lang.String,?> defnMetaData,
                        java.lang.String mosName,
                        boolean event,
                        boolean retainMbos,
                        boolean ignoreActions,
                        java.lang.String operationName,
                        boolean response,
                        boolean updatesOnly)
                 throws MXException

Parameters:

defClassName - the object structure defintion class name. This is the call back class for OS xml creation.

defnMetaData - the Metadata for serialization

mosName - the object structure name

event - true implies that this request for serialization is based on an Mbo event

retainMbos - if set to true will not discard the Mbos that are being serialized.

operationName - the operation name

response - true if serilization needs to be done for response of the operation

updatesOnly - send only updated fields out if set to true.

Throws:

MXException

MOSStAXStructure

public MOSStAXStructure(java.lang.String defClassName,
                        java.util.Map<java.lang.String,?> defnMetaData,
                        java.lang.String mosName,
                        boolean event,
                        boolean retainMbos,
                        boolean ignoreActions,
                        java.lang.String operationName,
                        boolean response,
                        boolean updatesOnly,
                        java.lang.String inputAction)
                 throws MXException

Parameters:

defClassName - the object structure defintion class name. This is the call back class for OS xml creation.

defnMetaData - the Metadata for serialization

mosName - the object structure name

event - true implies that this request for serialization is based on an Mbo event

retainMbos - if set to true will not discard the Mbos that are being serialized.

operationName - the operation name

response - true if serilization needs to be done for response of the operation

updatesOnly - send only updated fields out if set to true.

Throws:

MXException

MOSStAXStructure

public MOSStAXStructure(java.lang.String defClassName,
                        java.util.Map<java.lang.String,?> defnMetaData,
                        java.lang.String mosName,
                        boolean event,
                        boolean retainMbos,
                        boolean ignoreActions,
                        java.lang.String operationName,
                        boolean response,
                        boolean updatesOnly,
                        java.lang.String inputAction,
                        boolean dropNullCols)
                 throws MXException

Parameters:

defClassName - the object structure defintion class name. This is the call back class for OS xml creation.

defnMetaData - the Metadata for serialization

mosName - the object structure name

event - true implies that this request for serialization is based on an Mbo event

ignoreActions - true implies that this request for serialization will ignore all Mbo actions even if the Mbos are modified

retainMbos - if set to true will not discard the Mbos that are being serialized.

operationName - the operation name

response - true if serilization needs to be done for response of the operation

updatesOnly - send only updated fields out if set to true.

dropNullCols - drops null value clumns from xml if this is set to true.

Throws:

MXException

MOSStAXStructure

public MOSStAXStructure(java.util.Map<java.lang.String,?> defnMetaData,
                        java.lang.String mosName,
                        boolean retainMbos,
                        boolean updatesOnly)
                 throws MXException

Parameters:

defnMetaData - the Metadata for serialization

mosName - the object structure name

retainMbos - if set to true will not discard the Mbos that are being serialized.

updatesOnly - send only updated fields out if set to true.

Throws:

MXException

MOSStAXStructure

public MOSStAXStructure(java.lang.String defClassName,
                        java.util.Map<java.lang.String,?> defnMetaData,
                        java.lang.String mosName,
                        boolean event,
                        java.lang.String operationName,
                        boolean response)
                 throws MXException

Parameters:

defClassName - the object structure defintion class name. This is the call back class for OS xml creation.

defnMetaData - the Metadata for serialization

mosName - the object structure name

event - true implies that this request for serialization is based on an Mbo event

operationName - the operation name

response - true if serilization needs to be done for response of the operation

Throws:

MXException

MOSStAXStructure

public MOSStAXStructure(java.util.Map<java.lang.String,?> defnMetaData,
                        java.lang.String mosName,
                        boolean event,
                        java.lang.String operationName,
                        boolean response)
                 throws MXException

Parameters:

defnMetaData - the Metadata for serialization

mosName - the object structure name

event - true implies that this request for serialization is based on an Mbo event

operationName - the operation name

response - true if serilization needs to be done for response of the operation

Throws:

MXException

Method Detail

setProcessAsSelfRefRelName

public void setProcessAsSelfRefRelName(java.lang.String relName,
                                       boolean allowSelfRefDup)

setResourceProperties

public void setResourceProperties(java.util.Map<java.lang.String,OslcResourceProperty> resourceProperties)

setAllowEmptyXML

public void setAllowEmptyXML(boolean emptyXML)

setAllowSkipRows

public void setAllowSkipRows(boolean allowSkipRows)

isAllowSkipRows

public boolean isAllowSkipRows()

getMosDefinitionImpl

public MosDefinitionImpl getMosDefinitionImpl()

Returns:

return the callback class handle

getUsedMboList

public java.util.List<MboRemote> getUsedMboList()

Returns:

the list of primary Mbos that were actually serialized

getSerializedMboCount

public int getSerializedMboCount()

Returns:

the count of Mbos serialized

setEvaluateMboXmlType

public void setEvaluateMboXmlType(boolean evaluateXMLType)

evaluateMboXmlType

public boolean evaluateMboXmlType()

setTotalCount

public void setTotalCount(java.lang.Integer totCount)

setResolvedTotalCount

public void setResolvedTotalCount(int resolvedTotalCount)

setInitialResolvedCount

public void setInitialResolvedCount(int initialResolvedCount)

setResolvedStartCount

public void setResolvedStartCount(int resolvedStartCount)