org.alfresco.web.bean.wcm
Class AVMBrowseBean

java.lang.Object
  extended by org.alfresco.web.bean.wcm.AVMBrowseBean
All Implemented Interfaces:
java.io.Serializable, IContextListener

public class AVMBrowseBean
extends java.lang.Object
implements IContextListener

Bean backing up the AVM specific browse screens

See Also:
Serialized Form

Nested Class Summary
 class AVMBrowseBean.FormSearchContext
          Wrap SearchContext to allow prebuilt canned Form query to be apply as search context
 
Field Summary
protected  org.alfresco.service.cmr.action.ActionService actionService
          Action service bean reference
protected  org.alfresco.service.cmr.avm.AVMService avmService
          AVM service bean reference
protected  org.alfresco.service.cmr.avmsync.AVMSyncService avmSyncService
          AVM sync service bean reference
static java.lang.String BEAN_NAME
           
protected  FormsService formsService
          The FormsService reference
protected  NavigationBean navigator
          The NavigationBean bean reference
protected  org.alfresco.service.cmr.security.PermissionService permissionService
          The PermissionService reference
static java.lang.String REQUEST_BEEN_DEPLOYED_RESULT
           
protected  org.alfresco.wcm.sandbox.SandboxService sbService
          SandboxService bean reference
protected  org.alfresco.wcm.webproject.WebProjectService wpService
          WebProjectService bean reference
 
Constructor Summary
AVMBrowseBean()
          Default Constructor
 
Method Summary
 void areaChanged()
          Method called by UIContextService.areaChanged() to inform all registered beans that the user has changed area i.e.
 void cancelPendingSubmission(javax.faces.event.ActionEvent event)
          Event handler that cancels a pending submission.
 void clickFolder(javax.faces.event.ActionEvent event)
          Update the UI after a folder click action in the website browsing screens
 void closeSearch(javax.faces.event.ActionEvent event)
          Action called to Close the search dialog by returning to the last viewed path
 void contextUpdated()
          Method called by UIContextService.notifyBeans() to inform all registered beans that all UI Beans should refresh dump all cached data and settings.
 void createFormContent(javax.faces.event.ActionEvent event)
          Create web content from a specific Form via the User Sandbox 'Available Forms' panel
protected  org.alfresco.service.cmr.action.ActionService getActionService()
           
 boolean getAllItemsAction()
           
 AVMNode getAvmActionNode()
           
protected  org.alfresco.service.cmr.avm.AVMService getAvmService()
           
protected  org.alfresco.service.cmr.avmsync.AVMSyncService getAvmSyncService()
           
 java.lang.String getCurrentNodeTemplate()
           
 java.lang.String getCurrentNodeWebscript()
           
 java.lang.String getCurrentPath()
           
 AVMNode getCurrentPathNode()
           
 java.util.Map getCustomWebscriptContext()
           
 java.util.List getDeploymentMonitorIds()
           
 java.util.List getFiles()
           
 UIRichList getFilesRichList()
           
 java.util.List getFolders()
           
 UIRichList getFoldersRichList()
           
protected  FormsService getFormsService()
           
 boolean getHasCustomView()
           
 boolean getHasDeployBeenAttempted()
           
 boolean getHasTemplateView()
           
 boolean getHasWebscriptView()
           
 java.lang.String getIcon()
           
 boolean getIsManagerOrPublisherRole()
           
 boolean getIsManagerRole()
           
 boolean getIsStagingStore()
           
 java.util.List getLocation()
           
static int getMinimumSearchLength()
           
 org.alfresco.service.cmr.repository.NodeService getNodeService()
          Getter used by the Inline Edit XML JSP
 java.util.List getNodesForSubmit()
           
 int getPageSizeFiles()
           
 java.lang.String getPageSizeFilesStr()
           
 int getPageSizeFolders()
           
 java.lang.String getPageSizeFoldersStr()
           
protected  org.alfresco.service.cmr.security.PermissionService getPermissionService()
           
 java.lang.String getSandbox()
           
 java.lang.String getSandboxPreviewUrl()
           
