Appendix B. Model API Reference

 
                        public interface de.verit.klaros.core.model.IKlarosAttachment {
// Public Methods  public java.lang.String getUuid();
                        
}

B.1.1.1.2. getUuid()

public java.lang.String getUuid();

Get the uuid.

Parameters
return	The uuid of this attachment.

B.1.1.2. Interface IKlarosConfiguration

This interface provides access to data of a project's configuration.

B.1.1.2.1. Synopsis

 
                        public interface de.verit.klaros.core.model.IKlarosConfiguration {
// Public Methods  public java.lang.String getDescription();
                        

                          public java.util.Set<de.verit.klaros.core.model.KlarosTestEnvironment> getEnvs();
                        

                          public java.lang.String getName();
                        

                          public java.util.Set<de.verit.klaros.core.model.KlarosSUTImplementation> getSuts();
                        

                          public java.util.Set<de.verit.klaros.core.model.KlarosTestCase> getTestCases();
                        

                          public java.util.Set<de.verit.klaros.core.model.KlarosTestRequirement> getTestRequirements();
                        

                          public java.util.Set<de.verit.klaros.core.model.KlarosTestRun> getTestRuns();
                        

                          public java.util.Set<de.verit.klaros.core.model.KlarosTestSuite> getTestSuites();
                        

                          public java.lang.Boolean isEnabled();
                        

                          public java.lang.Boolean isSecured();
                        
}

B.1.1.2.2. getDescription()

public java.lang.String getDescription();

Returns the project description.

Parameters
return	The description of the project.

B.1.1.2.3. getEnvs()

public java.util.Set<de.verit.klaros.core.model.KlarosTestEnvironment> getEnvs();

Returns the project test environments.

Parameters
return	Set containing the test environments of the project.

B.1.1.2.4. getName()

public java.lang.String getName();

Returns the project name.

Parameters
return	The name of the project.

B.1.1.2.5. getSuts()

public java.util.Set<de.verit.klaros.core.model.KlarosSUTImplementation> getSuts();

Returns the project SUTs (systems under test).

Parameters
return	KlarosSet containing the SUT objects of the project.

B.1.1.2.6. getTestCases()

public java.util.Set<de.verit.klaros.core.model.KlarosTestCase> getTestCases();

Returns the project test cases.

Parameters
return	Set containing the test case objects of the project.

B.1.1.2.7. getTestRequirements()

public java.util.Set<de.verit.klaros.core.model.KlarosTestRequirement> getTestRequirements();

Returns the project test requirements.

Parameters
return	Set containing the test requirement objects of the project.

B.1.1.2.8. getTestRuns()

public java.util.Set<de.verit.klaros.core.model.KlarosTestRun> getTestRuns();

Returns the project test runs.

Parameters
return	Set containing the test run objects of the project.

B.1.1.2.9. getTestSuites()

public java.util.Set<de.verit.klaros.core.model.KlarosTestSuite> getTestSuites();

Returns the project test suites.

Parameters
return	Set containing the test suite objects of the project.

B.1.1.2.10. isEnabled()

public java.lang.Boolean isEnabled();

Returns whether this project is enabled or not.

Parameters
return	true if this project is enabled and active, false if not.

B.1.1.2.11. isSecured()

public java.lang.Boolean isSecured();

Returns whether this project is secured or not.

Parameters
return	true if this project is secured, false if not.

B.1.1.3. Interface IKlarosExternalImplementation

This interface provides access to the information about the implementation of a test case.

B.1.1.3.1. Synopsis

 
                        public interface de.verit.klaros.core.model.IKlarosExternalImplementation extends, de.verit.klaros.core.model.IKlarosExternalLink {
// Public Methods  public java.lang.String getDate();
                        

                          public de.verit.klaros.core.model.KlarosTestCase getImplementationOf();
                        
}

B.1.1.3.2. getDate()

public java.lang.String getDate();

get date.

Parameters
return	`String` containing the date of the creation of this implementation.

B.1.1.3.3. getImplementationOf()

public de.verit.klaros.core.model.KlarosTestCase getImplementationOf();

Get related test case.

Parameters
return	The test case for which this is an implementation.

B.1.1.4. Interface IKlarosExternalLink

This interface provides access to externally stored information about an object.

B.1.1.4.1. Synopsis

 
                        public interface de.verit.klaros.core.model.IKlarosExternalLink {
// Public Methods  public java.lang.String getReference();
                        
}

B.1.1.4.2. getReference()

public java.lang.String getReference();

Get the reference to the externally stored information.

Parameters
return	The reference to the information.

B.1.1.5. Interface IKlarosIssue

This interface provides access to a software issue.

B.1.1.5.1. Synopsis

 
                        public interface de.verit.klaros.core.model.IKlarosIssue {
// Public Methods  public java.lang.String getDescription();
                        

                          public java.util.Set<de.verit.klaros.core.model.KlarosTestCaseState> getStates();
                        

                          public java.util.List<de.verit.klaros.core.model.KlarosTestCase> getTestCases();
                        
}

B.1.1.5.2. getDescription()

public java.lang.String getDescription();

Get the description.

Parameters
return	The description of this issue.

B.1.1.5.3. getStates()

public java.util.Set<de.verit.klaros.core.model.KlarosTestCaseState> getStates();

Get the related test case states.

Parameters
return	`Set` of test cases states which exists because this issue is 'active' (created but not solved).

B.1.1.5.4. getTestCases()

public java.util.List<de.verit.klaros.core.model.KlarosTestCase> getTestCases();

