Package com.perforce.p4java.server.delegator

Interface IBranchesDelegator

All Known Subinterfaces:

IOptionsServer, IServer, IStreamingServer

All Known Implementing Classes:

BranchesDelegator, NtsServerImpl, OneShotServerImpl, RpcServer, Server

public interface IBranchesDelegator

Method Summary

Modifier and Type	Method	Description
java.util.List<IBranchSpecSummary>	getBranchSpecs(GetBranchSpecsOptions opts)	Get a list of all summary Perforce branch specs known to the Perforce server.
java.util.List<IBranchSpecSummary>	getBranchSpecs(java.lang.String userName, java.lang.String nameFilter, int maxReturns)	Old style getBranchSpecs api call.

Method Detail

getBranchSpecs

java.util.List<IBranchSpecSummary> getBranchSpecs(GetBranchSpecsOptions opts)
                                           throws P4JavaException

Get a list of all summary Perforce branch specs known to the Perforce server.

Note that the IBranchSpecSummary objects returned here do not have branch view specs; you must call the getBranchSpec method on a specific branch to get valid view specs for a branch.

Parameters:

opts - object describing optional parameters; if null, no options are set.

Returns:

non-null (but possibly-empty) list of IBranchSpecSummary objects.

Throws:

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

getBranchSpecs

java.util.List<IBranchSpecSummary> getBranchSpecs(java.lang.String userName,
                                                  java.lang.String nameFilter,
                                                  int maxReturns)
                                           throws ConnectionException,
                                                  RequestException,
                                                  AccessException

Old style getBranchSpecs api call. deprecated use getBranchSpecs(final GetBranchSpecsOptions opts) instead

Parameters:

userName - user name

nameFilter - name filter

maxReturns - maximum results

Returns:

list of Branch spec summaries

Throws:

ConnectionException - connection errors

RequestException - server request errors

AccessException - access restrictions