com.stellent.cis.client.api.scs.administrative.query
Interface ISCSAdministrativeQueryAPI

All Superinterfaces:

ICommandAPI

public interface ISCSAdministrativeQueryAPI
extends ICommandAPI

The command API implementation of the administrative.query commands. This implementation can be accessed directly via the ICommandFacade class, using the API name administrative.query, with the following syntax:

 ISCSAdministrativeQueryAPI commandAPI =
       (ISCSAdministrativeQueryAPI)m_commandFacade.getCommandAPI ("administrative.query", m_commandFacade.getCommandTypeForName ("active"));
 

Field Summary

static java.lang.String

API_CATEGORY Category for this Command API

Method Summary

ISCSServerResponse	executeSQLQuery(ISCSContext SCSContext, ISCSSQLQuery sqlQuery) Locate information from the DocumentHistory table in the content server to retrieve information about the various document events that have occurred.
ISCSServerResponse	executeSQLQuery(ISCSRequestModifier requestModifier, ISCSContext SCSContext, ISCSSQLQuery sqlQuery) Locate information from the DocumentHistory table in the content server to retrieve information about the various document events that have occurred.
ICISAPIObjectFactory	getObjectFactory() Retrieve the object factory associated with this API
ISCSQueryDocumentEventsResponse	queryDocumentHistory(ISCSContext SCSContext, ISCSSQLQuery sqlQuery) Locate information from the DocumentHistory table in the content server to retrieve information about the various document events that have occurred.
ISCSQueryDocumentEventsResponse	queryDocumentHistory(ISCSRequestModifier requestModifier, ISCSContext SCSContext, ISCSSQLQuery sqlQuery) Locate information from the DocumentHistory table in the content server to retrieve information about the various document events that have occurred.

Field Detail

API_CATEGORY

static final java.lang.String API_CATEGORY

Category for this Command API

See Also:

Constant Field Values

Method Detail

getObjectFactory

ICISAPIObjectFactory getObjectFactory()

Retrieve the object factory associated with this API

queryDocumentHistory

ISCSQueryDocumentEventsResponse queryDocumentHistory(ISCSContext SCSContext,
                                                     ISCSSQLQuery sqlQuery)
                                                     throws CommandException

Locate information from the DocumentHistory table in the content server to retrieve information about the various document events that have occurred. Note: it is advised to supply a where clause via the #setWhereClause(String) method; not doing so will return the entire contents of the DocumentHistory table which can be quite large.

Parameters:

SCSContext - the context object representing the current user

sqlQuery - the sql query

Throws:

CommandException

See Also:

"Content Server Documentation for: GET_DATARESULTSET"

queryDocumentHistory

ISCSQueryDocumentEventsResponse queryDocumentHistory(ISCSRequestModifier requestModifier,
                                                     ISCSContext SCSContext,
                                                     ISCSSQLQuery sqlQuery)
                                                     throws CommandException

Locate information from the DocumentHistory table in the content server to retrieve information about the various document events that have occurred. Note: it is advised to supply a where clause via the #setWhereClause(String) method; not doing so will return the entire contents of the DocumentHistory table which can be quite large.

Parameters:

requestModifier - modify the request

SCSContext - the context object representing the current user

sqlQuery - the sql query

Throws:

CommandException

See Also:

"Content Server Documentation for: GET_DATARESULTSET"

executeSQLQuery

ISCSServerResponse executeSQLQuery(ISCSContext SCSContext,
                                   ISCSSQLQuery sqlQuery)
                                   throws CommandException

Locate information from the DocumentHistory table in the content server to retrieve information about the various document events that have occurred. Note: it is advised to supply a where clause via the #setWhereClause(String) method; not doing so will return the entire contents of the DocumentHistory table which can be quite large.

Parameters:

SCSContext - the context object representing the current user

sqlQuery - the sql query

Throws:

CommandException

See Also:

"Content Server Documentation for: GET_DATARESULTSET"

executeSQLQuery

ISCSServerResponse executeSQLQuery(ISCSRequestModifier requestModifier,
                                   ISCSContext SCSContext,
                                   ISCSSQLQuery sqlQuery)
                                   throws CommandException

Locate information from the DocumentHistory table in the content server to retrieve information about the various document events that have occurred. Note: it is advised to supply a where clause via the #setWhereClause(String) method; not doing so will return the entire contents of the DocumentHistory table which can be quite large.

Parameters:

requestModifier - modify the request

SCSContext - the context object representing the current user

sqlQuery - the sql query

Throws:

CommandException

See Also:

"Content Server Documentation for: GET_DATARESULTSET"