|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface IPTMigrationManager
This interface manages the Import and Export of migration packages of Plumtree objects into/out of a system. It also provides methods used by the UI to perform various queries related to migration.
Method Summary | |
---|---|
void |
BulkSetMigratedStatusByUUID(java.lang.Object[] iaUUIDs)
Sets the status of the objects to MIGRATED. |
void |
BulkSetMigrationStatus(int nClassID,
int[] iaObjectIDs,
int nMigrationStatus,
java.lang.String strMigrationComment)
Sets the migration status of the specified objects to have the passed-in migration status. |
void |
CancelImport()
Cancel PerformImport, an in-progress migration import. |
boolean |
CheckObjectCreationRights()
Checks whether or not the calling user has sufficient activity rights to create all objects contained in the package. |
IPTMigrationElement |
CreateEmptyMigrationElement()
Creates an empty IPTMigrationElement. |
void |
EndExport()
Writes and closes the migration package file. |
void |
EndImport()
Closes the migration package currently open for import. |
IPTMigrationElement |
ExportObject(int nClassID,
int nObjectID,
com.plumtree.openfoundation.util.IXPPropertyBag pMigrationConfigBag)
Exports a single object into an IPTMigrationElement. |
java.lang.String |
GenerateNewUUID()
Generates a new Universally Unique Identifier (UUID). |
com.plumtree.openfoundation.util.XPHashtable |
GetMWSRemoteData()
Retrieve all MWS REMOTEDATA elements. |
int |
GetObjectClassIndex(int nClassID)
Returns the index in the PT_MIGRATION_CLASSES.SUPPORTED_CLASSES array, given a classID. |
int |
GetObjectCount(int nClassID)
Returns the count of objects of the specified classID in the currently loaded migration package. |
java.lang.String |
GetPackageSourcePortalUUID()
Returns the source portal UUID where the currently loaded migration package was created. |
java.lang.String |
GetPackageSourcePortalVersion()
Returns the portal version of the portal on which the currently loaded migration package was created. |
IPTMigrationProvider |
GetProvider(int nWebServiceID)
Creates and initializes an IPTMigrationProvider based on the web service ID. |
void |
ImportMigrationWebServices()
Imports all items in the MWSDataArray. |
IPTMigratable |
InflateObjectForImport(IPTMigrationElement pMigrationElement,
com.plumtree.openfoundation.util.IXPPropertyBag pMigrationConfigBag,
boolean bResolveObject)
Populates an in-memory instance of an object using the passed in IPTMigrationElement. |
void |
InitializeForExport(java.lang.String strMigrationPackagePath)
Initializes the migration manager for export and opens an empty migration package at the specified file system path. |
void |
InitializeForImport(byte[] _barMigrationPackage)
Initializes the migration manager for import. |
void |
InitializeForImport(java.lang.String strMigrationPackagePath)
Initializes the migration manager for import. |
java.lang.String |
LookupMappingInProfile(java.lang.String strSourcePortalUUID,
java.lang.String strSourceUUID)
Retrieves a migration mapping from the database, if it exists. |
boolean |
ObjectExistsInPackage(java.lang.String strUUID)
Checks whether or not the object with the specified UUID exists in the currently loaded migration package. |
boolean |
ObjectExistsInSystem(IPTMigrationElement ptME)
Checks whether or not the object serialized in the specified IPTMigrationElement already exists in the portal system. |
java.lang.String |
ObjectIDToUUID(int nClassID,
int nObjectID)
Looks up an object's UUID based on its class ID and object ID |
void |
PerformImport(com.plumtree.openfoundation.util.XPArrayList[] _xparObjsToMigrate,
boolean _bCreateNewObjectInstances,
boolean _bImportACLs,
boolean _bOverwriteRemoteServers,
boolean _bRememberDependencySettings)
Performs the actual import of objects passed in as arguments. |
void |
PurgeMigrationProfile(java.lang.String strSourcePortalUUID)
Clears all migration mappings associated with the specified portal UUID from the database. |
IPTQueryResult |
QueryMigrationHistory(int nClassID,
int nObjectID)
Queries the migration history for a specified object. |
int |
QueryMigrationStatus(int nClassID,
int nObjectID)
Queries migration status for a specified object. |
IPTQueryResult |
QueryObjectsByStatus(int nClassID,
int nStatus,
int nSkipRows,
int nMaxRows,
java.lang.Object[][] arQueryFilter)
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. |
IPTQueryResult |
QueryObjectsByStatusCount(int nStatus,
java.lang.Object[][] arQueryFilter)
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. |
IPTQueryResult |
QueryStatusForMigrationRequestor(int nClassID,
int nSkipRows,
int nMaxRows)
Queries migration status of all objects for which the calling user requested migration. |
IPTQueryResult |
QueryStatusForMigrationRequestorCount()
Queries the count of all objects for which the calling user requested migration, grouped by classID. |
java.lang.String |
ReadUserDataItemFromPackage(java.lang.String strName)
Reads a user-specified metadata item from the currently loaded migration package. |
int |
ResolveObject(IPTMigrationElement spME,
boolean bResolveObject)
Resolves the IPTMigrationElement and returns its object ID. |
java.lang.String[] |
RetrieveAllUserDataNames()
Retrieves an array of all user-specified metadata names. |
IPTMigrationElement |
RetrieveObjectFromImportPackage(int nIndex,
int nClassID)
Retrieves a single IPTMigrationElement from the migration package. |
void |
StoreMappingInProfile(java.lang.String strSourcePortalUUID,
java.lang.String strSourceUUID,
java.lang.String strMappedUUID)
Stores a migration mapping in the database. |
void |
StoreObjectInExportPackage(IPTMigrationElement ptME)
Stores an IPTMigrationElement into the migration package. |
void |
UpdateHistory(IPTMigrationElement pMigrationElement)
Adds a history item to the migration history for the specified object. |
java.lang.Object[] |
UUIDToObjectID(java.lang.String strUUID)
Converts a UUID to its (classID, objectID) equivalent on the local system, if it exists. |
void |
WriteMWSDataItemToPackage(int intWSID,
java.lang.String strValue)
Writes a Migration Web Service item to the migration package. |
void |
WriteUserDataItemToPackage(java.lang.String strName,
java.lang.String strValue)
Writes a user-specified metadata item to the migration package. |
Method Detail |
---|
IPTQueryResult QueryObjectsByStatus(int nClassID, int nStatus, int nSkipRows, int nMaxRows, java.lang.Object[][] arQueryFilter)
nClassID
- the class of interest, from PT_CLASSIDSnStatus
- the status of interest, from PT_MIGRATION_STATUS_TYPESnSkipRows
- number of rows to skip at the beginning, or 0 for nonenMaxRows
- maximum number of rows to return, or -1 for allarQueryFilter
- is a 2D array with 3 columns. The first column holds
the property id, from PT_PROPIDS. The second column holds the operator,
from PT_FILTEROPS. The third column holds the value to be matched.
PT_CLASSIDS
,
PT_MIGRATION_STATUS_TYPES
,
PT_PROPIDS
,
PT_ORDERBY_SETTINGS
int GetObjectCount(int nClassID)
nClassID
- - The classID of objects to count.
void PurgeMigrationProfile(java.lang.String strSourcePortalUUID)
strSourcePortalUUID
- - The portal UUID to clear mappings for.boolean ObjectExistsInSystem(IPTMigrationElement ptME)
ptME
- - The IPTMigrationElement being imported.
boolean ObjectExistsInPackage(java.lang.String strUUID)
strUUID
- - The UUID to check cor.
IPTMigrationElement CreateEmptyMigrationElement()
java.lang.Object[] UUIDToObjectID(java.lang.String strUUID)
strUUID
- - The UUID to look up.
IPTQueryResult QueryObjectsByStatusCount(int nStatus, java.lang.Object[][] arQueryFilter)
nStatus
- the status of interest, from PT_MIGRATION_STATUS_TYPESarQueryFilter
- is a 2D array with 3 columns. The first column holds
the property id, from PT_PROPIDS. The second column holds the operator,
from PT_FILTEROPS. The third column holds the value to be matched.
PT_MIGRATION_STATUS_TYPES
,
PT_PROPIDS
,
PT_ORDERBY_SETTINGS
void InitializeForExport(java.lang.String strMigrationPackagePath)
strMigrationPackagePath
- - The full path to the migration package file.void StoreObjectInExportPackage(IPTMigrationElement ptME)
ptME
- The IPTMigrationElement to store.void EndExport()
IPTMigrationElement ExportObject(int nClassID, int nObjectID, com.plumtree.openfoundation.util.IXPPropertyBag pMigrationConfigBag)
nClassID
- - The classID of the object to export.nObjectID
- - The objectID of the object to export.pMigrationConfigBag
- - A configuration propertybag containing parameters
that specify whether or not to include ACL information and EOD information, for
example, in the serialized IPTMigrationElement.
void InitializeForImport(java.lang.String strMigrationPackagePath)
strMigrationPackagePath
- - The full path to the package to be imported.void InitializeForImport(byte[] _barMigrationPackage)
byte[]
- byte array of XML representationvoid StoreMappingInProfile(java.lang.String strSourcePortalUUID, java.lang.String strSourceUUID, java.lang.String strMappedUUID)
strSourcePortalUUID
- - The UUID of the portal where the source object came from.strSourceUUID
- - The UUID of the object to be mapped.strMappedUUID
- - The UUID of the replacement object on the local system.java.lang.String LookupMappingInProfile(java.lang.String strSourcePortalUUID, java.lang.String strSourceUUID)
strSourcePortalUUID
- - The UUID of the portal where the source object came from.strSourceUUID
- - The UUID of the object to be mapped.
IPTMigrationElement RetrieveObjectFromImportPackage(int nIndex, int nClassID)
nIndex
- - The index of the object in the array. The upper bound for this is
obtained using the GetObjectCount(nClassID)
call.nClassID
- - The classID of the object.
void EndImport()
boolean CheckObjectCreationRights()
IPTMigratable InflateObjectForImport(IPTMigrationElement pMigrationElement, com.plumtree.openfoundation.util.IXPPropertyBag pMigrationConfigBag, boolean bResolveObject)
pMigrationElement
- - The IPTMigrationElement to use to populate the object.pMigrationConfigBag
- - The configuration Propertybag.bResolveObject
- - True if the migration manager should attempt to look to see if
this object already exists in the database. False if you want a new object to be created
(used for Creating New Object Instances. Need to make sure object is assigned a new UUID
before passing to this method.).
java.lang.String GetPackageSourcePortalUUID()
java.lang.String GetPackageSourcePortalVersion()
void BulkSetMigrationStatus(int nClassID, int[] iaObjectIDs, int nMigrationStatus, java.lang.String strMigrationComment)
nClassID
- - ClassID of the objects, from the PT_CLASSIDS enumeration.iaObjectIDs
- - Array of objectIDs of the objects to set migration status for.nMigrationStatus
- - The migration status to set, from the PT_MIGRATION_STATUS_TYPES enumeration.strMigrationComment
- - The migration comment to use for the objects. Ignored when setting
status to PT_MIGRATION_STATUS_NONE or PT_MIGRATION_STATUS_MIGRATED.int QueryMigrationStatus(int nClassID, int nObjectID)
nClassID
- - The classID of the object to query, from PT_CLASSIDS.nObjectID
- - The objectID of the object to query.
IPTQueryResult QueryMigrationHistory(int nClassID, int nObjectID)
nClassID
- - The classID of the object to query, from PT_CLASSIDS.nObjectID
- - The objectID of the object to query.
PT_PROPIDS
void UpdateHistory(IPTMigrationElement pMigrationElement)
pMigrationElement
- - The migration element containing object metadata
and history (migration comment).IPTQueryResult QueryStatusForMigrationRequestor(int nClassID, int nSkipRows, int nMaxRows)
nClassID
- - The classID of objects to query, from the PT_CLASSIDS enumeration.nSkipRows
- - The number of rows to skip. Pass 0 to start at the beginning.nMaxRows
- - The maximum row index to return, pass in -1 to return all rows.
IPTQueryResult QueryStatusForMigrationRequestorCount()
java.lang.String ReadUserDataItemFromPackage(java.lang.String strName)
strName
- - The name of the metadata item to retrieve.
void WriteUserDataItemToPackage(java.lang.String strName, java.lang.String strValue)
strName
- - The name of the metadata item to store.strValue
- - The value to associate.java.lang.String[] RetrieveAllUserDataNames()
ReadUserDataItemFromPackage
on the desired items.
java.lang.String GenerateNewUUID()
java.lang.String ObjectIDToUUID(int nClassID, int nObjectID)
nClassID
- nObjectID
-
void BulkSetMigratedStatusByUUID(java.lang.Object[] iaUUIDs)
iaUUIDs
- IPTMigrationProvider GetProvider(int nWebServiceID)
ptSession
- nWebServiceID
-
void WriteMWSDataItemToPackage(int intWSID, java.lang.String strValue)
intWSID
- Migration Web Service IDstrValue
- Package Data returned by finalize() from the MWS SCI Servicevoid ImportMigrationWebServices()
void PerformImport(com.plumtree.openfoundation.util.XPArrayList[] _xparObjsToMigrate, boolean _bCreateNewObjectInstances, boolean _bImportACLs, boolean _bOverwriteRemoteServers, boolean _bRememberDependencySettings)
_xparObjsToMigrate
- array of XPArrayLists containing IPTMigrationElements to
import, indexed by classID._bCreateNewObjectInstances
- _bImportACLs
- _bOverwriteRemoteServers
- _bRememberDependencySettings
- int GetObjectClassIndex(int nClassID)
nClassID
- - The classid to lookup, from PT_CLASSIDS.
int ResolveObject(IPTMigrationElement spME, boolean bResolveObject)
spME
-
void CancelImport()
com.plumtree.openfoundation.util.XPHashtable GetMWSRemoteData()
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |