Package com.piketec.tpt.api

Interface Assessment

    • Field Detail

      • CHECK_LOG_ENTRIES_TYPE

        static final java.lang.String CHECK_LOG_ENTRIES_TYPE
        Type String for Check Log Entries Assesslet
        See Also:
        Constant Field Values

      • CONDITION_TREE_TYPE

        static final java.lang.String CONDITION_TREE_TYPE
        Type String for Check Log Entries Assesslet
        See Also:
        Constant Field Values

      • EQUIVALENCE_CLASSES_TYPE

        static final java.lang.String EQUIVALENCE_CLASSES_TYPE
        Type String for Equivalence Classes Assesslet
        See Also:
        Constant Field Values

      • FORMAL_REQUIREMENTS_TYPE

        static final java.lang.String FORMAL_REQUIREMENTS_TYPE
        Type String for Equivalence Classes Assesslet
        See Also:
        Constant Field Values

      • IMPORT_MEASUREMENTS_TYPE

        static final java.lang.String IMPORT_MEASUREMENTS_TYPE
        Type String for Import Measurements Assesslet
        See Also:
        Constant Field Values

      • MATLAB_SCRIPT_TYPE

        static final java.lang.String MATLAB_SCRIPT_TYPE
        Type String for Matlab-Script Assesslet
        See Also:
        Constant Field Values

      • MIN_MAX_COMPARISON_TYPE

        static final java.lang.String MIN_MAX_COMPARISON_TYPE
        Type String for Min/Max Comparison Assesslet
        See Also:
        Constant Field Values

      • REPORT_ASSESSLET_SUMMARY_TABLE_TYPE

        static final java.lang.String REPORT_ASSESSLET_SUMMARY_TABLE_TYPE
        Type String for Report Assesslet Summary Table
        See Also:
        Constant Field Values

      • REPORT_IMAGE_TYPE

        static final java.lang.String REPORT_IMAGE_TYPE
        Type String for Report Image Assesslet
        See Also:
        Constant Field Values

      • REPORT_META_INFORMATION_TYPE

        static final java.lang.String REPORT_META_INFORMATION_TYPE
        Type String for Report Meta Information Assesslet
        See Also:
        Constant Field Values

      • REPORT_PARAGRAPH_TYPE

        static final java.lang.String REPORT_PARAGRAPH_TYPE
        Type String for Report Paragraph Assesslet
        See Also:
        Constant Field Values

      • REPORT_SECTION_TYPE

        static final java.lang.String REPORT_SECTION_TYPE
        Type String for Report Section Assesslet
        See Also:
        Constant Field Values

      • REPORT_SIGNAL_GRAPHIC_TYPE

        static final java.lang.String REPORT_SIGNAL_GRAPHIC_TYPE
        Type String for Report Signal Graphic Assesslet
        See Also:
        Constant Field Values

      • REPORT_SIGNAL_TABLE_TYPE

        static final java.lang.String REPORT_SIGNAL_TABLE_TYPE
        Type String for Report Signal Table Assesslet
        See Also:
        Constant Field Values

      • REPORT_TABLE_OF_CONTENTS_TYPE

        static final java.lang.String REPORT_TABLE_OF_CONTENTS_TYPE
        Type String for Report Table of Contents Assesslet
        See Also:
        Constant Field Values

      • REPORT_TABLE_OF_FIGURES_TYPE

        static final java.lang.String REPORT_TABLE_OF_FIGURES_TYPE
        Type String for Report Table of Figures Assesslet
        See Also:
        Constant Field Values

      • SCRIPT_TYPE

        static final java.lang.String SCRIPT_TYPE
        Type String for Script Assesslet
        See Also:
        Constant Field Values

      • SEQUENCE_CHECK_TYPE

        static final java.lang.String SEQUENCE_CHECK_TYPE
        Type String for Sequence Check Assesslet
        See Also:
        Constant Field Values

      • SIGNAL_COMPARISON_TYPE

        static final java.lang.String SIGNAL_COMPARISON_TYPE
        Type String for Signal Comparison Assesslet
        See Also:
        Constant Field Values

      • TEST_STEP_LIST_ASSESSMENTS_TYPE

        static final java.lang.String TEST_STEP_LIST_ASSESSMENTS_TYPE
        Type String for Step List Assesslet
        See Also:
        Constant Field Values

      • TIMEOUT_TYPE

        static final java.lang.String TIMEOUT_TYPE
        Type String for Timeout Assesslet
        See Also:
        Constant Field Values

      • TRIGGER_RULE_TYPE

        static final java.lang.String TRIGGER_RULE_TYPE
        Type String for Trigger Rule Assesslet
        See Also:
        Constant Field Values

      • VARIABLE_DEFINITIONS_TYPE

        static final java.lang.String VARIABLE_DEFINITIONS_TYPE
        Type String for Variable Definitions Assesslet
        See Also:
        Constant Field Values

      • GLOBAL_SCRIPT_TYPE

        static final java.lang.String GLOBAL_SCRIPT_TYPE
        Type String for Global Script Assesslet
        See Also:
        Constant Field Values

      • GLOBAL_VARIABLE_TYPE

        static final java.lang.String GLOBAL_VARIABLE_TYPE
        Type String for Global Variable Assesslet
        See Also:
        Constant Field Values

      • GLOBAL_EQUIVALENCE_CLASSES_TYPE

        static final java.lang.String GLOBAL_EQUIVALENCE_CLASSES_TYPE
        Type String for Global Equivalence Classes Assesslet
        See Also:
        Constant Field Values

      • REPORT_LINKED_REQUIREMENTS_TYPE

        @Deprecated
