com.plumtree.server
Interface IPTMigratable

All Superinterfaces:

IPTUnknown

public interface IPTMigratable
extends IPTUnknown

This interface is implemented by objects that are migratable via Object migration. All objects implementing the IPTObject interface in the server should also implement this interface. Non-IPTObjects that need to be migrated via the Object Migration framework should also implement this interface.

Author:

michaels

See Also:

IPTMigrationElement

Method Summary

IPTMigrationElement	Export(com.plumtree.openfoundation.util.IXPPropertyBag pMigrationConfigBag) Returns a MigrationElement that contains serialized metadata about the object which can be used to import the object into another Portal
int	GetObjectClass() Returns the PT_CLASSIDS Object Class of this object
java.lang.String	GetObjectUUID() Returns the UUID (Universally Unique Identifier) for this object
void	Import(IPTMigrationElement pMigrationElement, com.plumtree.openfoundation.util.IXPPropertyBag pMigrationConfigBag) Sets object metadata to values specified in the MigrationElement
void	SetObjectUUID(java.lang.String Value) Sets the UUID (Universally Unique Identifier) for this object.
void	StoreObject() Stores the object to the database

Methods inherited from interface com.plumtree.server.IPTUnknown

GetInterfaces

Method Detail

GetObjectClass

int GetObjectClass()

Returns the PT_CLASSIDS Object Class of this object

Returns:

the Class ID

GetObjectUUID

java.lang.String GetObjectUUID()

Returns the UUID (Universally Unique Identifier) for this object

Returns:

the UUID

SetObjectUUID

void SetObjectUUID(java.lang.String Value)

Sets the UUID (Universally Unique Identifier) for this object. Callers should assure that this string is truly unique.

Parameters:

Value - the UUID

Export

IPTMigrationElement Export(com.plumtree.openfoundation.util.IXPPropertyBag pMigrationConfigBag)

Returns a MigrationElement that contains serialized metadata about the object which can be used to import the object into another Portal

Parameters:

pMigrationConfigBag - contains configuration information for migration, such as whether ACLs should be exported.

Returns:

the MigrationElement containing object data

Import

void Import(IPTMigrationElement pMigrationElement,
            com.plumtree.openfoundation.util.IXPPropertyBag pMigrationConfigBag)

Sets object metadata to values specified in the MigrationElement

Parameters:

pMigrationElement - contains the metadata to be imported into this object

pMigrationConfigBag - contains configuration information for migration, such as whether ACLs should be imported.

StoreObject

void StoreObject()

Stores the object to the database