public interface IClientsDelegator
Modifier and Type | Method and Description |
---|---|
java.util.List<IClientSummary> |
getClients(GetClientsOptions opts)
Get a list of IClientSummary objects for all Perforce clients known to this Perforce
server.
|
java.util.List<IClientSummary> |
getClients(java.lang.String userName,
java.lang.String nameFilter,
int maxResults)
Get a list of IClientSummary objects for all Perforce clients known to this Perforce
server.
|
java.util.List<IClientSummary> getClients(GetClientsOptions opts) throws P4JavaException
Note that this method returns light-weight IClientSummary objects rather than full IClient objects; if you need the heavy-weight IClient objects, you should use getClient().
Note also that the returned IClient objects are not "complete", in the sense that implementations are free to leave certain attributes null for performance reasons. In general, at least the client's name, root, description, last modification time are guaranteed correct.
opts
- GetClientsOptions object describing optional parameters; if null, no options are
set.P4JavaException
- if any error occurs in the processing of this method.java.util.List<IClientSummary> getClients(java.lang.String userName, java.lang.String nameFilter, int maxResults) throws ConnectionException, RequestException, AccessException
Note that this method returns light-weight IClientSummary objects rather than full IClient objects; if you need the heavy-weight IClient objects, you should use getClient().
Note also that the returned IClient objects are not "complete", in the sense that implementations are free to leave certain attributes null for performance reasons. In general, at least the client's name, root, description, last modification time are guaranteed correct.
userName
- user namenameFilter
- limits output to clients whose name matches the nameFilter pattern.
Corresponds to -enameFilter flagmaxResults
- If greater than zero, limit output to the first maxResults number of
clients.ConnectionException
- on errorRequestException
- on errorAccessException
- on error