static final java.lang.String REPORT_LINKED_REQUIREMENTS_TYPE
        Deprecated.
        Will be removed in TPT-20.
        See Also:
        Constant Field Values

      • REQUIREMENTS_COVERAGE_TYPE

        static final java.lang.String REQUIREMENTS_COVERAGE_TYPE
        Type String for Requirements Coverage Assesslet
        See Also:
        Constant Field Values

    • Method Detail

      • getType

        java.lang.String getType()
                  throws java.rmi.RemoteException
        Returns:
        The name of the assessment type.
        Throws:
        java.rmi.RemoteException - remote communication problem

      • getDescription

        java.lang.String getDescription()
                         throws java.rmi.RemoteException
        Returns:
        The value of the description field in the assessment header.
        Throws:
        java.rmi.RemoteException - remote communication problem

      • getUsing

        java.lang.String getUsing()
                   throws ApiException,
                          java.rmi.RemoteException
        Returns:
        A comma separated list of the used namespaces for the assessment.
        Throws:
        java.rmi.RemoteException - remote communication problem
        ApiException - if assessment does not support using

      • setUsing

        void setUsing​(java.lang.String using)
       throws ApiException,
              java.rmi.RemoteException
        Set the used namespace(s) for the assessment. For more namespaces provide a comma separated list.
        Parameters:
        using - The new namespace(s) that shall be used.
        Throws:
        java.rmi.RemoteException - remote communication problem
        ApiException - if assessment does not support using

      • setDescription

        void setDescription​(java.lang.String description)
             throws java.rmi.RemoteException
        Set the value for the description field of the assessment header. Null will be reduced to an empty string.
        Parameters:
        description - The new description of the assessment.
        Throws:
        java.rmi.RemoteException - remote communication problem

      • getSelectedVariantsOrGroups

        RemoteCollection<ScenarioOrGroup> getSelectedVariantsOrGroups()
                                                       throws java.rmi.RemoteException
        Returns a list of variants and variant groups, for which the assessment is enabled. Returns an empty list, if the assssement is enabled for all variants. If a group is contained in the set all descendent scenarios in this group are contained in the set as well. Removing an element will remove parent elements as well to retain this constraint. Please note that removing a group will only disable the group, but leave all its subelements enabled.
        Returns:
        A set of variants.
        Throws:
        java.rmi.RemoteException - remote communication problem
        ApiException - if assessment does not support enabling for variants

      • enableForVariant

        void enableForVariant​(ScenarioOrGroup sog)
               throws java.rmi.RemoteException
        Enables the assessment for a variant or variant group. To disable, use getSelectedVariantsOrGroups() and remove the desired objects.
        Please note that using this method to enable a group will also recursively enable all its subelements. Removing a group however will only disable the group, but leave all its subelements enabled.
        Parameters:
        sog - The variant / variant group (ScenarioOrGroup) for which the assesslet should be enabled.
        Throws:
        java.rmi.RemoteException - remote communication problem
        ApiException - if assessment does not support enabling for variants

      • getSelectedTestCasesOrGroups

        RemoteCollection<ScenarioOrGroup> getSelectedTestCasesOrGroups()
                                                        throws java.rmi.RemoteException
        Returns a list of test cases and test case groups, for which the assessment is enabled. If a group is contained in the set all descendent scenarios in this group are contained in the set as well. Removing an element will remove parent elements as well to retain this constraint. Please note that removing a group will only disable the group, but leave all its subelements enabled.
        Returns:
        A set of test cases.
        Throws:
        java.rmi.RemoteException - remote communication problem
        ApiException - if assessment does not support enabling for test cases

      • enableForTestCase

        void enableForTestCase​(ScenarioOrGroup sog)
                throws java.rmi.RemoteException
        Enables the assessment for a test case or test case group. To disable, use getSelectedTestCasesOrGroups() and remove the desired objects.
        Please note that using this method to enable a group will also recursively enable all its subelements. Removing a group however will only disable the group, but leave all its subelements enabled.
        Parameters:
        sog - A test case or test case group (ScenarioOrGroup), the test case should be enabled for.
        Throws:
        java.rmi.RemoteException - remote communication problem
        ApiException - if assessment does not support enabling for test cases

      • getEnabledPlatformConfigurationsOrExecutionConfigurationItems

        RemoteList<PlatformOrExecutionItemEnabler> getEnabledPlatformConfigurationsOrExecutionConfigurationItems()
                                                                                                  throws java.rmi.RemoteException
        Returns a list of platform configurations, execution configurations and execution configuration items for which the assessment is enabled. Returns an empty list, if the Assessment is enabled for all platforms and all execution configuration items.
        Returns:
        A list of platform configurations, execution configurations and execution configuration items (PlatformOrExecutionItemEnabler)
        Throws:
        java.rmi.RemoteException - remote communication problem

      • enableForExecutionConfiguration

        void enableForExecutionConfiguration​(ExecutionConfiguration ec)
                              throws java.rmi.RemoteException
        Enables the assessment for a particular a ExecutionConfiguration.
        Parameters:
        ec - The ExecutionConfiguration, the assessment should be enabled for.
        Throws:
        java.rmi.RemoteException - remote communication problem
        ApiException - if assessment does not support enabling for ExecutionConfigurations

      • getProperties

        PropertyMap getProperties()
                   throws java.rmi.RemoteException
        Returns the properties of the assessment as PropertyMap.

        A PropertyMap maps the properties as follows: String -> Property. A Property is either a PropertyMap or a String value.

        The structure of the PropertyMap depends on the type of the assessment.
        Returns:
        A PropertyMap with the settings for the assessments.
        Throws:
        java.rmi.RemoteException - remote communication problem

      • setProperties

        void setProperties​(PropertyMap properties)
            throws java.rmi.RemoteException

        Configures the assessment with the provided PropertyMap.

        To remove a removable property, e.g. a report section, set it to null.

        It is strongly recommended to modify the PropertyMap returned by getProperties()
        Parameters:
        properties - A PropertyMap containing the settings.
        Throws:
        java.rmi.RemoteException - remote communication problem

      • getActiveTestCases

        java.util.Set<Scenario> getActiveTestCases()
                                    throws java.rmi.RemoteException
        Returns all active test cases with respect to the variant context.
        Returns:
        set of active test cases
        Throws:
        java.rmi.RemoteException - remote communication problem
        ApiException - if assessment cannot be activated for test cases

      • getLinkedRequirements

        RemoteCollection<Requirement> getLinkedRequirements()
                                             throws java.rmi.RemoteException
        Get all requirements currently linked to this assesslet. The content of the collection is only a snapshot of the current state but removing items from this list will remove the link in TPT anyway even if the link was created after receiving this collection.
        Returns:
        The currently linked requirements.
        Throws:
        java.rmi.RemoteException - remote communication problem

      • getCompileError

        java.lang.String getCompileError()
                          throws java.rmi.RemoteException
        Returns null if assessment can be compiled without errors, the compile error message otherwise.
        Returns:
        The compile error message or null.
        Throws:
        java.rmi.RemoteException - remote communication problem

      • getCurrentStatus

        Status getCurrentStatus()
                 throws java.rmi.RemoteException
        Returns the current status of the assessment.
        Returns:
        The current status or null if status is "new".
        Throws:
        java.rmi.RemoteException - remote communication problem

      • getStatusHistory

        RemoteList<Status> getStatusHistory()
                             throws java.rmi.RemoteException
        Returns a list of all status history entries of the assessment, the newest comes first.
        Returns:
        A list of all Statuses.
        Throws:
        java.rmi.RemoteException - remote communication problem

      • checkForNewRevision

        boolean checkForNewRevision()
                     throws java.rmi.RemoteException
        Returns true if this assessment has been modified since the last status history entry or if it has no revision. Otherwise, returns false.
        Returns:
        • true if it is modified or new
        • false if it is not modified
        Throws:
        java.rmi.RemoteException - remote communication problem

      • isStatusOutdated

        boolean isStatusOutdated()
                  throws java.rmi.RemoteException
        Returns true if this assessment is marked as "modified"(=outdated) or has no revision. Otherwise, returns false.
        Returns:
        • true if it is outdated or new
        • false if it is up-to-date
        Throws:
        java.rmi.RemoteException - remote communication problem

      • isGlobal

        boolean isGlobal()
          throws java.rmi.RemoteException
        Returns true if this assessment is global
        Returns:
        • true if it is a global assessment
        • false if it is not a global assessment
        Throws:
        java.rmi.RemoteException - remote communication problem

      • setReportSection

        void setReportSection​(Assessment reportSecAssessment)
               throws ApiException,
                      java.rmi.RemoteException
        Set the report section for the assessment.
        Parameters:
        reportSecAssessment - Assesslet to be set as the report section or null if the <Top-Level> should be set.
        Throws:
        ApiException - if reportSecAssessment is not a report section assesslet
        java.rmi.RemoteException - remote communication problem