Package jetbrains.buildServer.serverSide.mute

Interface MuteInfo

  • public interface MuteInfo
    Brief information about problem muting.

    The major contract of this entity is invariance of all data returned by getters of this interface. So, if a client got a value from one of getters they can assume that the next call of this getter even from another instance (but with the same key) will return an equivalent value.

    The key is Id - see getId(). So all implementations MUST implement Object.equals(Object) and Object.hashCode() that consider Id only.

    Since:
    6.5
    Author:
    Leonid Bushuev from JetBrains
    See Also:
    MuteScope

    • Method Detail

      • getId

        @NotNull
java.lang.Integer getId()
        The key of the mute fact.
        Returns:
        muting identifier.

      • getProjectId

        @NotNull
java.lang.String getProjectId()
        The internal project ID where an object was muted.
        Returns:
        project id

      • getProject

        @Nullable
SProject getProject()
        The project where an object was muted. The result can be null, if the project does not exist anymore.
        Returns:
        the project

      • getMutingUserId

        long getMutingUserId()
        User that has muted something.
        Returns:
        user id.

      • getMutingUser

        @Nullable
User getMutingUser()
        Returns user who muted test. Can return null if such user does not exist anymore.
        Returns:
        see above

      • getMutingTime

        @NotNull
java.util.Date getMutingTime()
        Date and time of the muting fact.
        Returns:
        time stamp when the test has been muted.

      • getMutingComment

        @Nullable
java.lang.String getMutingComment()
        Muting note.
        Returns:
        a comment user left when he/she muted the test. This note is always not null to around a problem in JSP. May be null but never empty.

      • getScope

        @NotNull
MuteScope getScope()
        Scope, where problems were muted. This represents the initial state of the mute. Later unmutes do not affect the data returned here.
        Returns:
        scope.

      • getTestNameIds

        @NotNull
java.util.Collection<java.lang.Long> getTestNameIds()
        Set of tests that were muted. This represents the initial state of the mute. Later unmutes do not affect the data returned here.
        Returns:
        immutable set of test name identifiers. These identifiers are without run-count incrementing even when the scope is MuteScope.ScopeType.IN_ONE_BUILD.

      • getTests

        @NotNull
java.util.Collection<STest> getTests()
        Retrieves tests that were muted. This represents the initial state of the mute. Later unmutes do not affect the data returned here.
        Returns:
        collection of tests.

      • getBuildProblemIds

        @NotNull
java.util.Collection<java.lang.Integer> getBuildProblemIds()
        Returns collection of build problems that were muted in scope of this muting operation. This represents the initial state of the mute. Later unmutes do not affect the data returned here.
        Returns:
        see above

      • getAutoUnmuteOptions

        @NotNull
UnmuteOptions getAutoUnmuteOptions()
        Options how the system should unmute the problem automatically.
        Returns:
        how the system should unmute the problem automatically.