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

Class OpenedDelegator

java.lang.Object

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

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

All Implemented Interfaces:

IOpenedDelegator

public class OpenedDelegator
extends BaseDelegator
implements IOpenedDelegator

Implementation for p4 opened.

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
OpenedDelegator(IOptionsServer server) Instantiates a new opened delegator.

Method Summary

Modifier and Type	Method and Description
List<IFileSpec>	getOpenedFiles(List<IFileSpec> fileSpecs, boolean allClients, 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.
List<IFileSpec>	getOpenedFiles(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.

Methods inherited from class java.lang.Object

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

Constructor Detail

OpenedDelegator

public OpenedDelegator(IOptionsServer server)

Instantiates a new opened delegator.

Parameters:

server - the server

Method Detail

getOpenedFiles

public List<IFileSpec> getOpenedFiles(List<IFileSpec> fileSpecs,
                                      boolean allClients,
                                      String clientName,
                                      int maxFiles,
                                      int changeListId)
                               throws ConnectionException,
                                      AccessException

Description copied from interface: IOpenedDelegator

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.

The returned list can be modified with the other arguments as described below.

Specified by:

getOpenedFiles in interface IOpenedDelegator

Parameters:

fileSpecs - if non-empty, determine the status of the specified files; otherwise return all qualifying files known to be open

allClients - 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.

Returns:

non-null but possibly-empty list of qualifying open files. Not all fields in individual file specs will be valid or make sense to be accessed.

Throws:

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

AccessException - if the Perforce server denies access to the caller

getOpenedFiles

public List<IFileSpec> getOpenedFiles(List<IFileSpec> fileSpecs,
                                      OpenedFilesOptions opts)
                               throws P4JavaException

Description copied from interface: IOpenedDelegator

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.

Specified by:

getOpenedFiles in interface IOpenedDelegator

Parameters:

fileSpecs - if non-empty, determine the status of the specified files; otherwise return all qualifying files known to be open

opts - possibly-null OpenedFilesOptions object object specifying method options.

Returns:

non-null but possibly-empty list of qualifying open files. Not all fields in individual file specs will be valid or make sense to be accessed.

Throws:

P4JavaException - if an error occurs processing this method and its parameters.