com.stellent.cis.client.api.scs.schema
Interface ISCSSchemaAPI

All Superinterfaces:

ICommandAPI

public interface ISCSSchemaAPI
extends ICommandAPI

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

 ISCSSchemaAPI commandAPI =
       (ISCSSchemaAPI)m_commandFacade.getCommandAPI ("schema", m_commandFacade.getCommandTypeForName ("active"));
 

Field Summary

static java.lang.String

API_CATEGORY Category for this Command API

Method Summary

ICISTransferStream	getBaseSchemaJavascript(ISCSContext SCSContext) Retrieve the base.js Schema JavaScript file from the content server.
ICISTransferStream	getBaseSchemaJavascript(ISCSRequestModifier requestModifier, ISCSContext SCSContext) Retrieve the base.js Schema JavaScript file from the content server.
ISCSSchemaFieldsResponse	getFields(ISCSContext SCSContext) Retrieve a list of the available Schema fields.
ISCSSchemaFieldsResponse	getFields(ISCSRequestModifier requestModifier, ISCSContext SCSContext) Retrieve a list of the available Schema fields.
ICISAPIObjectFactory	getObjectFactory() Retrieve the object factory associated with this API
ISCSSchemaFragmentResponse	getViewFragment(ISCSContext SCSContext, java.lang.String viewName) Retrieve a schema view fragment.
ISCSSchemaFragmentResponse	getViewFragment(ISCSContext SCSContext, java.lang.String viewName, java.lang.String relationName, java.lang.String parentValue) Retrieve a schema view fragment.
ISCSSchemaFragmentResponse	getViewFragment(ISCSRequestModifier requestModifier, ISCSContext SCSContext, java.lang.String viewName) Retrieve a schema view fragment.
ISCSSchemaFragmentResponse	getViewFragment(ISCSRequestModifier requestModifier, ISCSContext SCSContext, java.lang.String viewName, java.lang.String relationName, java.lang.String parentValue) Retrieve a schema view fragment.
ICISTransferStream	getViewFragmentStream(ISCSContext SCSContext, java.lang.String viewName) Retrieve a schema view fragment.
ICISTransferStream	getViewFragmentStream(ISCSContext SCSContext, java.lang.String viewName, java.lang.String relationName, java.lang.String parentValue) Retrieve a schema view fragment.
ICISTransferStream	getViewFragmentStream(ISCSRequestModifier requestModifier, ISCSContext SCSContext, java.lang.String viewName) Retrieve a schema view fragment.
ICISTransferStream	getViewFragmentStream(ISCSRequestModifier requestModifier, ISCSContext SCSContext, java.lang.String viewName, java.lang.String relationName, java.lang.String parentValue) Retrieve a schema view fragment.

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

getBaseSchemaJavascript

ICISTransferStream getBaseSchemaJavascript(ISCSContext SCSContext)
                                           throws CommandException

Retrieve the base.js Schema JavaScript file from the content server.

Parameters:

SCSContext - the context object representing the current user

Throws:

CommandException

See Also:

"Content Server Documentation for: GET_DYNAMIC_URL"

getBaseSchemaJavascript

ICISTransferStream getBaseSchemaJavascript(ISCSRequestModifier requestModifier,
                                           ISCSContext SCSContext)
                                           throws CommandException

Retrieve the base.js Schema JavaScript file from the content server.

Parameters:

requestModifier - modify the request

SCSContext - the context object representing the current user

Throws:

CommandException

See Also:

"Content Server Documentation for: GET_DYNAMIC_URL"

getFields

ISCSSchemaFieldsResponse getFields(ISCSContext SCSContext)
                                   throws CommandException

Retrieve a list of the available Schema fields.

Parameters:

SCSContext - the context object representing the current user

Throws:

CommandException

See Also:

"Content Server Documentation for: GET_SCHEMA_FIELDS"

getFields

ISCSSchemaFieldsResponse getFields(ISCSRequestModifier requestModifier,
                                   ISCSContext SCSContext)
                                   throws CommandException

Retrieve a list of the available Schema fields.

Parameters:

requestModifier - modify the request

SCSContext - the context object representing the current user

Throws:

CommandException

See Also:

"Content Server Documentation for: GET_SCHEMA_FIELDS"

getViewFragment

ISCSSchemaFragmentResponse getViewFragment(ISCSContext SCSContext,
                                           java.lang.String viewName)
                                           throws CommandException

