Package mks.ci.server.engine

Class LocalTriggerManager.ScriptSourceTraceBean

  • All Implemented Interfaces:
    mks.frame.triggers.ScriptExposableBean
    Enclosing class:
    LocalTriggerManager
    public static class LocalTriggerManager.ScriptSourceTraceBean
extends LocalTriggerManager.ScriptIMBaseBean
implements mks.frame.triggers.ScriptExposableBean
    Bean which describes a link or trace from an item to a source artifact. Each such source link / trace contains the information required to identify the source artifact.

    As of the Integrity 10.3 release, the source artifacts supported for source links include members, subprojects, and projects. Source traces are limited to member artifacts only.

    These beans are returned by ScriptIssueBean.getSourceTraceBeans, ScriptIssueDeltaBean.getOldSourceTraceBeans and ScriptIssueDeltaBean.getNewSourceTraceBeans. To determine whether a given field contains source links or source traces, use the ScriptFieldBean.isTrace method on the corresponding field.

    • Constructor Summary

      Constructors 
      Constructor Description
      ScriptSourceTraceBean​(int userId, mks.ci.server.engine.SourceTrace sourceTrace, java.sql.Connection c)  

    • Method Summary

      All Methods Instance Methods Concrete Methods Deprecated Methods 
      Modifier and Type Method Description
      java.lang.String getConfigPath()
      Return the configuration path of the project that participates in the artifact being linked or traced to.
      java.lang.String getDevPath()
      Return the development path name of the variant project that participates in the artifact being linked or traced to, or null if the participating project is not a variant project.
      java.lang.String getEndLine()
      Return the end line number (as a String) of this link or trace.
      java.lang.String getExposedName()
      Return the name of this bean that is exposed to the scripting language.
      java.lang.String getFileName()
      Deprecated. 
      java.lang.String getMemberName()
      Return the name of the source member being linked or traced to, or null if the artifact being linked or traced to is not a member.
      java.lang.String getProject()
      Return the name of the project that participates in the artifact being linked or traced to.
      java.lang.String getProjectRevision()
      Return the project revision of the build project that participates in the artifact being linked or traced to, or null if the participating project is not a build project.
      java.lang.String getRevision()
      Return the revision of the artifact being linked or traced to.
      java.lang.String getServerName()
      Return the name of the Windchill RV&S Server that hosted the source artifact being linked or traced to at the time the link or trace was created.
      java.lang.String getServerPort()
      Return the port number (as a String) of the Windchill RV&S Server that hosted the source artifact being linked or traced to at the time the link or trace was created.
      java.lang.String getStartLine()
      Return the start line number (as a String) of this link or trace.
      java.lang.String getSubprojectName()
      Return the name of the source subproject being linked to, or null if the artifact being linked to is not a subproject.
      boolean isLive()
      Return true if the revision of the source trace points to :live, false otherwise.
      boolean isMemberLink()
      Return true if the artifact being linked or traced to is a member, false otherwise.
      boolean isProjectLink()
      Return true if the artifact being linked to is a project, false otherwise.
      boolean isSubprojectLink()
      Return true if the artifact being linked to is a subproject, false otherwise.

      • Methods inherited from class java.lang.Object

        equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

      • Methods inherited from interface mks.frame.triggers.ScriptExposableBean

        getEnvironmentBean, setEnvironmentBean

    • Constructor Detail

      • ScriptSourceTraceBean

        public ScriptSourceTraceBean​(int userId,
                             mks.ci.server.engine.SourceTrace sourceTrace,
                             java.sql.Connection c)

    • Method Detail

      • getExposedName

        public java.lang.String getExposedName()
        Return the name of this bean that is exposed to the scripting language.
        Specified by:
        getExposedName in interface mks.frame.triggers.ScriptExposableBean
        Specified by:
        getExposedName in class ScriptBaseBean
        Returns:
        the bean name: imSourceTraceBean.

      • getServerName

        public java.lang.String getServerName()
                               throws mks.frame.triggers.TriggerException
        Return the name of the Windchill RV&S Server that hosted the source artifact being linked or traced to at the time the link or trace was created.
        Throws:
        mks.frame.triggers.TriggerException

      • getServerPort

        public java.lang.String getServerPort()
                               throws mks.frame.triggers.TriggerException
        Return the port number (as a String) of the Windchill RV&S Server that hosted the source artifact being linked or traced to at the time the link or trace was created.
        Throws:
        mks.frame.triggers.TriggerException

      • isMemberLink

        public boolean isMemberLink()
                     throws mks.frame.triggers.TriggerException
        Return true if the artifact being linked or traced to is a member, false otherwise.
        Throws:
        mks.frame.triggers.TriggerException

      • isSubprojectLink

        public boolean isSubprojectLink()
                         throws mks.frame.triggers.TriggerException
        Return true if the artifact being linked to is a subproject, false otherwise.

        As of the Integrity 10.3 release, traces to subproject artifacts are not supported.

        Throws:
        mks.frame.triggers.TriggerException

      • isProjectLink

        public boolean isProjectLink()
                      throws mks.frame.triggers.TriggerException
        Return true if the artifact being linked to is a project, false otherwise.

        As of the Integrity 10.3 release, traces to project artifacts are not supported.

        Throws:
        mks.frame.triggers.TriggerException

      • getFileName

        @Deprecated
