|
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||
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 |
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. |
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). |
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. |
IPTMigratable |
InflateObjectForImport(IPTMigrationElement pMigrationElement,
com.plumtree.openfoundation.util.IXPPropertyBag pMigrationConfigBag)
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(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. |
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. |
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 |
WriteUserDataItemToPackage(java.lang.String strName,
java.lang.String strValue)
Writes a user-specified metadata item to the migration package. |
| Methods inherited from interface com.plumtree.server.IPTUnknown |
GetInterfaces |
| Method Detail |
public 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_SETTINGSpublic int GetObjectCount(int nClassID)
nClassID - - The classID of objects to count.public void PurgeMigrationProfile(java.lang.String strSourcePortalUUID)
strSourcePortalUUID - - The portal UUID to clear mappings for.public boolean ObjectExistsInSystem(IPTMigrationElement ptME)
ptME - - The IPTMigrationElement being imported.public boolean ObjectExistsInPackage(java.lang.String strUUID)
strUUID - - The UUID to check cor.public IPTMigrationElement CreateEmptyMigrationElement()
public java.lang.Object[] UUIDToObjectID(java.lang.String strUUID)
strUUID - - The UUID to look up.
public 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_SETTINGSpublic void InitializeForExport(java.lang.String strMigrationPackagePath)
strMigrationPackagePath - - The full path to the migration package file.public void StoreObjectInExportPackage(IPTMigrationElement ptME)
ptME - The IPTMigrationElement to store.public void EndExport()
public 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.public void InitializeForImport(java.lang.String strMigrationPackagePath)
strMigrationPackagePath - - The full path to the package to be imported.
public void 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.
public 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.
public 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.public void EndImport()
public boolean CheckObjectCreationRights()
public IPTMigratable InflateObjectForImport(IPTMigrationElement pMigrationElement,
com.plumtree.openfoundation.util.IXPPropertyBag pMigrationConfigBag)
pMigrationElement - - The IPTMigrationElement to use to populate the object.pMigrationConfigBag - - The configuration Propertybag.public java.lang.String GetPackageSourcePortalUUID()
public java.lang.String GetPackageSourcePortalVersion()
public 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.
public 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.
public 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_PROPIDSpublic void UpdateHistory(IPTMigrationElement pMigrationElement)
pMigrationElement - - The migration element containing object metadata
and history (migration comment).
public 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.public IPTQueryResult QueryStatusForMigrationRequestorCount()
public java.lang.String ReadUserDataItemFromPackage(java.lang.String strName)
strName - - The name of the metadata item to retrieve.
public void WriteUserDataItemToPackage(java.lang.String strName,
java.lang.String strValue)
strName - - The name of the metadata item to store.strValue - - The value to associate.public java.lang.String[] RetrieveAllUserDataNames()
ReadUserDataItemFromPackage on the desired items.public java.lang.String GenerateNewUUID()
|
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||