com.perforce.p4java.impl.mapbased.server.cmd

Class UnloadDelegator

java.lang.Object

com.perforce.p4java.impl.mapbased.server.cmd.BaseDelegator

com.perforce.p4java.impl.mapbased.server.cmd.UnloadDelegator

All Implemented Interfaces:

IUnloadDelegator

public class UnloadDelegator
extends BaseDelegator
implements IUnloadDelegator

Implementation to handle the Unload command.

Field Summary

Fields inherited from class com.perforce.p4java.impl.mapbased.server.cmd.BaseDelegator

MAX_LIMIT_SUPPORTED_MIN_VERSION, QUERY_EXPRESSIONS_SUPPORTED_MIN_VERSION, USER_RESTRICTIONS_SUPPORTED_MIN_VERSION

Constructor Summary

Constructors

Constructor and Description
UnloadDelegator(IOptionsServer server) Instantiate a new UnloadDelegator, providing the server object that will be used to execute Perforce Helix attribute commands.

Method Summary

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

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

UnloadDelegator

public UnloadDelegator(IOptionsServer server)

Instantiate a new UnloadDelegator, providing the server object that will be used to execute Perforce Helix attribute commands.

Parameters:

server - a concrete implementation of a Perforce Helix Server

Method Detail

unload

public String unload(UnloadOptions opts)
              throws P4JavaException

Description copied from interface: IUnloadDelegator

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.

Specified by:

unload in interface IUnloadDelegator

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.