com.perforce.p4java.server.delegator

Interface ITagDelegator

All Known Subinterfaces:

IOptionsServer, IServer, IStreamingServer

All Known Implementing Classes:

NtsServerImpl, OneShotServerImpl, RpcServer, Server, TagDelegator

public interface ITagDelegator

Interface to handle the Tag command.

Method Summary

Modifier and Type	Method and Description
List<IFileSpec>	tagFiles(List<IFileSpec> fileSpecs, String labelName, boolean listOnly, boolean delete) Tag files with a Perforce label.
List<IFileSpec>	tagFiles(List<IFileSpec> fileSpecs, String labelName, TagFilesOptions opts)

Method Detail

tagFiles

List<IFileSpec> tagFiles(List<IFileSpec> fileSpecs,
                         String labelName,
                         boolean listOnly,
                         boolean delete)
                  throws ConnectionException,
                         RequestException,
                         AccessException

Tag files with a Perforce label.

Parameters:

fileSpecs - non-null list of files to be tagged.

labelName - non-null label name to use for the tagging.

listOnly - if true, don't do the actual tag, just return the list of files that would have been tagged.

delete - if true, delete the label tag from the files.

Returns:

a non-null (but possibly empty) list of affected file specs

Throws:

ConnectionException - if the Perforce server is unreachable or is not connected.

RequestException - if the Perforce server encounters an error during its processing of the request

AccessException - if the Perforce server denies access to the caller

tagFiles

List<IFileSpec> tagFiles(List<IFileSpec> fileSpecs,
                         String labelName,
                         TagFilesOptions opts)
                  throws P4JavaException

Parameters:

fileSpecs - non-null list of files to be tagged.

labelName - non-null label name to use for the tagging.

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

Returns:

a non-null (but possibly empty) list of affected file specs.

Throws:

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