SYNC.SyncSetObject models a record in a SYNC.SyncSet. More...

Inheritance diagram for SyncSetObject:

[legend]

Collaboration diagram for SyncSetObject:

[legend]

Public Member Functions
_.Library.Status	OnNew (_.Library.RawString initvalue)
	This callback method is invoked by the <METHOD>New</METHOD> method to. More...

_.Library.RegisteredObject	SSObjectGet ()
	Overridden SSObject Get method. More...

Public Member Functions inherited from RegisteredObject
_.Library.Status	OnAddToSaveSet (_.Library.Integer depth, _.Library.Integer insert, _.Library.Integer callcount)
	This callback method is invoked when the current object is added to the SaveSet,. More...

_.Library.Status	OnClose ()
	This callback method is invoked by the <METHOD>Close</METHOD> method to. More...

_.Library.Status	OnConstructClone (_.Library.RegisteredObject object, _.Library.Boolean deep, _.Library.String cloned)
	This callback method is invoked by the <METHOD>ConstructClone</METHOD> method to. More...

_.Library.Status	OnNew ()
	This callback method is invoked by the <METHOD>New</METHOD> method to. More...

_.Library.Status	OnValidateObject ()
	This callback method is invoked by the <METHOD>ValidateObject</METHOD> method to. More...

Public Member Functions inherited from Adaptor
_.Library.Status	XMLExport (_.Library.String top, _.Library.String format, _.XML.Namespaces namespaces, attrs, _.Library.String createId, _.Library.String typeAttr, oreflist, idlist, _.Library.String initialIndent, _.Library.Boolean local, _.Net.MIMEPart mimeAttachments)
	Serialize an XML enabled class as an XML document and write. More...

_.Library.Status	XMLExportToStream (_.Stream.Object export, _.Library.String top, _.Library.String format, _.XML.Namespaces namespaces, attrs, _.Library.String createId, _.Library.String typeAttr, oreflist, idlist, _.Library.String initialIndent)
	Serialize an XML enabled class as an XML document and appends it to a stream. More...

_.Library.Status	XMLExportToString (_.Library.String export, _.Library.String top, _.Library.String format, _.XML.Namespaces namespaces, attrs, _.Library.String createId, _.Library.String typeAttr, oreflist, idlist, _.Library.String initialIndent)
	Serialize an XML enabled class as an XML document and write it to a string. More...

Public Attributes
	BackwardLink
	BackwardLink is a link to the SyncSet instance that caused this SyncSet instance to be created. More...

	Class
	The name of the Class of which this object in the SyncSet is an instance. More...

	Error
	This is a list of errors that are recorded for this SyncSet instance. More...

	FileOperation
	The type of filing event that produced this SyncSet object. More...

	ForwardLink
	ForwardLink is a link to another SyncSet instance in the same SyncSet. More...

	GUID
	The GUID of this object in the SyncSet. More...

	Namespace
	The Namespace in which the SyncSet was created. More...

	Ptr
	The Sync Set pointer. More...

	SSObject
	OREF referencing the object identified by GUID as it exists in the target database. More...

	SysGUID
	The GUID of the system where the SyncSet was created. More...

Private Member Functions
_.Library.Status	SyncObjectIn (_.SYNC.SyncSet SyncSet)
	Sync this SyncSet instance with the current database. More...

Private Attributes
	__sId
	sId is the global identifier and it is used to qualify the global name. More...

Additional Inherited Members
Static Public Member Functions inherited from Adaptor
_.Library.Status	XMLDTD (_.Library.String top, _.Library.String format, _.Library.Boolean input, dtdlist)
	Write the DTD to the current device for this XML enabled class serialized as. More...

_.Library.RegisteredObject	XMLNew (_.XML.Document document, _.Library.Integer node, _.Library.RegisteredObject containerOref)
	Get an instance of an XML enabled class. More...

_.Library.Status	XMLSchema (_.Library.String top, _.Library.String format, _.Library.String namespacePrefix, _.Library.Boolean input, _.Library.Boolean refOnly, schema)
	Write an XML Schema fragment to the current device which describes an XML enabled class and dependent classes. More...

_.Library.String	XMLSchemaNamespace ()
	Get the namespace to which this class belongs for use in schema generation. More...

_.Library.Status	XMLSchemaType (_.XML.Schema schemaInstance, _.XML.Node node, _.Library.String top, _.Library.Boolean encoded, _.Library.Boolean summary, _.Library.Boolean input, _.Library.Boolean refOnly)
	Add a complexType to the schema that is respresented by an <class>XML.Schema</class> instance. More...

Static Public Attributes inherited from RegisteredObject
	CAPTION = None
	Optional name used by the Form Wizard for a class when generating forms. More...

	JAVATYPE = None
	The Java type to be used when exported.

	PROPERTYVALIDATION = None
	This parameter controls the default validation behavior for the object. More...