public java.lang.String getFileName()
                             throws mks.frame.triggers.TriggerException
        Deprecated.
        Return the name of the source artifact being linked or traced to. If the artifact is a member, this returns the member name. If the artifact is a subproject, this returns the subproject name. If the artifact is a project, this returns the project name.

        This method is deprecated in favor of the getMemberName(), getSubprojectName(), and getProject() methods which are specific to the type of artifact linked or traced to.

        Throws:
        mks.frame.triggers.TriggerException
        See Also:
        isMemberLink(), getMemberName(), isSubprojectLink(), getSubprojectName(), isProjectLink(), getProject()

      • getMemberName

        public java.lang.String getMemberName()
                               throws mks.frame.triggers.TriggerException
        Return the name of the source member being linked or traced to, or null if the artifact being linked or traced to is not a member. The name returned is the member's path relative to its parent project.
        Throws:
        mks.frame.triggers.TriggerException
        See Also:
        isMemberLink()

      • getSubprojectName

        public java.lang.String getSubprojectName()
                                   throws mks.frame.triggers.TriggerException
        Return the name of the source subproject being linked to, or null if the artifact being linked to is not a subproject. The name returned is the subproject's path relative to its parent project.

        As of the Integrity 10.3 release, traces to subproject artifacts are not supported.

        Throws:
        mks.frame.triggers.TriggerException
        See Also:
        isSubprojectLink()

      • getProject

        public java.lang.String getProject()
                            throws mks.frame.triggers.TriggerException
        Return the name of the project that participates in the artifact being linked or traced to. If the artifact is a member or subproject, this is the name of the member or subproject's parent project. If the artifact is a project, this is the name of the artifact itself.
        Throws:
        mks.frame.triggers.TriggerException

      • getRevision

        public java.lang.String getRevision()
                             throws mks.frame.triggers.TriggerException
        Return the revision of the artifact being linked or traced to. Note that if the artifact is a project, this method and the getProjectRevision() method return identical results.
        Throws:
        mks.frame.triggers.TriggerException

      • getProjectRevision

        public java.lang.String getProjectRevision()
                                    throws mks.frame.triggers.TriggerException
        Return the project revision of the build project that participates in the artifact being linked or traced to, or null if the participating project is not a build project. If the artifact is a member or subproject, the participating project is the member or subproject's parent project. If the artifact is a project, the partcipating project is the artifact itself.
        Throws:
        mks.frame.triggers.TriggerException

      • getConfigPath

        public java.lang.String getConfigPath()
                               throws mks.frame.triggers.TriggerException
        Return the configuration path of the project that participates in the artifact being linked or traced to. If the artifact is a member or subproject, the participating project is the member or subproject's parent project. If the artifact is a project, the participating project is the artifact itself.
        Throws:
        mks.frame.triggers.TriggerException

      • getStartLine

        public java.lang.String getStartLine()
                              throws mks.frame.triggers.TriggerException
        Return the start line number (as a String) of this link or trace.
        Throws:
        mks.frame.triggers.TriggerException

      • getEndLine

        public java.lang.String getEndLine()
                            throws mks.frame.triggers.TriggerException
        Return the end line number (as a String) of this link or trace.
        Throws:
        mks.frame.triggers.TriggerException

      • getDevPath

        public java.lang.String getDevPath()
                            throws mks.frame.triggers.TriggerException
        Return the development path name of the variant project that participates in the artifact being linked or traced to, or null if the participating project is not a variant project. If the artifact is a member or subproject, the participating project is the member or subproject's parent project. If the artifact is a project, the partcipating project is the artifact itself.
        Throws:
        mks.frame.triggers.TriggerException

      • isLive

        public boolean isLive()
        Return true if the revision of the source trace points to :live, false otherwise.