org.alfresco.web.bean

Class BaseDetailsBean

java.lang.Object

org.alfresco.web.bean.dialog.BaseDialogBean

org.alfresco.web.bean.BaseDetailsBean

All Implemented Interfaces:

Serializable, IDialogBean

Direct Known Subclasses:

DocumentDetailsDialog, DocumentLinkDetailsDialog, ForumDetailsDialog, ForumsDetailsDialog, SpaceDetailsDialog, SpaceLinkDetailsDialog, TopicDetailsDialog

public abstract class BaseDetailsBean
extends BaseDialogBean

Backing bean provided access to the details of a Node

Author:

Kevin Roast

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected TemplateImageResolver	imageResolver Template Image resolver helper
protected Map<String,Boolean>	panels
protected String	template Selected template Id
protected Map<String,Serializable>	workflowProperties The map of workflow properties

Fields inherited from class org.alfresco.web.bean.dialog.BaseDialogBean

browseBean, isFinished, navigator, parameters

Constructor Summary

Constructors

Constructor and Description
BaseDetailsBean()

Method Summary

Modifier and Type	Method and Description
void	applyTemplate(ActionEvent event) Action handler to apply the selected Template and Templatable aspect to the current node
void	approve(ActionEvent event) Event handler called to handle the approve step of the simple workflow
String	cancelWorkflowEdit() Cancel Workflow Edit dialog
void	expandPanel(ActionEvent event) Save the state of the panel that was expanded/collapsed
String	getApproveStepName() Returns the name of the approve step of the attached workflow
String	getBookmarkUrl() Returns the URL to access the details page for the current node
String	getCifsPath() Returns the CIFS path for the current node
protected CopyService	getCopyService()
boolean	getHasCustomView()
boolean	getHasTemplateView()
boolean	getHasWebscriptView()
String	getId() Returns the id of the current node
protected abstract Node	getLinkResolvedNode() Resolve the actual Node from any Link object that may be proxying it
String	getName() Returns the name of the current node
abstract Node	getNode() Returns the Node this bean is currently representing
String	getNodeRefUrl() Return the Alfresco NodeRef URL for the current node
protected OwnableService	getOwnableService()
Map<String,Boolean>	getPanels()
protected org.alfresco.service.cmr.security.PermissionService	getPermissionService()
protected abstract String	getPropertiesPanelId()
String	getRejectStepName() Returns the name of the reject step of the attached workflow
String	getTemplate()
abstract Map	getTemplateModel() Returns a model for use by a template on the Details page.
String	getTemplateRef()
String	getWebdavUrl() Returns the WebDAV URL for the current node
String	getWebscriptUrl()
Map<String,Serializable>	getWorkflowProperties() Returns the properties for the attached workflow as a map
void	reject(ActionEvent event) Event handler called to handle the approve step of the simple workflow
void	removeTemplate(ActionEvent event) Action handler to remove a custom view template from the current node
String	saveWorkflow() Saves the details of the workflow stored in workflowProperties to the current node
void	setCopyService(CopyService copyService) Sets the copy service instance the bean should use
void	setOwnableService(OwnableService ownableService) Sets the ownable service instance the bean should use
void	setPanels(Map<String,Boolean> panels)
void	setPermissionService(org.alfresco.service.cmr.security.PermissionService permissionService)
void	setTemplate(String template)
void	takeOwnership(ActionEvent event) Action Handler to take Ownership of the current node

Methods inherited from class org.alfresco.web.bean.dialog.BaseDialogBean

cancel, doPostCommitProcessing, finish, finishImpl, formatErrorMessage, getActionsConfigId, getActionsContext, getAdditionalButtons, getCancelButtonLabel, getCheckOutCheckInService, getContainerDescription, getContainerSubTitle, getContainerTitle, getDefaultCancelOutcome, getDefaultFinishOutcome, getDictionaryService, getErrorMessageId, getErrorOutcome, getFileFolderService, getFinishButtonDisabled, getFinishButtonLabel, getMoreActionsConfigId, getNamespaceService, getNodeService, getRuleService, getSearchService, getTransactionService, init, isFinished, restored, setBrowseBean, setDictionaryService, setFileFolderService, setNamespaceService, setNavigator, setNodeService, setSearchService

