Package org.silverpeas.components.questionreply.service

Interface QuestionManager

All Known Implementing Classes:

SilverpeasQuestionManager

public interface QuestionManager

The service managing the questions and the replies of the FAQs, that is to say of the QuestionReply application instances. Except for finding out the FAQ of a question, the questions and the replies are always accessed within a given FAQ: those of other FAQs are ignored.

Method Summary

Modifier and Type	Method	Description
void	closeQuestions(Collection<Long> questionIds, String instanceId)	Closes the specified questions of the given FAQ.
long	createQuestion(Question question)
long	createQuestionReply(Question question, Reply reply)	Create and persist a question reply
long	createQuestionReply(Question question, Reply reply, List<org.silverpeas.core.pdc.pdc.model.PdcPosition> positions)	Creates and persists a question with its reply, and classifies the question on the PdC on the specified positions.
long	createReply(Reply reply, Question question)
void	deleteQuestionAndReplies(Collection<Long> questionIds, String instanceId)	Deletes the specified questions of the given FAQ with their replies.
List<Question>	getAllQuestions(String instanceId)
List<Question>	getAllQuestionsByCategory(String instanceId, String categoryId)
List<Reply>	getAllReplies(long questionId, String instanceId)	Gets the private then the public replies to the specified question of the given FAQ.
Optional<String>	getInstanceIdOfQuestion(long questionId)	Gets the unique identifier of the FAQ in which the specified question is asked.
List<Question>	getPublicQuestions(String instanceId)
Question	getQuestion(long questionId, String instanceId)	Gets the specified question of the given FAQ.
List<Reply>	getQuestionPrivateReplies(long questionId, String instanceId)	Gets the private replies to the specified question of the given FAQ.
List<Reply>	getQuestionPublicReplies(long questionId, String instanceId)	Gets the public replies to the specified question of the given FAQ.
List<Recipient>	getQuestionRecipients(long questionId)
List<Reply>	getQuestionReplies(long questionId, String instanceId)	Gets all the replies to the specified question of the given FAQ.
List<Question>	getQuestions(String instanceId)
List<Question>	getQuestionsByIds(List<String> ids, String instanceId)	Gets the specified questions of the given FAQ.
List<Question>	getReceiveQuestions(String userId, String instanceId)
Reply	getReply(long replyId, String instanceId)	Gets the specified reply to a question of the given FAQ.
List<Question>	getSendQuestions(String userId, String instanceId)
void	openQuestions(Collection<Long> questionIds, String instanceId)	Opens again the specified questions of the given FAQ.
void	updateQuestion(Question question)
void	updateRepliesPrivateStatus(Collection<Long> replyIds, Question question)
void	updateRepliesPublicStatus(Collection<Long> replyIds, Question question)
void	updateReply(Reply reply)

Method Details

createQuestion

long createQuestion(Question question)
             throws QuestionReplyException

Throws:

QuestionReplyException

createReply

long createReply(Reply reply,
 Question question)
          throws QuestionReplyException

Throws:

QuestionReplyException

closeQuestions

void closeQuestions(Collection<Long> questionIds,
 String instanceId)
             throws QuestionReplyException

Closes the specified questions of the given FAQ. The questions of other FAQs are ignored.

Parameters:

questionIds - the unique identifiers of the questions.

instanceId - the unique identifier of the FAQ.

Throws:

QuestionReplyException - if an error occurs.

openQuestions

void openQuestions(Collection<Long> questionIds,
 String instanceId)
            throws QuestionReplyException

Opens again the specified questions of the given FAQ. The questions of other FAQs are ignored.

Parameters:

questionIds - the unique identifiers of the questions.

instanceId - the unique identifier of the FAQ.

Throws:

QuestionReplyException - if an error occurs.

updateRepliesPublicStatus

void updateRepliesPublicStatus(Collection<Long> replyIds,
 Question question)
                        throws QuestionReplyException

Throws:

QuestionReplyException

updateRepliesPrivateStatus

void updateRepliesPrivateStatus(Collection<Long> replyIds,
 Question question)
                         throws QuestionReplyException

Throws:

QuestionReplyException

updateQuestion

void updateQuestion(Question question)
             throws QuestionReplyException

Throws:

QuestionReplyException

updateReply

void updateReply(Reply reply)
          throws QuestionReplyException

Throws:

QuestionReplyException

deleteQuestionAndReplies

void deleteQuestionAndReplies(Collection<Long> questionIds,
 String instanceId)
                       throws QuestionReplyException

Deletes the specified questions of the given FAQ with their replies. The questions of other FAQs are ignored.

Parameters:

questionIds - the unique identifiers of the questions.

instanceId - the unique identifier of the FAQ.

Throws:

QuestionReplyException - if an error occurs.

getAllReplies

List<Reply> getAllReplies(long questionId,
 String instanceId)
                   throws QuestionReplyException

Gets the private then the public replies to the specified question of the given FAQ.

Parameters:

questionId - the unique identifier of the question.