protected  org.alfresco.wcm.sandbox.SandboxService getSandboxService()
           
 java.lang.String getSandboxTitle()
           
 SearchContext getSearchContext()
           
 org.alfresco.service.cmr.search.SearchService getSearchService()
           
 java.util.List getSelectedSandboxItems()
          Return the list of selected items for the current user sandbox view
 boolean getShowAllSandboxes()
           
 java.lang.String getSnapshotDateFilter()
           
 java.lang.String getStagingPreviewUrl()
           
 java.lang.String getStagingStore()
           
 java.lang.String getStagingSummary()
          Summary text for the staging store: Created On: xx/yy/zz Created By: username There are N user(s) working on this website.
 java.util.Map getTemplateModel()
          Returns a model for use by a template on a space Dashboard page.
 java.lang.String getUsername()
           
 UIUserSandboxes getUserSandboxes()
           
 java.lang.String getWebapp()
           
 java.util.List getWebapps()
           
 int getWebappsSize()
           
 WebProject getWebProject()
           
protected  org.alfresco.wcm.webproject.WebProjectService getWebProjectService()
           
 Node getWebsite()
           
 java.lang.String getWebsiteQuery()
           
protected  org.alfresco.service.cmr.workflow.WorkflowService getWorkflowService()
           
 void promotePendingSubmission(javax.faces.event.ActionEvent event)
          Event handler that transitions a 'submitpending' task to effectively bypass the lauch date and immediately submit the items.
 void refreshSandbox(javax.faces.event.ActionEvent event)
          Refresh Sandbox in the virtualisation server
 void revertAllConflict(javax.faces.event.ActionEvent event)
          Revert All Conflicts
 void revertNode(javax.faces.event.ActionEvent event)
          Undo changes to a single node
 void revertSnapshot(java.util.Map params)
          Revert a sandbox to a specific snapshot version ID
 void searchFormContent(javax.faces.event.ActionEvent event)
          Perform a canned search for previously generated Form content
 void searchWebsite(javax.faces.event.ActionEvent event)
          Perform a lucene search of the website
 void setActionService(org.alfresco.service.cmr.action.ActionService actionService)
           
 void setAvmActionNode(AVMNode avmNode)
           
 void setAVMActionNodeDescriptor(org.alfresco.service.cmr.avm.AVMNodeDescriptor avmRef)
           
 void setAvmService(org.alfresco.service.cmr.avm.AVMService avmService)
           
 void setAvmSyncService(org.alfresco.service.cmr.avmsync.AVMSyncService avmSyncService)
           
 void setCurrentPath(java.lang.String path)
           
 void setDeploymentMonitorIds(java.util.List deploymentMonitorIds)
           
 void setFilesRichList(UIRichList filesRichList)
           
 void setFoldersRichList(UIRichList foldersRichList)
           
 void setFormsService(FormsService formsService)
           
 void setLocation(java.util.List location)
           
 void setNavigationBean(NavigationBean navigator)
           
 void setNodeService(org.alfresco.service.cmr.repository.NodeService nodeService)
           
 void setNodesForSubmit(java.util.List nodesForSubmit)
           
 void setPageSizeFiles(int pageSizeContent)
           
 void setPageSizeFilesStr(java.lang.String pageSizeContentStr)
           
 void setPageSizeFolders(int pageSizeSpaces)
           
 void setPageSizeFoldersStr(java.lang.String pageSizeSpacesStr)
           
 void setPermissionService(org.alfresco.service.cmr.security.PermissionService permissionService)
           
 void setSandbox(java.lang.String sandbox)
           
 void setSandboxService(org.alfresco.wcm.sandbox.SandboxService sbService)
           
 void setSandboxTitle(java.lang.String sandboxTitle)
           
 void setSearchService(org.alfresco.service.cmr.search.SearchService searchService)
           
 void setShowAllSandboxes(boolean value)
           
 void setSnapshotDateFilter(java.lang.String snapshotDateFilter)
           
 void setupAllItemsAction(javax.faces.event.ActionEvent event)
          Action handler for all nodes from user sandbox
 void setupContentAction(javax.faces.event.ActionEvent event)
          Action event called by all actions that need to setup a Content node context on the before an action page/wizard is called.
 void setupEditAction(javax.faces.event.ActionEvent event)
          Action handler called to calculate which editing screen to display based on the mimetype of a document.
 void setupEditAction(java.lang.String path)
          Action handler called to calculate which editing screen to display based on the mimetype of a document.
 void setupSandboxAction(javax.faces.event.ActionEvent event)
          Setup the context for a sandbox browse action
 void setupSandboxAction(java.lang.String store, java.lang.String username)
          Setup the context for a sandbox browse action
 void setUsername(java.lang.String username)
           
 void setUserSandboxes(UIUserSandboxes userSandboxes)
           
 void setWebapp(java.lang.String webapp)
           
 void setWebProjectService(org.alfresco.wcm.webproject.WebProjectService wpService)
           
 void setWebsiteQuery(java.lang.String websiteQuery)
           
 void setWorkflowService(org.alfresco.service.cmr.workflow.WorkflowService service)
          Set the workflow service
 void snapshotDateFilterChanged(javax.faces.event.ActionEvent event)
          Action handler called when the Snapshot Date filter is changed by the user
 void spaceChanged()
          Method called by UIContextService.spaceChanged() to inform all registered beans that the current space has changed.
 void updateFilesPageSize(javax.faces.event.ActionEvent event)
          Update page size based on user selection
 void updateFoldersPageSize(javax.faces.event.ActionEvent event)
          Update page size based on user selection
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

