com.stellent.cis.client.api.scs
Class SCSActiveAPI

java.lang.Object
  com.stellent.cis.client.api.scs.SCSActiveAPI

All Implemented Interfaces:

ICommandApplicationAware

public class SCSActiveAPI
extends java.lang.Object
implements ICommandApplicationAware

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

Field Summary

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

Constructor Summary

SCSActiveAPI()

Method Summary

ISCSContentID	_createActiveContentID(java.lang.String contentID)
ISCSDocumentID	_createActiveDocumentID(java.lang.String documentID)
ISCSFolderID	_createActiveFolderID(java.lang.String folderID)
ISCSFolderPathID	_createActiveFolderPathID(java.lang.String folderPath)
ISCSRequestModifier	_createRequestModifier() Creates a new ISCSRequestModifier object for changing the format of the request.
ISCSContext	_createSCSContext() Creates a new ISCSContext object to use during command invocation.
ISCSNativePropertyFilter	_createStandardPropertyFilter() Provides a property filter that will limit the properties to only those beginning with lowercase "d" or lowercase "x"
ISCSDaoObject	asDirectAccessObject(ISCSObject o) Get a Direct Access Object to retrieve raw properties contained within the backing object.
ISCSAdministrativeAPI	getAdministrativeAPI()
ISCSAdministrativeQueryAPI	getAdministrativeQueryAPI()
ICommandFacade	getCommandFacade()
ISCSComponentCISAPI	getComponentCISAPI()
ISCSComponentFolderAPI	getComponentFolderAPI()
ISCSComponentMultisortAPI	getComponentMultisortAPI()
ISCSDocumentCheckinAPI	getDocumentCheckinAPI()
ISCSDocumentCheckoutAPI	getDocumentCheckoutAPI()
ISCSDocumentDeleteAPI	getDocumentDeleteAPI()
ISCSDocumentInformationAPI	getDocumentInformationAPI()
ISCSDocumentSubscriptionAPI	getDocumentSubscriptionAPI()
ISCSDocumentUpdateAPI	getDocumentUpdateAPI()
ISCSFileAPI	getFileAPI()
ISCSLocaleAPI	getLocaleAPI()
ISCSMetadataAPI	getMetadataAPI()
ICISAPIObjectFactory	getObjectFactory()
ISCSSchemaAPI	getSchemaAPI()
ISCSSearchAPI	getSearchAPI()
ISCSUserAPI	getUserAPI()
ISCSWorkflowAPI	getWorkflowAPI()
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

SCSActiveAPI

public SCSActiveAPI()

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()

_createSCSContext

public ISCSContext _createSCSContext()

Creates a new ISCSContext object to use during command invocation.

Returns:

a new context object

_createActiveDocumentID

public ISCSDocumentID _createActiveDocumentID(java.lang.String documentID)

Returns:

an ISCSActiveDocumentID object that contains the given document ID

_createActiveContentID

public ISCSContentID _createActiveContentID(java.lang.String contentID)

Returns:

an ISCSActiveContentID object that contains the given content ID

_createActiveFolderID

public ISCSFolderID _createActiveFolderID(java.lang.String folderID)

Returns:

an ISCSActiveFolderID object that contains the given folder ID

_createActiveFolderPathID

public ISCSFolderPathID _createActiveFolderPathID(java.lang.String folderPath)

Returns:

an ISCSActiveFolderPathID object that contains the given folder path ID

_createRequestModifier

public ISCSRequestModifier _createRequestModifier()

Creates a new ISCSRequestModifier object for changing the format of the request.

Returns:

a new request modifier

_createStandardPropertyFilter

public ISCSNativePropertyFilter _createStandardPropertyFilter()

Provides a property filter that will limit the properties to only those beginning with lowercase "d" or lowercase "x"

Returns:

a new instance of the property filter

asDirectAccessObject

public ISCSDaoObject asDirectAccessObject(ISCSObject o)

Get a Direct Access Object to retrieve raw properties contained within the backing object.

Parameters:

o - ISCSObject

Returns:

ISCSDaoObject or null if backing object doesn't implement Direct Access

getSearchAPI

public ISCSSearchAPI getSearchAPI()
                           throws CommandException

Returns:

the implementation of the ISCSSearchAPI active API

Throws:

CommandException

getComponentCISAPI

public ISCSComponentCISAPI getComponentCISAPI()
                                       throws CommandException

Returns:

the implementation of the ISCSComponentCISAPI active API

Throws:

CommandException

getDocumentSubscriptionAPI

public ISCSDocumentSubscriptionAPI getDocumentSubscriptionAPI()
                                                       throws CommandException

Returns:

the implementation of the ISCSDocumentSubscriptionAPI active API

Throws:

CommandException

getSchemaAPI

public ISCSSchemaAPI getSchemaAPI()
                           throws CommandException

Returns:

the implementation of the ISCSSchemaAPI active API

Throws:

CommandException

getDocumentInformationAPI

public ISCSDocumentInformationAPI getDocumentInformationAPI()
                                                     throws CommandException

Returns:

the implementation of the ISCSDocumentInformationAPI active API

Throws:

CommandException

getDocumentUpdateAPI

public ISCSDocumentUpdateAPI getDocumentUpdateAPI()
                                           throws CommandException

Returns:

the implementation of the ISCSDocumentUpdateAPI active API

Throws:

CommandException

getAdministrativeQueryAPI

public ISCSAdministrativeQueryAPI getAdministrativeQueryAPI()
                                                     throws CommandException

Returns:

the implementation of the ISCSAdministrativeQueryAPI active API

Throws:

CommandException

getFileAPI

public ISCSFileAPI getFileAPI()
                       throws CommandException

Returns:

the implementation of the ISCSFileAPI active API

Throws:

CommandException

getDocumentDeleteAPI

public ISCSDocumentDeleteAPI getDocumentDeleteAPI()
                                           throws CommandException

Returns:

the implementation of the ISCSDocumentDeleteAPI active API

Throws:

CommandException

getAdministrativeAPI

public ISCSAdministrativeAPI getAdministrativeAPI()
                                           throws CommandException

Returns:

the implementation of the ISCSAdministrativeAPI active API

Throws:

CommandException

getDocumentCheckinAPI

public ISCSDocumentCheckinAPI getDocumentCheckinAPI()
                                             throws CommandException

Returns:

the implementation of the ISCSDocumentCheckinAPI active API

Throws:

CommandException

getDocumentCheckoutAPI

public ISCSDocumentCheckoutAPI getDocumentCheckoutAPI()
                                               throws CommandException

Returns:

the implementation of the ISCSDocumentCheckoutAPI active API

Throws:

CommandException

getWorkflowAPI

public ISCSWorkflowAPI getWorkflowAPI()
                               throws CommandException

Returns:

the implementation of the ISCSWorkflowAPI active API

Throws:

CommandException

getLocaleAPI

public ISCSLocaleAPI getLocaleAPI()
                           throws CommandException

Returns:

the implementation of the ISCSLocaleAPI active API

Throws:

CommandException

getMetadataAPI

public ISCSMetadataAPI getMetadataAPI()
                               throws CommandException

Returns:

the implementation of the ISCSMetadataAPI active API

Throws:

CommandException

getUserAPI

public ISCSUserAPI getUserAPI()
                       throws CommandException

Returns:

the implementation of the ISCSUserAPI active API

Throws:

CommandException

getComponentMultisortAPI

public ISCSComponentMultisortAPI getComponentMultisortAPI()
                                                   throws CommandException

Returns:

the implementation of the ISCSComponentMultisortAPI active API

Throws:

CommandException

getComponentFolderAPI

public ISCSComponentFolderAPI getComponentFolderAPI()
                                             throws CommandException

Returns:

the implementation of the ISCSComponentFolderAPI active API

Throws:

CommandException