Package com.perforce.p4java.core

Interface ILabelSummary

  • All Superinterfaces:
    IServerResource
    All Known Subinterfaces:
    ILabel
    All Known Implementing Classes:
    Label, LabelSummary
    public interface ILabelSummary
extends IServerResource
    Defines summary information for Perforce labels. Label summary objects contain the summary field information returned by (e.g.) the "p4 labels" command (which does not include the label view), and do not support server-side operations against them. For the full Perforce label object functionality, see ILabel, which extends this interface.

    ILabelSummary objects are complete and neither refreshable nor updateable.

    See the main Perforce documentation for label usage and semantics.

    • Method Detail

      • getName

        java.lang.String getName()
        Get the label's name (the label's label, so to speak).
        Returns:
        possibly-null label name (should only be null if the underlying label object has just been created on the client and has no server-side counterpart yet).

      • setName

        void setName​(java.lang.String name)
        Set the label's name.
        Parameters:
        name - the label's (new) name.

      • getOwnerName

        java.lang.String getOwnerName()
        Get the name of the owner of this label.
        Returns:
        possibly-null owner name.

      • setOwnerName

        void setOwnerName​(java.lang.String ownerName)
        Set the name of the owner of this label.
        Parameters:
        ownerName - the new owner name.

      • getLastUpdate

        java.util.Date getLastUpdate()
        Get the date and time the label specification was last updated.
        Returns:
        possibly-null Date

      • setLastUpdate

        void setLastUpdate​(java.util.Date lastUpdate)
        Set the date and time the label specification was last updated.
        Parameters:
        lastUpdate - Date last updated.

      • getLastAccess

        java.util.Date getLastAccess()
        Get the date and time of the last 'labelsync' or use of '@label' on this label.
        Returns:
        possibly-null Date

      • setLastAccess

        void setLastAccess​(java.util.Date lastAccess)
        Set the date and time of the last 'labelsync' or use of '@label' on this label.
        Parameters:
        lastAccess - new last access date.

      • getDescription

        java.lang.String getDescription()
        Get the description associated with this label.
        Returns:
        possibly-null description string.

      • setDescription

        void setDescription​(java.lang.String description)
        Set the description associated with this label.
        Parameters:
        description - new label description string.

      • isLocked

        boolean isLocked()
        Return the "locked/unlocked" status for this label.
        Returns:
        true iff the label is locked else it is unlocked.

      • setLocked

        void setLocked​(boolean locked)
        Set the "locked/unlocked" status for this label.
        Parameters:
        locked - true iff the label is locked else it is unlocked.

      • isAutoReload

        boolean isAutoReload()
        Return the "autoreload/noautoreload" status for this label.
        Returns:
        true iff the label is "autoreload" else it is "noautoreload".

      • setAutoReload

        void setAutoReload​(boolean autoreload)
        Set the "autoreload/noautoreload" status for this label.
        Parameters:
        autoreload - true iff the label is "autoreload" else it is "noautoreload".

      • getRevisionSpec

        java.lang.String getRevisionSpec()
        Get the optional revision specification for this label.
        Returns:
        possibly-null revision spec string.

      • setRevisionSpec

        void setRevisionSpec​(java.lang.String revisionSpec)
        Set the optional revision specification for this label.
        Parameters:
        revisionSpec - new revision spec string

      • isUnloaded

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