BEAN_NAME

public static final java.lang.String BEAN_NAME
See Also:
Constant Field Values

REQUEST_BEEN_DEPLOYED_RESULT

public static final java.lang.String REQUEST_BEEN_DEPLOYED_RESULT
See Also:
Constant Field Values

navigator

protected NavigationBean navigator
The NavigationBean bean reference


wpService

protected transient org.alfresco.wcm.webproject.WebProjectService wpService
WebProjectService bean reference


sbService

protected transient org.alfresco.wcm.sandbox.SandboxService sbService
SandboxService bean reference


avmService

protected transient org.alfresco.service.cmr.avm.AVMService avmService
AVM service bean reference


avmSyncService

protected transient org.alfresco.service.cmr.avmsync.AVMSyncService avmSyncService
AVM sync service bean reference


actionService

protected transient org.alfresco.service.cmr.action.ActionService actionService
Action service bean reference


formsService

protected transient FormsService formsService
The FormsService reference


permissionService

protected transient org.alfresco.service.cmr.security.PermissionService permissionService
The PermissionService reference

Constructor Detail

AVMBrowseBean

public AVMBrowseBean()
Default Constructor

Method Detail

setWebProjectService

public void setWebProjectService(org.alfresco.wcm.webproject.WebProjectService wpService)
Parameters:
wpService - The WebProjectService to set.

getWebProjectService

protected org.alfresco.wcm.webproject.WebProjectService getWebProjectService()

setSandboxService

public void setSandboxService(org.alfresco.wcm.sandbox.SandboxService sbService)
Parameters:
sbService - The SandboxService to set.

getSandboxService

protected org.alfresco.wcm.sandbox.SandboxService getSandboxService()

setAvmService

public void setAvmService(org.alfresco.service.cmr.avm.AVMService avmService)
Parameters:
avmService - The AVMService to set.

getAvmService

protected org.alfresco.service.cmr.avm.AVMService getAvmService()

setAvmSyncService

public void setAvmSyncService(org.alfresco.service.cmr.avmsync.AVMSyncService avmSyncService)
Parameters:
avmSyncService - The AVMSyncService to set.

getAvmSyncService

protected org.alfresco.service.cmr.avmsync.AVMSyncService getAvmSyncService()

setNodeService

public void setNodeService(org.alfresco.service.cmr.repository.NodeService nodeService)
Parameters:
nodeService - The NodeService to set.

getNodeService

public org.alfresco.service.cmr.repository.NodeService getNodeService()
Getter used by the Inline Edit XML JSP

Returns:
The NodeService

setWorkflowService

public void setWorkflowService(org.alfresco.service.cmr.workflow.WorkflowService service)
Set the workflow service

Parameters:
service - The workflow service instance.

getWorkflowService

protected org.alfresco.service.cmr.workflow.WorkflowService getWorkflowService()

setSearchService

public void setSearchService(org.alfresco.service.cmr.search.SearchService searchService)
Parameters:
searchService - The Searcher to set.

