com.perforce.p4java.client
Interface IClientSummary

All Superinterfaces:

IServerResource

All Known Subinterfaces:

IClient

All Known Implementing Classes:

Client, ClientSummary

public interface IClientSummary
extends IServerResource

Lightweight Perforce client interface that defines summary client metadata and associated operations, without providing client views or actual client-related operations. Corresponds closely to the information retruned by a "p4 clients" command.

Lightweight IClientSummary objects are typically returned from client list operations such as IServer.getClientList; further use of these specs for heavier-weight operations (etc.) requires getting the full client (IClient) object from the server via an explicit getClient() or similar operation.

Note that field setter methods defined below have local effect only, and in order to update the corresponding client on the Perforce server, you would need to create a corresponding full IClient object and update that object on the server. "Pure" IClientSummary objects (those implementing just the IClientSummary interface) are complete but are not refreshable or updateable (full IClient objects, on the other hand, are complete, refreshable, and updateable).

Nested Class Summary

static class	IClientSummary.ClientLineEnd Defines the line end options available for text files.
static interface	IClientSummary.IClientOptions Defines what options are available or set (or whatever) for a specific Perforce Client.
static interface	IClientSummary.IClientSubmitOptions Defines the options to be used when submitting Perforce changelists associated with this Perforce client.

Method Summary

java.util.Date	getAccessed() Gets the date this client was last used in any way.
java.util.List<java.lang.String>	getAlternateRoots() Get the alternate roots associated with this Perforce client, if any.
java.lang.String	getDescription() Returns a short description of the Perforce server client.
java.lang.String	getHostName() Returns the name of the associated host, if any.
IClientSummary.ClientLineEnd	getLineEnd() Get the line end options for this client.
java.lang.String	getName() Get the name of this client.
IClientSummary.IClientOptions	getOptions() Get the Perforce client options associated with this client.
java.lang.String	getOwnerName() Get the name of the owner of this Perforce client.
java.lang.String	getRoot() Returns the root of this Perforce client.
IClientSummary.IClientSubmitOptions	getSubmitOptions() Get the Perforce client changelist submit options associated with this client.
java.util.Date	getUpdated() Get the date the client's specification was last modified.
void	setAccessed(java.util.Date accessed) Set the client's accessed date / time.
void	setAlternateRoots(java.util.List<java.lang.String> alternateRoots) Set the alternate roots associated with this Perforce client.
void	setDescription(java.lang.String description) Set the description associated with this client.
void	setHostName(java.lang.String hostName) Set the name of the associated host.
void	setLineEnd(IClientSummary.ClientLineEnd lineEnd) Set the line end options for this client.
void	setName(java.lang.String name) Set the name of this client.
void	setOptions(IClientSummary.IClientOptions options) Set the client options associated with this client.
void	setOwnerName(java.lang.String ownerName) Set the name of the owner of this client.
void	setRoot(java.lang.String root) Set the root of this client.
void	setSubmitOptions(IClientSummary.IClientSubmitOptions submitOptions) Set the client submit options for this client.
void	setUpdated(java.util.Date updated) Set the client's updated date / time.

Methods inherited from interface com.perforce.p4java.core.IServerResource

canRefresh, canUpdate, refresh, setServer, update

Method Detail

getName

java.lang.String getName()

Get the name of this client.

Returns:

the name of this client, if set or known; null otherwise.

setName

void setName(java.lang.String name)

Set the name of this client.

Parameters:

name - new client name.

getUpdated

java.util.Date getUpdated()

Get the date the client's specification was last modified.

Returns:

the date the client's specification was last modified, or null if not known.

setUpdated

void setUpdated(java.util.Date updated)

Set the client's updated date / time.

Parameters:

updated - new updated date.

getAccessed

java.util.Date getAccessed()

Gets the date this client was last used in any way. Note that this is a server-side date and does not reflect client-side usage.

Returns:

the date this client was last used in any way, or null if not known.

setAccessed

void setAccessed(java.util.Date accessed)

Set the client's accessed date / time.

Parameters:

accessed - new accessed date.

getOwnerName

java.lang.String getOwnerName()

Get the name of the owner of this Perforce client.

Returns:

the name of the owner of this Perforce client, if known; null otherwise.

setOwnerName

void setOwnerName(java.lang.String ownerName)

Set the name of the owner of this client.

Parameters:

ownerName - the name of the owner of this Perforce client.

getHostName

java.lang.String getHostName()

Returns the name of the associated host, if any.

Returns:

the name of the associated host, if any; null otherwise.

setHostName

void setHostName(java.lang.String hostName)

Set the name of the associated host.

Parameters:

hostName - new host name.

getDescription

java.lang.String getDescription()

Returns a short description of the Perforce server client.

Returns:

the short description of the client, or null if no such description is available.

setDescription

void setDescription(java.lang.String description)

Set the description associated with this client.

Parameters:

description - new description string.

getRoot

java.lang.String getRoot()

Returns the root of this Perforce client.

Returns:

the root of this client, or null if no such root is available.

setRoot

void setRoot(java.lang.String root)

Set the root of this client.

Parameters:

root - new client root.

getAlternateRoots

java.util.List<java.lang.String> getAlternateRoots()

Get the alternate roots associated with this Perforce client, if any.

Returns:

list of alternate roots if they exist; null otherwise.

setAlternateRoots

void setAlternateRoots(java.util.List<java.lang.String> alternateRoots)

Set the alternate roots associated with this Perforce client.

Parameters:

alternateRoots - new alternate roots list. Note that order within the list is significant.

getLineEnd

IClientSummary.ClientLineEnd getLineEnd()

Get the line end options for this client.

Returns:

ClientLineEnd representing the line end options for this client.

setLineEnd

void setLineEnd(IClientSummary.ClientLineEnd lineEnd)

Set the line end options for this client.

Parameters:

lineEnd - ClientLineEnd representing the line end options for this client.

getOptions

IClientSummary.IClientOptions getOptions()

Get the Perforce client options associated with this client.

Returns:

non-null options

setOptions

void setOptions(IClientSummary.IClientOptions options)

Set the client options associated with this client.

Parameters:

options - new options.

getSubmitOptions

IClientSummary.IClientSubmitOptions getSubmitOptions()

Get the Perforce client changelist submit options associated with this client.

Returns:

non-null changelist submit options

setSubmitOptions

void setSubmitOptions(IClientSummary.IClientSubmitOptions submitOptions)

Set the client submit options for this client.

Parameters:

submitOptions - new client submit options.