Aqualogic Interaction API  
 

IPTMigrationElement Members

IPTMigrationElement overview

Public Instance Methods

ApplyDependencyMapping Applies a dependency mapping to this IPTMigrationElement. Used to substitute a missing dependency with an existing object on a target system.
BeginComplexElement Begins an element with child nodes (a scope) when reading or writing to the IPTMigrationElement, and sets the node as the active element.
CheckDependencies Returns only missing dependencies for this object, as a 2-D array.
ChildElementExists Tests whether or not a child element of the specified name exists.
EndComplexElement Ends an element with child nodes (a scope) when reading or writing to the IPTMigrationElement, and sets the parent node as the active element.
GetClassID Returns the classID of the underlying object.
GetDependencies Returns all dependencies for this object, as a 2-D array.
GetDescription Returns the description of the serialized object.
GetFolderID Returns the folderID where the serialized object resides. Can be an admin folder ID or document folder ID, depending on the object.
GetFolderPath Returns the full path to the folder where the serialized object resides.
GetMigrationComment Returns the migration comment used when requesting migration for the object.
GetName Returns the name of the serialized object.
GetUUID Returns the UUID (Universally Unique Identifier) of the serialized object.
OverwriteSimpleElementOverloaded. Overwrites the value of an existing child element of the currently active node.
ReadArrayAsObject1DArray Reads an array of primitive types from an IPTMigrationElement. Each object in the array has an innter element name which contains the simple datatype (int, String, float, double, or IXPPropertyBag).
ReadArrayAsObject2DArray Reads an array of primitive types from an IPTMigrationElement. Each object in the array can have multiple columns, with each column holding a simple datatype (int, String, float, double, or IXPPropertyBag).
ReadArrayOfObjectReferences Reads an array of object references from the IPTMigrationElement.
ReadSimpleElementAsDouble Reads a value from the specified child node of the currently active element.
ReadSimpleElementAsFloat Reads a value from the specified child node of the currently active element.
ReadSimpleElementAsInt Reads a value from the specified child node of the currently active element.
ReadSimpleElementAsIXPPropertyBag Reads a value from the specified child node of the currently active element.
ReadSimpleElementAsObject Reads a value from the specified child node of the currently active element.
ReadSimpleElementAsString Reads a value from the specified child node of the currently active element.
ReadSimpleElementAsXPDateTime Reads a value from the specified child node of the currently active element.
RemoveElement Removes the child element with the specified name.
RestoreFromXML Deprecated. Populates an IPTMigrationElement from an XML string.
SerializeToXML Serializes an IPTMigrationElement to an XML string.
SetClassID Sets the classID of the underlying object. Can only be set once per instance of an IPTMigrationElement.
SetFolderID Returns the folderID where the serialized object resides. Will be interpreted as an admin folder ID or a document folder ID, depending on the object.
SetMigrationComment Sets the migration comment for the object.
SetMigrationConfigBagSettings Sets user specified migration configuration options, such as export parent folders.
SetRootAsActiveElement Sets the root element as the active element when enumerating over the tree nodes in the IPTMigrationElement.
SetUUID Sets the UUID (Universally Unique Identifier) of the serialized object. Can only be called once the IPTMigrationElement has been populated.
WriteArrayOverloaded. Creates a new child node and associates a 1-D array of primitive datatypes as the value.
WriteArrayOfObjectReferences Writes an array of object references into the IPTMigrationElement.
WriteSimpleElementOverloaded. Creates a new child node of the currently active element, with the specified name, and associates a value with the node.

See Also

IPTMigrationElement Interface | com.plumtree.server Namespace