WebCenter Interaction API  
 

IPTMigrationManager Members

IPTMigrationManager overview

Public Instance Methods

public methodBulkSetMigratedStatusByUUID Sets the status of the objects to MIGRATED.
public methodBulkSetMigrationStatus Sets the migration status of the specified objects to have the passed-in migration status. The permissions on this method are checked as follows: Admins have rights to set any object to any status. Non-admins can set objects to the following access levels given the constraints: PT_MIGRATION_STATUS_NONE - only if the calling user was the last migration requestor, and the current status of the object is *not* PT_MIGRATION_STATUS_APPROVED PT_MIGRATION_STATUS_APPROVAL_REQUESTED - if the calling user has Edit access on the objects being marked for the request PT_MIGRATION_STATUS_APPROVED, PT_MIGRATION_STATUS_DENIED, and PT_MIGRATION_STATUS_MIGRATED can only be set on objects by users with admin access.
public methodCancelImport Cancel PerformImport, an in-progress migration import. This method should not be used unless PerformImport has been called in a separate thread. This method has no effect if the IPTMigrationManager is not currently importing. This method does not interrupt an in-progress IPTMigratable object import but instead stops before beginning the next object's import. This behavior should prevent corrupt object state. Implementers must guarantee thread safety and should log any exceptions.
public methodCheckObjectCreationRights Checks whether or not the calling user has sufficient activity rights to create all objects contained in the package.
public methodCreateEmptyMigrationElement Creates an empty IPTMigrationElement.
public methodEndExport Writes and closes the migration package file. This method should be called once all objects have been added to the migration package; otherwise the file will not be written. For use on export only.
public methodEndImport Closes the migration package currently open for import. For use on import only.
public methodExportObject Exports a single object into an IPTMigrationElement. For use on export only.
public methodGenerateNewUUID Generates a new Universally Unique Identifier (UUID).
public methodGetMWSRemoteData Retrieve all MWS REMOTEDATA elements. Each String key is the REMOTEDATA element of an MWSDATAARRAY. These UUIDs represent the zip files required for Collaboration or Publisher object import. Each String value is a constant that identifies the MWS by type, either COLLABORATION, PUBLISHER, or UNKNOWN. See PTMigrationConstants for a full list of MWS_REMOTEDATA types. This allows the remote MWS to determine if the zip UUID refers to a Collaboration specific file, for instance.
public methodGetObjectClassIndex Returns the index in the PT_MIGRATION_CLASSES.SUPPORTED_CLASSES array, given a classID.
public methodGetObjectCount Returns the count of objects of the specified classID in the currently loaded migration package.
public methodGetPackageSourcePortalUUID Returns the source portal UUID where the currently loaded migration package was created. For use on import only.
public methodGetPackageSourcePortalVersion Returns the portal version of the portal on which the currently loaded migration package was created. For use on import only.
public methodGetProvider Creates and initializes an IPTMigrationProvider based on the web service ID.
public methodImportMigrationWebServices Imports all items in the MWSDataArray. For use on import only.
public methodInflateObjectForImport Populates an in-memory instance of an object using the passed in IPTMigrationElement. The parameters of this process are controlled by the passed in IXPPropertyBag that containst configuration information.
public methodInitializeForExport Initializes the migration manager for export and opens an empty migration package at the specified file system path.
public methodInitializeForImportOverloaded. Initializes the migration manager for import. Loads the package at the specified file system path.
public methodLookupMappingInProfile Retrieves a migration mapping from the database, if it exists.
public methodObjectExistsInPackage Checks whether or not the object with the specified UUID exists in the currently loaded migration package.
public methodObjectExistsInSystem Checks whether or not the object serialized in the specified IPTMigrationElement already exists in the portal system.
public methodObjectIDToUUID Looks up an object's UUID based on its class ID and object ID
public methodPerformImport Performs the actual import of objects passed in as arguments.
public methodPurgeMigrationProfile Clears all migration mappings associated with the specified portal UUID from the database.
public methodQueryMigrationHistory Queries the migration history for a specified object.
public methodQueryMigrationStatus Queries migration status for a specified object.
public methodQueryObjectsByStatus This function returns a QueryResult with PT_PROPID_NAME, PT_PROPID_DESCRIPTION, PT_PROPID_ISLOCALIZED, PT_PROPID_CLASSID, PT_PROPID_OBJECTID, PT_PROPID_UUID, PT_PROPID_MIGRATION_DATE, and PT_PROPID_MIGRATION_COMMENT for all objects with the passed in values nClassID and nStatus. Used by the UI, requires admin access.
public methodQueryObjectsByStatusCount This function returns a QueryResult with PT_PROPID_NAME, PT_PROPID_DESCRIPTION, PT_PROPID_ISLOCALIZED, PT_PROPID_CLASSID, PT_PROPID_OBJECTID, PT_PROPID_UUID, PT_PROPID_MIGRATION_DATE, and PT_PROPID_MIGRATION_COMMENT for all objects with the passed in value of nStatus. Used by the UI.
public methodQueryStatusForMigrationRequestor Queries migration status of all objects for which the calling user requested migration.
public methodQueryStatusForMigrationRequestorCount Queries the count of all objects for which the calling user requested migration, grouped by classID.
public methodReadUserDataItemFromPackage Reads a user-specified metadata item from the currently loaded migration package. For use on import only.
public methodResolveObject Resolves the IPTMigrationElement and returns its object ID. Some special-casing for class types, like resolving folders or users.
public methodRetrieveAllUserDataNames Retrieves an array of all user-specified metadata names. The associated values can be retrieved by iterating through the array and calling ReadUserDataItemFromPackage on the desired items.
public methodRetrieveObjectFromImportPackage Retrieves a single IPTMigrationElement from the migration package. For use on import only.
public methodStoreMappingInProfile Stores a migration mapping in the database.
public methodStoreObjectInExportPackage Stores an IPTMigrationElement into the migration package. For use on export only.
public methodUpdateHistory Adds a history item to the migration history for the specified object.
public methodUUIDToObjectID Converts a UUID to its (classID, objectID) equivalent on the local system, if it exists.
public methodWriteMWSDataItemToPackage Writes a Migration Web Service item to the migration package. For use on export only.
public methodWriteUserDataItemToPackage Writes a user-specified metadata item to the migration package. For use on export only.

See Also

IPTMigrationManager Interface | com.plumtree.server Namespace