public interface IClientDelegator
Modifier and Type | Method and Description |
---|---|
java.lang.String |
createClient(IClient newClient) |
void |
createTempClient(IClient newClient) |
java.lang.String |
deleteClient(java.lang.String clientName,
boolean force) |
java.lang.String |
deleteClient(java.lang.String clientName,
DeleteClientOptions opts)
Delete a Perforce client from a Perforce server.
|
IClient |
getClient(IClientSummary clientSummary) |
IClient |
getClient(java.lang.String clientName) |
IClient |
getClientTemplate(java.lang.String clientName) |
IClient |
getClientTemplate(java.lang.String clientName,
boolean allowExistent) |
IClient |
getClientTemplate(java.lang.String clientName,
GetClientTemplateOptions getClientTemplateOptions)
Get a template of a non-existent named Perforce client.
|
java.lang.String |
switchClientView(java.lang.String templateClientName,
java.lang.String targetClientName,
SwitchClientViewOptions opts)
Switch the target client spec's view without invoking the editor.
|
java.lang.String |
switchStreamView(java.lang.String streamPath,
java.lang.String targetClientName,
SwitchClientViewOptions opts)
Switch the target client spec's view without invoking the editor.
|
java.lang.String |
updateClient(IClient client) |
java.lang.String |
updateClient(IClient client,
boolean force)
Update an existing Perforce client on the current Perforce server.
|
java.lang.String |
updateClient(IClient client,
UpdateClientOptions opts)
Update an existing Perforce client on the current Perforce server.
|
IClient getClient(java.lang.String clientName) throws ConnectionException, RequestException, AccessException
IClient getClient(@Nonnull IClientSummary clientSummary) throws ConnectionException, RequestException, AccessException
IClient getClientTemplate(java.lang.String clientName) throws ConnectionException, RequestException, AccessException
IClient getClientTemplate(java.lang.String clientName, boolean allowExistent) throws ConnectionException, RequestException, AccessException
IClient getClientTemplate(java.lang.String clientName, GetClientTemplateOptions getClientTemplateOptions) throws P4JavaException
clientName
- Not blank Perforce client name.getClientTemplateOptions
- GetClientTemplateOptions object describing optional
parameters; if null, no options are set.P4JavaException
- if any error occurs in the processing of this method.java.lang.String createClient(@Nonnull IClient newClient) throws ConnectionException, RequestException, AccessException
void createTempClient(@Nonnull IClient newClient) throws ConnectionException, RequestException, AccessException
java.lang.String updateClient(@Nonnull IClient client) throws ConnectionException, RequestException, AccessException
java.lang.String updateClient(IClient client, boolean force) throws ConnectionException, RequestException, AccessException
client
- non-null IClient defining the Perforce client to be updatedforce
- if true, tell the server to attempt to force the update regardless of the
consequences. You're on your own with this one...RequestException
- if any error occurs in the processing of this method.ConnectionException
- on errorAccessException
- on errorjava.lang.String updateClient(IClient client, UpdateClientOptions opts) throws P4JavaException
client
- non-null IClient defining the Perforce client to be updatedopts
- UpdateClientOptions object describing optional parameters; if null, no options
are set.P4JavaException
- if any error occurs in the processing of this method.java.lang.String deleteClient(java.lang.String clientName, boolean force) throws ConnectionException, RequestException, AccessException
java.lang.String deleteClient(java.lang.String clientName, DeleteClientOptions opts) throws P4JavaException
clientName
- non-null name of the client to be deleted from the server.opts
- DeleteClientOptions object describing optional parameters; if null, no
options are set.P4JavaException
- if any error occurs in the processing of this method.java.lang.String switchClientView(java.lang.String templateClientName, java.lang.String targetClientName, SwitchClientViewOptions opts) throws P4JavaException
templateClientName
- non-null name of the template client who's view will be used for
the target (or current) client to switched to.targetClientName
- possibly-null name of the target client whose view will be changed
to the template client's view. If null, the current client will be
used.opts
- SwitchClientViewOptions object describing optional parameters; if
null, no options are set.P4JavaException
- if any error occurs in the processing of this method.java.lang.String switchStreamView(java.lang.String streamPath, java.lang.String targetClientName, SwitchClientViewOptions opts) throws P4JavaException
streamPath
- non-null stream's path in a stream depot, of the form
//depotname/streamname who's view will be used for the target (or
current) client to switched to.targetClientName
- possibly-null name of the target client whose view will be changed to
the stream's view. If null, the current client will be used.opts
- SwitchClientViewOptions object describing optional parameters; if
null, no options are set.P4JavaException
- if any error occurs in the processing of this method.