Get the related test cases.

Parameters
return	`List` of test cases which have detected this issue.

B.1.1.6. Interface IKlarosNamedEntity

This interface provides access to data of a properties owner.

B.1.1.6.1. Synopsis

 
                        public interface de.verit.klaros.core.model.IKlarosNamedEntity {
// Public Methods  public java.lang.String getName();
                        

                          public java.util.List<java.lang.String> getPropertyAsList(java.lang.String name);
                        

                          public java.lang.String getPropertyAsString(java.lang.String name);
                        

                          public boolean isDefinedProperty(java.lang.String propertyName);
                        
}

B.1.1.6.2. getName()

public java.lang.String getName();

Get name.

Parameters
return	The name of the properties owner.

B.1.1.6.3. getPropertyAsList(String)

public java.util.List<java.lang.String> getPropertyAsList(java.lang.String name);

Get the generic property as a List.

Parameters
name	The property's name.
return	The property's value in a list.

B.1.1.6.4. getPropertyAsString(String)

public java.lang.String getPropertyAsString(java.lang.String name);

Get the generic property as a String.

Parameters
name	The property's name.
return	The property's value in a single string.

B.1.1.6.5. isDefinedProperty(String)

public boolean isDefinedProperty(java.lang.String propertyName);

Check if a property identified by given name is a defined property.

Parameters
propertyName	The name of the property to check.
return	`true` if the identified property is a defined property, `false` else.

B.1.1.7. Interface IKlarosProject

This interface provides access to data of a test project.

B.1.1.7.1. Synopsis

 
                        public interface de.verit.klaros.core.model.IKlarosProject extends, de.verit.klaros.core.model.IKlarosNamedEntity {
// Public Methods  public boolean isDefinedProperty(java.lang.String propertyName);
                        
}

B.1.1.7.2. isDefinedProperty(String)

public boolean isDefinedProperty(java.lang.String propertyName);

Specified by: Method isDefinedProperty in interface IKlarosNamedEntity

Check if a property identified by given name is a defined property.

Parameters
propertyName	The name of the property to check.
return	`true` if the identified property is a defined property, `false` else.

B.1.1.8. Interface IKlarosRequirementGroup

The interface to retrieve the information about a requirement group.

B.1.1.8.1. Synopsis

 
                        public interface de.verit.klaros.core.model.IKlarosRequirementGroup extends, de.verit.klaros.core.model.IKlarosNamedEntity {
// Public Methods  public java.util.Set<de.verit.klaros.core.model.KlarosTestRequirement> getAllTestRequirements();
                        

                          public java.util.Set<de.verit.klaros.core.model.KlarosRequirementGroup> getChildren();
                        

                          public double getCoverage();
                        

                          public java.lang.Integer getDepth();
                        

                          public java.util.List<de.verit.klaros.core.model.KlarosRequirementGroup> getDescendants();
                        

                          public java.util.List<de.verit.klaros.core.model.KlarosRequirementGroup> getFamily();
                        

                          public int getNumberCoveredRequirements();
                        

                          public int getNumberRequirements();
                        

                          public de.verit.klaros.core.model.KlarosRequirementGroup getParent();
                        

                          public java.util.Set<de.verit.klaros.core.model.KlarosTestRequirement> getTestRequirements();
                        
}

B.1.1.8.2. getAllTestRequirements()

public java.util.Set<de.verit.klaros.core.model.KlarosTestRequirement> getAllTestRequirements();

Get all test requirements of this group hierarchy.

Parameters
return	`List` containing own test requirements and all test requirements of groups which are descendants of this group.

B.1.1.8.3. getChildren()

public java.util.Set<de.verit.klaros.core.model.KlarosRequirementGroup> getChildren();

Get the children of this requirement group.

Parameters
return	`Set` containing the requirement groups that are children of this requirement group.

B.1.1.8.4. getCoverage()

public double getCoverage();

Get test requirement coverage for the group.

Parameters
return	the coverage in percent. If no requirements are found, `1.0` is returned.

B.1.1.8.5. getDepth()

public java.lang.Integer getDepth();

Get depth in tree of this node.

Parameters
return	The depth in the tree

B.1.1.8.6. getDescendants()

public java.util.List<de.verit.klaros.core.model.KlarosRequirementGroup> getDescendants();

Get all descending subgroups of this group.

Parameters
return	`List` containing all groups which are descendants of this group.

B.1.1.8.7. getFamily()

public java.util.List<de.verit.klaros.core.model.KlarosRequirementGroup> getFamily();

Get whole family with this group as root.

Parameters
return	List containing this group and all of its descendants.

B.1.1.8.8. getNumberCoveredRequirements()

public int getNumberCoveredRequirements();

Get number of test requirements covered by at least one test case.

Parameters
return	The number of covered test requirements.

B.1.1.8.9. getNumberRequirements()

public int getNumberRequirements();

Get number of test requirements, including all descendants' test requirements.

Parameters
return	The number of overall test requirements.

B.1.1.8.10. getParent()

public de.verit.klaros.core.model.KlarosRequirementGroup getParent();

Get the parent of this requirement group.

Parameters
return	The parent requirement group, or `null`.

B.1.1.8.11. getTestRequirements()

public java.util.Set<de.verit.klaros.core.model.KlarosTestRequirement> getTestRequirements();

Get the related test requirements of this requirement group.

Parameters
return	`Set` containing the test requirements which belong to this requirement group.

B.1.1.9. Interface IKlarosRevision

This interface provides access to a revisionable klaros object.

