Class EngineComment.ReviewSessionActionHandler

  • Enclosing class:
    EngineComment

    public class EngineComment.ReviewSessionActionHandler
    extends java.lang.Object
    Manages all the actions for Review Session
    • Constructor Summary

      Constructors 
      Constructor Description
      ReviewSessionActionHandler​(java.sql.Connection c, java.lang.Integer userID)  
      ReviewSessionActionHandler​(java.sql.Connection c, java.lang.Integer userID, mks.ci.common.comment.reviewsession.ReviewSessionOpArgs args)  
    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      void abortReviewSession​(java.lang.Integer contextID)
      This method will abort all the open review sessions for given contextID.
      void createAReviewSession​(int userID, int contextID, java.lang.String documentState, java.util.Set<java.lang.Integer> reviewerList)
      Create a Review session against an a context.
      mks.ci.common.comment.reviewsession.ReviewSessionOpReturn editReview​(mks.ci.common.comment.reviewsession.review.ReviewOpArgs.ReviewState reviewState)
      Editing the review verdicts
      mks.ci.common.comment.reviewsession.ReviewSessionOpReturn view()
      View one or all review sessions.
      • Methods inherited from class java.lang.Object

        equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    • Constructor Detail

      • ReviewSessionActionHandler

        public ReviewSessionActionHandler​(java.sql.Connection c,
                                          java.lang.Integer userID)
      • ReviewSessionActionHandler

        public ReviewSessionActionHandler​(java.sql.Connection c,
                                          java.lang.Integer userID,
                                          mks.ci.common.comment.reviewsession.ReviewSessionOpArgs args)
    • Method Detail

      • createAReviewSession

        public void createAReviewSession​(int userID,
                                         int contextID,
                                         java.lang.String documentState,
                                         java.util.Set<java.lang.Integer> reviewerList)
                                  throws java.sql.SQLException,
                                         mks.ci.exception.CIException
        Create a Review session against an a context. As of now it's designed for Document type. This code is invoked directly on the defined state change. No command is implemented for it.
        Throws:
        java.sql.SQLException
        mks.ci.exception.CIException
      • view

        public mks.ci.common.comment.reviewsession.ReviewSessionOpReturn view()
                                                                       throws java.sql.SQLException,
                                                                              mks.ci.exception.CIException
        View one or all review sessions. If only conextID is provided, it'll return all the review sessions associated with it. If --latest parameter along with contextID is given, only latest review session will be returned.
        Throws:
        java.sql.SQLException
        mks.ci.exception.CIException
      • editReview

        public mks.ci.common.comment.reviewsession.ReviewSessionOpReturn editReview​(mks.ci.common.comment.reviewsession.review.ReviewOpArgs.ReviewState reviewState)
                                                                             throws java.sql.SQLException,
                                                                                    mks.ci.exception.CIException
        Editing the review verdicts
        Parameters:
        reviewSessionID -
        reviewerID -
        verdict -
        Returns:
        Throws:
        java.sql.SQLException
        mks.ci.exception.CIException
      • abortReviewSession

        public void abortReviewSession​(java.lang.Integer contextID)
                                throws java.sql.SQLException,
                                       mks.ci.exception.CIException
        This method will abort all the open review sessions for given contextID.
        Parameters:
        contextID -
        Throws:
        java.sql.SQLException
        mks.ci.exception.CIException