com.stellent.cis.client.api.scs.locale
Interface ISCSLocaleAPI

All Superinterfaces:

ICommandAPI

public interface ISCSLocaleAPI
extends ICommandAPI

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

 ISCSLocaleAPI commandAPI =
       (ISCSLocaleAPI)m_commandFacade.getCommandAPI ("locale", m_commandFacade.getCommandTypeForName ("active"));
 

Field Summary

static java.lang.String

API_CATEGORY Category for this Command API

Method Summary

ISCSLocaleGetDataResponse	getLocalizationData(ISCSContext SCSContext) Load the various pieces of locale-specific information from the content server.
ISCSLocaleGetDataResponse	getLocalizationData(ISCSRequestModifier requestModifier, ISCSContext SCSContext) Load the various pieces of locale-specific information from the content server.
ICISAPIObjectFactory	getObjectFactory() Retrieve the object factory associated with this API

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

getLocalizationData

ISCSLocaleGetDataResponse getLocalizationData(ISCSContext SCSContext)
                                              throws CommandException

Load the various pieces of locale-specific information from the content server. Note: this service returns a large quanity of data and should be called sparingly.

Parameters:

SCSContext - the context object representing the current user

Throws:

CommandException

See Also:

"Content Server Documentation for: LOAD_USER_LOCALIZATION"

getLocalizationData

ISCSLocaleGetDataResponse getLocalizationData(ISCSRequestModifier requestModifier,
                                              ISCSContext SCSContext)
                                              throws CommandException

Load the various pieces of locale-specific information from the content server. Note: this service returns a large quanity of data and should be called sparingly.

Parameters:

requestModifier - modify the request

SCSContext - the context object representing the current user

Throws:

CommandException

See Also:

"Content Server Documentation for: LOAD_USER_LOCALIZATION"