B.1.1.9.1. Synopsis

 
                        public interface de.verit.klaros.core.model.IKlarosRevision extends, de.verit.klaros.core.model.IKlarosNamedEntity {
// Public Methods  public de.verit.klaros.core.model.KlarosRevision<?, ?> getBranchRoot();
                        

                          public java.util.Set<de.verit.klaros.core.model.KlarosRevision<?, ?>> getBranches();
                        

                          public de.verit.klaros.core.model.KlarosRevision<?, ?> getPredecessor();
                        

                          public java.lang.String getRevisionComment();
                        

                          public java.lang.String getRevisionId();
                        

                          public de.verit.klaros.core.model.KlarosRevision<?, ?> getRoot();
                        

                          public de.verit.klaros.core.model.KlarosRevision<?, ?> getSuccessor();
                        

                          public java.util.Set<de.verit.klaros.core.model.KlarosTag> getTags();
                        

                          public de.verit.klaros.core.model.KlarosRevision<?, ?> getTrunkRoot();
                        
}

B.1.1.9.2. getBranches()

public java.util.Set<de.verit.klaros.core.model.KlarosRevision<?, ?>> getBranches();

Get branches of this revision.

Parameters
return	`Set` containing all revision objects which have been created as first revision of a branch (trunk root) and habe been created using this revision.

B.1.1.9.3. getBranchRoot()

public de.verit.klaros.core.model.KlarosRevision<?, ?> getBranchRoot();

Get the original revision of a trunk root revision object.

Parameters
return	The revision object that has been used to create a new branch.

B.1.1.9.4. getPredecessor()

public de.verit.klaros.core.model.KlarosRevision<?, ?> getPredecessor();

Get the predecessor of the revision.

Parameters
return	The revision object that is the predecessor of this revision.

B.1.1.9.5. getRevisionComment()

public java.lang.String getRevisionComment();

Get comment.

Parameters
return	The comment of the revision.

B.1.1.9.6. getRevisionId()

public java.lang.String getRevisionId();

Get the revision id.

Parameters
return	The revision id.

B.1.1.9.7. getRoot()

public de.verit.klaros.core.model.KlarosRevision<?, ?> getRoot();

Get the root of the revision hierarchy.

Parameters
return	The root revision object.

B.1.1.9.8. getSuccessor()

public de.verit.klaros.core.model.KlarosRevision<?, ?> getSuccessor();

Get the successor of the revision.

Parameters
return	The revision object that is the successor of this revision.

B.1.1.9.9. getTags()

public java.util.Set<de.verit.klaros.core.model.KlarosTag> getTags();

Get tags of this revision.

Parameters
return	`Set` containing all tags this revision belongs to.

B.1.1.9.10. getTrunkRoot()

public de.verit.klaros.core.model.KlarosRevision<?, ?> getTrunkRoot();

Get the 'root' of a trunk.

Parameters
return	the revision which is the first revision of the branch to which this revision belongs.

B.1.1.10. Interface IKlarosSUTImplementation

This interface provides access to data of a system under test version.

B.1.1.10.1. Synopsis

 
                        public interface de.verit.klaros.core.model.IKlarosSUTImplementation extends, de.verit.klaros.core.model.IKlarosRevision {
// Public Methods  public de.verit.klaros.core.model.KlarosConfiguration getConfiguration();
                        

                          public java.lang.String getCreator();
                        

                          public int getNumberStates(java.lang.String name);
                        

                          public java.lang.String getProductversion();
                        

                          public java.util.Set<?> getTestCaseStates();
                        

                          public java.util.List<de.verit.klaros.core.model.KlarosTestCaseState> getTestCaseStates(java.lang.String name);
                        

                          public java.util.Set<?> getTestRuns();
                        

                          public java.lang.Boolean isEnabled();
                        
}

B.1.1.10.2. getConfiguration()

public de.verit.klaros.core.model.KlarosConfiguration getConfiguration();

Get configuration.

Parameters
return	The related configuration.

B.1.1.10.3. getCreator()

public java.lang.String getCreator();

Parameters
return	The name of the creator.

B.1.1.10.4. getNumberStates(String)

public int getNumberStates(java.lang.String name);

Get number of test case states which are related to this revision and have the given name.

Parameters
name	The name of the states to look for
return	number of states with given name and relation to this SUT object

B.1.1.10.5. getProductversion()

public java.lang.String getProductversion();

Get product version.

Parameters
return	The version id of the system under test.

B.1.1.10.6. getTestCaseStates()

public java.util.Set<?> getTestCaseStates();

Get test case states.

Parameters
return	`Set` of test case states related to the SUT version.

B.1.1.10.7. getTestCaseStates(String)

public java.util.List<de.verit.klaros.core.model.KlarosTestCaseState> getTestCaseStates(java.lang.String name);

Get test case states which are related to this revision and have the given name.

Parameters
name	The name of the states to look for
return	Set of the states with given name

B.1.1.10.8. getTestRuns()

public java.util.Set<?> getTestRuns();

Get test runs.

Parameters
return	`Set` of test runs performed for this SUT version.

B.1.1.10.9. isEnabled()

public java.lang.Boolean isEnabled();

Check if enabled.

Parameters
return	true if enabled

B.1.1.11. Interface IKlarosStatusMessage

This class provides access to data of a test case.

B.1.1.11.1. Synopsis

 
                        public interface de.verit.klaros.core.model.IKlarosStatusMessage {
// Public Methods  public java.lang.String getMessage();
                        

                          public java.lang.String getStatus();
                        

                          public java.util.Date getTimestamp();
                        

                          public de.verit.klaros.core.persistent.User getUser();
                        
}

