com.atlassian.crucible.plugin.export
Interface CrucibleClient

All Known Implementing Classes:
CrucibleDirectClient, CrucibleRestClient

public interface CrucibleClient

Interface that specifies the entry points to the Crucible API.

Author:
Ross Rowe

Method Summary
 java.util.List<com.atlassian.crucible.spi.data.GeneralCommentData> getGeneralComments(java.lang.String reviewId)
          Returns the list of GeneralCommentData instances for the reviewId.
 com.atlassian.crucible.spi.data.ReviewData getReview(java.lang.String reviewId)
          Retrieves the ReviewData instance for the reviewId.
 com.atlassian.crucible.spi.data.FisheyeReviewItemData getReviewItemData(java.lang.String reviewId, java.lang.String reviewItemId)
          Retrieves the FisheyeReviewItemData instance for the reviewId and the reviewItemId.
 java.lang.String getUserName(java.lang.String userId)
          Returns a user's real name.
 java.util.List<com.atlassian.crucible.spi.data.VersionedLineCommentData> getVersionedComments(java.lang.String reviewId)
          Returns a list of VersionedLineCommentData instances for the reviewId.
 java.lang.String login(java.lang.String username, java.lang.String password)
          Performs a login action using the username and password.
 

Method Detail

getGeneralComments

java.util.List<com.atlassian.crucible.spi.data.GeneralCommentData> getGeneralComments(java.lang.String reviewId)
Returns the list of GeneralCommentData instances for the reviewId.

Parameters:
reviewId -
Returns:

getReview

com.atlassian.crucible.spi.data.ReviewData getReview(java.lang.String reviewId)
Retrieves the ReviewData instance for the reviewId.

Parameters:
reviewId -
Returns:

getVersionedComments

java.util.List<com.atlassian.crucible.spi.data.VersionedLineCommentData> getVersionedComments(java.lang.String reviewId)
Returns a list of VersionedLineCommentData instances for the reviewId.

Parameters:
reviewId -
Returns:

login

java.lang.String login(java.lang.String username,
                       java.lang.String password)
Performs a login action using the username and password.

Parameters:
username -
password -
Returns:

getReviewItemData

com.atlassian.crucible.spi.data.FisheyeReviewItemData getReviewItemData(java.lang.String reviewId,
                                                                        java.lang.String reviewItemId)
Retrieves the FisheyeReviewItemData instance for the reviewId and the reviewItemId.

Parameters:
reviewId -
reviewItemId -
Returns:

getUserName

java.lang.String getUserName(java.lang.String userId)
Returns a user's real name.

Parameters:
userId -
Returns:


Copyright © 2008. All Rights Reserved.