public class ClientsDelegator extends BaseDelegator implements IClientsDelegator
MAX_LIMIT_SUPPORTED_MIN_VERSION, QUERY_EXPRESSIONS_SUPPORTED_MIN_VERSION, USER_RESTRICTIONS_SUPPORTED_MIN_VERSION
Constructor and Description |
---|
ClientsDelegator(IOptionsServer server)
Instantiate a new ClientsDelegator, providing the server object that will be used to
execute Perforce Helix attribute commands.
|
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.
|
public ClientsDelegator(IOptionsServer server)
server
- a concrete implementation of a Perforce Helix Serverpublic java.util.List<IClientSummary> getClients(GetClientsOptions opts) throws P4JavaException
IClientsDelegator
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.
getClients
in interface IClientsDelegator
opts
- GetClientsOptions object describing optional parameters; if null, no options are
set.P4JavaException
- if any error occurs in the processing of this method.public java.util.List<IClientSummary> getClients(java.lang.String userName, java.lang.String nameFilter, int maxResults) throws ConnectionException, RequestException, AccessException
IClientsDelegator
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.
getClients
in interface IClientsDelegator
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