B.1.1.11.2. getMessage()

public java.lang.String getMessage();

Get the message of the status message.

Parameters
return	`String` of the message of the status message.

B.1.1.11.3. getStatus()

public java.lang.String getStatus();

Get the status of the status message.

Parameters
return	`String` of the status of the status message.

B.1.1.11.4. getTimestamp()

public java.util.Date getTimestamp();

Get the timestamp of the status message.

Parameters
return	`timestamp` of the status message.

B.1.1.11.5. getUser()

public de.verit.klaros.core.persistent.User getUser();

Get the user of the status message.

Parameters
return	`User` of the status message.

B.1.1.12. Interface IKlarosTag

This interface provides access to the data of a tag.

B.1.1.12.1. Synopsis

 
                        public interface de.verit.klaros.core.model.IKlarosTag {
// Public Methods  public java.util.Set<de.verit.klaros.core.model.KlarosRevision<?, ?>> getRevisions();
                        

                          public java.lang.String getTagId();
                        

                          public java.util.Date getTimestamp();
                        
}

B.1.1.12.2. getRevisions()

public java.util.Set<de.verit.klaros.core.model.KlarosRevision<?, ?>> getRevisions();

Get related revisions.

Parameters
return	`Collection` of revision objects which are related to this tag.

B.1.1.12.3. getTagId()

public java.lang.String getTagId();

Get tag id.

Parameters
return	The id of the tag.

B.1.1.12.4. getTimestamp()

public java.util.Date getTimestamp();

Get timestamp.

Parameters
return	The time of the creation of the tag as a `Date` object.

B.1.1.13. Interface IKlarosTestCase

This class provides access to data of a test case.

B.1.1.13.1. Synopsis

 
                        public interface de.verit.klaros.core.model.IKlarosTestCase extends, de.verit.klaros.core.model.IKlarosRevision {
// Public Methods  public de.verit.klaros.core.types.TestAreatopic getArea();
                        

                          public de.verit.klaros.core.model.KlarosConfiguration getConfiguration();
                        

                          public java.util.Set<de.verit.klaros.core.model.KlarosTestRequirement> getCovers();
                        

                          public java.util.Date getCreated();
                        

                          public java.lang.String getCreatedString(java.util.Locale locale);
                        

                          public de.verit.klaros.core.model.KlarosUser getCreator();
                        

                          public java.lang.String getDependency();
                        

                          public java.lang.String getDescription();
                        

                          public de.verit.klaros.core.types.TestDesignTechnique getDesignTechnique();
                        

                          public java.util.List<de.verit.klaros.core.model.KlarosIssue> getDetectedIssues();
                        

                          public java.lang.String getDocbase();
                        

                          public java.lang.String getEvaluation();
                        

                          public de.verit.klaros.core.types.TestExecutionMethod getExecution();
                        

                          public java.lang.String getExpectedResult();
                        

                          public de.verit.klaros.core.model.KlarosExternalImplementation getImplementation();
                        

                          public de.verit.klaros.core.types.TestLevel getLevel();
                        

                          public java.lang.String getNote();
                        

                          public java.lang.String getPostcondition();
                        

                          public java.lang.String getPrecondition();
                        

                          public de.verit.klaros.core.types.TestPriority getPriority();
                        

                          public java.util.Set<de.verit.klaros.core.model.KlarosTestCaseResult> getResults();
                        

                          public java.lang.String getShortname();
                        

                          public java.lang.String getState();
                        

                          public java.lang.String getStateName(de.verit.klaros.core.model.KlarosSUTImplementation sut);
                        

                          public java.util.Map<de.verit.klaros.core.model.KlarosSUTImplementation, de.verit.klaros.core.model.KlarosTestCaseState> getStates();
                        

                          public java.lang.String getTeam();
                        

                          public java.util.List<de.verit.klaros.core.model.KlarosTestCaseStep> getTestCaseSteps();
                        

                          public java.lang.String getTraceability();
                        

                          public de.verit.klaros.core.types.TestVariety getVariety();
                        
}

B.1.1.13.2. getArea()

public de.verit.klaros.core.types.TestAreatopic getArea();

The area of this test case.

Parameters
return	The area.

B.1.1.13.3. getConfiguration()

public de.verit.klaros.core.model.KlarosConfiguration getConfiguration();

Get configuration.

Parameters
return	The related configuration.

B.1.1.13.4. getCovers()

public java.util.Set<de.verit.klaros.core.model.KlarosTestRequirement> getCovers();

Get covered test requirements.

Parameters
return	`Set` of test requirements which are covered by this test case revision.

B.1.1.13.5. getCreated()

public java.util.Date getCreated();

The creation date of this test case.

Parameters
return	The creation date.

B.1.1.13.6. getCreatedString(Locale)

public java.lang.String getCreatedString(java.util.Locale locale);

Formats a date with the given locale and returns it as string.

Parameters
locale	The locale.
return	The formated date string.

B.1.1.13.7. getCreator()

public de.verit.klaros.core.model.KlarosUser getCreator();

Parameters
return	The creator of this test case.

B.1.1.13.8. getDependency()

public java.lang.String getDependency();

The dependency of this test case.

Parameters
return	The dependency.

B.1.1.13.9. getDescription()

public java.lang.String getDescription();

The description of this test case.

Parameters
return	The description.

B.1.1.13.10. getDesignTechnique()

public de.verit.klaros.core.types.TestDesignTechnique getDesignTechnique();

