Package com.perforce.p4java.core

Interface IChangelistSummary

  • All Known Subinterfaces:
    IChangelist
    All Known Implementing Classes:
    Changelist, ChangelistSummary
    public interface IChangelistSummary
    Defines the methods and operations available on Perforce changelist summaries returned from the server.

    Changelist summaries are typically returned from the server's changelist list methods (e.g. getChangelists) and normally contain only the fields returned by the Perforce "p4 changes" command (i.e. they're missing things like files and job lists), and allow only "local" field setter and getter operations. For full changelist functionality, use the IChangelist interface that extends this interface.

    Unextended IChangelistSummary objects are complete, and neither refreshable nor updateable.

    • Method Detail

      • getId

        int getId()
        Return the Perforce changelist's ID.
        Returns:
        changelist ID, or UNKNOWN if unknown or not yet allocated.

      • getDescription

        java.lang.String getDescription()
        Return the description associated with this changelist.
        Returns:
        textual changelist description, or null if no such description.

      • setDescription

        java.lang.String setDescription​(java.lang.String newDescription)
        Set the description string for this changelist.
        Parameters:
        newDescription - non-null new description string.
        Returns:
        the old description string.

      • getStatus

        ChangelistStatus getStatus()
        Get the status of this changelist, if known.
        Returns:
        IChangelistStatus status, or null if not known.

      • getDate

        java.util.Date getDate()
        Get the date the changelist was created or last updated.
        Returns:
        the date the changelist was created or last updated, or null if unknown.

      • getClientId

        java.lang.String getClientId()
        Get the ID of the Perforce client workspace associated with this changelist.
        Returns:
        the ID of the client associated with this changelist, or null if not known.

      • getUsername

        java.lang.String getUsername()
        Get the user name of the user associated with this changelist.
        Returns:
        the user name of the user associated with this changelist, or null if no such name exists or can be determined.

      • setId

        void setId​(int id)
        Set the changelist ID. Will not cause the associated changelist to be updated on the Perforce server without a suitable update being performed.
        Parameters:
        id - new changelist ID.

      • setClientId

        void setClientId​(java.lang.String clientId)
        Set the client ID. Will not cause the associated changelist to be updated on the Perforce server without a suitable update being performed.
        Parameters:
        clientId - new client ID.

      • setUsername

        void setUsername​(java.lang.String username)
        Set the changelist owner ID. Will not cause the associated changelist to be updated on the Perforce server without a suitable update being performed.
        Parameters:
        username - new owner's user name.

      • setStatus

        void setStatus​(ChangelistStatus status)
        Set the changelist status. Will not cause the associated changelist to be updated on the Perforce server without a suitable update being performed.
        Parameters:
        status - status

      • setDate

        void setDate​(java.util.Date date)
        Set the changelist date. Will not cause the associated changelist to be updated on the Perforce server without a suitable update being performed.
        Parameters:
        date - new changelist date

      • isShelved

        boolean isShelved()
        Does this changelist contain at least one shelved file? This only applies to changelists whose getStatus() is ChangelistStatus.PENDING and that have been returned as IChangelistSummary objects. The value here is unreliable for full IChangelist objects returned from getChangelist, etc.
        Returns:
        - true if changelist contains shelved files, false otherwise

      • setShelved

        void setShelved​(boolean shelved)
        Set the shelved status of of this changelist (see isShelved()).
        Parameters:
        shelved - new shelved value.

      • getVisibility

        IChangelistSummary.Visibility getVisibility()
        Get the visibility associated with this changelist. May be null if no visibility is associated with this changelist.
        Returns:
        possibly-null visibility.
        Since:
        2011.1

      • setVisibility

        void setVisibility​(IChangelistSummary.Visibility visibility)
        Set the visibility associated with this changelist.
        Parameters:
        visibility - visability
        Since:
        2011.1

      • getChangelistStream

        java.lang.String getChangelistStream()
        Return the Stream spec mark for edit in changelist. Return the Stream path marked for edit in changelist.
        Returns:
        Stream path, or null if no such description.
        Since:
        2021.2