Methods inherited from class java.lang.Object

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

Field Detail

template

protected String template

Selected template Id

workflowProperties

protected Map<String,Serializable> workflowProperties

The map of workflow properties

panels

protected Map<String,Boolean> panels

imageResolver

protected TemplateImageResolver imageResolver

Template Image resolver helper

Constructor Detail

BaseDetailsBean

public BaseDetailsBean()

Method Detail

setOwnableService

public void setOwnableService(OwnableService ownableService)

Sets the ownable service instance the bean should use

Parameters:

ownableService - The OwnableService

getOwnableService

protected OwnableService getOwnableService()

setCopyService

public void setCopyService(CopyService copyService)

Sets the copy service instance the bean should use

Parameters:

copyService - The CopyService

getCopyService

protected CopyService getCopyService()

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()

getPanels

public Map<String,Boolean> getPanels()

Returns:

Returns the panels expanded state map.

setPanels

public void setPanels(Map<String,Boolean> panels)

Parameters:

panels - The panels expanded state map.

getNode

public abstract Node getNode()

Returns the Node this bean is currently representing

Returns:

The Node

getId

public String getId()

Returns the id of the current node

Returns:

The id

getName

public String getName()

Returns the name of the current node

Returns:

Name of the current

getNodeRefUrl

public String getNodeRefUrl()

Return the Alfresco NodeRef URL for the current node

Returns:

the Alfresco NodeRef URL

getWebdavUrl

public String getWebdavUrl()

Returns the WebDAV URL for the current node

Returns:

The WebDAV url

getCifsPath

public String getCifsPath()

Returns the CIFS path for the current node

Returns:

The CIFS path

getBookmarkUrl

public String getBookmarkUrl()

Returns the URL to access the details page for the current node

Returns:

The bookmark URL

getLinkResolvedNode

protected abstract Node getLinkResolvedNode()

Resolve the actual Node from any Link object that may be proxying it

Returns:

current Node or Node resolved from any Link object

getTemplate

public String getTemplate()

Returns:

Returns the template Id.

setTemplate

public void setTemplate(String template)

Parameters:

template - The template Id to set.

getHasCustomView

public boolean getHasCustomView()

Returns:

true if the current node has a custom Template or Webscript view applied and references a template/webscript that currently exists in the system.

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

getTemplateRef

public String getTemplateRef()

Returns:

String of the NodeRef for the custom view for the node

getWebscriptUrl

public String getWebscriptUrl()

Returns:

Webscript URL for the custom view for the node

getTemplateModel

public abstract Map getTemplateModel()

Returns a model for use by a template on the Details page.

Returns:

model containing current current node info.

getWorkflowProperties

public Map<String,Serializable> getWorkflowProperties()

Returns the properties for the attached workflow as a map

Returns:

Properties of the attached workflow, null if there is no workflow

cancelWorkflowEdit

public String cancelWorkflowEdit()

Cancel Workflow Edit dialog

saveWorkflow

public String saveWorkflow()

Saves the details of the workflow stored in workflowProperties to the current node

Returns:

The outcome string

getApproveStepName

public String getApproveStepName()

Returns the name of the approve step of the attached workflow

Returns:

The name of the approve step or null if there is no workflow

approve

public void approve(ActionEvent event)

Event handler called to handle the approve step of the simple workflow

Parameters:

event - The event that was triggered

getRejectStepName

public String getRejectStepName()

Returns the name of the reject step of the attached workflow

Returns:

The name of the reject step or null if there is no workflow

reject

public void reject(ActionEvent event)

Event handler called to handle the approve step of the simple workflow

Parameters:

event - The event that was triggered

applyTemplate

public void applyTemplate(ActionEvent event)

Action handler to apply the selected Template and Templatable aspect to the current node

removeTemplate

public void removeTemplate(ActionEvent event)

Action handler to remove a custom view template from the current node

takeOwnership

public void takeOwnership(ActionEvent event)

Action Handler to take Ownership of the current node

getPropertiesPanelId

protected abstract String getPropertiesPanelId()

Returns:

id of the properties panel component

expandPanel

public void expandPanel(ActionEvent event)

Save the state of the panel that was expanded/collapsed