The design technique of this test case.

Parameters
return	The type.

B.1.1.13.11. getDetectedIssues()

public java.util.List<de.verit.klaros.core.model.KlarosIssue> getDetectedIssues();

Get detected issues.

Parameters
return	`List` of issues which have been detected by this test case revision.

B.1.1.13.12. getDocbase()

public java.lang.String getDocbase();

The docbase of this test case.

Parameters
return	The docbase.

B.1.1.13.13. getEvaluation()

public java.lang.String getEvaluation();

The evaluation of this test case.

Parameters
return	The evaluation.

B.1.1.13.14. getExecution()

public de.verit.klaros.core.types.TestExecutionMethod getExecution();

The execution method of this test case.

Parameters
return	The execution method.

B.1.1.13.15. getExpectedResult()

public java.lang.String getExpectedResult();

The expected result of this test case.

Parameters
return	The expected result.

B.1.1.13.16. getImplementation()

public de.verit.klaros.core.model.KlarosExternalImplementation getImplementation();

Get implementation.

Parameters
return	The object describing the location of the implementation of this test case revision.

B.1.1.13.17. getLevel()

public de.verit.klaros.core.types.TestLevel getLevel();

The level of this test case.

Parameters
return	The level.

B.1.1.13.18. getNote()

public java.lang.String getNote();

The note of this test case.

Parameters
return	The note.

B.1.1.13.19. getPostcondition()

public java.lang.String getPostcondition();

The postcondition of this test case.

Parameters
return	The postcondition.

B.1.1.13.20. getPrecondition()

public java.lang.String getPrecondition();

The precondition of this test case.

Parameters
return	The precondition.

B.1.1.13.21. getPriority()

public de.verit.klaros.core.types.TestPriority getPriority();

The priority of this test case.

Parameters
return	The priority.

B.1.1.13.22. getResults()

public java.util.Set<de.verit.klaros.core.model.KlarosTestCaseResult> getResults();

Get test case results.

Parameters
return	`Set` of results of executions of this test case revision.

B.1.1.13.23. getShortname()

public java.lang.String getShortname();

The short name (title) of this test case.

Parameters
return	The short name.

B.1.1.13.24. getState()

public java.lang.String getState();

The type of this test case.

Parameters
return	The type.

B.1.1.13.25. getStateName(KlarosSUTImplementation)

public java.lang.String getStateName(de.verit.klaros.core.model.KlarosSUTImplementation sut);

Get name of the state related to given SUT.

Parameters
sut	The related SUT implementation
return	The name of the state

B.1.1.13.26. getStates()

public java.util.Map<de.verit.klaros.core.model.KlarosSUTImplementation, de.verit.klaros.core.model.KlarosTestCaseState> getStates();

Get test case states.

Parameters
return	`Collection` of the states of this test case revision in relation to the different SUT versions..

B.1.1.13.27. getTeam()

public java.lang.String getTeam();

The team responsible for this test case.

Parameters
return	The team.

B.1.1.13.28. getTestCaseSteps()

public java.util.List<de.verit.klaros.core.model.KlarosTestCaseStep> getTestCaseSteps();

Get test case steps.

Parameters
return	`list` of steps of this test case revision.

B.1.1.13.29. getTraceability()

public java.lang.String getTraceability();

The traceability of this test case.

Parameters
return	The traceability.

B.1.1.13.30. getVariety()

public de.verit.klaros.core.types.TestVariety getVariety();

The variety of this test case.

Parameters
return	The variety.

B.1.1.14. Interface IKlarosTestCaseResult

This interface provides access to data of a test case result.

B.1.1.14.1. Synopsis

 
                        public interface de.verit.klaros.core.model.IKlarosTestCaseResult extends, de.verit.klaros.core.model.IKlarosNamedEntity {
// Public Methods  public java.lang.String getDescription();
                        

                          public long getExecutionTime();
                        

                          public java.lang.String getSummary();
                        

                          public de.verit.klaros.core.model.KlarosTestCase getTestCase();
                        

                          public de.verit.klaros.core.model.KlarosTestRun getTestRun();
                        

                          public boolean isError();
                        

                          public boolean isFailure();
                        

                          public boolean isPassed();
                        

                          public boolean isSkipped();
                        
}

B.1.1.14.2. getDescription()

public java.lang.String getDescription();

Get the test result description. This is usually set for failed/error status results.

Parameters
return	The test result description.

B.1.1.14.3. getExecutionTime()

public long getExecutionTime();

Get the test execution time in ms.

Parameters
return	The test execution time.

B.1.1.14.4. getSummary()

public java.lang.String getSummary();

Get the test result summary. This is usually set for failed/error status results.

Parameters
return	The test result summary.

B.1.1.14.5. getTestCase()

public de.verit.klaros.core.model.KlarosTestCase getTestCase();

Get test case.

Parameters
return	The test case that has been executed to get this result.

B.1.1.14.6. getTestRun()

public de.verit.klaros.core.model.KlarosTestRun getTestRun();

Get test run.

Parameters
return	The test run that created this result.

B.1.1.14.7. isError()

public boolean isError();

Check if this is an error result.

It is assumed, that error results have a property 'type' with the value 'E' or 'error'.

Parameters
return	`true` if this results represents an error.

B.1.1.14.8. isFailure()

public boolean isFailure();

Check if this is a failure result.

It is assumed, that failure results have a property 'type' with the value 'F' or 'failure'.

Parameters
return	`true` if this results represents a failure.

B.1.1.14.9. isPassed()