getSearchService

public org.alfresco.service.cmr.search.SearchService getSearchService()
Returns:
searchService

setPermissionService

public void setPermissionService(org.alfresco.service.cmr.security.PermissionService permissionService)
Parameters:
permissionService - The PermissionService to set.

getPermissionService

protected org.alfresco.service.cmr.security.PermissionService getPermissionService()

setNavigationBean

public void setNavigationBean(NavigationBean navigator)
Parameters:
navigator - The NavigationBean to set.

setActionService

public void setActionService(org.alfresco.service.cmr.action.ActionService actionService)
Parameters:
actionService - The actionService to set.

getActionService

protected org.alfresco.service.cmr.action.ActionService getActionService()

setFormsService

public void setFormsService(FormsService formsService)
Parameters:
formsService - The FormsService to set.

getFormsService

protected FormsService getFormsService()

getPageSizeFiles

public int getPageSizeFiles()

setPageSizeFiles

public void setPageSizeFiles(int pageSizeContent)

getPageSizeFolders

public int getPageSizeFolders()

setPageSizeFolders

public void setPageSizeFolders(int pageSizeSpaces)

getPageSizeFilesStr

public java.lang.String getPageSizeFilesStr()

setPageSizeFilesStr

public void setPageSizeFilesStr(java.lang.String pageSizeContentStr)

getPageSizeFoldersStr

public java.lang.String getPageSizeFoldersStr()

setPageSizeFoldersStr

public void setPageSizeFoldersStr(java.lang.String pageSizeSpacesStr)

getStagingSummary

public java.lang.String getStagingSummary()
Summary text for the staging store: Created On: xx/yy/zz Created By: username There are N user(s) working on this website.

Returns:
summary text

getStagingStore

public java.lang.String getStagingStore()
Returns:
the current staging store name

getStagingPreviewUrl

public java.lang.String getStagingPreviewUrl()
Returns:
Preview URL for the current Staging store and current webapp

getSandboxPreviewUrl

public java.lang.String getSandboxPreviewUrl()
Returns:
Preview URL for the current User Sandbox store and current webapp

setFoldersRichList

public void setFoldersRichList(UIRichList foldersRichList)
Parameters:
foldersRichList - The foldersRichList to set.

getFoldersRichList

public UIRichList getFoldersRichList()
Returns:
Returns the foldersRichList.

getFilesRichList

public UIRichList getFilesRichList()
Returns:
Returns the filesRichList.

setFilesRichList

public void setFilesRichList(UIRichList filesRichList)
Parameters:
filesRichList - The filesRichList to set.

getUserSandboxes

public UIUserSandboxes getUserSandboxes()
Returns:
Returns the userSandboxes.

setUserSandboxes

public void setUserSandboxes(UIUserSandboxes userSandboxes)
Parameters:
userSandboxes - The userSandboxes to set.

getSandbox

public java.lang.String getSandbox()
Returns:
Returns the current sandbox context.

setSandbox

public void setSandbox(java.lang.String sandbox)
Parameters:
sandbox - The sandbox to set.

getUsername

public java.lang.String getUsername()
Returns:
Returns the current username context.

setUsername

public void setUsername(java.lang.String username)
Parameters:
username - The username to set.

getWebapp

public java.lang.String getWebapp()
Returns:
current webapp context

setWebapp

public void setWebapp(java.lang.String webapp)
Parameters:
webapp - Webapp folder context

getDeploymentMonitorIds

public java.util.List getDeploymentMonitorIds()
Returns:
Returns the list of deployment monitor ids currently executing

setDeploymentMonitorIds

public void setDeploymentMonitorIds(java.util.List deploymentMonitorIds)
Parameters:
deploymentMonitorIds - Sets the list of deployment monitor ids

getNodesForSubmit

public java.util.List getNodesForSubmit()

setNodesForSubmit

public void setNodesForSubmit(java.util.List nodesForSubmit)

getWebapps

public java.util.List getWebapps()
Returns:
list of available root webapp folders for this Web project

getWebappsSize

public int getWebappsSize()
Returns:
count of the root webapps in the current web project

getSandboxTitle

public java.lang.String getSandboxTitle()
Returns:
Returns the sandboxTitle.

