org.springframework.extensions.webscripts

Class ScriptBase

java.lang.Object

org.springframework.extensions.webscripts.ScriptBase

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

ScriptForm, ScriptFormData, ScriptLinkBuilder, ScriptModelObject, ScriptRenderContext, ScriptRenderingInstance, ScriptResource, ScriptResourceContent, ScriptResources, ScriptResourceUtils, ScriptSiteData, ScriptSurf, ScriptUser, ScriptWebApplication, ScriptWidgetUtils

public abstract class ScriptBase
extends Object
implements Serializable

Base class for all Web Framework Root-Scope and Script Model objects This class can accept a binding to a RenderContext (for convenience). The RenderContext object is the primary interface to the request for the Java API.

Author:

muzquiano

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected RequestContext	context
protected org.springframework.extensions.webscripts.ScriptableMap<String,Serializable>	properties

Constructor Summary

Constructors

Constructor and Description
ScriptBase()
ScriptBase(RequestContext context) Instantiates a new web framework script base

Method Summary

Methods

Modifier and Type	Method and Description
protected abstract org.springframework.extensions.webscripts.ScriptableMap<String,Serializable>	buildProperties()
WebFrameworkConfigElement	getConfig()
ScriptModelObject	getObject(String objectTypeId, String objectId) Retrieves a model object from the underlying store and hands it back wrapped as a ScriptModelObject.
protected ModelObjectService	getObjectService() Gets the model object service
org.springframework.extensions.webscripts.ScriptableMap<String,Serializable>	getProperties()
RequestContext	getRequestContext() Gets the request context.
String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

context

protected final RequestContext context

properties

protected org.springframework.extensions.webscripts.ScriptableMap<String,Serializable> properties

Constructor Detail

ScriptBase

public ScriptBase(RequestContext context)

Instantiates a new web framework script base

Parameters:

context - the context

ScriptBase

public ScriptBase()

Method Detail

getRequestContext

public final RequestContext getRequestContext()

Gets the request context.

Returns:

the request context

getObjectService

protected ModelObjectService getObjectService()

Gets the model object service

Returns:

model object service

getObject

public final ScriptModelObject getObject(String objectTypeId,
                          String objectId)

Retrieves a model object from the underlying store and hands it back wrapped as a ScriptModelObject. If the model object cannot be found, null will be returned.

Parameters:

objectTypeId - the object type id

objectId - the object id

Returns:

the script model object

getProperties

public org.springframework.extensions.webscripts.ScriptableMap<String,Serializable> getProperties()

getConfig

public final WebFrameworkConfigElement getConfig()

toString

public String toString()

Overrides:

toString in class Object

buildProperties

protected abstract org.springframework.extensions.webscripts.ScriptableMap<String,Serializable> buildProperties()