public class OpenedDelegator extends BaseDelegator implements IOpenedDelegator
MAX_LIMIT_SUPPORTED_MIN_VERSION, QUERY_EXPRESSIONS_SUPPORTED_MIN_VERSION, USER_RESTRICTIONS_SUPPORTED_MIN_VERSION
Constructor and Description |
---|
OpenedDelegator(IOptionsServer server)
Instantiates a new opened delegator.
|
Modifier and Type | Method and Description |
---|---|
java.util.List<IFileSpec> |
getOpenedFiles(java.util.List<IFileSpec> fileSpecs,
boolean allClients,
java.lang.String clientName,
int maxFiles,
int changeListId)
If one or more Perforce file specs is passed-in, return the opened /
locked status of each file (if known) within an IFileSpec object;
otherwise return a list of all files known to be open for this Perforce
client workspace.
|
java.util.List<IFileSpec> |
getOpenedFiles(java.util.List<IFileSpec> fileSpecs,
OpenedFilesOptions opts)
If one or more Perforce file specs is passed-in, return the opened /
locked status of each file (if known) within an IFileSpec object;
otherwise return a list of all files known to be open for this Perforce
client workspace.
|
public OpenedDelegator(IOptionsServer server)
server
- the serverpublic java.util.List<IFileSpec> getOpenedFiles(java.util.List<IFileSpec> fileSpecs, boolean allClients, java.lang.String clientName, int maxFiles, int changeListId) throws ConnectionException, AccessException
IOpenedDelegator
The returned list can be modified with the other arguments as described below.
getOpenedFiles
in interface IOpenedDelegator
fileSpecs
- if non-empty, determine the status of the specified files;
otherwise return all qualifying files known to be openallClients
- if true, return results for all known clients rather than the
current client (if any).clientName
- if non-null, return results for the named client only.maxFiles
- if positive, return only the first maxFiles qualifying files.changeListId
- if positive, return only files associated with the given
changelist ID; if IChangelist.DEFAULT, retrieve files open
associated with the default changelist.ConnectionException
- if the Perforce server is unreachable or is not connected.AccessException
- if the Perforce server denies access to the callerpublic java.util.List<IFileSpec> getOpenedFiles(java.util.List<IFileSpec> fileSpecs, OpenedFilesOptions opts) throws P4JavaException
IOpenedDelegator
getOpenedFiles
in interface IOpenedDelegator
fileSpecs
- if non-empty, determine the status of the specified files;
otherwise return all qualifying files known to be openopts
- possibly-null OpenedFilesOptions object object specifying
method options.P4JavaException
- if an error occurs processing this method and its parameters.