com.perforce.p4java.server.delegator

Interface IUnloadDelegator

All Known Subinterfaces:

IOptionsServer, IServer, IStreamingServer

All Known Implementing Classes:

NtsServerImpl, OneShotServerImpl, RpcServer, Server, UnloadDelegator

public interface IUnloadDelegator

Interface to handle the Unload command.

Method Summary

Modifier and Type	Method and Description
String	unload(UnloadOptions opts) Unloads a client or label to the unload depot.

Method Detail

unload

String unload(UnloadOptions opts)
       throws P4JavaException

Unloads a client or label to the unload depot.

Note that by default, users can only unload their own clients or labels. The -f flag requires 'admin' access, which is granted by 'p4 protect'. The full semantics of this operation are found in the main 'p4 help unload' documentation.

Parameters:

opts - possibly-null UnloadOptions object specifying method options.

Returns:

non-null result message string from the unload operation.

Throws:

P4JavaException - if an error occurs processing this method and its parameters.

Since:

2012.3