Package com.perforce.p4java.server.delegator

Interface IDepotDelegator

All Known Subinterfaces:

IOptionsServer, IServer, IStreamingServer

All Known Implementing Classes:

DepotDelegator, NtsServerImpl, OneShotServerImpl, RpcServer, Server

public interface IDepotDelegator

Interface for a DepotDelegator implementation.

Method Summary

Modifier and Type	Method	Description
java.lang.String	createDepot(IDepot newDepot)	Create a new depot in the repository.
java.lang.String	deleteDepot(java.lang.String name)	Delete a named depot from the repository.
IDepot	getDepot(java.lang.String name)	Get an individual depot by name.

Method Detail

createDepot

java.lang.String createDepot(@Nonnull
                             IDepot newDepot)
                      throws P4JavaException

Create a new depot in the repository. You must be an admin for this operation to succeed.

Parameters:

newDepot - non-null IDepot object representing the depot to be created.

Returns:

possibly-null operation result message string from the Perforce server.

Throws:

P4JavaException - if any error occurs in the processing of this method.

Since:

2011.1

deleteDepot

java.lang.String deleteDepot(java.lang.String name)
                      throws P4JavaException

Delete a named depot from the repository. You must be an admin for this operation to succeed.

Parameters:

name - non-null IDepot object representing the depot to be deleted

Returns:

possibly-null operation result message string from the Perforce server.

Throws:

P4JavaException - if any error occurs in the processing of this method.

Since:

2011.1

getDepot

IDepot getDepot(java.lang.String name)
         throws P4JavaException

Get an individual depot by name. Note that this method will return a fake depot if you ask it for a non-existent depot, so it's not the most useful of operations.

Parameters:

name - non-null name of the depot to be retrieved.

Returns:

IDepot non-null object corresponding to the named depot if it exists and is retrievable; otherwise an IDepot object that looks real but does not, in fact, correspond to any known depot in the repository.

Throws:

P4JavaException - if any error occurs in the processing of this method.

Since:

2011.1