Retrieve a schema view fragment.

Parameters:

SCSContext - the context object representing the current user

viewName - the viewName parameter (maps to schViewName)

Throws:

CommandException

See Also:

"Content Server Documentation for: GET_SCHEMA_VIEW_FRAGMENT"

getViewFragment

ISCSSchemaFragmentResponse getViewFragment(ISCSRequestModifier requestModifier,
                                           ISCSContext SCSContext,
                                           java.lang.String viewName)
                                           throws CommandException

Retrieve a schema view fragment.

Parameters:

requestModifier - modify the request

SCSContext - the context object representing the current user

viewName - the viewName parameter (maps to schViewName)

Throws:

CommandException

See Also:

"Content Server Documentation for: GET_SCHEMA_VIEW_FRAGMENT"

getViewFragment

ISCSSchemaFragmentResponse getViewFragment(ISCSContext SCSContext,
                                           java.lang.String viewName,
                                           java.lang.String relationName,
                                           java.lang.String parentValue)
                                           throws CommandException

Retrieve a schema view fragment.

Parameters:

SCSContext - the context object representing the current user

viewName - the viewName parameter (maps to schViewName)

relationName - the relationName parameter (maps to schRelationName)

parentValue - the parentValue parameter (maps to schParentValue)

Throws:

CommandException

See Also:

"Content Server Documentation for: GET_SCHEMA_VIEW_FRAGMENT"

getViewFragment

ISCSSchemaFragmentResponse getViewFragment(ISCSRequestModifier requestModifier,
                                           ISCSContext SCSContext,
                                           java.lang.String viewName,
                                           java.lang.String relationName,
                                           java.lang.String parentValue)
                                           throws CommandException

Retrieve a schema view fragment.

Parameters:

requestModifier - modify the request

SCSContext - the context object representing the current user

viewName - the viewName parameter (maps to schViewName)

relationName - the relationName parameter (maps to schRelationName)

parentValue - the parentValue parameter (maps to schParentValue)

Throws:

CommandException

See Also:

"Content Server Documentation for: GET_SCHEMA_VIEW_FRAGMENT"

getViewFragmentStream

ICISTransferStream getViewFragmentStream(ISCSContext SCSContext,
                                         java.lang.String viewName)
                                         throws CommandException

Retrieve a schema view fragment.

Parameters:

SCSContext - the context object representing the current user

viewName - the viewName parameter (maps to schViewName)

Throws:

CommandException

See Also:

"Content Server Documentation for: GET_SCHEMA_VIEW_FRAGMENT"

getViewFragmentStream

ICISTransferStream getViewFragmentStream(ISCSRequestModifier requestModifier,
                                         ISCSContext SCSContext,
                                         java.lang.String viewName)
                                         throws CommandException

Retrieve a schema view fragment.

Parameters:

requestModifier - modify the request

SCSContext - the context object representing the current user

viewName - the viewName parameter (maps to schViewName)

Throws:

CommandException

See Also:

"Content Server Documentation for: GET_SCHEMA_VIEW_FRAGMENT"

getViewFragmentStream

ICISTransferStream getViewFragmentStream(ISCSContext SCSContext,
                                         java.lang.String viewName,
                                         java.lang.String relationName,
                                         java.lang.String parentValue)
                                         throws CommandException

Retrieve a schema view fragment.

Parameters:

SCSContext - the context object representing the current user

viewName - the viewName parameter (maps to schViewName)

relationName - the relationName parameter (maps to schRelationName)

parentValue - the parentValue parameter (maps to schParentValue)

Throws:

CommandException

See Also:

"Content Server Documentation for: GET_SCHEMA_VIEW_FRAGMENT"

getViewFragmentStream

ICISTransferStream getViewFragmentStream(ISCSRequestModifier requestModifier,
                                         ISCSContext SCSContext,
                                         java.lang.String viewName,
                                         java.lang.String relationName,
                                         java.lang.String parentValue)
                                         throws CommandException

Retrieve a schema view fragment.

Parameters:

requestModifier - modify the request

SCSContext - the context object representing the current user

viewName - the viewName parameter (maps to schViewName)

relationName - the relationName parameter (maps to schRelationName)

parentValue - the parentValue parameter (maps to schParentValue)

Throws:

CommandException

See Also:

"Content Server Documentation for: GET_SCHEMA_VIEW_FRAGMENT"