com.randomcoder.article
Interface ArticleBusiness

All Known Implementing Classes:

ArticleBusinessImpl

public interface ArticleBusiness

Business interface for managing articles.

 Copyright (c) 2006-2007, Craig Condit. All rights reserved.
 
 Redistribution and use in source and binary forms, with or without
 modification, are permitted provided that the following conditions are met:
 
   * Redistributions of source code must retain the above copyright notice,
     this list of conditions and the following disclaimer.
   * Redistributions in binary form must reproduce the above copyright notice,
     this list of conditions and the following disclaimer in the documentation
     and/or other materials provided with the distribution.
     
 THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
 AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
 ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
 LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
 CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
 SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
 INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
 CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
 ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
 POSSIBILITY OF SUCH DAMAGE.
 

Method Summary

Article	approveComment(Long commentId) Approves a comment.
void	createArticle(Producer<Article> producer, String userName) Create a new article.
void	createComment(Producer<Comment> comment, Long articleId, String userName, String referrer, String ipAddress, String userAgent) Creates a new comment.
void	deleteArticle(String userName, Long articleId) Delete an article.
Article	deleteComment(Long commentId) Deletes a comment.
Article	disapproveComment(Long commentId) Disapproves a comment.
void	loadArticleForEditing(Consumer<Article> consumer, Long articleId, String userName) Load an existing article for editing.
boolean	moderateComments(int count) Moderate a batch of comments.
void	updateArticle(Producer<Article> producer, Long articleId, String userName) Update an existing article.

Method Detail

createArticle

void createArticle(Producer<Article> producer,
                   String userName)

Create a new article.

Parameters:

producer - article producer

userName - user name

createComment

void createComment(Producer<Comment> comment,
                   Long articleId,
                   String userName,
                   String referrer,
                   String ipAddress,
                   String userAgent)

Creates a new comment.

Parameters:

comment - comment producer

articleId - article id

userName - user name

referrer - HTTP referrer

ipAddress - remote IP address

userAgent - HTTP user-agent

loadArticleForEditing

void loadArticleForEditing(Consumer<Article> consumer,
                           Long articleId,
                           String userName)

Load an existing article for editing.

Parameters:

consumer - article consumer

articleId - article id

userName - user name

updateArticle

void updateArticle(Producer<Article> producer,
                   Long articleId,
                   String userName)

Update an existing article.

Parameters:

producer - article producer

articleId - article id

userName - user name

deleteArticle

void deleteArticle(String userName,
                   Long articleId)

Delete an article.

Parameters:

userName - user name

articleId - article id

deleteComment

Article deleteComment(Long commentId)

Deletes a comment.

Parameters:

commentId - comment id

Returns:

Article which comment belongs to

approveComment

Article approveComment(Long commentId)
                       throws ModerationException

Approves a comment.

Parameters:

commentId - comment id

Returns:

Article which comment belongs to

Throws:

ModerationException - if moderation cannot be completed

disapproveComment

Article disapproveComment(Long commentId)
                          throws ModerationException

Disapproves a comment.

Parameters:

commentId - comment id

Returns:

Article which comment belongs to

Throws:

ModerationException - if moderation cannot be completed

moderateComments

boolean moderateComments(int count)
                         throws ModerationException

Moderate a batch of comments.

Parameters:

count - number of comments to moderate

Returns:

true if comments were moderated, false otherwise

Throws:

ModerationException - if moderation cannot be completed