setSandboxTitle

public void setSandboxTitle(java.lang.String sandboxTitle)
Parameters:
sandboxTitle - The sandboxTitle to set.

getSnapshotDateFilter

public java.lang.String getSnapshotDateFilter()
Returns:
Returns the Snapshot Date Filter.

setSnapshotDateFilter

public void setSnapshotDateFilter(java.lang.String snapshotDateFilter)
Parameters:
snapshotDateFilter - The Snapshot Date Filter to set.

getWebsiteQuery

public java.lang.String getWebsiteQuery()
Returns:
the website search query string

setWebsiteQuery

public void setWebsiteQuery(java.lang.String websiteQuery)
Parameters:
websiteQuery - The website search query string

getIcon

public java.lang.String getIcon()
Returns:
icon image for the appropriate sandbox type

getWebsite

public Node getWebsite()
Returns:
website node the view is currently within

getWebProject

public WebProject getWebProject()
Returns:
the web project the view is currently within

getAvmActionNode

public AVMNode getAvmActionNode()
Returns:
Returns the current AVM node action context.

setAvmActionNode

public void setAvmActionNode(AVMNode avmNode)
Parameters:
avmNode - The AVM node action context to set.

setAVMActionNodeDescriptor

public void setAVMActionNodeDescriptor(org.alfresco.service.cmr.avm.AVMNodeDescriptor avmRef)
Parameters:
avmRef - The AVMNodeDescriptor action context to set.

getCurrentPath

public java.lang.String getCurrentPath()
Returns:
the internal AVM path to the current folder for browsing

setCurrentPath

public void setCurrentPath(java.lang.String path)
Parameters:
path - the internal AVM path to the current folder for browsing

getCurrentPathNode

public AVMNode getCurrentPathNode()
Returns:
the AVMNode that represents the current browsing path

getLocation

public java.util.List getLocation()
Returns:
Breadcrumb location list

setLocation

public void setLocation(java.util.List location)
Parameters:
location - Breadcrumb location list

getHasCustomView

public boolean getHasCustomView()
Returns:
true if the current node has a custom view available

getHasTemplateView

public boolean getHasTemplateView()
Returns:
true if the current node has a Template based custom view available

getHasWebscriptView

public boolean getHasWebscriptView()
Returns:
true if the current node has a Webscript based custom view available

getCurrentNodeTemplate

public java.lang.String getCurrentNodeTemplate()
Returns:
the NodeRef.toString() for the current node Template custom view if it has one

getCurrentNodeWebscript

public java.lang.String getCurrentNodeWebscript()
Returns:
the service url for the current node Webscript custom view if it has one

getTemplateModel

public java.util.Map getTemplateModel()
Returns a model for use by a template on a space Dashboard page.

Returns:
model containing current current space info.

getCustomWebscriptContext

public java.util.Map getCustomWebscriptContext()

getIsManagerRole

public boolean getIsManagerRole()
Returns:
true if the current user has the manager role in the current website

getIsManagerOrPublisherRole

public boolean getIsManagerOrPublisherRole()

getShowAllSandboxes

public boolean getShowAllSandboxes()
Returns:
true to show all sandboxes visible to this user, false to only show the current user sandbox

setShowAllSandboxes

public void setShowAllSandboxes(boolean value)
Parameters:
value - true to show all sandboxes visible to this user, false to only show the current user sandbox

getHasDeployBeenAttempted

public boolean getHasDeployBeenAttempted()
Returns:
true if the website has had a deployment attempt

getSearchContext

public SearchContext getSearchContext()
Returns:
the Search Context object for the current website project

getFolders

public java.util.List getFolders()
Returns:
Map of avm node objects representing the folders with the current website space

getFiles

public java.util.List getFiles()
Returns:
Map of avm node objects representing the files with the current website space

getSelectedSandboxItems

public java.util.List getSelectedSandboxItems()
Return the list of selected items for the current user sandbox view

Returns:
List of AVMNodeDescriptor objects representing selected items

getAllItemsAction

public boolean getAllItemsAction()
Returns:
true if a special All Items action has been initialised

getIsStagingStore

public boolean getIsStagingStore()
Returns:
true if the current sandbox is a Staging store, false otherwise

