org.sakaiproject.entitybroker.providers.model

Class EntitySitePage

java.lang.Object

org.sakaiproject.entitybroker.providers.model.EntitySitePage

All Implemented Interfaces:

Serializable, org.sakaiproject.entity.api.Edit, org.sakaiproject.entity.api.Entity, org.sakaiproject.site.api.SitePage

@ReflectIgnoreClassFields(value={"createdBy","modifiedBy","containingSite","properties","propertiesEdit","tools"})
public class EntitySitePage
extends Object
implements org.sakaiproject.site.api.SitePage

This is needed to allow RESTful access to the site page data

Author:

Aaron Zeckoski (azeckoski @ gmail.com)

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
Map<String,String>	props

Fields inherited from interface org.sakaiproject.site.api.SitePage

HOME_TOOL_ID, IS_HOME_PAGE, LAYOUT_DOUBLE_COL, LAYOUT_SINGLE_COL, PAGE_CATEGORY_PROP, PAGE_CUSTOM_TITLE_PROP

Fields inherited from interface org.sakaiproject.entity.api.Entity

SEPARATOR

Constructor Summary

Constructors

Constructor and Description
EntitySitePage(org.sakaiproject.site.api.SitePage sitePage)

Method Summary

Methods

Modifier and Type	Method and Description
org.sakaiproject.site.api.ToolConfiguration	addTool()
org.sakaiproject.site.api.ToolConfiguration	addTool(String toolId)
org.sakaiproject.site.api.ToolConfiguration	addTool(org.sakaiproject.tool.api.Tool reg)
org.sakaiproject.site.api.Site	getContainingSite()
String	getId()
int	getLayout()
String	getLayoutTitle()
int	getPosition()
org.sakaiproject.entity.api.ResourceProperties	getProperties()
org.sakaiproject.entity.api.ResourcePropertiesEdit	getPropertiesEdit()
String	getProperty(String key)
Map<String,String>	getProps()
String	getReference()
String	getReference(String rootProperty)
String	getSiteId()
String	getSkin()
String	getTitle()
boolean	getTitleCustom()
org.sakaiproject.site.api.ToolConfiguration	getTool(String id)
List<org.sakaiproject.site.api.ToolConfiguration>	getTools()
List<org.sakaiproject.site.api.ToolConfiguration>	getTools(int col)
Collection<org.sakaiproject.site.api.ToolConfiguration>	getTools(String[] toolIds)
String	getUrl()
String	getUrl(String rootProperty)
boolean	isActiveEdit()
boolean	isPopUp()
void	localizePage()
void	moveDown()
void	moveUp()
void	removeTool(org.sakaiproject.site.api.ToolConfiguration tool)
void	setLayout(int layout)
void	setPopup(boolean popup)
void	setPosition(int pos)
void	setProperty(String key, String value)
void	setProps(Map<String,String> props)
void	setTitle(String title)
void	setTitleCustom(boolean custom)
void	setupPageCategory(String toolId)
Element	toXml(Document doc, Stack<Element> stack)

Methods inherited from class java.lang.Object

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

Field Detail

props

public Map<String,String> props

Constructor Detail

EntitySitePage

public EntitySitePage(org.sakaiproject.site.api.SitePage sitePage)

Method Detail

getProps

public Map<String,String> getProps()

setProps

public void setProps(Map<String,String> props)

setProperty

public void setProperty(String key,
               String value)

getProperty

public String getProperty(String key)

getId

public String getId()

Specified by:

getId in interface org.sakaiproject.entity.api.Entity

getTitle

public String getTitle()

Specified by:

getTitle in interface org.sakaiproject.site.api.SitePage

getSiteId

public String getSiteId()

Specified by:

getSiteId in interface org.sakaiproject.site.api.SitePage

setPosition

public void setPosition(int pos)

Specified by:

setPosition in interface org.sakaiproject.site.api.SitePage

getPosition

public int getPosition()

Specified by:

getPosition in interface org.sakaiproject.site.api.SitePage

setTitle

public void setTitle(String title)

Specified by:

setTitle in interface org.sakaiproject.site.api.SitePage

setTitleCustom

