com.webmethods.portal.service.meta2.thing

Interface IThingFactory

public interface IThingFactory

IThingFactory XType developers (DBO's) must implement this interface to allow proper functioning. Note that it is best to extend BasicThingFactory.java

See Also:

IThing, IThingID, IThingService, IThingIDService

Method Summary

Modifier and Type	Method and Description
IThingID	create(int xtypeID, IThingID parentID, IThingID ownerID, boolean isProtected, IMetaContext mc) Created a new thing in the DB based on the xtype.
IThingID	createForMigration(int xtypeID, Integer thingID, IThingID parentID, IThingID ownerID, boolean isProtected, IMetaContext mc) Created a new thing in the DB based on the xtype, and the old thingID.
IThing	instantiateThing(IThingID thingID) Instantiate a thing based on ID.
void	loadThings(IXType xtype) This is an optimization method that allows if neccessary bulk-load data for all things of this type that belong to the specified container.

Method Detail

create

IThingID create(int xtypeID,
                IThingID parentID,
                IThingID ownerID,
                boolean isProtected,
                IMetaContext mc)
         throws MetaException

Created a new thing in the DB based on the xtype. It is called by IThingService.createThing(int, com.webmethods.portal.service.meta2.thing.IThingID, com.webmethods.portal.service.meta2.thing.IThingID)

Parameters:

xtypeID - xtype of new object

parentID - the ID of the container the thing should be created in

ownerID - the ID of the owner of the created thing

isProtected - true if creating 'eternal' protected object, internal use only

mc -

Returns:

the thingID of the created thing

Throws:

MetaException

createForMigration

IThingID createForMigration(int xtypeID,
                            Integer thingID,
                            IThingID parentID,
                            IThingID ownerID,
                            boolean isProtected,
                            IMetaContext mc)
                     throws MetaException

Created a new thing in the DB based on the xtype, and the old thingID. This is used by side-by-side migration It is called by IThingService.createThing(int, com.webmethods.portal.service.meta2.thing.IThingID, com.webmethods.portal.service.meta2.thing.IThingID)

Parameters:

xtypeID - xtype of new object

parentID - the ID of the container the thing should be created in

ownerID - the ID of the owner of the created thing

isProtected - true if creating 'eternal' protected object, internal use only

mc -

Returns:

the thingID of the created thing

Throws:

MetaException

instantiateThing

IThing instantiateThing(IThingID thingID)

Instantiate a thing based on ID. It is called indirectly by IThingID.getThing() You must override this method in DBO's to create the proper item. ex: Form form = (Form) newThing(Form.class.getName()); form.setThingID(thingID); return form;

Parameters:

thingID - ID of the thing to instantiate

Returns:

an IThing instance for the given thingID

loadThings

void loadThings(IXType xtype)
         throws MetaException

This is an optimization method that allows if neccessary bulk-load data for all things of this type that belong to the specified container. The implementation will be responsible for loading all thing type specific data.

Parameters:

xtype -

Throws:

MetaException