Static Public Attributes inherited from Adaptor
	ATTRIBUTEQUALIFIED = None
	ATTRIBUTEQUALIFIED controls the format of exported XML by controlling whether attributes. More...

	ELEMENTQUALIFIED = None
	ELEMENTQUALIFIED controls the format of exported XML. More...

	NAMESPACE = None
	NAMESPACE specifies the XML namespace to be used when projecting the. More...

	SUPPRESSTYPEPREFIX = None
	SUPPRESSTYPEPREFIX allows the type name that refers to this class. More...

	XMLDEFAULTREFERENCE = None
	XMLDEFAULTREFERENCE specifies the default value of the XMLREFERENCE property parameter. More...

	XMLENABLED = None
	If this parameter is true then XML-enabling methods. More...

	XMLFORMAT = None
	The XMLFORMAT parameter controls the generation of the XMLExport and XMLImport. More...

	XMLIGNOREINVALIDATTRIBUTE = None
	The XMLIGNOREINVALIDATTRIBUTE parameter allows the programmer to control handling of unexpected. More...

	XMLIGNOREINVALIDTAG = None
	The XMLIGNOREINVALIDTAG parameter allows the programmer to control handling of unexpected. More...

	XMLIGNORENULL = None
	XMLIGNORENULL allows the programmer to override the default XML handling. More...

	XMLINCLUDEINGROUP = None
	XMLINCLUDEINGROUP allows the programmer to control whether a class is included. More...

	XMLINHERITANCE = None
	If the XMLINHERITANCE parameter is set to "LEFT", then in the case of multiple. More...

	XMLNAME = None
	This parameter provides the default XMLNAME for the class. More...

	XMLNIL = None
	The XMLNIL class parameter controls the use of xsi:nil by XMLExport. More...

	XMLNILNOOBJECT = None
	The XMLNILNOOBJECT parameter allows creation of an object to be skipped for elements. More...

	XMLPREFIX = None
	The XMLPREFIX parameter controls the prefix to be used for the XML namespace that. More...

	XMLSEQUENCE = None
	If the XMLSEQUENCE = 1, then the order of the XML elements must match the. More...

	XMLSUMMARY = None
	The summary fields to be used when an object is referenced are specified. More...

	XMLTYPE = None
	This parameter provides the default XMLTYPE for the class. More...

	XMLUNSWIZZLE = None
	If the XMLUNSWIZZLE parameter is set to 1, then single object. More...

	XMLUSEEMPTYELEMENT = None
	If the XMLUSEEMPTYELEMENT parameter is set to 1, then the empty element shorthand (<tag>) More...

Detailed Description

SYNC.SyncSetObject models a record in a SYNC.SyncSet.

SyncSets are globals containing records corresponding to filing events. A filing event is an insert of a new object, update of an existing object or delete of an existing object. Each time a filing event occurs in a class that is OBJJOURNALENABLED, the event is recorded in the ObjectJournalTransaction class. SyncSets are created from the ObjectJournalTransaction class and each record in the SyncSet corresponds to a ObjectJournalRecord. ObjectJournalRecords are individual filing events that occur with a transaction, the transaction being an instance of ObjectJournalTransaction. The SyncSetObject contains information that identifies the SyncSet as well as specific information about the filing event described by a record in the SyncSet.

Member Function Documentation

◆ OnNew()

_.Library.Status OnNew ( _.Library.RawString initvalue )

This callback method is invoked by the <METHOD>New</METHOD> method to.

provide notification that a new instance of an object is being created.

If this method returns an error then the object will not be created.

◆ SyncObjectIn()

_.Library.Status SyncObjectIn ( _.SYNC.SyncSet SyncSet )

private

Sync this SyncSet instance with the current database.

This method returns a Status value.

◆ SSObjectGet()

_.Library.RegisteredObject SSObjectGet ( )

Overridden SSObject Get method.

This method looks up the object in the local GUID index.

If the GUID is found then attempt to open the object associated with the GUID and return the result. If the GUID is not found in the GUID index then return NULLOREF.

Member Data Documentation

◆ BackwardLink

BackwardLink

BackwardLink is a link to the SyncSet instance that caused this SyncSet instance to be created.

Creating a new

SyncSet instance is triggered by the Requeue mechanism. Requeue is the operation triggered by a failure to successfully synchronize an object, usually because of an unresolvable reference. When a SyncSet instance is requeued the system is basically saying to 'try this operation again later'. The idea being that the cause of the sync failure will have been resolved by the time we process the requeued instance.

◆ Class

Class

The name of the Class of which this object in the SyncSet is an instance.

◆ Error

Error

This is a list of errors that are recorded for this SyncSet instance.

◆ FileOperation

FileOperation

The type of filing event that produced this SyncSet object.

Values are:

0 - UPDATE 1 - INSERT 2 - DELETE

◆ ForwardLink

ForwardLink

ForwardLink is a link to another SyncSet instance in the same SyncSet.

ForwardLinks are

created when an object cannot be synchronized due to some error. Errors that produce forward links are typically unresolvable references to other objects. The most common unresolvable reference in a properly constructed SyncSet will be a reference to an object that has not yet been created because it occurs later in the SyncSet.

◆ GUID

GUID

The GUID of this object in the SyncSet.

◆ Namespace

Namespace

The Namespace in which the SyncSet was created.

◆ Ptr

Ptr

The Sync Set pointer.

This property references the SyncSet object on disk.

◆ SSObject

SSObject

OREF referencing the object identified by GUID as it exists in the target database.

If the object does not yet exist in the target database then this oref will be null.

◆ SysGUID

SysGUID

The GUID of the system where the SyncSet was created.

◆ __sId

__sId

private

sId is the global identifier and it is used to qualify the global name.

Sync sets are constructed on

a system and then exported to other systems for synchronizing the objects it contains with a database on the target system. The sId is used to generate a unique name for this sync set on the target system.

Public Member Functions

Public Attributes

Private Member Functions

Private Attributes

Additional Inherited Members