org.springframework.extensions.surf.types

Interface Component

All Superinterfaces:

Comparable<Component>, ModelObject, Serializable, SurfBugData

All Known Subinterfaces:

AdvancedComponent

All Known Implementing Classes:

AdvancedComponentImpl, ComponentImpl

public interface Component
extends ModelObject, Comparable<Component>, SurfBugData

Interface for a Component object type

Author:

muzquiano

Field Summary

Fields

Modifier and Type	Field and Description
static String	PROP_CHROME
static String	PROP_COMPONENT_TYPE_ID
static String	PROP_GUID
static String	PROP_INDEX
static String	PROP_REGION_ID
static String	PROP_SCOPE
static String	PROP_SOURCE_ID
static String	PROP_URI
static String	PROP_URL
static String	TYPE_ID

Fields inherited from interface org.springframework.extensions.surf.ModelObject

PROP_DESCRIPTION, PROP_DESCRIPTION_ID, PROP_ID, PROP_TITLE, PROP_TITLE_ID

Method Summary

Methods

Modifier and Type	Method and Description
String	getChrome() Gets the chrome.
ComponentType	getComponentType(RequestContext context) Gets the component type.
String	getComponentTypeId() Gets the component type id.
String	getGUID() Gets the GUID.
String	getIndex() Gets the index of the component.
String	getRegionId() Gets the region id.
String	getScope() Gets the scope.
String	getSourceId() Gets the source id.
Object	getSourceObject(RequestContext context) Gets the source object.
String	getURI() Gets the URI
String	getURL() Gets the URL.
void	setChrome(String chrome) Sets the chrome.
void	setComponentTypeId(String componentTypeId) Sets the component type id.
void	setGUID(String guid) Sets the GUID.
void	setIndex(String index) Sets the index of the component.
void	setRegionId(String regionId) Sets the region id.
void	setScope(String scope) Sets the scope.
void	setSourceId(String sourceId) Sets the source id.
void	setURI(String uri) Sets the URI.
void	setURL(String url) Sets the URL.

Methods inherited from interface org.springframework.extensions.surf.ModelObject

getBooleanProperty, getCustomProperties, getCustomProperty, getDescription, getDescriptionId, getDocument, getId, getKey, getModelProperties, getModelProperty, getModificationTime, getPersisterId, getProperties, getProperty, getStoragePath, getTitle, getTitleId, getTypeId, isSaved, removeCustomProperty, removeModelProperty, removeProperty, setCustomProperty, setDescription, setDescriptionId, setModelProperty, setProperty, setTitle, setTitleId, touch, toXML

Methods inherited from interface java.lang.Comparable

compareTo

Methods inherited from interface org.springframework.extensions.surf.types.SurfBugData

getResolvedWebScript, setResolvedWebScript

Field Detail

TYPE_ID

static final String TYPE_ID

See Also:

Constant Field Values

PROP_REGION_ID

static final String PROP_REGION_ID

See Also:

Constant Field Values

PROP_SOURCE_ID

static final String PROP_SOURCE_ID

See Also:

Constant Field Values

PROP_SCOPE

static final String PROP_SCOPE

See Also:

Constant Field Values

PROP_COMPONENT_TYPE_ID

static final String PROP_COMPONENT_TYPE_ID

See Also:

Constant Field Values

PROP_CHROME

static final String PROP_CHROME

See Also:

Constant Field Values

PROP_URL

static final String PROP_URL

See Also:

Constant Field Values

PROP_URI

static final String PROP_URI

See Also:

Constant Field Values

PROP_GUID

static final String PROP_GUID

See Also:

Constant Field Values

PROP_INDEX

static final String PROP_INDEX

See Also:

Constant Field Values

Method Detail

getRegionId

String getRegionId()

Gets the region id.

Returns:

the region id

setRegionId

void setRegionId(String regionId)

Sets the region id.

Parameters:

regionId - the new region id

getSourceId

String getSourceId()

Gets the source id.

Returns:

the source id

setSourceId

void setSourceId(String sourceId)

Sets the source id.

Parameters:

sourceId - the new source id

getScope

String getScope()

Gets the scope.

Returns:

the scope

setScope

void setScope(String scope)

Sets the scope.

Parameters:

scope - the new scope

getComponentTypeId

String getComponentTypeId()

Gets the component type id.

Returns:

the component type id

setComponentTypeId

void setComponentTypeId(String componentTypeId)

Sets the component type id.

Parameters:

componentTypeId - the new component type id

getChrome

String getChrome()

Gets the chrome.

Returns:

the chrome

setChrome

void setChrome(String chrome)

Sets the chrome.

Parameters:

chrome - the new chrome

getURL

String getURL()

Gets the URL.

Returns:

the URL

setURL

void setURL(String url)

Sets the URL.

Parameters:

url - the new URL

getURI

String getURI()

Gets the URI

Returns:

String

setURI

void setURI(String uri)

Sets the URI.

getGUID

String getGUID()

Gets the GUID.

Returns:

the GUID

setGUID

void setGUID(String guid)

Sets the GUID.

Parameters:

guid - the new GUID

getSourceObject

Object getSourceObject(RequestContext context)

Gets the source object.

Parameters:

context - request context

Returns:

the object

getComponentType

ComponentType getComponentType(RequestContext context)

Gets the component type.

Parameters:

context - the context

Returns:

the component type

getIndex

String getIndex()

Gets the index of the component. This is only used for ordering components when they are part of a component group and does not have any affect when a component is bound directly to a region.

Returns:

String

setIndex

void setIndex(String index)

Sets the index of the component. This is only used for ordering components when they are part of a component group and does not have any affect when a component is bound directly to a region.