instanceId - the unique identifier of the FAQ.

Returns:

the replies, or an empty list if the FAQ has no such question.

Throws:

QuestionReplyException - if an error occurs.

getInstanceIdOfQuestion

Optional<String> getInstanceIdOfQuestion(long questionId)
                                  throws QuestionReplyException

Gets the unique identifier of the FAQ in which the specified question is asked. It is for the permalinks of the questions, that don't refer the FAQ.

Parameters:

questionId - the unique identifier of the question.

Returns:

the unique identifier of the FAQ, or nothing if there is no such question.

Throws:

QuestionReplyException - if an error occurs.

getQuestion

Question getQuestion(long questionId,
 String instanceId)
              throws QuestionReplyException

Gets the specified question of the given FAQ.

Parameters:

questionId - the unique identifier of the question.

instanceId - the unique identifier of the FAQ.

Returns:

the question, or null if the FAQ has no such question.

Throws:

QuestionReplyException - if an error occurs.

getQuestionsByIds

List<Question> getQuestionsByIds(List<String> ids,
 String instanceId)
                          throws QuestionReplyException

Gets the specified questions of the given FAQ. The questions of other FAQs are ignored.

Parameters:

ids - the unique identifiers of the questions to get.

instanceId - the unique identifier of the FAQ.

Returns:

the questions found, or an empty list if no identifiers are given.

Throws:

QuestionReplyException - if an error occurs while fetching the questions.

getQuestionReplies

List<Reply> getQuestionReplies(long questionId,
 String instanceId)
                        throws QuestionReplyException

Gets all the replies to the specified question of the given FAQ.

Parameters:

questionId - the unique identifier of the question.

instanceId - the unique identifier of the FAQ.

Returns:

the replies, or an empty list if the FAQ has no such question.

Throws:

QuestionReplyException - if an error occurs.

getQuestionPublicReplies

List<Reply> getQuestionPublicReplies(long questionId,
 String instanceId)
                              throws QuestionReplyException

Gets the public replies to the specified question of the given FAQ.

Parameters:

questionId - the unique identifier of the question.

instanceId - the unique identifier of the FAQ.

Returns:

the public replies, or an empty list if the FAQ has no such question.

Throws:

QuestionReplyException - if an error occurs.

getQuestionPrivateReplies

List<Reply> getQuestionPrivateReplies(long questionId,
 String instanceId)
                               throws QuestionReplyException

Gets the private replies to the specified question of the given FAQ.

Parameters:

questionId - the unique identifier of the question.

instanceId - the unique identifier of the FAQ.

Returns:

the private replies, or an empty list if the FAQ has no such question.

Throws:

QuestionReplyException - if an error occurs.

getQuestionRecipients

List<Recipient> getQuestionRecipients(long questionId)
                               throws QuestionReplyException

Throws:

QuestionReplyException

getReply

Reply getReply(long replyId,
 String instanceId)
        throws QuestionReplyException

Gets the specified reply to a question of the given FAQ.

Parameters:

replyId - the unique identifier of the reply.

instanceId - the unique identifier of the FAQ.

Returns:

the reply, or null if no question of the FAQ has such a reply.

Throws:

QuestionReplyException - if an error occurs.

getSendQuestions

List<Question> getSendQuestions(String userId,
 String instanceId)
                         throws QuestionReplyException

Throws:

QuestionReplyException

getReceiveQuestions

List<Question> getReceiveQuestions(String userId,
 String instanceId)
                            throws QuestionReplyException

Throws:

QuestionReplyException

getQuestions

List<Question> getQuestions(String instanceId)
                     throws QuestionReplyException

Throws:

QuestionReplyException

getAllQuestions

List<Question> getAllQuestions(String instanceId)
                        throws QuestionReplyException

Throws:

QuestionReplyException

getAllQuestionsByCategory

List<Question> getAllQuestionsByCategory(String instanceId,
 String categoryId)
                                  throws QuestionReplyException

Throws:

QuestionReplyException

getPublicQuestions

List<Question> getPublicQuestions(String instanceId)
                           throws QuestionReplyException

Throws:

QuestionReplyException

createQuestionReply

long createQuestionReply(Question question,
 Reply reply)
                  throws QuestionReplyException

Create and persist a question reply

Parameters:

question - the new question

reply - the answer linked to the given question

Returns:

long identifier of the created question

Throws:

QuestionReplyException

createQuestionReply

long createQuestionReply(Question question,
 Reply reply,
 List<org.silverpeas.core.pdc.pdc.model.PdcPosition> positions)
                  throws QuestionReplyException

Creates and persists a question with its reply, and classifies the question on the PdC on the specified positions. The question is classified before the subscribers are notified about the reply, and without alerting the subscribers on the PdC about the classification: they are notified about the reply with the other subscribers.

Parameters:

question - the new question

reply - the answer linked to the given question

positions - the positions on the PdC on which the question has to be classified. If empty, the question isn't classified.

Returns:

long identifier of the created question

Throws:

QuestionReplyException - if an error occurs