com.stellent.cis.client.api
Interface IUCPMAPI

All Known Subinterfaces:
ICISApi

public interface IUCPMAPI

Locator for the various API objects in the UCPM API.


Field Summary
static java.lang.String BEAN_ID
           
 
Method Summary
 java.lang.Object createObject(java.lang.Class type)
          Create an object in the system of the given type.
 ICISTransferStream createTransferStream()
          Create the transfer stream object.
 SCSActiveAPI getActiveAPI()
           
 SCSCommonAPI getCommonAPI()
           
 SCSFixedAPI getFixedAPI()
           
 ICISAPIObjectFactory getObjectFactory()
           
 

Field Detail

BEAN_ID

static final java.lang.String BEAN_ID
See Also:
Constant Field Values
Method Detail

getActiveAPI

SCSActiveAPI getActiveAPI()
Returns:
a reference to the SCSActiveAPI object

getCommonAPI

SCSCommonAPI getCommonAPI()
Returns:
a reference to the SCSCommonAPI object

getFixedAPI

SCSFixedAPI getFixedAPI()
Returns:
a reference to the SCSFixedAPI object

getObjectFactory

ICISAPIObjectFactory getObjectFactory()
Returns:
the API object factory

createTransferStream

ICISTransferStream createTransferStream()
Create the transfer stream object.

Returns:
the stream that can be transferred between CIS client and CIS server

createObject

java.lang.Object createObject(java.lang.Class type)
Create an object in the system of the given type. Allows for an abstraction between the client application and the implementation. Typically, the usage is to pass in the class reference of the interface to the object you wish to create as follows:

     ISCSContent content = (ISCSContent)createObject (ISCSContent.class);
     content.set (...)
  

Parameters:
type - the type of object to create
Returns:
the instantiated version of that object