Interface IBranchSpecSummary

  • All Superinterfaces:
    IServerResource
    All Known Subinterfaces:
    IBranchSpec
    All Known Implementing Classes:
    BranchSpec, BranchSpecSummary

    public interface IBranchSpecSummary
    extends IServerResource
    Defines the summary Perforce branch metadata typically returned by the getBranchSummaryList() method, corresponding to "p4 branches" and similar.

    In general, branch summary information excludes the branch view, and no server-side operations can be performed against them; for full branch functionality you should use the full IBranchSpec interface.

    Branch summaries are complete and not refreshable or updateable.

    • Method Detail

      • getName

        java.lang.String getName()
        Get the name of this branch.
        Returns:
        name
      • getOwnerName

        java.lang.String getOwnerName()
        Get the name of the user who created this branch.
        Returns:
        owner
      • getUpdated

        java.util.Date getUpdated()
        Get the date specification was last modified.
        Returns:
        date
      • getAccessed

        java.util.Date getAccessed()
        Get the date of the last 'integrate' using this branch.
        Returns:
        date
      • getDescription

        java.lang.String getDescription()
        Get the branch's description (if any).
        Returns:
        description
      • isLocked

        boolean isLocked()
        Return true if the branch spec is locked.
        Returns:
        true if locked
      • setName

        void setName​(java.lang.String name)
        Set the name of this branch. This will not change the name of the associated branch spec on the Perforce server unless you arrange for the update to server.
        Parameters:
        name - new branch spec name
      • setOwnerName

        void setOwnerName​(java.lang.String ownerName)
        Set the owner's name for this branch. This will not change the associated branch spec on the Perforce server unless you arrange for the update to server.
        Parameters:
        ownerName - new owner's name
      • setUpdated

        void setUpdated​(java.util.Date updated)
        Set the last-updated date. This generally has no effect on the associated Perforce server version of this spec.
        Parameters:
        updated - new updated date.
      • setAccessed

        void setAccessed​(java.util.Date accessed)
        Set the last-accessed date. This generally has no effect on the associated Perforce server version of this spec.
        Parameters:
        accessed - new accessed date.
      • setDescription

        void setDescription​(java.lang.String description)
        Set the branch spec description. This will not change the associated branch spec on the Perforce server unless you arrange for the update to server.
        Parameters:
        description - new description string.
      • setLocked

        void setLocked​(boolean locked)
        Set whether the branch spec is locked or not. This will not change the associated branch spec on the Perforce server unless you arrange for the update to server.
        Parameters:
        locked - boolean lock status