com.ibm.team.fvt.tests.clm.pages.rm
Class RmWebReviewPage

java.lang.Object
  extended by com.ibm.team.fvt.tests.web.WebPage
      extended by com.ibm.team.fvt.tests.clm.pages.ClmWebPage
          extended by com.ibm.team.fvt.tests.clm.pages.rm.RmWebPage
              extended by com.ibm.team.fvt.tests.clm.pages.rm.RmWebReviewPage
All Implemented Interfaces:
ClmWebPageConstants

public class RmWebReviewPage
extends RmWebPage

Manage the Review RM web page. The page displays the current state of a review, listing the artifacts in the review, and the participants of the review. The page allows interaction with the review, adding/removing users, adding/removing artifacts etc.

Following actions are accessible in this page:

Following functionalities are also defined or specialized by this page:


Nested Class Summary
 class RmWebReviewPage.ReviewArtifact
          Information class for an artifact in the review
static class RmWebReviewPage.ReviewDocumentState
          The states for an individuals document within a review
static class RmWebReviewPage.ReviewState
          The State of the review
 class RmWebReviewPage.ReviewUser
          Information class for a user within the review
static class RmWebReviewPage.ReviewUserRole
          The possible roles for a user
 
Field Summary
 
Fields inherited from class com.ibm.team.fvt.tests.web.WebPage
NO_DATA
 
Fields inherited from interface com.ibm.team.fvt.tests.clm.pages.ClmWebPageConstants
ADMINISTRATION_HOME_MENU_GROUP, JAZZ_TEAM_SERVER_HOME_MENU_ITEM, LIFECYCLE_PROJECT_ADMIN_MENU_ITEM, USER_NOT_AUTHORIZED_MESSAGE_ID, USER_NOT_AUTHORIZED_MESSAGE_LOCATOR
 
Constructor Summary
RmWebReviewPage(java.lang.String url, ClmConfig config, com.ibm.team.fvt.tests.config.User user, java.lang.String... data)
           
 
Method Summary
 void addUser(ClmUser userInfo, RmWebReviewPage.ReviewUserRole role)
          Deprecated. Use addUsers(ReviewUserRole, String, ClmUser...) instead.
 void addUsers(RmWebReviewPage.ReviewUserRole role, java.lang.String searchText, ClmUser... clmUsers)
          Adds the given users as users for the review in the given role (one of RmWebReviewPage.ReviewUserRole).
 void completeAllReviews()
          Completes this review (as Abstained) for all users.
 void continueReview()
          Continues a paused review, putting it into RmWebReviewPage.ReviewState IN_PROGRESS Note there is no check it is in the appropriate state prior to putting it into IN_PROGRESS.
 void finalizeReview()
          Finalizes a completed review, putting it into RmWebReviewPage.ReviewState FINALIZED The FINALIZED state is immutable; no further changes are allowed.
 java.util.List<RmWebReviewPage.ReviewArtifact> getArtifactDetails()
          Gets details for all the artifacts in the review
 java.lang.String getArtifactVersionInfo()
          Returns the string representing when the Artifacts for review were captured
 java.lang.String getDueDate()
          Gets the Due Date for the review
 java.lang.String getInstructions()
          Gets the instructions set for the review.
 java.util.List<RmWebReviewPage.ReviewUser> getParticipantDetails()
          Gets all the participants for this review return a List of RmWebReviewPage.ReviewUsers, with details of each participant.
 RmWebReviewPage.ReviewState getReviewState()
          Determines the current state of the review.
 RmAddUserToReviewDialog openSelectUsersDialog()
          Opens and returns the add users for review dialog
 void pauseReview()
          Pauses a started review, putting it into RmWebReviewPage.ReviewState PAUSED Note there is no check it is in the appropriate state prior to putting it into PAUSED.
 boolean save()
          Save changes done to the Review.
 void setDueDate(java.util.Date date)
          Sets the Due Date for the review
 void setInstructions(java.lang.String instructions)
          Sets the instructions for the review.
 void startReview()
          Starts the review, putting it into RmWebReviewPage.ReviewState IN_PROGRESS Note there is no check it is in the appropriate state prior to putting it into IN_PROGRESS.
 
Methods inherited from class com.ibm.team.fvt.tests.clm.pages.rm.RmWebPage
getAdminUIPopupMenu, getAllProjectAreasPage, getHelpPopupMenu, getSidebarSectionItemsCount, getUserPopupMenu
 
