|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object org.springframework.roo.addon.surf.page.PageOperations
public class PageOperations
Provides Surf Page related operations.
Constructor Summary | |
---|---|
PageOperations(org.springframework.roo.process.manager.FileManager fileManager,
org.springframework.roo.project.PathResolver pathResolver,
org.springframework.roo.metadata.MetadataService metadataService,
org.springframework.roo.project.ProjectOperations projectOperations)
|
Method Summary | |
---|---|
void |
createPage(String pageId,
String pagePath,
String templateInstance,
String templatePath,
String urls,
String title)
Creates a new Surf page using a specified template instance or template. |
void |
createPageAssociation(String name,
String srcPageId,
String desPageId,
String type)
Creates a new page association. |
void |
createPageAssociationAsFile(String name,
String srcPageId,
String desPageId,
String type)
Creates a new legacy page association which is stored as a seperated XML file. |
org.springframework.roo.file.monitor.event.FileDetails |
findSurfPageById(String pageId)
Finds Surf page by id. |
org.springframework.roo.file.monitor.event.FileDetails |
findSurfPageByPath(String path)
Find Surf page by path. |
String |
getInstanceTemplatePath(String instanceName)
Returns template path of the given template instance. |
String |
getPageXmlRootPath()
|
Hashtable<String,org.springframework.roo.file.monitor.event.FileDetails> |
getSurfPages()
Returns PageId/FileDetails pairs of Surf pages. |
String |
getTemplateInstance(String pageName)
Returns template instance path of a given page. |
String |
getTemplatePath(String pageId)
Returns template path of a Surf page with a given id. |
boolean |
isPageOperationAvailable()
Checks if page related operations are available. |
boolean |
isSurfPageAvailable(String pageId)
Returns true if the page id is available. |
SortedSet<String> |
listSurfPageAssociations(String pageId)
Lists associated pages of a specified Surf page. |
SortedSet<String> |
listSurfPages()
Returns ids and paths of all Surf pages. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public PageOperations(org.springframework.roo.process.manager.FileManager fileManager, org.springframework.roo.project.PathResolver pathResolver, org.springframework.roo.metadata.MetadataService metadataService, org.springframework.roo.project.ProjectOperations projectOperations)
fileManager
- pathResolver
- metadataService
- projectOperations
- Method Detail |
---|
public boolean isPageOperationAvailable()
public void createPage(String pageId, String pagePath, String templateInstance, String templatePath, String urls, String title)
pageId
- Page Id.pagePath
- Page path.templateInstance
- Name of the template instance for creating the new page.templatePath
- Path of the template for creating the new page.urls
- Page urls.title
- Page title.public SortedSet<String> listSurfPages()
public boolean isSurfPageAvailable(String pageId)
pageId
- Page Id.
public SortedSet<String> listSurfPageAssociations(String pageId)
pageId
- Page id.
public String getTemplateInstance(String pageName)
pagePath
- Page path.
public String getInstanceTemplatePath(String instanceName)
instanceName
- Template instance name.
public String getTemplatePath(String pageId)
pageId
- Page Id.
public void createPageAssociationAsFile(String name, String srcPageId, String desPageId, String type)
name
- Association name.srcPageId
- Source page id.desPageId
- Destination page id.type
- Association type.public void createPageAssociation(String name, String srcPageId, String desPageId, String type)
name
- Association name.srcPageId
- Source page id.desPageId
- Destination page id.type
- Association type.public org.springframework.roo.file.monitor.event.FileDetails findSurfPageByPath(String path)
path
- Page path.
public org.springframework.roo.file.monitor.event.FileDetails findSurfPageById(String pageId)
pageId
- Page Id
public Hashtable<String,org.springframework.roo.file.monitor.event.FileDetails> getSurfPages()
public String getPageXmlRootPath()
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |