Package org.ametys.plugins.workspaces

Class AbstractWorkspaceDAO

java.lang.Object

org.ametys.runtime.plugin.component.AbstractLogEnabled

org.ametys.plugins.workspaces.AbstractWorkspaceDAO

All Implemented Interfaces:

LogEnabled, Component, Contextualizable, Serviceable

Direct Known Subclasses:

AbstractCalendarDAO, AbstractWorkspaceTaskDAO, AbstractWorkspaceThreadDAO

public abstract class AbstractWorkspaceDAO
extends AbstractLogEnabled
implements Serviceable, Component, Contextualizable

Abstract class for workspace modules DAO's

Field Summary

Fields

Modifier and Type	Field	Description
protected Context	_context	The avalon context
protected CurrentUserProvider	_currentUserProvider	The current user provider.
protected ObservationManager	_observationManager	Observer manager.
protected ProjectManager	_projectManager	Workspaces project manager
protected ProjectTagsDAO	_projectTagsDAO	The project tags DAO
protected AmetysObjectResolver	_resolver	Ametys resolver
protected RichTextTransformer	_richTextTransformer	Rich text transformer
protected RightManager	_rightManager	The rights manager
protected UserManager	_userManager	User manager
protected WorkflowHelper	_workflowHelper	The workflow helper
protected WorkflowProvider	_workflowProvider	The workflow provider
protected WorkspacesHelper	_workspaceHelper	The Workspaces helper
protected WorkspaceModuleExtensionPoint	_workspaceModuleEP	The workspace module EP

Constructor Summary

Constructors

Constructor	Description
AbstractWorkspaceDAO()

Method Summary

Modifier and Type	Method	Description
protected void	_checkUserReadingRights(AmetysObject objectToCheck)	Check user reading rights
protected void	_checkUserRights(AmetysObject objectToCheck, String rightId)	Check user rights
protected Project	_getProject()	Get the project
protected String	_getProjectName()	Get the project name
protected String	_getSitemapLanguage()	Get the sitemap language
protected String	_getSiteName()	Get the site name
protected List<Map<String,Object>>	_handleTags(TaggableAmetysObject taggableAmetysObject, List<Object> tags)	Handle tags for the edition of a TaggableAmetysObject
protected boolean	_hasAfterSubComments(AbstractComment comment, List<AbstractComment> subComments)	Check if a given comment should be deleted or removed
protected void	_setAttachments(AttachableAmetysObject attachableAmetysObject, List<Part> newFiles, List<String> newFileNames, List<String> deleteFiles)	Edit the attachments of an AttachableAmetysObject
<T extends AbstractComment> T	answerComment(CommentableAmetysObject<T> commentableAmetysObject, String commentId, String commentText, ModifiableTraversableAmetysObject moduleRoot)	Answer to a commentableAmetysObject comment
void	contextualize(Context context)
<T extends AbstractComment> T	createComment(CommentableAmetysObject<T> commentableAmetysObject, String commentText, ModifiableTraversableAmetysObject moduleRoot)	Comment a commentableAmetysObject
CommentableAmetysObject	deleteComment(CommentableAmetysObject commentableAmetysObject, String commentId, ModifiableTraversableAmetysObject moduleRoot)	Edit a commentableAmetysObject comment
CommentableAmetysObject	editComment(CommentableAmetysObject commentableAmetysObject, String commentId, String commentText, ModifiableTraversableAmetysObject moduleRoot)	Edit a commentableAmetysObject comment
CommentableAmetysObject	likeOrUnlikeComment(CommentableAmetysObject commentableAmetysObject, String commentId, Boolean liked, ModifiableTraversableAmetysObject moduleRoot)	Answer to a commentableAmetysObject comment
void	service(ServiceManager manager)

Methods inherited from class org.ametys.runtime.plugin.component.AbstractLogEnabled

getLogger, setLogger

Methods inherited from class java.lang.Object

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

Field Details

_resolver

protected AmetysObjectResolver _resolver

Ametys resolver

_observationManager

protected ObservationManager _observationManager

Observer manager.

_currentUserProvider

protected CurrentUserProvider _currentUserProvider

The current user provider.

_rightManager

protected RightManager _rightManager

The rights manager

_userManager

protected UserManager _userManager

User manager

_workflowProvider

protected WorkflowProvider _workflowProvider

The workflow provider

_workflowHelper

protected WorkflowHelper _workflowHelper

The workflow helper

_projectManager

protected ProjectManager _projectManager

Workspaces project manager

_context

protected Context _context

The avalon context

_workspaceModuleEP

protected WorkspaceModuleExtensionPoint _workspaceModuleEP

The workspace module EP

_projectTagsDAO

protected ProjectTagsDAO _projectTagsDAO

The project tags DAO

_workspaceHelper

protected WorkspacesHelper _workspaceHelper

The Workspaces helper

_richTextTransformer

protected RichTextTransformer _richTextTransformer

Rich text transformer

Constructor Details

AbstractWorkspaceDAO

public AbstractWorkspaceDAO()

Method Details

contextualize

public void contextualize(Context context)
                   throws ContextException

Specified by:

contextualize in interface Contextualizable

Throws:

ContextException

service

public void service(ServiceManager manager)
             throws ServiceException

Specified by:

service in interface Serviceable

Throws:

ServiceException

_getProjectName

protected String _getProjectName()

Get the project name

Returns:

the project name

_getProject

protected Project _getProject()

Get the project

Returns:

the project

_getSitemapLanguage

protected String _getSitemapLanguage()

Get the sitemap language

Returns:

the sitemap language

_getSiteName

protected String _getSiteName()

Get the site name

Returns:

the site name

_checkUserRights

protected void _checkUserRights(AmetysObject objectToCheck,
 String rightId)
                         throws IllegalAccessException

Check user rights

Parameters:

objectToCheck - the object to check

rightId - the right id

Throws:

IllegalAccessException - if a right error occurred

_checkUserReadingRights

protected void _checkUserReadingRights(AmetysObject objectToCheck)
                                throws IllegalAccessException

Check user reading rights

Parameters:

objectToCheck - the object to check

Throws:

IllegalAccessException - if a right error occurred

_handleTags

protected List<Map<String,Object>> _handleTags(TaggableAmetysObject taggableAmetysObject,
 List<Object> tags)

Handle tags for the edition of a TaggableAmetysObject

Parameters:

taggableAmetysObject - the object to edit

tags - the tags

Returns:

the created tags

_setAttachments

protected void _setAttachments(AttachableAmetysObject attachableAmetysObject,
 List<Part> newFiles,
 List<String> newFileNames,
 List<String> deleteFiles)

Edit the attachments of an AttachableAmetysObject

Parameters:

attachableAmetysObject - the ametys object to edit

newFiles - list of new files

newFileNames - list of new files names

deleteFiles - list of names of old files to delete

createComment

public <T extends AbstractComment> T createComment(CommentableAmetysObject<T> commentableAmetysObject,
 String commentText,
 ModifiableTraversableAmetysObject moduleRoot)

Comment a commentableAmetysObject

Type Parameters:

T - type of the value to retrieve

Parameters:

commentableAmetysObject - the commentableAmetysObject

commentText - the comment text

moduleRoot - the module root

Returns:

The commentableAmetysObject

editComment

public CommentableAmetysObject editComment(CommentableAmetysObject commentableAmetysObject,
 String commentId,
 String commentText,
 ModifiableTraversableAmetysObject moduleRoot)
                                    throws IllegalAccessException

Edit a commentableAmetysObject comment

Parameters:

commentableAmetysObject - the commentableAmetysObject

commentId - the comment Id

commentText - the comment text

moduleRoot - the module root

Returns:

The commentableAmetysObject

Throws:

IllegalAccessException - If an error occurs when checking the rights

deleteComment

public CommentableAmetysObject deleteComment(CommentableAmetysObject commentableAmetysObject,
 String commentId,
 ModifiableTraversableAmetysObject moduleRoot)

Edit a commentableAmetysObject comment

Parameters:

commentableAmetysObject - the commentableAmetysObject

commentId - the comment Id

moduleRoot - the module root

Returns:

The commentableAmetysObject

_hasAfterSubComments

protected boolean _hasAfterSubComments(AbstractComment comment,
 List<AbstractComment> subComments)

Check if a given comment should be deleted or removed

Parameters:

comment - the comment

subComments - the subcomments

Returns:

true if the comment should be deleted, false if the comment should be removed instead

answerComment

public <T extends AbstractComment> T answerComment(CommentableAmetysObject<T> commentableAmetysObject,
 String commentId,
 String commentText,
 ModifiableTraversableAmetysObject moduleRoot)

Answer to a commentableAmetysObject comment

Type Parameters:

T - type of the value to retrieve

Parameters:

commentableAmetysObject - the commentableAmetysObject

commentId - the parent comment Id

commentText - the comment text

moduleRoot - the module root

Returns:

The commentableAmetysObject

likeOrUnlikeComment

public CommentableAmetysObject likeOrUnlikeComment(CommentableAmetysObject commentableAmetysObject,
 String commentId,
 Boolean liked,
 ModifiableTraversableAmetysObject moduleRoot)

Answer to a commentableAmetysObject comment

Parameters:

commentableAmetysObject - the commentableAmetysObject

commentId - the parent comment Id

liked - true if the comment is liked, otherwise the comment is unliked

moduleRoot - the module root

Returns:

The commentableAmetysObject