com.perforce.p4java.server.delegator

Interface IReviewsDelegator

All Known Subinterfaces:

IOptionsServer, IServer, IStreamingServer

All Known Implementing Classes:

NtsServerImpl, OneShotServerImpl, ReviewsDelegator, RpcServer, Server

public interface IReviewsDelegator

Interface to handle the Reviews command.

Method Summary

Modifier and Type	Method and Description
List<IUserSummary>	getReviews(int changelistId, List<IFileSpec> fileSpecs) 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.
List<IUserSummary>	getReviews(List<IFileSpec> fileSpecs, GetReviewsOptions opts) Get a list of all users who have subscribed to review the named files.

Method Detail

getReviews

List<IUserSummary> getReviews(List<IFileSpec> fileSpecs,
                              GetReviewsOptions opts)
                       throws P4JavaException

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.

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

List<IUserSummary> getReviews(int changelistId,
                              List<IFileSpec> fileSpecs)
                       throws ConnectionException,
                              RequestException,
                              AccessException

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.

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