public boolean isPassed();

Check if this is a result of a passed test case.

It is assumed, that passed results have a property 'testCasePassed' with value 'true'.

Parameters
return	`true` if this results represents an error.

B.1.1.14.10. isSkipped()

public boolean isSkipped();

Check if this is a skipped result.

It is assumed, that skipped results have a property 'type' with the value 'S' or 'skipped'.

Parameters
return	`true` if this results represents a skipped result.

B.1.1.15. Interface IKlarosTestCaseState

This interface provides access to data of a test case state.

B.1.1.15.1. Synopsis

 
                        public interface de.verit.klaros.core.model.IKlarosTestCaseState {
// Public Methods  public java.lang.String getStateDescription();
                        

                          public java.lang.String getStateName();
                        

                          public de.verit.klaros.core.model.KlarosSUTImplementation getSut();
                        

                          public de.verit.klaros.core.model.KlarosTestCase getTestCase();
                        
}

B.1.1.15.2. getStateDescription()

public java.lang.String getStateDescription();

Get description of state.

Parameters
return	The description of this state.

B.1.1.15.3. getStateName()

public java.lang.String getStateName();

Get name of state.

Parameters
return	The name of this state.

B.1.1.15.4. getSut()

public de.verit.klaros.core.model.KlarosSUTImplementation getSut();

Get related system under test version.

Parameters
return	The related SUT version.

B.1.1.15.5. getTestCase()

public de.verit.klaros.core.model.KlarosTestCase getTestCase();

Get test case.

Parameters
return	The test case whose state is defined by this state object.

B.1.1.16. Interface IKlarosTestCaseStep

This interface provides access to a software issue.

B.1.1.16.1. Synopsis

 
                        public interface de.verit.klaros.core.model.IKlarosTestCaseStep {
// Public Methods  public java.lang.String getAction();
                        

                          public java.util.List<de.verit.klaros.core.model.KlarosAttachment> getAttachments();
                        

                          public java.lang.String getPostcondition();
                        

                          public java.lang.String getPrecondition();
                        
}

B.1.1.16.2. getAction()

public java.lang.String getAction();

Get the action.

Parameters
return	The action of this test case step.

B.1.1.16.3. getAttachments()

public java.util.List<de.verit.klaros.core.model.KlarosAttachment> getAttachments();

Get the attachments.

Parameters
return	The attachments of this test case step.

B.1.1.16.4. getPostcondition()

public java.lang.String getPostcondition();

Get the post condition.

Parameters
return	The post condition of this test case step.

B.1.1.16.5. getPrecondition()

public java.lang.String getPrecondition();

Get the pre condition.

Parameters
return	The pre condition of this test case step.

B.1.1.17. Interface IKlarosTestEnvironment

This interface provides access to data of a test environment.

B.1.1.17.1. Synopsis

 
                        public interface de.verit.klaros.core.model.IKlarosTestEnvironment extends, de.verit.klaros.core.model.IKlarosNamedEntity {
// Public Methods  public java.lang.String getCreator();
                        

                          public java.lang.String getShortname();
                        

                          public java.util.Set<de.verit.klaros.core.persistent.TestRun> getTestRuns();
                        

                          public boolean isDefinedProperty(java.lang.String propertyName);
                        

                          public java.lang.Boolean isEnabled();
                        
}

B.1.1.17.2. getCreator()

public java.lang.String getCreator();

Parameters
return	The name of the creator.

B.1.1.17.3. getShortname()

public java.lang.String getShortname();

Parameters
return	The description.

B.1.1.17.4. getTestRuns()

public java.util.Set<de.verit.klaros.core.persistent.TestRun> getTestRuns();

Get test runs.

Parameters
return	`Collection` of test runs executed in the environment.

B.1.1.17.5. isDefinedProperty(String)

public boolean isDefinedProperty(java.lang.String propertyName);

Specified by: Method isDefinedProperty in interface IKlarosNamedEntity

Check if a property identified by given name is a defined property.

Parameters
propertyName	The name of the property to check.
return	`true` if the identified property is a defined property, `false` else.

B.1.1.17.6. isEnabled()

public java.lang.Boolean isEnabled();

Check if enabled.

Parameters
return	true, if enabled

B.1.1.18. Interface IKlarosTestExecutable

This class provides access to data of a test case.

B.1.1.18.1. Synopsis

 
                        public interface de.verit.klaros.core.model.IKlarosTestExecutable {
}

B.1.1.19. Interface IKlarosTestRequirement

This interface provides access to data of a test requirement.

B.1.1.19.1. Synopsis

 
                        public interface de.verit.klaros.core.model.IKlarosTestRequirement extends, de.verit.klaros.core.model.IKlarosRevision {
// Public Methods  public de.verit.klaros.core.model.KlarosConfiguration getConfiguration();
                        

                          public java.util.Set<de.verit.klaros.core.model.KlarosTestCase> getCoveringHeadTestCases();
                        

                          public java.util.Set<de.verit.klaros.core.model.KlarosTestCase> getCoveringTestCases();
                        

                          public de.verit.klaros.core.model.KlarosRequirementGroup getGroup();
                        
}

B.1.1.19.2. getConfiguration()

public de.verit.klaros.core.model.KlarosConfiguration getConfiguration();

Get configuration.

Parameters
return	The related configuration.

B.1.1.19.3. getCoveringHeadTestCases()

public java.util.Set<de.verit.klaros.core.model.KlarosTestCase> getCoveringHeadTestCases();

Get head revisions of covering test cases.

Parameters
return	Set of test cases

