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

Class RenameClientDelegator

    • Constructor Detail

      • RenameClientDelegator

        public RenameClientDelegator​(IOptionsServer server)
        Instantiate a new RenameClientDelegator, providing the server object that will be used to execute Perforce Helix attribute commands.
        Parameters:
        server - a concrete implementation of a Perforce Helix Server

    • Method Detail

      • renameClient

        public java.lang.String renameClient​(java.lang.String oldClientName,
                                     java.lang.String newClientName)
                              throws P4JavaException
        Description copied from interface: IRenameClientDelegator
        Completely renames a client, modifying all database records which mention the client.

        This includes all workspaces, labels, branches, streams, etc. which are owned by the client, all pending, shelved, and committed changes created by the client, any files that the client has opened or shelved, any fixes that the client made to jobs, any properties that apply to the client, any groups that the client is in, and the client record itself.

        Protection table entries that apply to the client are updated only if the Name: field exactly matches the client name; if the Name: field contains wildcards, it is not modified.

        The full semantics of this operation are found in the main 'p4 help' documentation.

        This method requires 'super' access granted by 'p4 protect'.

        Specified by:
        renameClient in interface IRenameClientDelegator
        Parameters:
        oldClientName - the old client name to be changed.
        newClientName - the new client name to be changed to.
        Returns:
        non-null result message string from the reload operation.
        Throws:
        P4JavaException - if an error occurs processing this method and its parameters.