Package 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).

  • Method Details

    • getName

      String getName()
      Get the name of this client.
      Returns:
      the name of this client, if set or known; null otherwise.

    • setName

      void setName(String name)
      Set the name of this client.
      Parameters:
      name - new client name.

    • getUpdated

      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(Date updated)
      Set the client's updated date / time.
      Parameters:
      updated - new updated date.

    • getAccessed

      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(Date accessed)
      Set the client's accessed date / time.
      Parameters:
      accessed - new accessed date.

    • getOwnerName

      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(String ownerName)
      Set the name of the owner of this client.
      Parameters:
      ownerName - the name of the owner of this Perforce client.

    • getHostName

      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(String hostName)
      Set the name of the associated host.
      Parameters:
      hostName - new host name.

    • getDescription

      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(String description)
      Set the description associated with this client.
      Parameters:
      description - new description string.

    • getRoot

      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(String root)
      Set the root of this client.
      Parameters:
      root - new client root.

    • getAlternateRoots

      List<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(List<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.

    • getStream

      String getStream()
      Get the stream's path in a stream depot, of the form //depotname/streamname, to which this client's view will be dedicated.
      Returns:
      the stream's path in a stream depot of this client, or null if this is not a stream client.

    • setStream

      void setStream(String stream)
      Set the stream's path in a stream depot, of the form //depotname/streamname, to which this client's view will be dedicated.
      Parameters:
      stream - new stream's path in a stream depot of this client.

    • isStream

      boolean isStream()
      Convenience method to check if this is a stream client
      Returns:
      true, if stream

    • getServerId

      String getServerId()
      Get the server id associated with this client.
      Returns:
      the server id associated with this client, or null if this client has no associated server id.

    • setServerId

      void setServerId(String serverId)
      Set the server id of this client.
      Parameters:
      serverId - new server id for this client.

    • getStreamAtChange

      int getStreamAtChange()
      Get the changelist id associated with this dynamically generated back-in-time stream client.
      Returns:
      the changelist id associated with this dynamically generated back-in-time stream client, or IChangelist.UNKNOWN if this is not a dynamically generated back-in-time stream client.

    • setStreamAtChange

      void setStreamAtChange(int streamAtChange)
      Set the changelist id associated with this dynamically generated back-in-time stream client.
      Parameters:
      streamAtChange - new changelist id associated with this dynamically generated back-in-time stream client.

    • isUnloaded

      boolean isUnloaded()
      Return the "unloaded" status for this client.
      Returns:
      true iff the client is unloaded.

    • getType

      String getType()
      Get the client workspace type 'graph' for Graph support
      Returns:
      String representation of the type

    • setType

      void setType(String type)
      Set the client workspace type 'graph' for Graph support
      Parameters:
      type - the type as a String

    • getBackup

      String getBackup()
      Get the client's participation in backup enable/disable. If not specified backup of a writable client defaults to enabled.
      Returns:
      String representation of the type

    • setBackup

      void setBackup(String backup)
      Set the client's participation in backup enable/disable
      Parameters:
      backup - enable/disable as a String