public void setTitleCustom(boolean custom)

Specified by:

setTitleCustom in interface org.sakaiproject.site.api.SitePage

getTitleCustom

public boolean getTitleCustom()

Specified by:

getTitleCustom in interface org.sakaiproject.site.api.SitePage

getReference

public String getReference()

Specified by:

getReference in interface org.sakaiproject.entity.api.Entity

isActiveEdit

public boolean isActiveEdit()

Specified by:

isActiveEdit in interface org.sakaiproject.entity.api.Edit

getPropertiesEdit

public org.sakaiproject.entity.api.ResourcePropertiesEdit getPropertiesEdit()

Specified by:

getPropertiesEdit in interface org.sakaiproject.entity.api.Edit

getUrl

public String getUrl()

Specified by:

getUrl in interface org.sakaiproject.entity.api.Entity

getUrl

public String getUrl(String rootProperty)

Specified by:

getUrl in interface org.sakaiproject.entity.api.Entity

getReference

public String getReference(String rootProperty)

Specified by:

getReference in interface org.sakaiproject.entity.api.Entity

getProperties

public org.sakaiproject.entity.api.ResourceProperties getProperties()

Specified by:

getProperties in interface org.sakaiproject.entity.api.Entity

toXml

public Element toXml(Document doc,
            Stack<Element> stack)

Specified by:

toXml in interface org.sakaiproject.entity.api.Entity

getLayout

public int getLayout()

Specified by:

getLayout in interface org.sakaiproject.site.api.SitePage

getLayoutTitle

public String getLayoutTitle()

Specified by:

getLayoutTitle in interface org.sakaiproject.site.api.SitePage

getTools

public List<org.sakaiproject.site.api.ToolConfiguration> getTools()

Specified by:

getTools in interface org.sakaiproject.site.api.SitePage

getTools

public List<org.sakaiproject.site.api.ToolConfiguration> getTools(int col)

Specified by:

getTools in interface org.sakaiproject.site.api.SitePage

getTools

public Collection<org.sakaiproject.site.api.ToolConfiguration> getTools(String[] toolIds)

Specified by:

getTools in interface org.sakaiproject.site.api.SitePage

getSkin

public String getSkin()

Specified by:

getSkin in interface org.sakaiproject.site.api.SitePage

isPopUp

public boolean isPopUp()

Specified by:

isPopUp in interface org.sakaiproject.site.api.SitePage

getTool

public org.sakaiproject.site.api.ToolConfiguration getTool(String id)

Specified by:

getTool in interface org.sakaiproject.site.api.SitePage

getContainingSite

public org.sakaiproject.site.api.Site getContainingSite()

Specified by:

getContainingSite in interface org.sakaiproject.site.api.SitePage

localizePage

public void localizePage()

Specified by:

localizePage in interface org.sakaiproject.site.api.SitePage

setLayout

public void setLayout(int layout)

Specified by:

setLayout in interface org.sakaiproject.site.api.SitePage

setPopup

public void setPopup(boolean popup)

Specified by:

setPopup in interface org.sakaiproject.site.api.SitePage

addTool

public org.sakaiproject.site.api.ToolConfiguration addTool()

Specified by:

addTool in interface org.sakaiproject.site.api.SitePage

addTool

public org.sakaiproject.site.api.ToolConfiguration addTool(org.sakaiproject.tool.api.Tool reg)

Specified by:

addTool in interface org.sakaiproject.site.api.SitePage

addTool

public org.sakaiproject.site.api.ToolConfiguration addTool(String toolId)

Specified by:

addTool in interface org.sakaiproject.site.api.SitePage

removeTool

public void removeTool(org.sakaiproject.site.api.ToolConfiguration tool)

Specified by:

removeTool in interface org.sakaiproject.site.api.SitePage

moveUp

public void moveUp()

Specified by:

moveUp in interface org.sakaiproject.site.api.SitePage

moveDown

public void moveDown()

Specified by:

moveDown in interface org.sakaiproject.site.api.SitePage

setupPageCategory

public void setupPageCategory(String toolId)

Specified by:

setupPageCategory in interface org.sakaiproject.site.api.SitePage