Skip navigation links

com.stellent.cis.client.api.common
Class SCSCommonAPI

java.lang.Object
com.stellent.cis.client.api.common.SCSCommonAPI

All Implemented Interfaces:

ICommandApplicationAware

public class SCSCommonAPI

extends java.lang.Object

implements ICommandApplicationAware

The available common API classes. This is a shortcut to calling ICommandFacade.getCommandAPI (category, ICommandFacade.getCommandTypeForName ("common")). Note: Automatically generated file

Field Summary

static java.lang.String	API
protected ICommandApplication	m_commandApplication
protected ICommandFacade	m_commandFacade

Constructor Summary

SCSCommonAPI()

Method Summary

ICISCommonContext	_createCommonContext() Create an empty SCS Common Context object
ICISAdministrativeAdapterAPI	getAdministrativeAdapterAPI()
ICISAdministrativeAPI	getAdministrativeAPI()
ICISAdministrativeSCSCacheAPI	getAdministrativeSCSCacheAPI()
ICommandFacade	getCommandFacade()
ICISDocumentAPI	getDocumentAPI()
ICISAPIObjectFactory	getObjectFactory()
ICISSearchAPI	getSearchAPI()
void	setCommandApplication(ICommandApplication application) Set the current command application
void	setCommandFacade(ICommandFacade commandFacade)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

API

public static final java.lang.String API

See Also:

Constant Field Values

m_commandApplication

protected ICommandApplication m_commandApplication

m_commandFacade

protected ICommandFacade m_commandFacade

Constructor Detail

SCSCommonAPI

public SCSCommonAPI()

Method Detail

setCommandApplication

public void setCommandApplication(ICommandApplication application)

Set the current command application

Specified by:

setCommandApplication in interface ICommandApplicationAware

Parameters:

application - the command application

setCommandFacade

public void setCommandFacade(ICommandFacade commandFacade)

getCommandFacade

public ICommandFacade getCommandFacade()

getObjectFactory

public ICISAPIObjectFactory getObjectFactory()

_createCommonContext

public ICISCommonContext _createCommonContext()

Create an empty SCS Common Context object

Returns:

a newly created scs common context object

getAdministrativeAPI

public ICISAdministrativeAPI getAdministrativeAPI()
                                           throws CommandException

Returns:

the implementation of the ICISAdministrativeAPI common API

Throws:

CommandException

getAdministrativeSCSCacheAPI

public ICISAdministrativeSCSCacheAPI getAdministrativeSCSCacheAPI()
                                                           throws CommandException

Returns:

the implementation of the ICISAdministrativeSCSCacheAPI common API

Throws:

CommandException

getSearchAPI

public ICISSearchAPI getSearchAPI()
                           throws CommandException

Returns:

the implementation of the ICISSearchAPI common API

Throws:

CommandException

getDocumentAPI

public ICISDocumentAPI getDocumentAPI()
                               throws CommandException

Returns:

the implementation of the ICISDocumentAPI common API

Throws:

CommandException

getAdministrativeAdapterAPI

public ICISAdministrativeAdapterAPI getAdministrativeAdapterAPI()
                                                         throws CommandException

Returns:

the implementation of the ICISAdministrativeAdapterAPI common API

Throws:

CommandException

Skip navigation links