com.stellent.cis.client.api.common
Interface ICISAPIObjectFactory

public interface ICISAPIObjectFactory

Factory for generating ISCSObject objects. Takes in a IDataBinder object and uses the data to create a new ISCSObject.

Nested Class Summary

static interface

ICISAPIObjectFactory.FactoryWrapper Wrap an object before sending to the source UCPM target for initialization.

Field Summary

static java.lang.String

BEAN_ID

Method Summary

java.lang.Object	createDataObject(java.lang.Class type) Create a supporting data object as needed for the ICISObject classes.
java.lang.Object	createObject(java.lang.Class type) Create an object from a given object.
java.lang.Object	createObject(java.lang.Class type, java.lang.Object object, java.lang.String adapterName) Create an object from a given object.
void	registerFactoryWrapper(ICISAPIObjectFactory.FactoryWrapper factoryWrapper) Register a new factory wrapper type
void	setObjectCreator(java.lang.String type, java.lang.Object className) Register a particular type of object with an implementation classname

Field Detail

BEAN_ID

static final java.lang.String BEAN_ID

See Also:

Constant Field Values

Method Detail

setObjectCreator

void setObjectCreator(java.lang.String type,
                      java.lang.Object className)

Register a particular type of object with an implementation classname

Parameters:

type - the full classname to the type of object, should extend ISCSObject

className - the full implentation class name

createObject

java.lang.Object createObject(java.lang.Class type)
                              throws CreateAPIObjectException

Create an object from a given object. If the object implements ICISObjectInitializable, the initialize method will be called with the given arguments. Otherwise, the default constructor will be called and the object returned.

Parameters:

type - the type of object to generate, should extend class ISCSObject

Returns:

the implementing object

Throws:

CreateAPIObjectException

createObject

java.lang.Object createObject(java.lang.Class type,
                              java.lang.Object object,
                              java.lang.String adapterName)
                              throws CreateAPIObjectException

Create an object from a given object. If the object implements ICISObjectInitializable, the initialize method will be called with the given arguments. Otherwise, the default constructor will be called and the object returned.

Parameters:

type - the type of object to generate, should extend class ISCSObject

object - the source object to pass to the initialize method

adapterName - the adapter name

Returns:

the implementing object

Throws:

CreateAPIObjectException

createDataObject

java.lang.Object createDataObject(java.lang.Class type)
                                  throws CreateAPIObjectException

Create a supporting data object as needed for the ICISObject classes. Used internally by the ISCSObjects.

Parameters:

type - the type of object to create

Returns:

the implementation of that type

Throws:

CreateAPIObjectException

registerFactoryWrapper

void registerFactoryWrapper(ICISAPIObjectFactory.FactoryWrapper factoryWrapper)

Register a new factory wrapper type

Parameters:

factoryWrapper - the FactoryWrapper to register