Methods inherited from class com.ibm.team.fvt.tests.clm.pages.ClmWebPage
checkRichHover, clickHomeMenuItem, getBannerTitle, getCcmApplication, getConfig, getDmApplication, getJtsApplication, getLpaApplication, getMiniDashboard, getQmApplication, getRmApplication, getTitle, getUser, gotoCcmProjectPage, gotoCcmProjectPage, gotoDmProjectPage, gotoDmProjectPage, gotoJtsAdminHomePage, gotoLpaAllProjectsPage, gotoQmProjectPage, gotoQmProjectPage, gotoRmProjectPage, gotoRmProjectPage, logout, openAdminUIMenu, openHelpMenu, openHomeMenu, openMenu, openMenu, openToolbarMenu, openUserProfileMenu, refresh, waitWhileBusy
 
Methods inherited from class com.ibm.team.fvt.tests.web.WebPage
changeUser, checkHoverTitle, checkRichHover, get, getBrowser, getLocation, getPage, getPage, getPageUsingBrowser, goBack, openPage, openPage, openPageUsingBrowser, openPageUsingHoverTitle, openPageUsingLink, openPageUsingLink, openPageUsingLink, openPageUsingLink, openPageUsingLink, openPageUsingLink, richHoverOverLink, toString
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

RmWebReviewPage

public RmWebReviewPage(java.lang.String url,
                       ClmConfig config,
                       com.ibm.team.fvt.tests.config.User user,
                       java.lang.String... data)
Method Detail

addUser

@Deprecated
public void addUser(ClmUser userInfo,
                               RmWebReviewPage.ReviewUserRole role)
Deprecated. Use addUsers(ReviewUserRole, String, ClmUser...) instead.

Adds the given user as a user for the review, in the given role (one of RmWebReviewPage.ReviewUserRole).

Parameters:
userInfo - The user to add.
role - The role for this user.

addUsers

public void addUsers(RmWebReviewPage.ReviewUserRole role,
                     java.lang.String searchText,
                     ClmUser... clmUsers)
Adds the given users as users for the review in the given role (one of RmWebReviewPage.ReviewUserRole).

Parameters:
role - The role for these users.
searchText - The text to enter in the search filter text box (if null, then Show All is used).
clmUsers - The users to add.

completeAllReviews

public void completeAllReviews()
Completes this review (as Abstained) for all users.


continueReview

public void continueReview()
Continues a paused review, putting it into RmWebReviewPage.ReviewState IN_PROGRESS Note there is no check it is in the appropriate state prior to putting it into IN_PROGRESS. If this is not valid, the results are undefined.


finalizeReview

public void finalizeReview()
Finalizes a completed review, putting it into RmWebReviewPage.ReviewState FINALIZED The FINALIZED state is immutable; no further changes are allowed. Note there is no check it is in the appropriate state prior to putting it into FINALIZED. If this is not valid, the results are undefined.


getArtifactDetails

public java.util.List<RmWebReviewPage.ReviewArtifact> getArtifactDetails()
Gets details for all the artifacts in the review

Returns:
a List of RmWebReviewPage.ReviewArtifact

getArtifactVersionInfo

public java.lang.String getArtifactVersionInfo()
Returns the string representing when the Artifacts for review were captured

Returns:
a string like 'Artifacts captured on '.

getDueDate

public java.lang.String getDueDate()
Gets the Due Date for the review

Returns:
the due date for the review as a string.

getInstructions

public java.lang.String getInstructions()
Gets the instructions set for the review.

Returns:
the instructions set for the review.

getParticipantDetails

public java.util.List<RmWebReviewPage.ReviewUser> getParticipantDetails()
Gets all the participants for this review return a List of RmWebReviewPage.ReviewUsers, with details of each participant.


getReviewState

public RmWebReviewPage.ReviewState getReviewState()
Determines the current state of the review.

Returns:
the review state as one of RmWebReviewPage.ReviewState

openSelectUsersDialog

public RmAddUserToReviewDialog openSelectUsersDialog()
Opens and returns the add users for review dialog

Returns:
RmAddUserToReviewDialg object

pauseReview

public void pauseReview()
Pauses a started review, putting it into RmWebReviewPage.ReviewState PAUSED Note there is no check it is in the appropriate state prior to putting it into PAUSED. If this is not valid, the results are undefined.


save

public boolean save()
Save changes done to the Review.

We cannot use the super.save method, as the ReviewPage save button is not really a button, and does not have a disabled flag.

Overrides:
save in class ClmWebPage
Returns:
true if the page was saved, false if the save was not necessary.

setDueDate

public void setDueDate(java.util.Date date)
Sets the Due Date for the review

Parameters:
date - the date to be used as the due date

setInstructions

public void setInstructions(java.lang.String instructions)
Sets the instructions for the review.

Parameters:
instructions - the instructions for the review.

startReview

public void startReview()
Starts the review, putting it into RmWebReviewPage.ReviewState IN_PROGRESS Note there is no check it is in the appropriate state prior to putting it into IN_PROGRESS. If this is not valid, the results are undefined.