B.1.1.19.4. getCoveringTestCases()

public java.util.Set<de.verit.klaros.core.model.KlarosTestCase> getCoveringTestCases();

Get test cases covering the test requirement.

Parameters
return	`Set` of test cases which cover this test requirement.

B.1.1.19.5. getGroup()

public de.verit.klaros.core.model.KlarosRequirementGroup getGroup();

Get requirement group.

Parameters
return	The requirement group the test requirement belongs to.

B.1.1.20. Interface IKlarosTestRun

This interface provides access to data of a test run.

B.1.1.20.1. Synopsis

 
                        public interface de.verit.klaros.core.model.IKlarosTestRun {
// Public Methods  public de.verit.klaros.core.model.KlarosConfiguration getConfiguration();
                        

                          public java.lang.String getCreator();
                        

                          public de.verit.klaros.core.model.KlarosTestEnvironment getEnv();
                        

                          public int getNumberErrors();
                        

                          public int getNumberFailures();
                        

                          public int getNumberPassed();
                        

                          public int getNumberSkipped();
                        

                          public java.util.Set<de.verit.klaros.core.model.KlarosTestCaseResult> getResults();
                        

                          public java.lang.String getRunId();
                        

                          public de.verit.klaros.core.model.KlarosSUTImplementation getSut();
                        

                          public java.util.Date getTimestamp();
                        

                          public java.lang.String getTimestampString(java.util.Locale locale);
                        
}

B.1.1.20.2. getConfiguration()

public de.verit.klaros.core.model.KlarosConfiguration getConfiguration();

Get configuration.

Parameters
return	The related configuration.

B.1.1.20.3. getCreator()

public java.lang.String getCreator();

Parameters
return	The name of the creator.

B.1.1.20.4. getEnv()

public de.verit.klaros.core.model.KlarosTestEnvironment getEnv();

Get test environment.

Parameters
return	The test environment in which the test cases have benn executed.

B.1.1.20.5. getNumberErrors()

public int getNumberErrors();

Get number of test cases with errors of this test run. It is assumed, that error results have a property 'type' with the value 'E'.

Parameters
return	The number of error test cases.

B.1.1.20.6. getNumberFailures()

public int getNumberFailures();

Get number of failed test cases of this test run. It is assumed, that failed results have a property 'type' with the value 'F'.

Parameters
return	The number of failed test cases.

B.1.1.20.7. getNumberPassed()

public int getNumberPassed();

Get number of passed test cases of this test run. It is assumed, that passed results have a property 'testCasePassed' with value 'true'.

Parameters
return	The number of passed test cases.

B.1.1.20.8. getNumberSkipped()

public int getNumberSkipped();

Get number of skipped test cases of this test run. It is assumed, that failed results have a property 'type' with the value 'S'.

Parameters
return	The number of skipped test cases.

B.1.1.20.9. getResults()

public java.util.Set<de.verit.klaros.core.model.KlarosTestCaseResult> getResults();

Get results.

Parameters
return	`Set` of results of test case executions.

B.1.1.20.10. getRunId()

public java.lang.String getRunId();

Get id of test run.

Parameters
return	The id of the test run.

B.1.1.20.11. getSut()

public de.verit.klaros.core.model.KlarosSUTImplementation getSut();

Get the tested system version.

Parameters
return	The SUT version which has been tested.

B.1.1.20.12. getTimestamp()

public java.util.Date getTimestamp();

Get timestamp.

Parameters
return	The time the test run has been executed as `Date` object.

B.1.1.20.13. getTimestampString(Locale)

public java.lang.String getTimestampString(java.util.Locale locale);

Formats the timestamp and returns it as string.

Parameters
locale	The locale to use for the format.
return	The time the test run has been executed as formated `String`.

B.1.1.21. Interface IKlarosTestSuite

This class provides access to data of a test case.

B.1.1.21.1. Synopsis

 
                        public interface de.verit.klaros.core.model.IKlarosTestSuite {
// Public Methods  public de.verit.klaros.core.model.KlarosUser getAssignee();
                        

                          public de.verit.klaros.core.model.KlarosConfiguration getConfiguration();
                        

                          public java.util.Date getCreated();
                        

                          public de.verit.klaros.core.model.KlarosUser getCreator();
                        

                          public de.verit.klaros.core.model.KlarosUser getLastEditor();
                        

                          public java.util.Date getLastUpdated();
                        

                          public java.lang.String getName();
                        

                          public java.util.List<de.verit.klaros.core.model.KlarosTestSuiteResult> getResults();
                        

                          public java.lang.String getShortname();
                        

                          public de.verit.klaros.core.model.KlarosSUTImplementation getSut();
                        

                          public java.util.List<de.verit.klaros.core.model.KlarosTestCase> getTestCases();
                        

                          public java.lang.Integer getTestSuiteResultCount();
                        

                          public java.lang.Boolean isEnabled();
                        
}

B.1.1.21.2. getAssignee()

public de.verit.klaros.core.model.KlarosUser getAssignee();

Parameters
return	The user to whom this test suite is assigned.

B.1.1.21.3. getConfiguration()

public de.verit.klaros.core.model.KlarosConfiguration getConfiguration();

Get configuration.

Parameters
return	The related configuration.

B.1.1.21.4. getCreated()

public java.util.Date getCreated();

Parameters
return	The date when the suite was created.

B.1.1.21.5. getCreator()

public de.verit.klaros.core.model.KlarosUser getCreator();

Parameters
return	The user who created the test suite.

B.1.1.21.6. getLastEditor()