clickFolder

public void clickFolder(javax.faces.event.ActionEvent event)
Update the UI after a folder click action in the website browsing screens


snapshotDateFilterChanged

public void snapshotDateFilterChanged(javax.faces.event.ActionEvent event)
Action handler called when the Snapshot Date filter is changed by the user


setupSandboxAction

public void setupSandboxAction(javax.faces.event.ActionEvent event)
Setup the context for a sandbox browse action


setupSandboxAction

public void setupSandboxAction(java.lang.String store,
                               java.lang.String username)
Setup the context for a sandbox browse action

Parameters:
store - The store name for the action
username - The authority pertinent to the action (null for staging store actions)

setupContentAction

public void setupContentAction(javax.faces.event.ActionEvent event)
Action event called by all actions that need to setup a Content node context on the before an action page/wizard is called. The context will be an AVMNodeDescriptor in setAVMNode() which can be retrieved on action pages via getAVMNode().

Parameters:
event - ActionEvent

setupEditAction

public void setupEditAction(javax.faces.event.ActionEvent event)
Action handler called to calculate which editing screen to display based on the mimetype of a document. If appropriate, the in-line editing screen will be shown.


setupEditAction

public void setupEditAction(java.lang.String path)
Action handler called to calculate which editing screen to display based on the mimetype of a document. If appropriate, the in-line editing screen will be shown.


setupAllItemsAction

public void setupAllItemsAction(javax.faces.event.ActionEvent event)
Action handler for all nodes from user sandbox


refreshSandbox

public void refreshSandbox(javax.faces.event.ActionEvent event)
Refresh Sandbox in the virtualisation server


revertNode

public void revertNode(javax.faces.event.ActionEvent event)
Undo changes to a single node


revertSnapshot

public void revertSnapshot(java.util.Map params)
Revert a sandbox to a specific snapshot version ID


createFormContent

public void createFormContent(javax.faces.event.ActionEvent event)
Create web content from a specific Form via the User Sandbox 'Available Forms' panel


searchFormContent

public void searchFormContent(javax.faces.event.ActionEvent event)
Perform a canned search for previously generated Form content


promotePendingSubmission

public void promotePendingSubmission(javax.faces.event.ActionEvent event)
Event handler that transitions a 'submitpending' task to effectively bypass the lauch date and immediately submit the items.

Parameters:
event - The event

cancelPendingSubmission

public void cancelPendingSubmission(javax.faces.event.ActionEvent event)
Event handler that cancels a pending submission.

Parameters:
event - The event

updateFoldersPageSize

public void updateFoldersPageSize(javax.faces.event.ActionEvent event)
Update page size based on user selection


updateFilesPageSize

public void updateFilesPageSize(javax.faces.event.ActionEvent event)
Update page size based on user selection


searchWebsite

public void searchWebsite(javax.faces.event.ActionEvent event)
Perform a lucene search of the website


closeSearch

public void closeSearch(javax.faces.event.ActionEvent event)
Action called to Close the search dialog by returning to the last viewed path


getMinimumSearchLength

public static int getMinimumSearchLength()
Returns:
Returns the minimum length of a valid search string.

contextUpdated

public void contextUpdated()
Description copied from interface: IContextListener
Method called by UIContextService.notifyBeans() to inform all registered beans that all UI Beans should refresh dump all cached data and settings.

Specified by:
contextUpdated in interface IContextListener
See Also:
IContextListener.contextUpdated()

areaChanged

public void areaChanged()
Description copied from interface: IContextListener
Method called by UIContextService.areaChanged() to inform all registered beans that the user has changed area i.e. from company home to my home.

Specified by:
areaChanged in interface IContextListener
See Also:
IContextListener.areaChanged()

spaceChanged

public void spaceChanged()
Description copied from interface: IContextListener
Method called by UIContextService.spaceChanged() to inform all registered beans that the current space has changed.

Specified by:
spaceChanged in interface IContextListener
See Also:
IContextListener.spaceChanged()

revertAllConflict

public void revertAllConflict(javax.faces.event.ActionEvent event)
Revert All Conflicts

Parameters:
event -


Copyright © 2005 - 2010 Alfresco Software, Inc. All Rights Reserved.