Class ReviewsDelegator

java.lang.Object
com.perforce.p4java.impl.mapbased.server.cmd.BaseDelegator
com.perforce.p4java.impl.mapbased.server.cmd.ReviewsDelegator
All Implemented Interfaces:
IReviewsDelegator

public class ReviewsDelegator extends BaseDelegator implements IReviewsDelegator
Implementation to handle the Reviews command.
  • Constructor Details

    • ReviewsDelegator

      public ReviewsDelegator(IOptionsServer server)
      Instantiate a new ReviewsDelegator, providing the server object that will be used to execute Perforce Helix attribute commands.
      Parameters:
      server - a concrete implementation of a Perforce Helix Server
  • Method Details

    • getReviews

      public List<IUserSummary> getReviews(List<IFileSpec> fileSpecs, GetReviewsOptions opts) throws P4JavaException
      Description copied from interface: IReviewsDelegator
      Get a list of all users who have subscribed to review the named files.

      Note that the returned IUserSummary objects will have null access and update dates associated with them.

      Specified by:
      getReviews in interface IReviewsDelegator
      Parameters:
      fileSpecs - if not null, use this list as the list of named files rather than all files.
      opts - GetReviewsOptions object describing optional parameters; if null, no options are set.
      Returns:
      non-null but possibly empty list of IUserSummary objects; note that these objects will have null update and access fields.
      Throws:
      P4JavaException - if any error occurs in the processing of this method.
    • getReviews

      public List<IUserSummary> getReviews(int changelistId, List<IFileSpec> fileSpecs) throws ConnectionException, RequestException, AccessException
      Description copied from interface: IReviewsDelegator
      Get a list of all users who have subscribed to review the named files, the files in the numbered changelist, or all files by default.

      Note that the returned IUserSummary objects will have null access and update dates associated with them.

      Specified by:
      getReviews in interface IReviewsDelegator
      Parameters:
      changelistId - if not IChangelist.UNKNOWN, use this changelist ID.
      fileSpecs - if not null, use this list as the list of named files rather than all files.
      Returns:
      non-null but possibly empty list of IUserSummary objects; note that these objects will have null update and access fields.
      Throws:
      ConnectionException - if the Perforce server is unreachable or is not connected.
      RequestException - if the Perforce server encounters an error during its processing of the request
      AccessException - if the Perforce server denies access to the caller