public de.verit.klaros.core.model.KlarosUser getLastEditor();

Parameters
return	The user who last edited the test suite.

B.1.1.21.7. getLastUpdated()

public java.util.Date getLastUpdated();

Parameters
return	The date when the last update was done.

B.1.1.21.8. getName()

public java.lang.String getName();

Get the name of the test suite.

Parameters
return	`String` of the name of the test suite.

B.1.1.21.9. getResults()

public java.util.List<de.verit.klaros.core.model.KlarosTestSuiteResult> getResults();

Get test suite results.

Parameters
return	`Set` of results of executions of this test suite.

B.1.1.21.10. getShortname()

public java.lang.String getShortname();

Get the short name of the test suite.

Parameters
return	`String` of the description of the test suite.

B.1.1.21.11. getSut()

public de.verit.klaros.core.model.KlarosSUTImplementation getSut();

Get the description of the test suite.

Parameters
return	`String` of the description of the test suite.

B.1.1.21.12. getTestCases()

public java.util.List<de.verit.klaros.core.model.KlarosTestCase> getTestCases();

Get the executables of this test suite.

Parameters
return	`Set` of test cases of this test suite.

B.1.1.21.13. getTestSuiteResultCount()

public java.lang.Integer getTestSuiteResultCount();

Return the number of test suite results in this test suite.

Parameters
return	The number of test suite results in this test suite.

B.1.1.21.14. isEnabled()

public java.lang.Boolean isEnabled();

Returns the value of the enabled flag of this test suite.

Parameters
return	`true` if the test suite is enabled, else `false`

B.1.1.22. Interface IKlarosTestSuiteResult

This interface provides access to data of a test case result.

B.1.1.22.1. Synopsis

 
                        public interface de.verit.klaros.core.model.IKlarosTestSuiteResult extends, de.verit.klaros.core.model.IKlarosNamedEntity {
// Public Methods  public de.verit.klaros.core.model.KlarosTestRun getTestRun();
                        

                          public de.verit.klaros.core.model.KlarosTestSuite getTestSuite();
                        
}

B.1.1.22.2. getTestRun()

public de.verit.klaros.core.model.KlarosTestRun getTestRun();

Get the test run for this result.

Parameters
return	the test run

B.1.1.22.3. getTestSuite()

public de.verit.klaros.core.model.KlarosTestSuite getTestSuite();

Get test case.

Parameters
return	The test case that has been executed to get this result.

B.1.1.23. Interface IKlarosUser

The user object.

B.1.1.23.1. Synopsis

 
                        public interface de.verit.klaros.core.model.IKlarosUser {
// Public Methods  public java.lang.String getEmail();
                        

                          public java.lang.String getRole();
                        

                          public java.lang.String getUsername();
                        
}

B.1.1.23.2. getEmail()

public java.lang.String getEmail();

The email address of this user.

Parameters
return	the email address

B.1.1.23.3. getRole()

public java.lang.String getRole();

The role name of this user.

Parameters
return	the role name

B.1.1.23.4. getUsername()

public java.lang.String getUsername();

The user name of this user as used when logging in.

Parameters
return	the user name

B.1.1.24. Class KlarosAttachment

This class provides access to attachments.

B.1.1.24.1. Synopsis

 
                        public final class de.verit.klaros.core.model.KlarosAttachment extends, de.verit.klaros.core.model.KlarosWrapper<de.verit.klaros.core.model.KlarosAttachment, de.verit.klaros.core.persistent.Attachment>
                        
    implements, de.verit.klaros.core.model.IKlarosAttachment {
// Public Constructors  public KlarosAttachment();
                        
// Public Methods  public java.lang.String getUuid();
                        
}

Methods inherited from java.lang.Object: equals , getClass , hashCode , notify , notifyAll , toString , wait

B.1.1.24.2. getUuid()

public java.lang.String getUuid();

Specified by: Method getUuid in interface IKlarosAttachment

Get the uuid.

B.1.1.25. Class KlarosConfiguration

This class provides access to the information stored for project's configuration.

B.1.1.25.1. Synopsis

 
                        public class de.verit.klaros.core.model.KlarosConfiguration extends, de.verit.klaros.core.model.KlarosWrapper<de.verit.klaros.core.model.KlarosConfiguration, de.verit.klaros.core.persistent.Configuration>
                        
    implements, de.verit.klaros.core.model.IKlarosConfiguration, java.lang.Comparable<de.verit.klaros.core.model.KlarosConfiguration> {
// Public Methods  public int compareTo(de.verit.klaros.core.model.KlarosConfiguration o);
                        

                          public boolean equals(java.lang.Object o);
                        

                          public java.lang.String getDescription();
                        

                          public java.util.Set<de.verit.klaros.core.model.KlarosTestEnvironment> getEnvs();
                        

                          public java.lang.String getName();
                        

                          public java.util.Set<de.verit.klaros.core.model.KlarosSUTImplementation> getSuts();
                        

                          public java.util.Set<de.verit.klaros.core.model.KlarosTestCase> getTestCases();
                        

                          public java.util.Set<de.verit.klaros.core.model.KlarosTestRequirement> getTestRequirements();
                        

                          public java.util.Set<de.verit.klaros.core.model.KlarosTestRun> getTestRuns();
                        

                          public java.util.Set<de.verit.klaros.core.model.KlarosTestSuite> getTestSuites();
                        

                          public int hashCode();
                        

                          public java.lang.Boolean isEnabled();
                        

                          public java.lang.Boolean isSecured();
                        
}