WebCenter Interaction API  
 

IPTMigrationElement Members

IPTMigrationElement overview

Public Instance Methods

public methodApplyDependencyMapping Applies a dependency mapping to this IPTMigrationElement. Used to substitute a missing dependency with an existing object on a target system.
public methodBeginComplexElement Begins an element with child nodes (a scope) when reading or writing to the IPTMigrationElement, and sets the node as the active element.
public methodCheckDependencies Returns only missing dependencies for this object, as a 2-D array.
public methodChildElementExists Tests whether or not a child element of the specified name exists.
public methodEndComplexElement Ends an element with child nodes (a scope) when reading or writing to the IPTMigrationElement, and sets the parent node as the active element.
public methodGetClassID Returns the classID of the underlying object.
public methodGetDependencies Returns all dependencies for this object, as a 2-D array.
public methodGetDescription Returns the description of the serialized object.
public methodGetFolderID Returns the folderID where the serialized object resides. Can be an admin folder ID or document folder ID, depending on the object.
public methodGetFolderPath Returns the full path to the folder where the serialized object resides.
public methodGetMigrationComment Returns the migration comment used when requesting migration for the object.
public methodGetName Returns the name of the serialized object.
public methodGetUUID Returns the UUID (Universally Unique Identifier) of the serialized object.
public methodOverwriteSimpleElementOverloaded. Overwrites the value of an existing child element of the currently active node.
public methodReadArrayAsObject1DArray 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).
public methodReadArrayAsObject2DArray 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).
public methodReadArrayOfObjectReferences Reads an array of object references from the IPTMigrationElement.
public methodReadSimpleElementAsDouble Reads a value from the specified child node of the currently active element.
public methodReadSimpleElementAsFloat Reads a value from the specified child node of the currently active element.
public methodReadSimpleElementAsInt Reads a value from the specified child node of the currently active element.
public methodReadSimpleElementAsIXPPropertyBag Reads a value from the specified child node of the currently active element.
public methodReadSimpleElementAsObject Reads a value from the specified child node of the currently active element.
public methodReadSimpleElementAsString Reads a value from the specified child node of the currently active element.
public methodReadSimpleElementAsXPDateTime Reads a value from the specified child node of the currently active element.
public methodRemoveElement Removes the child element with the specified name.
public methodRestoreFromXML Deprecated. Populates an IPTMigrationElement from an XML string.
public methodSerializeToXML Serializes an IPTMigrationElement to an XML string.
public methodSetClassID Sets the classID of the underlying object. Can only be set once per instance of an IPTMigrationElement.
public methodSetFolderID 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.
public methodSetMigrationComment Sets the migration comment for the object.
public methodSetMigrationConfigBagSettings Sets user specified migration configuration options, such as export parent folders.
public methodSetRootAsActiveElement Sets the root element as the active element when enumerating over the tree nodes in the IPTMigrationElement.
public methodSetUUID Sets the UUID (Universally Unique Identifier) of the serialized object. Can only be called once the IPTMigrationElement has been populated.
public methodWriteArrayOverloaded. Creates a new child node and associates a 1-D array of primitive datatypes as the value.
public methodWriteArrayOfObjectReferences Writes an array of object references into the IPTMigrationElement.
public methodWriteSimpleElementOverloaded. 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