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

Class ClientsDelegator

    • Constructor Detail

      • ClientsDelegator

        public ClientsDelegator​(IOptionsServer server)
        Instantiate a new ClientsDelegator, 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

      • getClients

        public java.util.List<IClientSummary> getClients​(GetClientsOptions opts)
                                          throws P4JavaException
        Description copied from interface: IClientsDelegator
        Get a list of IClientSummary objects for all Perforce clients known to this Perforce server.

        Note that this method returns light-weight IClientSummary objects rather than full IClient objects; if you need the heavy-weight IClient objects, you should use getClient().

        Note also that the returned IClient objects are not "complete", in the sense that implementations are free to leave certain attributes null for performance reasons. In general, at least the client's name, root, description, last modification time are guaranteed correct.

        Specified by:
        getClients in interface IClientsDelegator
        Parameters:
        opts - GetClientsOptions object describing optional parameters; if null, no options are set.
        Returns:
        non-null (but possibly empty) list of Client objects for Perforce clients known to this Perforce server.
        Throws:
        P4JavaException - if any error occurs in the processing of this method.

      • getClients

        public java.util.List<IClientSummary> getClients​(java.lang.String userName,
                                                 java.lang.String nameFilter,
                                                 int maxResults)
                                          throws ConnectionException,
                                                 RequestException,
                                                 AccessException
        Description copied from interface: IClientsDelegator
        Get a list of IClientSummary objects for all Perforce clients known to this Perforce server.

        Note that this method returns light-weight IClientSummary objects rather than full IClient objects; if you need the heavy-weight IClient objects, you should use getClient().

        Note also that the returned IClient objects are not "complete", in the sense that implementations are free to leave certain attributes null for performance reasons. In general, at least the client's name, root, description, last modification time are guaranteed correct.

        Specified by:
        getClients in interface IClientsDelegator
        Parameters:
        userName - user name
        nameFilter - limits output to clients whose name matches the nameFilter pattern. Corresponds to -enameFilter flag
        maxResults - If greater than zero, limit output to the first maxResults number of clients.
        Returns:
        non-null (but possibly empty) list of Client objects for Perforce clients known to
        Throws:
        ConnectionException - on error
        RequestException - on error
        AccessException - on error