|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface ISCSSchemaAPI
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 |
---|
static final java.lang.String API_CATEGORY
Method Detail |
---|
ICISAPIObjectFactory getObjectFactory()
ICISTransferStream getBaseSchemaJavascript(ISCSContext SCSContext) throws CommandException
SCSContext
- the context object representing the current user
CommandException
ICISTransferStream getBaseSchemaJavascript(ISCSRequestModifier requestModifier, ISCSContext SCSContext) throws CommandException
requestModifier
- modify the requestSCSContext
- the context object representing the current user
CommandException
ISCSSchemaFieldsResponse getFields(ISCSContext SCSContext) throws CommandException
SCSContext
- the context object representing the current user
CommandException
ISCSSchemaFieldsResponse getFields(ISCSRequestModifier requestModifier, ISCSContext SCSContext) throws CommandException
requestModifier
- modify the requestSCSContext
- the context object representing the current user
CommandException
ISCSSchemaFragmentResponse getViewFragment(ISCSContext SCSContext, java.lang.String viewName) throws CommandException
SCSContext
- the context object representing the current userviewName
- the viewName parameter (maps to schViewName)
CommandException
ISCSSchemaFragmentResponse getViewFragment(ISCSRequestModifier requestModifier, ISCSContext SCSContext, java.lang.String viewName) throws CommandException
requestModifier
- modify the requestSCSContext
- the context object representing the current userviewName
- the viewName parameter (maps to schViewName)
CommandException
ISCSSchemaFragmentResponse getViewFragment(ISCSContext SCSContext, java.lang.String viewName, java.lang.String relationName, java.lang.String parentValue) throws CommandException
SCSContext
- the context object representing the current userviewName
- the viewName parameter (maps to schViewName)relationName
- the relationName parameter (maps to schRelationName)parentValue
- the parentValue parameter (maps to schParentValue)
CommandException
ISCSSchemaFragmentResponse getViewFragment(ISCSRequestModifier requestModifier, ISCSContext SCSContext, java.lang.String viewName, java.lang.String relationName, java.lang.String parentValue) throws CommandException
requestModifier
- modify the requestSCSContext
- the context object representing the current userviewName
- the viewName parameter (maps to schViewName)relationName
- the relationName parameter (maps to schRelationName)parentValue
- the parentValue parameter (maps to schParentValue)
CommandException
ICISTransferStream getViewFragmentStream(ISCSContext SCSContext, java.lang.String viewName) throws CommandException
SCSContext
- the context object representing the current userviewName
- the viewName parameter (maps to schViewName)
CommandException
ICISTransferStream getViewFragmentStream(ISCSRequestModifier requestModifier, ISCSContext SCSContext, java.lang.String viewName) throws CommandException
requestModifier
- modify the requestSCSContext
- the context object representing the current userviewName
- the viewName parameter (maps to schViewName)
CommandException
ICISTransferStream getViewFragmentStream(ISCSContext SCSContext, java.lang.String viewName, java.lang.String relationName, java.lang.String parentValue) throws CommandException
SCSContext
- the context object representing the current userviewName
- the viewName parameter (maps to schViewName)relationName
- the relationName parameter (maps to schRelationName)parentValue
- the parentValue parameter (maps to schParentValue)
CommandException
ICISTransferStream getViewFragmentStream(ISCSRequestModifier requestModifier, ISCSContext SCSContext, java.lang.String viewName, java.lang.String relationName, java.lang.String parentValue) throws CommandException
requestModifier
- modify the requestSCSContext
- the context object representing the current userviewName
- the viewName parameter (maps to schViewName)relationName
- the relationName parameter (maps to schRelationName)parentValue
- the parentValue parameter (maps to schParentValue)
CommandException
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |