Appendix B. The Klaros Object Model API Reference

Table of Contents

B.1. Klaros Object Model API Reference
B.1.1. de.verit.klaros.core.model
B.1.2. Deprecated API
B.2. Scripting API Reference
B.2.1. de.verit.klaros.scripting
B.2.2. de.verit.klaros.scripting.context
B.2.3. de.verit.klaros.scripting.model

B.1. Klaros Object Model API Reference

B.1.1. de.verit.klaros.core.model

B.1.1.1. IKlarosAttachment
B.1.1.2. IKlarosCategoryNode
B.1.1.3. IKlarosCategoryTree
B.1.1.4. IKlarosConfiguration
B.1.1.5. IKlarosEnumValue
B.1.1.6. IKlarosExternalLink
B.1.1.7. IKlarosExternalServer
B.1.1.8. IKlarosIssue
B.1.1.9. IKlarosIssueManagement
B.1.1.10. IKlarosIteration
B.1.1.11. IKlarosJob
B.1.1.12. IKlarosJobDependency
B.1.1.13. IKlarosJobTimeBlock
B.1.1.14. IKlarosJobUpdateAction
B.1.1.15. IKlarosLabeledObject
B.1.1.16. IKlarosNamedEntity
B.1.1.17. IKlarosPersistentObject
B.1.1.18. IKlarosProperty
B.1.1.19. IKlarosRepositoryEntity
B.1.1.20. IKlarosRequirement
B.1.1.21. IKlarosRequirementsManagement
B.1.1.22. IKlarosResult
B.1.1.23. IKlarosRevision
B.1.1.24. IKlarosSUTImplementation
B.1.1.25. IKlarosTestCase
B.1.1.26. IKlarosTestCaseResult
B.1.1.27. IKlarosTestCaseStep
B.1.1.28. IKlarosTestCaseStepResult
B.1.1.29. IKlarosTestEnvironment
B.1.1.30. IKlarosTestExecutable
B.1.1.31. IKlarosTestRun
B.1.1.32. IKlarosTestSegment
B.1.1.33. IKlarosTestStepContainer
B.1.1.34. IKlarosTestSuite
B.1.1.35. IKlarosTestSuiteResult
B.1.1.36. IKlarosUser
B.1.1.37. KlarosAttachment
B.1.1.38. KlarosCategoryNode
B.1.1.39. KlarosCategoryTree
B.1.1.40. KlarosConfiguration
B.1.1.41. KlarosEnumValue
B.1.1.42. KlarosExternalServer
B.1.1.43. KlarosIssue
B.1.1.44. KlarosIssueManagement
B.1.1.45. KlarosIteration
B.1.1.46. KlarosJob
B.1.1.47. KlarosJobDependency
B.1.1.48. KlarosJobTimeBlock
B.1.1.49. KlarosJobUpdateAction
B.1.1.50. KlarosLabeledObject
B.1.1.51. KlarosNamedEntity
B.1.1.52. KlarosProperty
B.1.1.53. KlarosRepositoryEntity
B.1.1.54. KlarosRequirement
B.1.1.55. KlarosRequirementsManagement
B.1.1.56. KlarosResult
B.1.1.57. KlarosRevision
B.1.1.58. KlarosSUTImplementation
B.1.1.59. KlarosTestCase
B.1.1.60. KlarosTestCaseResult
B.1.1.61. KlarosTestCaseStep
B.1.1.62. KlarosTestCaseStepResult
B.1.1.63. KlarosTestEnvironment
B.1.1.64. KlarosTestExecutable
B.1.1.65. KlarosTestRun
B.1.1.66. KlarosTestSegment
B.1.1.67. KlarosTestStepContainer
B.1.1.68. KlarosTestSuite
B.1.1.69. KlarosTestSuiteResult
B.1.1.70. KlarosUser

B.1.1.1. IKlarosAttachment

This interface provides access to a binary attachment.

B.1.1.1.1. Synopsis
 public interface IKlarosAttachment extends, IKlarosRepositoryEntity<KlarosAttachment> {
// Public Methods  public abstract long getSize();
}
B.1.1.1.2. getSize()
public abstract long getSize();

Gets the size in bytes of this attachment.

Parameters

return

the size

B.1.1.2. IKlarosCategoryNode

A Klaros Category Node.

B.1.1.2.1. Synopsis
 public interface IKlarosCategoryNode extends, IKlarosPersistentObject {
// Public Methods  public abstract CategoryTree getCategoryTree();
  public abstract String getDescription();
  public abstract KlarosCategoryNode getParent();
  public abstract String getShortname();
  public abstract List<KlarosCategoryNode> getSubCategories();
}
B.1.1.2.2. getCategoryTree()
public abstract CategoryTree getCategoryTree();

Gets the category tree.

Parameters

return

the category tree

B.1.1.2.3. getDescription()
public abstract String getDescription();

Gets the description.

Parameters

return

the description

B.1.1.2.4. getParent()
public abstract KlarosCategoryNode getParent();

Gets the parent category node.

Parameters

return

the parent

B.1.1.2.5. getShortname()
public abstract String getShortname();

Gets the shortname.

Parameters

return

the shortname

B.1.1.2.6. getSubCategories()
public abstract List<KlarosCategoryNode> getSubCategories();

Gets the sub categories.

Parameters

return

the sub categories

B.1.1.3. IKlarosCategoryTree

A category tree.

B.1.1.3.1. Synopsis
 public interface IKlarosCategoryTree extends, IKlarosNamedEntity<KlarosCategoryTree> {
// Public Methods  public abstract String getDescription();
  public abstract KlarosCategoryNode getRootNode();
  public abstract String getShortname();
}
B.1.1.3.2. getDescription()
public abstract String getDescription();

Gets the description.

Parameters

return

the description

B.1.1.3.3. getRootNode()
public abstract KlarosCategoryNode getRootNode();

Gets the root category node.

Parameters

return

the root

B.1.1.3.4. getShortname()
public abstract String getShortname();

Gets the shortname.

Parameters

return

the shortname

B.1.1.4. IKlarosConfiguration

This interface provides access to data of a test project.

B.1.1.4.1. Synopsis
 public interface IKlarosConfiguration extends, IKlarosLabeledObject<KlarosConfiguration> {
// Public Methods  public abstract String getDescription();
  public abstract Set<KlarosTestEnvironment> getEnvs();
  public abstract Set<KlarosIssueManagement> getIssueManagementSystems();
  public abstract Set<KlarosIssue> getIssues();
  public abstract Set<KlarosCategoryTree> getIterationCategoryTrees();
  public abstract Set<KlarosIteration> getIterations();
  public abstract Set<KlarosJob> getJobs();
  public abstract Set<KlarosCategoryTree> getRequirementCategoryTrees();
  public abstract Set<KlarosRequirement> getRequirements();
  public abstract KlarosRequirementsManagement getRequirementsManagementSystem();
  public abstract Set<KlarosSUTImplementation> getSuts();
  public abstract Set<KlarosCategoryTree> getSystemUnderTestCategoryTrees();
  public abstract Set<KlarosCategoryTree> getTestCaseCategoryTrees();
  public abstract Set<KlarosTestCase> getTestCases();
  public abstract Set<KlarosCategoryTree> getTestEnvironmentCategoryTrees();
  public abstract Set<KlarosTestRun> getTestRuns();
  public abstract Set<KlarosCategoryTree> getTestSegmentCategoryTrees();
  public abstract Set<KlarosCategoryTree> getTestSuiteCategoryTrees();
  public abstract Set<KlarosTestSuite> getTestSuites();
  public abstract Boolean isSecured();
}
B.1.1.4.2. getDescription()
public abstract String getDescription();

Returns the project description.

Parameters

return

The description of the project.

B.1.1.4.3. getEnvs()
public abstract Set<KlarosTestEnvironment> getEnvs();

Returns the project test environments.

Parameters

return

Set containing the test environments of the project.

B.1.1.4.4. getIssueManagementSystems()
public abstract Set<KlarosIssueManagement> getIssueManagementSystems();

Returns the related issue management systems.

Parameters

return

Set containing the related issue management systems of the project.

B.1.1.4.5. getIssues()
public abstract Set<KlarosIssue> getIssues();

Returns the issues.

Parameters

return

KlarosSet containing the issue objects of the project.

B.1.1.4.6. getIterationCategoryTrees()
public abstract Set<KlarosCategoryTree> getIterationCategoryTrees();

Returns the project iteration category trees.

Parameters

return

Set containing the iteration category trees of the project.

B.1.1.4.7. getIterations()
public abstract Set<KlarosIteration> getIterations();

Returns the project iteration.

Parameters

return

KlarosSet containing the iteration objects of the project.

B.1.1.4.8. getJobs()
public abstract Set<KlarosJob> getJobs();

Returns the project jobs.

Parameters

return

KlarosSet containing the job objects of the project.

B.1.1.4.9. getRequirementCategoryTrees()
public abstract Set<KlarosCategoryTree> getRequirementCategoryTrees();

Returns the project requirement category trees.

Parameters

return

Set containing the requirement category trees of the project.

B.1.1.4.10. getRequirements()
public abstract Set<KlarosRequirement> getRequirements();

Returns the project requirements.

Parameters

return

Set containing the requirement objects of the project.

B.1.1.4.11. getRequirementsManagementSystem()
public abstract KlarosRequirementsManagement getRequirementsManagementSystem();

Returns the related requirement management system.

Parameters

return

Set containing the related requirement management system of the project.

B.1.1.4.12. getSuts()
public abstract Set<KlarosSUTImplementation> getSuts();

Returns the project SUTs (systems under test).

Parameters

return

KlarosSet containing the SUT objects of the project.

B.1.1.4.13. getSystemUnderTestCategoryTrees()
public abstract Set<KlarosCategoryTree> getSystemUnderTestCategoryTrees();

Returns the project system under test category trees.

Parameters

return

Set containing the system under test category trees of the project.

B.1.1.4.14. getTestCaseCategoryTrees()
public abstract Set<KlarosCategoryTree> getTestCaseCategoryTrees();

Returns the project test case category trees.

Parameters

return

Set containing the test case category trees of the project.

B.1.1.4.15. getTestCases()
public abstract Set<KlarosTestCase> getTestCases();

Returns the project test cases.

Parameters

return

Set containing the test case objects of the project.

B.1.1.4.16. getTestEnvironmentCategoryTrees()
public abstract Set<KlarosCategoryTree> getTestEnvironmentCategoryTrees();

Returns the project test environment category trees.

Parameters

return

Set containing the test environment category trees of the project.

B.1.1.4.17. getTestRuns()
public abstract Set<KlarosTestRun> getTestRuns();

Returns the project test runs.

Parameters

return

Set containing the test run objects of the project.

B.1.1.4.18. getTestSegmentCategoryTrees()
public abstract Set<KlarosCategoryTree> getTestSegmentCategoryTrees();

Returns the project test segment category trees.

Parameters

return

Set containing the test segment category trees of the project.

B.1.1.4.19. getTestSuiteCategoryTrees()
public abstract Set<KlarosCategoryTree> getTestSuiteCategoryTrees();

Returns the project test suite category trees.

Parameters

return

Set containing the test suite category trees of the project.

B.1.1.4.20. getTestSuites()
public abstract Set<KlarosTestSuite> getTestSuites();

Returns the project test suites.

Parameters

return

Set containing the test suite objects of the project.

B.1.1.4.21. isSecured()
public abstract Boolean isSecured();

Returns whether this project is secured or not.

Parameters

return

true if this project is secured, false if not.

B.1.1.5. IKlarosEnumValue

A Custom property enumeration value.

B.1.1.5.1. Synopsis
 public interface IKlarosEnumValue extends, IKlarosPersistentObject {
// Public Methods  public abstract String getValue();
}
B.1.1.5.2. getValue()
public abstract String getValue();

Gets the enumeration value.

Parameters

return

the value

B.1.1.6. IKlarosExternalLink

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

B.1.1.6.1. Synopsis
 public interface IKlarosExternalLink extends, IKlarosPersistentObject {
// Public Methods  public abstract String getReference();
}
B.1.1.6.2. getReference()
public abstract String getReference();

Get the reference to the externally stored information.

Parameters

return

The reference to the information.

B.1.1.7. IKlarosExternalServer

This interface provides access to external systems.

B.1.1.7.1. Synopsis
 public interface IKlarosExternalServer<T> extends, IKlarosLabeledObject<T> {
// Public Methods  public abstract String getDescription();
  public abstract String getType();
  public abstract String getUrl();
}
B.1.1.7.2. getDescription()
public abstract String getDescription();

Get the description of the external system.

Parameters

return

The description of the external system.

B.1.1.7.3. getType()
public abstract String getType();

Get the type of this system.

Parameters

return

The type

B.1.1.7.4. getUrl()
public abstract String getUrl();

Get the base url of this system.

Parameters

return

The url

B.1.1.8. IKlarosIssue

This interface provides access to a software issue.

B.1.1.8.1. Synopsis
 public interface IKlarosIssue extends, IKlarosNamedEntity<KlarosIssue> {
// Public Methods  @Deprecated(since="5.3.3") public abstract KlarosSUTImplementation getAcceptedIn();
  public abstract Date getCreationDate();
  public abstract String getDescription();
  public abstract String getExternalId();
  public abstract KlarosIssueManagement getIssueManagement();
  public abstract Date getLastSynched();
  public abstract String getOwner();
  public abstract String getPriority();
  public abstract String getRemoteBrowseUrl();
  public abstract String getReporter();
  public abstract String getResolution();
  public abstract String getState();
  public abstract String getSubject();
  public abstract Set<KlarosSUTImplementation> getSystemsUnderTest();
  public abstract Set<KlarosTestCase> getTestCases();
  public abstract boolean isResolved();
}
B.1.1.8.2. getAcceptedIn()
@Deprecated(since="5.3.3") public abstract KlarosSUTImplementation getAcceptedIn();

Gets the system under test this issue has been accepted/detected in.

Parameters

return

the system under test

B.1.1.8.3. getCreationDate()
public abstract Date getCreationDate();

Gets the creation date of this issue.

Parameters

return

the creation date of this issue.

B.1.1.8.4. getDescription()
public abstract String getDescription();

Get the description.

Parameters

return

The description of this issue.

B.1.1.8.5. getExternalId()
public abstract String getExternalId();

Gets the external id of this issue, if available. This id is generated by the external issue management system upon creation of the issue.

Parameters

return

the external id

B.1.1.8.6. getIssueManagement()
public abstract KlarosIssueManagement getIssueManagement();

Gets the issue management this issue belongs to.

Parameters

return

the issue management

B.1.1.8.7. getLastSynched()
public abstract Date getLastSynched();

Gets the last synchronization date of this issue.

Parameters

return

the last synchronization date of this issue.

B.1.1.8.8. getOwner()
public abstract String getOwner();

Gets the name of the owner/assignee of this issue.

Parameters

return

the owner name of this issue.

B.1.1.8.9. getPriority()
public abstract String getPriority();

Gets the priority of this issue. The format and content of this value varies with the issue management system and its configuration.

Parameters

return

the priority of this issue.

B.1.1.8.10. getRemoteBrowseUrl()
public abstract String getRemoteBrowseUrl();

Returns an url to browse the issue in the remote issue management system.

Parameters

return

the remote browse url

B.1.1.8.11. getReporter()
public abstract String getReporter();

Gets the name of the reporter of this issue.

Parameters

return

the reporter name of this issue.

B.1.1.8.12. getResolution()
public abstract String getResolution();

Gets the resolution of this issue. The format and content of this value varies with the issue management system and its configuration.

Parameters

return

the resolution of this issue.

B.1.1.8.13. getState()
public abstract String getState();

Gets the state of this issue. The format and content of this value varies with the issue management system and its configuration.

Parameters

return

the state string of this issue.

B.1.1.8.14. getSubject()
public abstract String getSubject();

Gets the subject of this issue.

Parameters

return

the subject string of this issue.

B.1.1.8.15. getSystemsUnderTest()
public abstract Set<KlarosSUTImplementation> getSystemsUnderTest();

Get the related systems under test.

Parameters

return

Set of systems under test which have detected this issue.

B.1.1.8.16. getTestCases()
public abstract Set<KlarosTestCase> getTestCases();

Get the related test cases.

Parameters

return

Set of test cases which have detected this issue.

B.1.1.8.17. isResolved()
public abstract boolean isResolved();

Checks if this issue is resolved.

Parameters

return

true, if resolved

B.1.1.9. IKlarosIssueManagement

The interface for accessing issue management systems.

B.1.1.9.1. Synopsis
 public interface IKlarosIssueManagement extends, IKlarosExternalServer<KlarosIssueManagement> {
// Public Methods  public abstract Set<KlarosIssue> getIssues();
  public abstract String getProject();
}
B.1.1.9.2. getIssues()
public abstract Set<KlarosIssue> getIssues();

Gets the referenced issues of this system.

Parameters

return

the issues

B.1.1.9.3. getProject()
public abstract String getProject();

Get the optional project of this system.

Parameters

return

The project

B.1.1.10. IKlarosIteration

An iteration in a project.

B.1.1.10.1. Synopsis
 public interface IKlarosIteration extends, IKlarosNamedEntity<KlarosIteration> {
// Public Methods  public abstract Set<KlarosAttachment> getAttachments();
  public abstract Set<KlarosCategoryNode> getCategories();
  public abstract StateDef getCurrentState();
  public abstract String getDescription();
  public abstract Date getDueDate();
  public abstract Set<KlarosTestEnvironment> getEnvs();
  public abstract Set<KlarosJob> getJobs();
  public abstract String getShortname();
  public abstract Date getStartDate();
  public abstract String getSuccessCriteria();
  public abstract Set<KlarosSUTImplementation> getSuts();
  public abstract Set<KlarosTestRun> getTestRuns();
}
B.1.1.10.2. getAttachments()
public abstract Set<KlarosAttachment> getAttachments();

Gets the attachments associated with this iteration.

Parameters

return

the attachments

B.1.1.10.3. getCategories()
public abstract Set<KlarosCategoryNode> getCategories();

Gets the categories this object belongs to. Each category node will belong to a different category tree.

Parameters

return

the category nodes

B.1.1.10.4. getCurrentState()
public abstract StateDef getCurrentState();

Gets the current state.

Parameters

return

the current state

B.1.1.10.5. getDescription()
public abstract String getDescription();

Gets the description.

Parameters

return

the description

B.1.1.10.6. getDueDate()
public abstract Date getDueDate();

Gets the due date.

Parameters

return

the due date

B.1.1.10.7. getEnvs()
public abstract Set<KlarosTestEnvironment> getEnvs();

Gets the test environments associated with this iteration.

Parameters

return

the test environments

B.1.1.10.8. getJobs()
public abstract Set<KlarosJob> getJobs();

Gets the jobs associated with this iteration.

Parameters

return

the jobs

B.1.1.10.9. getShortname()
public abstract String getShortname();

Gets the short name.

Parameters

return

the short name

B.1.1.10.10. getStartDate()
public abstract Date getStartDate();

Gets the start date.

Parameters

return

the start date

B.1.1.10.11. getSuccessCriteria()
public abstract String getSuccessCriteria();

Gets the success criteria.

Parameters

return

the success criteria

B.1.1.10.12. getSuts()
public abstract Set<KlarosSUTImplementation> getSuts();

Gets the systems under test associated with this iteration.

Parameters

return

the systems under test

B.1.1.10.13. getTestRuns()
public abstract Set<KlarosTestRun> getTestRuns();

Gets the test runs associated with this iteration.

Parameters

return

the test runs

B.1.1.11. IKlarosJob

This interface provides access to the data of a job.

B.1.1.11.1. Synopsis
 public interface IKlarosJob extends, IKlarosNamedEntity<KlarosJob> {
// Public Methods  public abstract Set<KlarosAttachment> getAttachments();
  public abstract KlarosConfiguration getConfiguration();
  public abstract Set<KlarosJobDependency> getDependentJobs();
  public abstract String getDescription();
  public abstract Date getDueDate();
  public abstract KlarosTestEnvironment getEnv();
  public abstract String getEstimatedTime();
  public abstract Long getEstimatedTimeInMilliseconds();
  public abstract JobPriority getJobPriority();
  public abstract JobStatus getJobStatus();
  public abstract JobType getJobType();
  public abstract KlarosJob getParent();
  public abstract Integer getProgress();
  public abstract Set<KlarosJobDependency> getRequiredJobs();
  public abstract Date getStartDate();
  public abstract List<KlarosJob> getSubJobs();
  public abstract Integer getSuccessRate();
  public abstract String getSummary();
  public abstract KlarosSUTImplementation getSut();
  public abstract KlarosTestCase getTestCase();
  public abstract Set<KlarosTestRun> getTestRuns();
  public abstract KlarosTestSuite getTestSuite();
  public abstract List<KlarosJobUpdateAction> getUpdateAction();
  public abstract List<KlarosJobTimeBlock> getWork();
}
B.1.1.11.2. getAttachments()
public abstract Set<KlarosAttachment> getAttachments();

Gets the attachments associated with this job.

Parameters

return

the attachments

B.1.1.11.3. getDependentJobs()
public abstract Set<KlarosJobDependency> getDependentJobs();

Gets the jobs depending on this jobs state.

Parameters

return

the dependent jobs

B.1.1.11.4. getRequiredJobs()
public abstract Set<KlarosJobDependency> getRequiredJobs();

Gets the jobs on which states this job is depending on.

Parameters

return

the required jobs

B.1.1.11.5. getTestRuns()
public abstract Set<KlarosTestRun> getTestRuns();

Gets the test runs executed with this job.

Parameters

return

the test runs

B.1.1.11.6. getUpdateAction()
public abstract List<KlarosJobUpdateAction> getUpdateAction();

Gets the update action list.

Parameters

return

the update action

B.1.1.11.7. getWork()
public abstract List<KlarosJobTimeBlock> getWork();

Gets the list of work items done on this job.

Parameters

return

the work items

B.1.1.12. IKlarosJobDependency

This interface provides access to the data of a job.

B.1.1.12.1. Synopsis
 public interface IKlarosJobDependency extends, IKlarosPersistentObject {
// Public Methods  public abstract Set<JobStatus> getJobStates();
  public abstract UUID getKey();
  public abstract Integer getProgress();
  public abstract KlarosJob getRequiredBy();
  public abstract KlarosJob getRequires();
  public abstract Integer getSuccessRate();
  public abstract Set<Verdict> getVerdicts();
}
B.1.1.12.2. getJobStates()
public abstract Set<JobStatus> getJobStates();

Gets the job states.

Parameters

return

the job states

B.1.1.12.3. getKey()
public abstract UUID getKey();

Get the internal key of the object. This key is globally unique.

Parameters

return

The internal key.

B.1.1.12.4. getRequiredBy()
public abstract KlarosJob getRequiredBy();

Gets the job this dependency is required by.

Parameters

return

the job this dependency is required by

B.1.1.12.5. getRequires()
public abstract KlarosJob getRequires();

Returns the job this dependency requires for evaluation.

Parameters

return

the job this dependency requires

B.1.1.12.6. getVerdicts()
public abstract Set<Verdict> getVerdicts();

Gets the verdicts.

Parameters

return

the verdicts

B.1.1.13. IKlarosJobTimeBlock

The job time block defines a certain amount of time the job has been worked on.

B.1.1.13.1. Synopsis
 public interface IKlarosJobTimeBlock extends, IKlarosLabeledObject<KlarosJobTimeBlock> {
// Public Methods  public abstract String getDescription();
  public abstract Date getDoneAt();
  public abstract String getDuration();
  public abstract Long getDurationInMilliseconds();
  public abstract String getEstimatedTimeLeft();
  public abstract Long getEstimatedTimeLeftInMilliseconds();
  public abstract KlarosJob getJob();
  public abstract KlarosTestRun getTestRun();
}
B.1.1.13.2. getDescription()
public abstract String getDescription();

Gets the work description.

Parameters

return

the work description

B.1.1.13.3. getDoneAt()
public abstract Date getDoneAt();

Gets the date this work was done at.

Parameters

return

the start date

B.1.1.13.4. getDuration()
public abstract String getDuration();

Gets the work duration as a String.

Parameters

return

the duration

B.1.1.13.5. getDurationInMilliseconds()
public abstract Long getDurationInMilliseconds();

Gets the work duration in milliseconds.

Parameters

return

the work duration in hours

B.1.1.13.6. getEstimatedTimeLeft()
public abstract String getEstimatedTimeLeft();

Gets the estimated time left for this job as a String.

Parameters

return

the estimated time left

B.1.1.13.7. getEstimatedTimeLeftInMilliseconds()
public abstract Long getEstimatedTimeLeftInMilliseconds();

Gets the estimated time left for this job in milliseconds.

Parameters

return

the estimated time left in hours

B.1.1.13.8. getJob()
public abstract KlarosJob getJob();

Gets the job this job time block belongs to.

Parameters

return

the job

B.1.1.13.9. getTestRun()
public abstract KlarosTestRun getTestRun();

Gets the test run this job time block belongs to.

Parameters

return

the test run

B.1.1.14. IKlarosJobUpdateAction

This interface provides access to the job update action.

B.1.1.14.1. Synopsis
 public interface IKlarosJobUpdateAction extends, IKlarosLabeledObject<KlarosJobUpdateAction> {
// Public Methods  public abstract String getChanges();
  public abstract String getDescription();
}
B.1.1.14.2. getChanges()
public abstract String getChanges();

Gets the changes.

Parameters

return

the changes

B.1.1.14.3. getDescription()
public abstract String getDescription();

Gets the description.

Parameters

return

the description

B.1.1.15. IKlarosLabeledObject

This interface provides access to the fields of a labeled object.

B.1.1.15.1. Synopsis
 public interface IKlarosLabeledObject<T> extends, IKlarosPersistentObject {
// Public Methods  public abstract Iterable<T> asIterable();
  public abstract Date getCreated();
  public abstract KlarosUser getCreator();
  public abstract UUID getKey();
  public abstract KlarosUser getLastEditor();
  public abstract Date getLastUpdated();
  public abstract String getName();
  public abstract boolean isEnabled();
}
B.1.1.15.2. asIterable()
public abstract Iterable<T> asIterable();

Return this object as an iterable containing just this object.

Parameters

return

the iterable container

B.1.1.15.3. getKey()
public abstract UUID getKey();

Get the internal key of the object. This key is globally unique.

Parameters

return

The internal key.

B.1.1.15.4. getName()
public abstract String getName();

Get the name of the object. This matches the id field visible in the UI.

Parameters

return

The name of the object.

B.1.1.15.5. isEnabled()
public abstract boolean isEnabled();

Returns the value of the enabled flag of this object.

Parameters

return

true if the entity is enabled, else false

B.1.1.16. IKlarosNamedEntity

This interface provides access to data of a properties owner.

B.1.1.16.1. Synopsis
 public interface IKlarosNamedEntity<T> extends, IKlarosLabeledObject<T> {
// Public Methods  public abstract KlarosUser getAssignee();
  public abstract List<IKlarosProperty> getProperties();
  public abstract String getPropertyValue(String propertyName);
  public abstract boolean isDefinedProperty(String propertyName);
}
B.1.1.16.2. getProperties()
public abstract List<IKlarosProperty> getProperties();

Gets the list of properties.

Parameters

return

the properties

B.1.1.16.3. getPropertyValue(String)
public abstract String getPropertyValue(String propertyName);

Gets the property value for the given property name.

Parameters

propertyName

the property name

return

the property value or null if not name is not present

B.1.1.16.4. isDefinedProperty(String)
public abstract boolean isDefinedProperty(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.17. IKlarosPersistentObject

Base interface.

B.1.1.17.1. Synopsis
 public interface IKlarosPersistentObject {
}

B.1.1.18. IKlarosProperty

A user defined property.

B.1.1.18.1. Synopsis
 public interface IKlarosProperty extends, IKlarosPersistentObject {
// Public Methods  public abstract String getName();
  public abstract String getValue();
}
B.1.1.18.2. getName()
public abstract String getName();

Gets the property name.

Parameters

return

the property name

B.1.1.18.3. getValue()
public abstract String getValue();

Gets the property value.

Parameters

return

the property value

B.1.1.19. IKlarosRepositoryEntity

This interface provides access to binary content.

B.1.1.19.1. Synopsis
 public interface IKlarosRepositoryEntity<T> extends, IKlarosLabeledObject<T> {
// Public Methods  public abstract String getMimeType();
  public abstract String getUuid();
  public abstract String getVersion();
}
B.1.1.19.2. getMimeType()
public abstract String getMimeType();

Gets the mime type of the attachment.

Parameters

return

the mime type

B.1.1.19.3. getUuid()
public abstract String getUuid();

Get the unique id of this attachment. This may be resolved by calling KlarosContext.­getAttachmentURL() to an URL pointing to the attachment data.

Parameters

return

The uuid of this attachment.

B.1.1.19.4. getVersion()
public abstract String getVersion();

Gets the version of this attachment.

Parameters

return

the version

B.1.1.20. IKlarosRequirement

This interface provides access to data of a requirement.

B.1.1.20.1. Synopsis
 public interface IKlarosRequirement<T,S extends Revision<?>> extends, IKlarosRevision<T, S> {
// Public Methods  public abstract Set<KlarosAttachment> getAttachments();
  public abstract Set<KlarosCategoryNode> getCategories();
  public abstract KlarosConfiguration getConfiguration();
  public abstract Set<KlarosTestCase> getCoveringTestCases();
  public abstract String getDescription();
  public abstract Set<String> getExternalNames();
  public abstract String getExternalStatus();
  public abstract Set<KlarosIteration> getIterations();
  public abstract RequirementPriority getPriority();
  public abstract String getShortname();
  public abstract String getState();
  public abstract String getSummary();
}
B.1.1.20.2. getAttachments()
public abstract Set<KlarosAttachment> getAttachments();

Gets the attachments associated with this requirement.

Parameters

return

the attachments

B.1.1.20.3. getCategories()
public abstract Set<KlarosCategoryNode> getCategories();

Gets the categories this object belongs to. Each category node will belong to a different category tree.

Parameters

return

the category nodes

B.1.1.20.4. getConfiguration()
public abstract KlarosConfiguration getConfiguration();

Get configuration.

Parameters

return

The related configuration.

B.1.1.20.5. getCoveringTestCases()
public abstract Set<KlarosTestCase> getCoveringTestCases();

Get test cases covering the requirement.

Parameters

return

Set of test cases which cover this test requirement.

B.1.1.20.6. getDescription()
public abstract String getDescription();

Get the description.

Parameters

return

the string

B.1.1.20.7. getExternalNames()
public abstract Set<String> getExternalNames();

Gets the external requirement names this requirement is associated with. External requirement names are used to match imported requirements to existing requirements.

Parameters

return

the external names

B.1.1.20.8. getExternalStatus()
public abstract String getExternalStatus();

Gets the external status.

Parameters

return

the external status

B.1.1.20.9. getIterations()
public abstract Set<KlarosIteration> getIterations();

Get the iterations this requirement is assigned to.

Parameters

return

Set of iterations this requirement is assigned to.

B.1.1.20.10. getPriority()
public abstract RequirementPriority getPriority();

Gets the priority.

Parameters

return

the priority

B.1.1.20.11. getShortname()
public abstract String getShortname();

Gets the shortname.

Parameters

return

the shortname

B.1.1.20.12. getState()
public abstract String getState();

Gets the state.

Parameters

return

the state

B.1.1.20.13. getSummary()
public abstract String getSummary();

Gets the summary.

Parameters

return

the summary

B.1.1.21. IKlarosRequirementsManagement

The interface for accessing requirements management systems.

B.1.1.21.1. Synopsis
 public interface IKlarosRequirementsManagement extends, IKlarosExternalServer<KlarosRequirementsManagement> {
// Public Methods  public abstract String getProject();
}
B.1.1.21.2. getProject()
public abstract String getProject();

Get the optional project of this system.

Parameters

return

The project

B.1.1.22. IKlarosResult

This interface provides access to data of generic result.

B.1.1.22.1. Synopsis
 public interface IKlarosResult<T> extends, IKlarosNamedEntity<T> {
// Public Methods  public abstract String getDescription();
  public abstract long getExecutionTime();
  public abstract KlarosJob getJob();
  public abstract String getSummary();
  public abstract KlarosTestRun getTestRun();
  public abstract String getVerdict();
  public abstract String getVerdict(Locale locale);
  public abstract boolean isError();
  public abstract boolean isFailure();
  public abstract boolean isInconclusive();
  public abstract boolean isPassed();
  public abstract boolean isSkipped();
}
B.1.1.22.2. getDescription()
public abstract 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.22.3. getExecutionTime()
public abstract long getExecutionTime();

Get the test execution time in ms.

Parameters

return

The test execution time.

B.1.1.22.4. getJob()
public abstract KlarosJob getJob();

Gets the job this result belongs if one exists.

Parameters

return

the associated job

B.1.1.22.5. getSummary()
public abstract 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.22.6. getTestRun()
public abstract KlarosTestRun getTestRun();

Get the associated test run.

Parameters

return

The test run that created this result.

B.1.1.22.7. getVerdict()
public abstract String getVerdict();

Returns the Test Case Result verdict as String. P = Passed U = Unknown S = Skipped E = Error F = Failed

Parameters

return

The Test Case Result verdict as String.

B.1.1.22.8. getVerdict(Locale)
public abstract String getVerdict(Locale locale);

Returns the Test Case Result verdict as String with localization. P = Passed U = Unknown S = Skipped E = Error F = Failed

Parameters

locale

set location Information

return

The Test Case Result verdict as String.

B.1.1.22.9. isError()
public abstract 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.22.10. isFailure()
public abstract 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.22.11. isInconclusive()
public abstract boolean isInconclusive();

Check if this is an inconclusive result. It is assumed, that inconclusive results have a property 'type' with the value 'I' or 'inconclusive'.

Parameters

return

true if this results represents an inconclusive result.

B.1.1.22.12. isPassed()
public abstract boolean isPassed();

Check if this is a result of a passed test case. It is assumed, that passed results have a property 'type' with the value 'P' or 'error'.

Parameters

return

true if this results represents an error.

B.1.1.22.13. isSkipped()
public abstract 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.23. IKlarosRevision

This interface provides access to a revisionable Klaros object.

B.1.1.23.1. Synopsis
 public interface IKlarosRevision<T,S extends Revision<?>> extends, IKlarosNamedEntity<T> {
// Public Methods  public abstract KlarosRevision<T, S> getPredecessor();
  public abstract String getRevisionComment();
  public abstract String getRevisionId();
  public abstract KlarosRevision<T, S> getRoot();
  public abstract KlarosRevision<T, S> getSuccessor();
}
B.1.1.23.2. getPredecessor()
public abstract KlarosRevision<T, S> getPredecessor();

Get the predecessor of the revision.

Parameters

return

The revision object that is the predecessor of this revision.

B.1.1.23.3. getRevisionComment()
public abstract String getRevisionComment();

Get comment.

Parameters

return

The comment of the revision.

B.1.1.23.4. getRevisionId()
public abstract String getRevisionId();

Get the revision id.

Parameters

return

The revision id.

B.1.1.23.5. getRoot()
public abstract KlarosRevision<T, S> getRoot();

Get the root of the revision hierarchy.

Parameters

return

The root revision object.

B.1.1.23.6. getSuccessor()
public abstract KlarosRevision<T, S> getSuccessor();

Get the successor of the revision.

Parameters

return

The revision object that is the successor of this revision.

B.1.1.24. IKlarosSUTImplementation

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

B.1.1.24.1. Synopsis
 public interface IKlarosSUTImplementation extends, IKlarosNamedEntity<KlarosSUTImplementation> {
// Public Methods  public abstract Set<KlarosAttachment> getAttachments();
  public abstract Set<KlarosCategoryNode> getCategories();
  public abstract KlarosConfiguration getConfiguration();
  public abstract Set<KlarosIssue> getIssues();
  public abstract Set<KlarosIteration> getIterations();
  public abstract String getProductversion();
  public abstract Set<KlarosTestRun> getTestRuns();
}
B.1.1.24.2. getAttachments()
public abstract Set<KlarosAttachment> getAttachments();

Gets the attachments associated with this system under test.

Parameters

return

the attachments

B.1.1.24.3. getCategories()
public abstract Set<KlarosCategoryNode> getCategories();

Gets the categories this system under test belongs to. Each category node will belong to a different category tree.

Parameters

return

the category nodes

B.1.1.24.4. getConfiguration()
public abstract KlarosConfiguration getConfiguration();

Get configuration.

Parameters

return

The related configuration.

B.1.1.24.5. getIssues()
public abstract Set<KlarosIssue> getIssues();

Gets the issues related to this system under test.

Parameters

return

the issues

B.1.1.24.6. getIterations()
public abstract Set<KlarosIteration> getIterations();

Get the iterations this system under test is assigned to.

Parameters

return

Set of iterations this system under test is assigned to.

B.1.1.24.7. getProductversion()
public abstract String getProductversion();

Get product version.

Parameters

return

The version id of the system under test.

B.1.1.24.8. getTestRuns()
public abstract Set<KlarosTestRun> getTestRuns();

Get the test runs performed with this system under test.

Parameters

return

Set of test runs performed for this system under test.

B.1.1.25. IKlarosTestCase

This class provides access to data of a test case.

B.1.1.25.1. Synopsis
 public interface IKlarosTestCase extends, IKlarosRevision<KlarosTestCase, TestCase> {
// Public Methods  public abstract Set<KlarosAttachment> getAttachments();
  public abstract Set<KlarosCategoryNode> getCategories();
  public abstract KlarosConfiguration getConfiguration();
  public abstract Set<KlarosRequirement> getCovers();
  public abstract String getDependency();
  public abstract String getDescription();
  public abstract TestDesignTechnique getDesignTechnique();
  public abstract List<KlarosIssue> getDetectedIssues();
  public abstract String getDocbase();
  public abstract Long getEstimatedDuration();
  public abstract TestEvaluationMethod getEvaluation();
  public abstract TestExecutionMethod getExecution();
  public abstract String getExpectedResult();
  public abstract Set<String> getExternalNames();
  public abstract List<KlarosJob> getJobs();
  public abstract TestLevel getLevel();
  public abstract String getNote();
  public abstract String getPostcondition();
  public abstract String getPrecondition();
  public abstract TestPriority getPriority();
  public abstract Set<KlarosTestCaseResult> getResults();
  public abstract String getShortname();
  public abstract String getState();
  public abstract String getTeam();
  public abstract List<KlarosTestCaseStep> getTestCaseSteps();
  public abstract TestAreatopic getTestType();
  public abstract String getTraceability();
  public abstract TestVariety getVariety();
}
B.1.1.25.2. getAttachments()
public abstract Set<KlarosAttachment> getAttachments();

Gets the attachments associated with this test case.

Parameters

return

the attachments

B.1.1.25.3. getCategories()
public abstract Set<KlarosCategoryNode> getCategories();

Gets the categories this object belongs to. Each category node will belong to a different category tree.

Parameters

return

the category nodes

B.1.1.25.4. getConfiguration()
public abstract KlarosConfiguration getConfiguration();

Get the project configuration this test case revision belongs to.

Parameters

return

The related configuration.

B.1.1.25.5. getCovers()
public abstract Set<KlarosRequirement> getCovers();

Get covered requirements.

Parameters

return

Set of requirements which are covered by this test case.

B.1.1.25.6. getDependency()
public abstract String getDependency();

The dependency of this test case.

Parameters

return

The dependency.

B.1.1.25.7. getDescription()
public abstract String getDescription();

The description of this test case.

Parameters

return

The description.

B.1.1.25.8. getDesignTechnique()
public abstract TestDesignTechnique getDesignTechnique();

The design technique of this test case.

Parameters

return

The type.

B.1.1.25.9. getDetectedIssues()
public abstract List<KlarosIssue> getDetectedIssues();

Get detected issues.

Parameters

return

List of issues which have been detected by this test case.

B.1.1.25.10. getDocbase()
public abstract String getDocbase();

The docbase of this test case.

Parameters

return

The docbase.

B.1.1.25.11. getEstimatedDuration()
public abstract Long getEstimatedDuration();

The estimated duration of this test case.

Parameters

return

The estimatedDuration.

B.1.1.25.12. getEvaluation()
public abstract TestEvaluationMethod getEvaluation();

The evaluation of this test case.

Parameters

return

The evaluation.

B.1.1.25.13. getExecution()
public abstract TestExecutionMethod getExecution();

The execution method of this test case.

Parameters

return

The execution method.

B.1.1.25.14. getExpectedResult()
public abstract String getExpectedResult();

The expected result of this test case.

Parameters

return

The expected result.

B.1.1.25.15. getExternalNames()
public abstract Set<String> getExternalNames();

Gets the external test case names this test case is associated with. External test case names are used to match imported test case result to existing test cases.

Parameters

return

the external names

B.1.1.25.16. getJobs()
public abstract List<KlarosJob> getJobs();

Gets the jobs associated with this test case.

Parameters

return

the jobs

B.1.1.25.17. getLevel()
public abstract TestLevel getLevel();

The level of this test case.

Parameters

return

The level.

B.1.1.25.18. getNote()
public abstract String getNote();

The note of this test case.

Parameters

return

The note.

B.1.1.25.19. getPostcondition()
public abstract String getPostcondition();

The postcondition of this test case.

Parameters

return

The postcondition.

B.1.1.25.20. getPrecondition()
public abstract String getPrecondition();

The precondition of this test case.

Parameters

return

The precondition.

B.1.1.25.21. getPriority()
public abstract TestPriority getPriority();

The priority of this test case.

Parameters

return

The priority.

B.1.1.25.22. getResults()
public abstract Set<KlarosTestCaseResult> getResults();

Get test case results.

Parameters

return

Set of results of executions of this test case.

B.1.1.25.23. getShortname()
public abstract String getShortname();

The short name (title) of this test case.

Parameters

return

The short name.

B.1.1.25.24. getState()
public abstract String getState();

The type of this test case.

Parameters

return

The type.

B.1.1.25.25. getTeam()
public abstract String getTeam();

The team responsible for this test case.

Parameters

return

The team.

B.1.1.25.26. getTestCaseSteps()
public abstract List<KlarosTestCaseStep> getTestCaseSteps();

Get test case steps.

Parameters

return

list of steps of this test case.

B.1.1.25.27. getTestType()
public abstract TestAreatopic getTestType();

The test type of this test case.

Parameters

return

The test type.

B.1.1.25.28. getTraceability()
public abstract String getTraceability();

The traceability of this test case.

Parameters

return

The traceability.

B.1.1.25.29. getVariety()
public abstract TestVariety getVariety();

The variety of this test case.

Parameters

return

The variety.

B.1.1.26. IKlarosTestCaseResult

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

B.1.1.26.1. Synopsis
 public interface IKlarosTestCaseResult extends, IKlarosResult<KlarosTestCaseResult> {
// Public Methods  public abstract Set<KlarosAttachment> getAttachments();
  public abstract List<KlarosTestCaseStepResult> getStepResults();
  public abstract KlarosTestCase getTestCase();
  public abstract Integer getTestSuitePosition();
  public abstract KlarosTestSuiteResult getTestSuiteResult();
  public abstract boolean isPending();
}
B.1.1.26.2. getAttachments()
public abstract Set<KlarosAttachment> getAttachments();

Gets the attachments associated with this result.

Parameters

return

the attachments

B.1.1.26.3. getStepResults()
public abstract List<KlarosTestCaseStepResult> getStepResults();

Get the associated step results.

Parameters

return

List of test case step results.

B.1.1.26.4. getTestCase()
public abstract KlarosTestCase getTestCase();

Get the associated test case.

Parameters

return

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

B.1.1.26.5. getTestSuitePosition()
public abstract Integer getTestSuitePosition();

Return the position in the test suite result this test case result belongs to or null if this test case has not been executed by executing a test suite.

Parameters

return

the position of the test case in the test suite, or null

B.1.1.26.6. getTestSuiteResult()
public abstract KlarosTestSuiteResult getTestSuiteResult();

Return the test suite result this test case result belongs to or null if this test case has not been executed by executing a test suite.

Parameters

return

the test suite result, or null

B.1.1.26.7. isPending()
public abstract boolean isPending();

Checks if the result is pending. This means that it has not yet been completely executed.

Parameters

return

true, if the result is pending

B.1.1.27. IKlarosTestCaseStep

This interface provides access to a test case step.

B.1.1.27.1. Synopsis
 public interface IKlarosTestCaseStep<T> extends, IKlarosTestStepContainer<T> {
// Public Methods  public abstract Set<KlarosAttachment> getAttachments();
}
B.1.1.27.2. getAttachments()
public abstract Set<KlarosAttachment> getAttachments();

Gets the attachments associated with this test case.

Parameters

return

the attachments

B.1.1.28. IKlarosTestCaseStepResult

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

B.1.1.28.1. Synopsis
 public interface IKlarosTestCaseStepResult extends, IKlarosResult<KlarosTestCaseStepResult> {
// Public Methods  public abstract String getAction();
  public abstract Set<KlarosAttachment> getAttachments();
  public abstract String getExpectedResult();
  public abstract String getPostcondition();
  public abstract String getPrecondition();
  public abstract KlarosTestCase getTestCase();
  public abstract KlarosTestCaseResult getTestCaseResult();
}
B.1.1.28.2. getAction()
public abstract String getAction();

Get the action.

Parameters

return

The action of this test case step.

B.1.1.28.3. getAttachments()
public abstract Set<KlarosAttachment> getAttachments();

Gets the attachments associated with this test case.

Parameters

return

the attachments

B.1.1.28.4. getExpectedResult()
public abstract String getExpectedResult();

Get the expected result.

Parameters

return

The expected result of this test case step.

B.1.1.28.5. getPostcondition()
public abstract String getPostcondition();

Get the postcondition.

Parameters

return

The postcondition of this test case step.

B.1.1.28.6. getPrecondition()
public abstract String getPrecondition();

Get the precondition.

Parameters

return

The precondition of this test case step.

B.1.1.28.7. getTestCase()
public abstract KlarosTestCase getTestCase();

Get test case.

Parameters

return

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

B.1.1.28.8. getTestCaseResult()
public abstract KlarosTestCaseResult getTestCaseResult();

Get test case result.

Parameters

return

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

B.1.1.29. IKlarosTestEnvironment

This interface provides access to data of a test environment.

B.1.1.29.1. Synopsis
 public interface IKlarosTestEnvironment extends, IKlarosNamedEntity<KlarosTestEnvironment> {
// Public Methods  public abstract Set<KlarosAttachment> getAttachments();
  public abstract Set<KlarosCategoryNode> getCategories();
  public abstract String getDescription();
  public abstract Set<KlarosIteration> getIterations();
  public abstract Set<KlarosTestRun> getTestRuns();
}
B.1.1.29.2. getAttachments()
public abstract Set<KlarosAttachment> getAttachments();

Gets the attachments associated with this test environment.

Parameters

return

the attachments

B.1.1.29.3. getCategories()
public abstract Set<KlarosCategoryNode> getCategories();

Gets the categories this test environment belongs to. Each category node will belong to a different category tree.

Parameters

return

the category nodes

B.1.1.29.4. getIterations()
public abstract Set<KlarosIteration> getIterations();

Get the iterations this test environment is assigned to.

Parameters

return

Set of iterations this test environment is assigned to.

B.1.1.29.5. getTestRuns()
public abstract Set<KlarosTestRun> getTestRuns();

Gets the test runs associated with this test environment.

Parameters

return

Collection of test runs executed in the environment.

B.1.1.30. IKlarosTestExecutable

This class provides access to a test executable. This may wrap a test case or a test suite.

B.1.1.30.1. Synopsis
 public interface IKlarosTestExecutable extends, IKlarosPersistentObject {
}

B.1.1.31. IKlarosTestRun

This interface provides access to data of a test run.

B.1.1.31.1. Synopsis
 public interface IKlarosTestRun extends, IKlarosNamedEntity<KlarosTestRun> {
// Public Methods  public abstract KlarosConfiguration getConfiguration();
  public abstract KlarosTestEnvironment getEnv();
  public abstract KlarosIteration getIteration();
  public abstract KlarosJob getJob();
  public abstract int getNumberErrors();
  public abstract int getNumberFailures();
  public abstract int getNumberInconclusive();
  public abstract int getNumberPassed();
  public abstract int getNumberSkipped();
  public abstract String getRelatedSummary();
  public abstract Set<KlarosTestCaseResult> getResults();
  public abstract String getRunId();
  public abstract KlarosSUTImplementation getSut();
  public abstract KlarosTestSuite getTestSuite();
  public abstract Date getTimestamp();
  public abstract Set<KlarosJobTimeBlock> getWork();
  public abstract boolean isPending();
}
B.1.1.31.2. getConfiguration()
public abstract KlarosConfiguration getConfiguration();

Get configuration.

Parameters

return

The related configuration

B.1.1.31.3. getEnv()
public abstract KlarosTestEnvironment getEnv();

Get test environment.

Parameters

return

The test environment in which the test cases have been executed.

B.1.1.31.4. getIteration()
public abstract KlarosIteration getIteration();

Get the iteration in which the test run has been created, if available.

Parameters

return

The iteration in which the test run has been created

B.1.1.31.5. getJob()
public abstract KlarosJob getJob();

Get the job that initiated the test run, if available.

Parameters

return

The job that initiated the test run

B.1.1.31.6. getNumberErrors()
public abstract 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.31.7. getNumberFailures()
public abstract 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.31.8. getNumberInconclusive()
public abstract int getNumberInconclusive();

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

Parameters

return

The number of skipped test cases

B.1.1.31.9. getNumberPassed()
public abstract 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.31.10. getNumberSkipped()
public abstract int getNumberSkipped();

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

Parameters

return

The number of skipped test cases

B.1.1.31.11. getRelatedSummary()
public abstract String getRelatedSummary();

Gets the summary of the job, test suite or test case related to this test run.

Parameters

return

the related summary

B.1.1.31.12. getResults()
public abstract Set<KlarosTestCaseResult> getResults();

Get results.

Parameters

return

Set of results of test case executions.

B.1.1.31.13. getRunId()
public abstract String getRunId();

Get id of test run.

Parameters

return

The id of the test run

B.1.1.31.14. getSut()
public abstract KlarosSUTImplementation getSut();

Get the tested system version.

Parameters

return

The SUT version which has been tested

B.1.1.31.15. getTestSuite()
public abstract KlarosTestSuite getTestSuite();

Get the test suite executed with this test run, if available.

Parameters

return

The test suite executed with this test run

B.1.1.31.16. getTimestamp()
public abstract Date getTimestamp();

Get timestamp.

Parameters

return

The time the test run has been executed as Date object

B.1.1.31.17. getWork()
public abstract Set<KlarosJobTimeBlock> getWork();

Get the job time blocks of this test run.

Parameters

return

Set of job time blocks.

B.1.1.31.18. isPending()
public abstract boolean isPending();

Checks if the test run is pending. This means that it has not yet been completely executed.

Parameters

return

true, if the test run is pending

B.1.1.32. IKlarosTestSegment

This interface provides access to a test segment.

B.1.1.32.1. Synopsis
 public interface IKlarosTestSegment<T,S extends Revision<S>> extends, IKlarosRevision<T, S> {
// Public Methods  public abstract String getDescription();
  public abstract String getExpectedResult();
  public abstract String getNote();
  public abstract String getPostcondition();
  public abstract String getPrecondition();
  public abstract String getShortname();
  public abstract List<KlarosTestCaseStep> getSteps();
}
B.1.1.32.2. getDescription()
public abstract String getDescription();

Get the description.

Parameters

return

The description of this test segment.

B.1.1.32.3. getExpectedResult()
public abstract String getExpectedResult();

Get the expected result.

Parameters

return

The expected result of this test case step.

B.1.1.32.4. getNote()
public abstract String getNote();

Get the note.

Parameters

return

The note of this test segment.

B.1.1.32.5. getPostcondition()
public abstract String getPostcondition();

Get the postcondition.

Parameters

return

The postcondition of this test case step.

B.1.1.32.6. getPrecondition()
public abstract String getPrecondition();

Get the precondition.

Parameters

return

The precondition of this test case step.

B.1.1.32.7. getShortname()
public abstract String getShortname();

Get the shortname.

Parameters

return

The shortname of this test case segment.

B.1.1.32.8. getSteps()
public abstract List<KlarosTestCaseStep> getSteps();

Get the test case steps.

Parameters

return

list of steps of this test segment.

B.1.1.33. IKlarosTestStepContainer

This interface provides access to a test step containers.

B.1.1.33.1. Synopsis
 public interface IKlarosTestStepContainer<T> extends, IKlarosNamedEntity<T> {
// Public Methods  public abstract String getAction();
  public abstract String getExpectedResult();
  public abstract String getPostcondition();
  public abstract String getPrecondition();
}
B.1.1.33.2. getAction()
public abstract String getAction();

Get the action.

Parameters

return

The action of this test case step.

B.1.1.33.3. getExpectedResult()
public abstract String getExpectedResult();

Get the expected result.

Parameters

return

The expected result of this test case step.

B.1.1.33.4. getPostcondition()
public abstract String getPostcondition();

Get the postcondition.

Parameters

return

The postcondition of this test case step.

B.1.1.33.5. getPrecondition()
public abstract String getPrecondition();

Get the precondition.

Parameters

return

The precondition of this test case step.

B.1.1.34. IKlarosTestSuite

This interface provides access to data of a test suite.

B.1.1.34.1. Synopsis
 public interface IKlarosTestSuite<T,S extends Revision<?>> extends, IKlarosRevision<T, S> {
// Public Methods  public abstract Set<KlarosAttachment> getAttachments();
  public abstract Set<KlarosCategoryNode> getCategories();
  public abstract KlarosConfiguration getConfiguration();
  public abstract List<KlarosTestSuiteResult> getResults();
  public abstract String getShortname();
  public abstract KlarosSUTImplementation getSut();
  public abstract List<KlarosTestCase> getTestCases();
  public abstract Integer getTestSuiteResultCount();
}
B.1.1.34.2. getAttachments()
public abstract Set<KlarosAttachment> getAttachments();

Gets the attachments associated with this test suite.

Parameters

return

the attachments

B.1.1.34.3. getCategories()
public abstract Set<KlarosCategoryNode> getCategories();

Gets the categories this object belongs to. Each category node will belong to a different category tree.

Parameters

return

the category nodes

B.1.1.34.4. getConfiguration()
public abstract KlarosConfiguration getConfiguration();

Get configuration.

Parameters

return

The related configuration.

B.1.1.34.5. getResults()
public abstract List<KlarosTestSuiteResult> getResults();

Get test suite results.

Parameters

return

Set of results of executions of this test suite.

B.1.1.34.6. getShortname()
public abstract String getShortname();

Get the short name of the test suite.

Parameters

return

String of the description of the test suite.

B.1.1.34.7. getSut()
public abstract KlarosSUTImplementation getSut();

Get the description of the test suite.

Parameters

return

String of the description of the test suite.

B.1.1.34.8. getTestCases()
public abstract List<KlarosTestCase> getTestCases();

Get the executables of this test suite.

Parameters

return

Set of test cases of this test suite.

B.1.1.34.9. getTestSuiteResultCount()
public abstract 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.35. IKlarosTestSuiteResult

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

B.1.1.35.1. Synopsis
 public interface IKlarosTestSuiteResult extends, IKlarosResult<KlarosTestSuiteResult> {
// Public Methods  public abstract Set<KlarosTestCaseResult> getResults();
  public abstract KlarosTestSuite getTestSuite();
  public abstract boolean isPending();
}
B.1.1.35.2. getResults()
public abstract Set<KlarosTestCaseResult> getResults();

Gets the test case results for this test suite result. The list is sorted by the position in which the test cases appear in the test suite.

Parameters

return

the results

B.1.1.35.3. getTestSuite()
public abstract KlarosTestSuite getTestSuite();

Get the related test suite.

Parameters

return

The test suite that has been executed to get this result.

B.1.1.35.4. isPending()
public abstract boolean isPending();

Checks if the result is pending. This means that it has not yet been completely executed.

Parameters

return

true, if the result is pending

B.1.1.36. IKlarosUser

The user object.

B.1.1.36.1. Synopsis
 public interface IKlarosUser extends, IKlarosLabeledObject<KlarosUser> {
// Public Methods  public abstract String getEmail();
  public abstract UserRole getRole();
  public abstract String getUsername();
}
B.1.1.36.2. getEmail()
public abstract String getEmail();

The email address of this user.

Parameters

return

the email address

B.1.1.36.3. getRole()
public abstract UserRole getRole();

The role name of this user.

Parameters

return

the role name

B.1.1.36.4. getUsername()
public abstract String getUsername();

The username of this user as used when logging in.

Parameters

return

the username

B.1.1.37. KlarosAttachment

This class provides access to binary attachment.

B.1.1.37.1. Synopsis
 public final class KlarosAttachment extends, 
                                KlarosRepositoryEntity<KlarosAttachment, Attachment>
                            
    implements, IKlarosAttachment {
// Public Methods  public long getSize();
}

Methods inherited from de.verit.klaros.core.model.KlarosRepositoryEntity: getMimeType , getName , getUuid , getVersion

Methods inherited from de.verit.klaros.core.model.KlarosLabeledObject: asIterable , getCreated , getCreator , getKey , getLastEditor , getLastUpdated , isEnabled

Methods inherited from de.verit.klaros.core.model.KlarosWrapper: equals , getWrapped , hashCode

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

B.1.1.38. KlarosCategoryNode

A generic category node.

B.1.1.38.1. Synopsis
 public class KlarosCategoryNode extends, KlarosWrapper<KlarosCategoryNode, CategoryNode>
    implements, IKlarosCategoryNode {
// Public Constructors  public KlarosCategoryNode();
// Public Methods  public CategoryTree getCategoryTree();
  public String getDescription();
  public KlarosCategoryNode getParent();
  public String getShortname();
  public List<KlarosCategoryNode> getSubCategories();
}

Methods inherited from de.verit.klaros.core.model.KlarosWrapper: equals , getWrapped , hashCode

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

B.1.1.38.2. KlarosCategoryNode()
public KlarosCategoryNode();

Constructor.

B.1.1.39. KlarosCategoryTree

A category tree.

B.1.1.39.1. Synopsis
 public class KlarosCategoryTree extends, 
                                KlarosNamedEntity<KlarosCategoryTree, CategoryTree>
                            
    implements, IKlarosCategoryTree {
// Public Constructors  public KlarosCategoryTree();
// Public Methods  public String getDescription();
  public KlarosCategoryNode getRootNode();
  public String getShortname();
}

Methods inherited from de.verit.klaros.core.model.KlarosNamedEntity: getAssignee , getProperties , getPropertyValue , isDefinedProperty

Methods inherited from de.verit.klaros.core.model.KlarosLabeledObject: asIterable , getCreated , getCreator , getKey , getLastEditor , getLastUpdated , getName , isEnabled

Methods inherited from de.verit.klaros.core.model.KlarosWrapper: equals , getWrapped , hashCode

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

B.1.1.39.2. KlarosCategoryTree()
public KlarosCategoryTree();

Serialization constructor.

B.1.1.40. KlarosConfiguration

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

B.1.1.40.1. Synopsis
 public class KlarosConfiguration extends, 
                                KlarosLabeledObject<KlarosConfiguration, Configuration>
                            
    implements, IKlarosConfiguration, Comparable<KlarosConfiguration> {
// Public Methods  public int compareTo(KlarosConfiguration o);
  public boolean equals(Object o);
  public String getDescription();
  public Set<KlarosTestEnvironment> getEnvs();
  public Set<KlarosIssueManagement> getIssueManagementSystems();
  public Set<KlarosIssue> getIssues();
  public Set<KlarosCategoryTree> getIterationCategoryTrees();
  public Set<KlarosIteration> getIterations();
  public Set<KlarosJob> getJobs();
  public Set<KlarosCategoryTree> getRequirementCategoryTrees();
  public Set<KlarosRequirement> getRequirements();
  public KlarosRequirementsManagement getRequirementsManagementSystem();
  public Set<KlarosSUTImplementation> getSuts();
  public Set<KlarosCategoryTree> getSystemUnderTestCategoryTrees();
  public Set<KlarosCategoryTree> getTestCaseCategoryTrees();
  public Set<KlarosTestCase> getTestCases();
  public Set<KlarosCategoryTree> getTestEnvironmentCategoryTrees();
  public Set<KlarosTestRun> getTestRuns();
  public Set<KlarosCategoryTree> getTestSegmentCategoryTrees();
  public Set<KlarosCategoryTree> getTestSuiteCategoryTrees();
  public Set<KlarosTestSuite> getTestSuites();
  public int hashCode();
  public Boolean isSecured();
}

Methods inherited from de.verit.klaros.core.model.KlarosLabeledObject: asIterable , getCreated , getCreator , getKey , getLastEditor , getLastUpdated , getName , isEnabled

Methods inherited from de.verit.klaros.core.model.KlarosWrapper: equals , getWrapped , hashCode

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

B.1.1.41. KlarosEnumValue

A Custom property enumeration value.

B.1.1.41.1. Synopsis
 public final class KlarosEnumValue extends, KlarosWrapper<KlarosEnumValue, EnumValue>
    implements, IKlarosEnumValue {
// Public Methods  public String getValue();
}

Methods inherited from de.verit.klaros.core.model.KlarosWrapper: equals , getWrapped , hashCode

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

B.1.1.42. KlarosExternalServer

This class encapsulates the (dynamic) properties of a klaros object.

B.1.1.42.1. Synopsis
 public abstract class KlarosExternalServer<T extends KlarosExternalServer<T, S>,S extends ExternalServer> extends, 
                                KlarosLabeledObject<T, S>
                            
    implements, IKlarosExternalServer<T> {
// Public Methods  public String getDescription();
  public String getType();
  public String getUrl();
}

Direct known subclasses: de.­verit.­klaros.­core.­model.­KlarosIssueManagement , de.­verit.­klaros.­core.­model.­KlarosRequirementsManagement

Methods inherited from de.verit.klaros.core.model.KlarosLabeledObject: asIterable , getCreated , getCreator , getKey , getLastEditor , getLastUpdated , getName , isEnabled

Methods inherited from de.verit.klaros.core.model.KlarosWrapper: equals , getWrapped , hashCode

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

B.1.1.43. KlarosIssue

This class provides access to the information stored for detected issues.

B.1.1.43.1. Synopsis
 public final class KlarosIssue extends, 
                                KlarosNamedEntity<KlarosIssue, Issue>
                            
    implements, IKlarosIssue {
// Public Methods  public KlarosSUTImplementation getAcceptedIn();
  public Date getCreationDate();
  public String getDescription();
  public String getExternalId();
  public KlarosIssueManagement getIssueManagement();
  public Date getLastSynched();
  public String getOwner();
  public String getPriority();
  public String getRemoteBrowseUrl();
  public String getReporter();
  public String getResolution();
  public String getState();
  public String getSubject();
  public Set<KlarosSUTImplementation> getSystemsUnderTest();
  public Set<KlarosTestCase> getTestCases();
  public boolean isResolved();
}

Methods inherited from de.verit.klaros.core.model.KlarosNamedEntity: getAssignee , getProperties , getPropertyValue , isDefinedProperty

Methods inherited from de.verit.klaros.core.model.KlarosLabeledObject: asIterable , getCreated , getCreator , getKey , getLastEditor , getLastUpdated , getName , isEnabled

Methods inherited from de.verit.klaros.core.model.KlarosWrapper: equals , getWrapped , hashCode

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

B.1.1.44. KlarosIssueManagement

An issue management system.

B.1.1.44.1. Synopsis
 public class KlarosIssueManagement extends, 
                                KlarosExternalServer<KlarosIssueManagement, IssueManagement>
                            
    implements, IKlarosIssueManagement {
// Public Methods  public Set<KlarosIssue> getIssues();
  public String getProject();
}

Methods inherited from de.verit.klaros.core.model.KlarosExternalServer: getDescription , getType , getUrl

Methods inherited from de.verit.klaros.core.model.KlarosLabeledObject: asIterable , getCreated , getCreator , getKey , getLastEditor , getLastUpdated , getName , isEnabled

Methods inherited from de.verit.klaros.core.model.KlarosWrapper: equals , getWrapped , hashCode

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

B.1.1.45. KlarosIteration

An iteration in a project.

B.1.1.45.1. Synopsis
 public final class KlarosIteration extends, 
                                KlarosNamedEntity<KlarosIteration, Iteration>
                            
    implements, IKlarosIteration, Comparable<KlarosIteration> {
// Public Methods  public int compareTo(KlarosIteration o);
  public boolean equals(Object o);
  public Set<KlarosAttachment> getAttachments();
  public Set<KlarosCategoryNode> getCategories();
  public StateDef getCurrentState();
  public String getDescription();
  public Date getDueDate();
  public Set<KlarosTestEnvironment> getEnvs();
  public Set<KlarosJob> getJobs();
  public String getShortname();
  public Date getStartDate();
  public String getSuccessCriteria();
  public Set<KlarosSUTImplementation> getSuts();
  public Set<KlarosTestRun> getTestRuns();
  public int hashCode();
}

Methods inherited from de.verit.klaros.core.model.KlarosNamedEntity: getAssignee , getProperties , getPropertyValue , isDefinedProperty

Methods inherited from de.verit.klaros.core.model.KlarosLabeledObject: asIterable , getCreated , getCreator , getKey , getLastEditor , getLastUpdated , getName , isEnabled

Methods inherited from de.verit.klaros.core.model.KlarosWrapper: equals , getWrapped , hashCode

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

B.1.1.46. KlarosJob

This class provides access to the information stored for jobs.

B.1.1.46.1. Synopsis
 public final class KlarosJob extends, 
                                KlarosNamedEntity<KlarosJob, Job>
                            
    implements, IKlarosJob, Comparable<KlarosJob> {
// Public Methods  public int compareTo(KlarosJob o);
  public boolean equals(Object o);
  public Set<KlarosAttachment> getAttachments();
  public KlarosConfiguration getConfiguration();
  public Set<KlarosJobDependency> getDependentJobs();
  public String getDescription();
  public Date getDueDate();
  public KlarosTestEnvironment getEnv();
  public String getEstimatedTime();
  public Long getEstimatedTimeInMilliseconds();
  public JobPriority getJobPriority();
  public JobStatus getJobStatus();
  public JobType getJobType();
  public KlarosJob getParent();
  public Integer getProgress();
  public Set<KlarosJobDependency> getRequiredJobs();
  public Date getStartDate();
  public List<KlarosJob> getSubJobs();
  public Integer getSuccessRate();
  public String getSummary();
  public KlarosSUTImplementation getSut();
  public KlarosTestCase getTestCase();
  public Set<KlarosTestRun> getTestRuns();
  public KlarosTestSuite getTestSuite();
  public List<KlarosJobUpdateAction> getUpdateAction();
  public List<KlarosJobTimeBlock> getWork();
  public int hashCode();
}

Methods inherited from de.verit.klaros.core.model.KlarosNamedEntity: getAssignee , getProperties , getPropertyValue , isDefinedProperty

Methods inherited from de.verit.klaros.core.model.KlarosLabeledObject: asIterable , getCreated , getCreator , getKey , getLastEditor , getLastUpdated , getName , isEnabled

Methods inherited from de.verit.klaros.core.model.KlarosWrapper: equals , getWrapped , hashCode

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

B.1.1.47. KlarosJobDependency

This class provides access to the information stored for jobs.

B.1.1.47.1. Synopsis
 public final class KlarosJobDependency extends, KlarosWrapper<KlarosJobDependency, JobDependency>
    implements, IKlarosJobDependency, Comparable<KlarosJobDependency> {
// Public Methods  public int compareTo(KlarosJobDependency o);
  public boolean equals(Object o);
  public Set<JobStatus> getJobStates();
  public UUID getKey();
  public Integer getProgress();
  public KlarosJob getRequiredBy();
  public KlarosJob getRequires();
  public Integer getSuccessRate();
  public Set<Verdict> getVerdicts();
  public int hashCode();
}

Methods inherited from de.verit.klaros.core.model.KlarosWrapper: equals , getWrapped , hashCode

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

B.1.1.48. KlarosJobTimeBlock

The implementation of a job time block, measuring a unit of work done for a job.

B.1.1.48.1. Synopsis
 public final class KlarosJobTimeBlock extends, 
                                KlarosLabeledObject<KlarosJobTimeBlock, JobTimeBlock>
                            
    implements, IKlarosJobTimeBlock, Comparable<KlarosJobTimeBlock> {
// Public Methods  public int compareTo(KlarosJobTimeBlock o);
  public boolean equals(Object o);
  public String getDescription();
  public Date getDoneAt();
  public String getDuration();
  public Long getDurationInMilliseconds();
  public String getEstimatedTimeLeft();
  public Long getEstimatedTimeLeftInMilliseconds();
  public KlarosJob getJob();
  public KlarosTestRun getTestRun();
  public int hashCode();
}

Methods inherited from de.verit.klaros.core.model.KlarosLabeledObject: asIterable , getCreated , getCreator , getKey , getLastEditor , getLastUpdated , getName , isEnabled

Methods inherited from de.verit.klaros.core.model.KlarosWrapper: equals , getWrapped , hashCode

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

B.1.1.49. KlarosJobUpdateAction

The model of a job comment.

B.1.1.49.1. Synopsis
 public final class KlarosJobUpdateAction extends, 
                                KlarosLabeledObject<KlarosJobUpdateAction, JobUpdateAction>
                            
    implements, IKlarosJobUpdateAction, Comparable<KlarosJobUpdateAction> {
// Public Methods  public int compareTo(KlarosJobUpdateAction o);
  public boolean equals(Object o);
  public String getChanges();
  public String getDescription();
  public int hashCode();
}

Methods inherited from de.verit.klaros.core.model.KlarosLabeledObject: asIterable , getCreated , getCreator , getKey , getLastEditor , getLastUpdated , getName , isEnabled

Methods inherited from de.verit.klaros.core.model.KlarosWrapper: equals , getWrapped , hashCode

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

B.1.1.50. KlarosLabeledObject

This class encapsulates the (dynamic) properties of a klaros object.

B.1.1.50.1. Synopsis
 public abstract class KlarosLabeledObject<T,S extends LabeledObject> extends, KlarosWrapper<T, S>
    implements, IKlarosLabeledObject<T> {
// Public Methods  public Iterable<T> asIterable();
  public Date getCreated();
  public KlarosUser getCreator();
  public UUID getKey();
  public KlarosUser getLastEditor();
  public Date getLastUpdated();
  public String getName();
  public boolean isEnabled();
}

Direct known subclasses: de.­verit.­klaros.­core.­model.­KlarosConfiguration , de.­verit.­klaros.­core.­model.­KlarosExternalServer , de.­verit.­klaros.­core.­model.­KlarosJobTimeBlock , de.­verit.­klaros.­core.­model.­KlarosJobUpdateAction , de.­verit.­klaros.­core.­model.­KlarosNamedEntity , de.­verit.­klaros.­core.­model.­KlarosRepositoryEntity , de.­verit.­klaros.­core.­model.­KlarosUser

Methods inherited from de.verit.klaros.core.model.KlarosWrapper: equals , getWrapped , hashCode

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

B.1.1.51. KlarosNamedEntity

This class encapsulates the (dynamic) properties of a klaros object.

B.1.1.51.1. Synopsis
 public abstract class KlarosNamedEntity<T,S extends NamedEntity> extends, 
                                KlarosLabeledObject<T, S>
                            
    implements, IKlarosNamedEntity<T> {
// Public Methods  public KlarosUser getAssignee();
  public List<IKlarosProperty> getProperties();
  public String getPropertyValue(String propertyName);
  public boolean isDefinedProperty(String propertyName);
}

Direct known subclasses: de.­verit.­klaros.­core.­model.­KlarosCategoryTree , de.­verit.­klaros.­core.­model.­KlarosIssue , de.­verit.­klaros.­core.­model.­KlarosIteration , de.­verit.­klaros.­core.­model.­KlarosJob , de.­verit.­klaros.­core.­model.­KlarosResult , de.­verit.­klaros.­core.­model.­KlarosRevision , de.­verit.­klaros.­core.­model.­KlarosSUTImplementation , de.­verit.­klaros.­core.­model.­KlarosTestEnvironment , de.­verit.­klaros.­core.­model.­KlarosTestRun , de.­verit.­klaros.­core.­model.­KlarosTestStepContainer

Methods inherited from de.verit.klaros.core.model.KlarosLabeledObject: asIterable , getCreated , getCreator , getKey , getLastEditor , getLastUpdated , getName , isEnabled

Methods inherited from de.verit.klaros.core.model.KlarosWrapper: equals , getWrapped , hashCode

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

B.1.1.52. KlarosProperty

The Klaros property class.

B.1.1.52.1. Synopsis
 public final class KlarosProperty extends, KlarosWrapper<KlarosProperty, Property>
    implements, IKlarosProperty {
// Public Methods  public String getName();
  public String getValue();
}

Methods inherited from de.verit.klaros.core.model.KlarosWrapper: equals , getWrapped , hashCode

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

B.1.1.53. KlarosRepositoryEntity

This class encapsulates the (dynamic) properties of a klaros object.

B.1.1.53.1. Synopsis
 public abstract class KlarosRepositoryEntity<T extends KlarosRepositoryEntity<T, S>,S extends RepositoryEntity> extends, 
                                KlarosLabeledObject<T, S>
                            
    implements, IKlarosRepositoryEntity<T> {
// Public Methods  public String getMimeType();
  public String getName();
  public String getUuid();
  public String getVersion();
}

Direct known subclasses: de.­verit.­klaros.­core.­model.­KlarosAttachment

Methods inherited from de.verit.klaros.core.model.KlarosLabeledObject: asIterable , getCreated , getCreator , getKey , getLastEditor , getLastUpdated , getName , isEnabled

Methods inherited from de.verit.klaros.core.model.KlarosWrapper: equals , getWrapped , hashCode

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

B.1.1.54. KlarosRequirement

This class provides access to the information stored for requirements.

B.1.1.54.1. Synopsis
 public final class KlarosRequirement extends, 
                                KlarosRevision<KlarosRequirement, Requirement>
                            
    implements, IKlarosRequirement<KlarosRequirement, Requirement> {
// Public Methods  public Set<KlarosAttachment> getAttachments();
  public Set<KlarosCategoryNode> getCategories();
  public KlarosConfiguration getConfiguration();
  public Set<KlarosTestCase> getCoveringTestCases();
  public String getDescription();
  public Set<String> getExternalNames();
  public String getExternalStatus();
  public Set<KlarosIteration> getIterations();
  public KlarosRequirement getPredecessor();
  public RequirementPriority getPriority();
  public KlarosRequirement getRoot();
  public String getShortname();
  public String getState();
  public KlarosRequirement getSuccessor();
  public String getSummary();
}

Methods inherited from de.verit.klaros.core.model.KlarosRevision: getRevisionComment , getRevisionId

Methods inherited from de.verit.klaros.core.model.KlarosNamedEntity: getAssignee , getProperties , getPropertyValue , isDefinedProperty

Methods inherited from de.verit.klaros.core.model.KlarosLabeledObject: asIterable , getCreated , getCreator , getKey , getLastEditor , getLastUpdated , getName , isEnabled

Methods inherited from de.verit.klaros.core.model.KlarosWrapper: equals , getWrapped , hashCode

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

B.1.1.54.2. getExternalStatus()
public String getExternalStatus();

The external status of this requirement.

Parameters

return

the external status

B.1.1.55. KlarosRequirementsManagement

A requirement management system.

B.1.1.55.1. Synopsis
 public class KlarosRequirementsManagement extends, 
                                KlarosExternalServer<KlarosRequirementsManagement, RequirementsManagement>
                            
    implements, IKlarosRequirementsManagement {
// Public Methods  public String getProject();
}

Methods inherited from de.verit.klaros.core.model.KlarosExternalServer: getDescription , getType , getUrl

Methods inherited from de.verit.klaros.core.model.KlarosLabeledObject: asIterable , getCreated , getCreator , getKey , getLastEditor , getLastUpdated , getName , isEnabled

Methods inherited from de.verit.klaros.core.model.KlarosWrapper: equals , getWrapped , hashCode

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

B.1.1.56. KlarosResult

This class provides access to the information stored for generic results.

B.1.1.56.1. Synopsis
 public abstract class KlarosResult<T,S extends Result> extends, 
                                KlarosNamedEntity<T, S>
                            
    implements, IKlarosResult<T> {
// Public Methods  public String getDescription();
  public long getExecutionTime();
  public KlarosJob getJob();
  public String getSummary();
  public String getVerdict();
  public String getVerdict(Locale locale);
  public boolean isError();
  public boolean isFailure();
  public boolean isInconclusive();
  public boolean isPassed();
  public boolean isSkipped();
}

Direct known subclasses: de.­verit.­klaros.­core.­model.­KlarosTestCaseResult , de.­verit.­klaros.­core.­model.­KlarosTestCaseStepResult , de.­verit.­klaros.­core.­model.­KlarosTestSuiteResult

Methods inherited from de.verit.klaros.core.model.KlarosNamedEntity: getAssignee , getProperties , getPropertyValue , isDefinedProperty

Methods inherited from de.verit.klaros.core.model.KlarosLabeledObject: asIterable , getCreated , getCreator , getKey , getLastEditor , getLastUpdated , getName , isEnabled

Methods inherited from de.verit.klaros.core.model.KlarosWrapper: equals , getWrapped , hashCode

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

B.1.1.57. KlarosRevision

This class encapsulates the revision related information of a klaros object.

B.1.1.57.1. Synopsis
 public abstract class KlarosRevision<T,S extends Revision<?>> extends, 
                                KlarosNamedEntity<T, S>
                            
    implements, IKlarosRevision<T, S> {
// Public Methods  public final String getRevisionComment();
  public final String getRevisionId();
}

Direct known subclasses: de.­verit.­klaros.­core.­model.­KlarosRequirement , de.­verit.­klaros.­core.­model.­KlarosTestCase , de.­verit.­klaros.­core.­model.­KlarosTestSegment , de.­verit.­klaros.­core.­model.­KlarosTestSuite

Methods inherited from de.verit.klaros.core.model.KlarosNamedEntity: getAssignee , getProperties , getPropertyValue , isDefinedProperty

Methods inherited from de.verit.klaros.core.model.KlarosLabeledObject: asIterable , getCreated , getCreator , getKey , getLastEditor , getLastUpdated , getName , isEnabled

Methods inherited from de.verit.klaros.core.model.KlarosWrapper: equals , getWrapped , hashCode

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

B.1.1.58. KlarosSUTImplementation

This class provides access to the information stored for systems under tests (SUT).

B.1.1.58.1. Synopsis
 public final class KlarosSUTImplementation extends, 
                                KlarosNamedEntity<KlarosSUTImplementation, SystemUnderTest>
                            
    implements, IKlarosSUTImplementation, Comparable<KlarosSUTImplementation> {
// Public Methods  public int compareTo(KlarosSUTImplementation o);
  public boolean equals(Object o);
  public Set<KlarosAttachment> getAttachments();
  public Set<KlarosCategoryNode> getCategories();
  public KlarosConfiguration getConfiguration();
  public Set<KlarosIssue> getIssues();
  public Set<KlarosIteration> getIterations();
  public String getProductversion();
  public Set<KlarosTestRun> getTestRuns();
  public int hashCode();
}

Methods inherited from de.verit.klaros.core.model.KlarosNamedEntity: getAssignee , getProperties , getPropertyValue , isDefinedProperty

Methods inherited from de.verit.klaros.core.model.KlarosLabeledObject: asIterable , getCreated , getCreator , getKey , getLastEditor , getLastUpdated , getName , isEnabled

Methods inherited from de.verit.klaros.core.model.KlarosWrapper: equals , getWrapped , hashCode

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

B.1.1.59. KlarosTestCase

This class provides access to the information stored for a test case.

B.1.1.59.1. Synopsis
 public final class KlarosTestCase extends, 
                                KlarosRevision<KlarosTestCase, TestCase>
                            
    implements, IKlarosTestCase, Comparable<KlarosTestCase> {
// Public Methods  public int compareTo(KlarosTestCase o);
  public boolean equals(Object o);
  public Set<KlarosAttachment> getAttachments();
  public Set<KlarosCategoryNode> getCategories();
  public KlarosConfiguration getConfiguration();
  public Set<KlarosRequirement> getCovers();
  public String getDependency();
  public String getDescription();
  public TestDesignTechnique getDesignTechnique();
  public List<KlarosIssue> getDetectedIssues();
  public String getDocbase();
  public Long getEstimatedDuration();
  public TestEvaluationMethod getEvaluation();
  public TestExecutionMethod getExecution();
  public String getExpectedResult();
  public Set<String> getExternalNames();
  public List<KlarosJob> getJobs();
  public TestLevel getLevel();
  public String getNote();
  public String getPostcondition();
  public String getPrecondition();
  public KlarosTestCase getPredecessor();
  public TestPriority getPriority();
  public Set<KlarosTestCaseResult> getResults();
  public KlarosTestCase getRoot();
  public String getShortname();
  public String getState();
  public KlarosTestCase getSuccessor();
  public String getTeam();
  public List<KlarosTestCaseStep> getTestCaseSteps();
  public TestAreatopic getTestType();
  public String getTraceability();
  public TestVariety getVariety();
  public int hashCode();
}

Methods inherited from de.verit.klaros.core.model.KlarosRevision: getRevisionComment , getRevisionId

Methods inherited from de.verit.klaros.core.model.KlarosNamedEntity: getAssignee , getProperties , getPropertyValue , isDefinedProperty

Methods inherited from de.verit.klaros.core.model.KlarosLabeledObject: asIterable , getCreated , getCreator , getKey , getLastEditor , getLastUpdated , getName , isEnabled

Methods inherited from de.verit.klaros.core.model.KlarosWrapper: equals , getWrapped , hashCode

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

B.1.1.60. KlarosTestCaseResult

This class provides access to the information stored for test case results.

B.1.1.60.1. Synopsis
 public final class KlarosTestCaseResult extends, 
                                KlarosResult<KlarosTestCaseResult, TestCaseResult>
                            
    implements, IKlarosTestCaseResult, Comparable<KlarosTestCaseResult> {
// Public Methods  public int compareTo(KlarosTestCaseResult o);
  public boolean equals(Object o);
  public Set<KlarosAttachment> getAttachments();
  public List<KlarosTestCaseStepResult> getStepResults();
  public KlarosTestCase getTestCase();
  public KlarosTestRun getTestRun();
  public Integer getTestSuitePosition();
  public KlarosTestSuiteResult getTestSuiteResult();
  public int hashCode();
  public boolean isPending();
}

Methods inherited from de.verit.klaros.core.model.KlarosResult: getDescription , getExecutionTime , getJob , getSummary , getVerdict , isError , isFailure , isInconclusive , isPassed , isSkipped

Methods inherited from de.verit.klaros.core.model.KlarosNamedEntity: getAssignee , getProperties , getPropertyValue , isDefinedProperty

Methods inherited from de.verit.klaros.core.model.KlarosLabeledObject: asIterable , getCreated , getCreator , getKey , getLastEditor , getLastUpdated , getName , isEnabled

Methods inherited from de.verit.klaros.core.model.KlarosWrapper: equals , getWrapped , hashCode

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

B.1.1.61. KlarosTestCaseStep

This class provides access to the information stored for test case steps.

B.1.1.61.1. Synopsis
 public final class KlarosTestCaseStep extends, 
                                KlarosTestStepContainer<KlarosTestCaseStep, TestStep>
                            
    implements, IKlarosTestCaseStep<KlarosTestCaseStep> {
// Public Methods  public String getAction();
  public Set<KlarosAttachment> getAttachments();
  public String getExpectedResult();
  public String getPostcondition();
  public String getPrecondition();
}

Methods inherited from de.verit.klaros.core.model.KlarosNamedEntity: getAssignee , getProperties , getPropertyValue , isDefinedProperty

Methods inherited from de.verit.klaros.core.model.KlarosLabeledObject: asIterable , getCreated , getCreator , getKey , getLastEditor , getLastUpdated , getName , isEnabled

Methods inherited from de.verit.klaros.core.model.KlarosWrapper: equals , getWrapped , hashCode

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

B.1.1.62. KlarosTestCaseStepResult

This class provides access to the information stored for test case step results.

B.1.1.62.1. Synopsis
 public final class KlarosTestCaseStepResult extends, 
                                KlarosResult<KlarosTestCaseStepResult, TestCaseStepResult>
                            
    implements, IKlarosTestCaseStepResult, Comparable<KlarosTestCaseStepResult> {
// Public Methods  public int compareTo(KlarosTestCaseStepResult o);
  public boolean equals(Object o);
  public String getAction();
  public Set<KlarosAttachment> getAttachments();
  public String getExpectedResult();
  public String getPostcondition();
  public String getPrecondition();
  public KlarosTestCase getTestCase();
  public KlarosTestCaseResult getTestCaseResult();
  public KlarosTestRun getTestRun();
  public int hashCode();
}

Methods inherited from de.verit.klaros.core.model.KlarosResult: getDescription , getExecutionTime , getJob , getSummary , getVerdict , isError , isFailure , isInconclusive , isPassed , isSkipped

Methods inherited from de.verit.klaros.core.model.KlarosNamedEntity: getAssignee , getProperties , getPropertyValue , isDefinedProperty

Methods inherited from de.verit.klaros.core.model.KlarosLabeledObject: asIterable , getCreated , getCreator , getKey , getLastEditor , getLastUpdated , getName , isEnabled

Methods inherited from de.verit.klaros.core.model.KlarosWrapper: equals , getWrapped , hashCode

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

B.1.1.63. KlarosTestEnvironment

This class provides access to the information stored for test environments.

B.1.1.63.1. Synopsis
 public final class KlarosTestEnvironment extends, 
                                KlarosNamedEntity<KlarosTestEnvironment, TestEnvironment>
                            
    implements, IKlarosTestEnvironment, Comparable<KlarosTestEnvironment> {
// Public Methods  public int compareTo(KlarosTestEnvironment o);
  public boolean equals(Object o);
  public Set<KlarosAttachment> getAttachments();
  public Set<KlarosCategoryNode> getCategories();
  public String getDescription();
  public Set<KlarosIteration> getIterations();
  public Set<KlarosTestRun> getTestRuns();
  public int hashCode();
}

Methods inherited from de.verit.klaros.core.model.KlarosNamedEntity: getAssignee , getProperties , getPropertyValue , isDefinedProperty

Methods inherited from de.verit.klaros.core.model.KlarosLabeledObject: asIterable , getCreated , getCreator , getKey , getLastEditor , getLastUpdated , getName , isEnabled

Methods inherited from de.verit.klaros.core.model.KlarosWrapper: equals , getWrapped , hashCode

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

B.1.1.64. KlarosTestExecutable

This class provides access to the information stored for test cases.

B.1.1.64.1. Synopsis
 public final class KlarosTestExecutable extends, KlarosWrapper<KlarosTestExecutable, TestExecutable>
    implements, IKlarosTestExecutable {
}

Methods inherited from de.verit.klaros.core.model.KlarosWrapper: equals , getWrapped , hashCode

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

B.1.1.65. KlarosTestRun

This class provides access to the information stored for test runs.

B.1.1.65.1. Synopsis
 public final class KlarosTestRun extends, 
                                KlarosNamedEntity<KlarosTestRun, TestRun>
                            
    implements, IKlarosTestRun, Comparable<KlarosTestRun> {
// Public Methods  public int compareTo(KlarosTestRun o);
  public boolean equals(Object o);
  public KlarosConfiguration getConfiguration();
  public KlarosTestEnvironment getEnv();
  public KlarosIteration getIteration();
  public KlarosJob getJob();
  public int getNumberErrors();
  public int getNumberFailures();
  public int getNumberInconclusive();
  public int getNumberPassed();
  public int getNumberSkipped();
  public String getRelatedSummary();
  public Set<KlarosTestCaseResult> getResults();
  public String getRunId();
  public KlarosSUTImplementation getSut();
  public KlarosTestSuite getTestSuite();
  public Date getTimestamp();
  public Set<KlarosJobTimeBlock> getWork();
  public int hashCode();
  public boolean isPending();
}

Methods inherited from de.verit.klaros.core.model.KlarosNamedEntity: getAssignee , getProperties , getPropertyValue , isDefinedProperty

Methods inherited from de.verit.klaros.core.model.KlarosLabeledObject: asIterable , getCreated , getCreator , getKey , getLastEditor , getLastUpdated , getName , isEnabled

Methods inherited from de.verit.klaros.core.model.KlarosWrapper: equals , getWrapped , hashCode

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

B.1.1.66. KlarosTestSegment

This class provides access to the information stored for test segments.

B.1.1.66.1. Synopsis
 public final class KlarosTestSegment extends, 
                                KlarosRevision<KlarosTestSegment, TestSegment>
                            
    implements, IKlarosTestSegment<KlarosTestSegment, TestSegment> {
// Public Methods  public String getDescription();
  public String getExpectedResult();
  public String getNote();
  public String getPostcondition();
  public String getPrecondition();
  public KlarosRevision<KlarosTestSegment, TestSegment> getPredecessor();
  public KlarosRevision<KlarosTestSegment, TestSegment> getRoot();
  public String getShortname();
  public List<KlarosTestCaseStep> getSteps();
  public KlarosRevision<KlarosTestSegment, TestSegment> getSuccessor();
}

Methods inherited from de.verit.klaros.core.model.KlarosRevision: getRevisionComment , getRevisionId

Methods inherited from de.verit.klaros.core.model.KlarosNamedEntity: getAssignee , getProperties , getPropertyValue , isDefinedProperty

Methods inherited from de.verit.klaros.core.model.KlarosLabeledObject: asIterable , getCreated , getCreator , getKey , getLastEditor , getLastUpdated , getName , isEnabled

Methods inherited from de.verit.klaros.core.model.KlarosWrapper: equals , getWrapped , hashCode

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

B.1.1.67. KlarosTestStepContainer

This class encapsulates the (dynamic) properties of a klaros object.

B.1.1.67.1. Synopsis
 public abstract class KlarosTestStepContainer<T extends KlarosTestStepContainer<T, S>,S extends TestStepContainer> extends, 
                                KlarosNamedEntity<T, S>
                            
    implements, IKlarosTestStepContainer<T> {
}

Direct known subclasses: de.­verit.­klaros.­core.­model.­KlarosTestCaseStep

Methods inherited from de.verit.klaros.core.model.KlarosNamedEntity: getAssignee , getProperties , getPropertyValue , isDefinedProperty

Methods inherited from de.verit.klaros.core.model.KlarosLabeledObject: asIterable , getCreated , getCreator , getKey , getLastEditor , getLastUpdated , getName , isEnabled

Methods inherited from de.verit.klaros.core.model.KlarosWrapper: equals , getWrapped , hashCode

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

B.1.1.68. KlarosTestSuite

This class provides access to the information stored for test suites.

B.1.1.68.1. Synopsis
 public final class KlarosTestSuite extends, 
                                KlarosRevision<KlarosTestSuite, TestSuite>
                            
    implements, IKlarosTestSuite<KlarosTestSuite, TestSuite> {
// Public Methods  public Set<KlarosAttachment> getAttachments();
  public Set<KlarosCategoryNode> getCategories();
  public KlarosConfiguration getConfiguration();
  public KlarosTestSuite getPredecessor();
  public List<KlarosTestSuiteResult> getResults();
  public KlarosTestSuite getRoot();
  public String getShortname();
  public KlarosTestSuite getSuccessor();
  public KlarosSUTImplementation getSut();
  public List<KlarosTestCase> getTestCases();
  public Integer getTestSuiteResultCount();
}

Methods inherited from de.verit.klaros.core.model.KlarosRevision: getRevisionComment , getRevisionId

Methods inherited from de.verit.klaros.core.model.KlarosNamedEntity: getAssignee , getProperties , getPropertyValue , isDefinedProperty

Methods inherited from de.verit.klaros.core.model.KlarosLabeledObject: asIterable , getCreated , getCreator , getKey , getLastEditor , getLastUpdated , getName , isEnabled

Methods inherited from de.verit.klaros.core.model.KlarosWrapper: equals , getWrapped , hashCode

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

B.1.1.69. KlarosTestSuiteResult

This class provides access to the information stored for test suite results.

B.1.1.69.1. Synopsis
 public final class KlarosTestSuiteResult extends, 
                                KlarosResult<KlarosTestSuiteResult, TestSuiteResult>
                            
    implements, IKlarosTestSuiteResult, Comparable<KlarosTestSuiteResult> {
// Public Methods  public int compareTo(KlarosTestSuiteResult o);
  public boolean equals(Object o);
  public Set<KlarosTestCaseResult> getResults();
  public KlarosTestRun getTestRun();
  public KlarosTestSuite getTestSuite();
  public int hashCode();
  public boolean isPending();
}

Methods inherited from de.verit.klaros.core.model.KlarosResult: getDescription , getExecutionTime , getJob , getSummary , getVerdict , isError , isFailure , isInconclusive , isPassed , isSkipped

Methods inherited from de.verit.klaros.core.model.KlarosNamedEntity: getAssignee , getProperties , getPropertyValue , isDefinedProperty

Methods inherited from de.verit.klaros.core.model.KlarosLabeledObject: asIterable , getCreated , getCreator , getKey , getLastEditor , getLastUpdated , getName , isEnabled

Methods inherited from de.verit.klaros.core.model.KlarosWrapper: equals , getWrapped , hashCode

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

B.1.1.70. KlarosUser

The user object.

B.1.1.70.1. Synopsis
 public class KlarosUser extends, 
                                KlarosLabeledObject<KlarosUser, User>
                            
    implements, IKlarosUser, Comparable<KlarosUser> {
// Public Methods  public int compareTo(KlarosUser o);
  public boolean equals(Object o);
  public String getEmail();
  public UserRole getRole();
  public String getUsername();
  public int hashCode();
  public String toString();
}

Methods inherited from de.verit.klaros.core.model.KlarosLabeledObject: asIterable , getCreated , getCreator , getKey , getLastEditor , getLastUpdated , getName , isEnabled

Methods inherited from de.verit.klaros.core.model.KlarosWrapper: equals , getWrapped , hashCode

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

B.1.2. Deprecated API

B.1.2.1. Deprecated Methods

B.2. Scripting API Reference

B.2.1. de.verit.klaros.scripting

B.2.1.1. IKlarosQueryFactory

A factory for executing Klaros queries.

B.2.1.1.1. Synopsis
 public interface IKlarosQueryFactory extends, Serializable {
// Public Methods  public abstract List<?> execute(String query);
  public abstract List<?> execute(String query,
                                  ParameterContext params);

}
B.2.1.1.2. execute(String)
public abstract List<?> execute(String query);

Prepares the given query string with our KlarosOdaQuery and returns a KlarosList with the results of the query.

Parameters

query

the query

return

the list of query results

B.2.1.1.3. execute(String, ParameterContext)
public abstract List<?> execute(String query,
                                ParameterContext params);

Prepares the given query string with our KlarosOdaQuery and returns a KlarosList with the results of the query.

Parameters

query

the query

params

the parameters

return

the list

B.2.1.2. KlarosContext

Context to provide all methods to the user to add own objects to the event context.

B.2.1.2.1. Synopsis
 public class KlarosContextimplements, IKlarosContext {
// Public Constructors  public KlarosContext(Context context,
                       UUID authenticatedUserId,
                       UUID activeProjectId,
                       UUID activeIterationId,
                       String applicationUrl,
                       IKlarosQueryFactory factory,
                       ParameterContext parameters);

  public KlarosContext(Context context,
                       UUID authenticatedUserId,
                       UUID activeProjectId,
                       UUID activeIterationId,
                       String applicationUrl,
                       IKlarosQueryFactory factory,
                       ParameterContext parameters,
                       Locale locale);

// Public Methods  public void add(String name,
                  Object value);

  public boolean containsParameter(String name);
  public List<?> executeParameterizedQuery(String query);
  public List<?> executeQuery(String query);
  public KlarosIteration getActiveIteration();
  public KlarosConfiguration getActiveProject();
  public String getAttachmentUrl(String attachmentId);
  public String getAttachmentUrl(String attachmentId,
                                 String version);

  public String getAttachmentUrl(UUID attachmentId);
  public String getAttachmentUrl(UUID attachmentId,
                                 String version);

  public String getBrowsePageUrl(KlarosLabeledObject<?, ?> artifact);
  public Locale getLocale();
  public Parameter getParameter(String name);
  public Object getParameterValue(String name);
  public String getPrintPageUrl(KlarosLabeledObject<?, ?> artifact);
  public void setLocale(Locale locale);
}

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

B.2.1.2.2. KlarosContext(Context, UUID, UUID, UUID, String, IKlarosQueryFactory, ParameterContext)
public KlarosContext(Context context,
                     UUID authenticatedUserId,
                     UUID activeProjectId,
                     UUID activeIterationId,
                     String applicationUrl,
                     IKlarosQueryFactory factory,
                     ParameterContext parameters);

Create a KlarosContext.

Parameters

context

Gets passed by the relating servlet.

authenticatedUserId

the authenticated user id

activeProjectId

the active project id

activeIterationId

the active iteration id if available

applicationUrl

the application url

factory

the factory

parameters

the parameters

B.2.1.2.3. KlarosContext(Context, UUID, UUID, UUID, String, IKlarosQueryFactory, ParameterContext, Locale)
public KlarosContext(Context context,
                     UUID authenticatedUserId,
                     UUID activeProjectId,
                     UUID activeIterationId,
                     String applicationUrl,
                     IKlarosQueryFactory factory,
                     ParameterContext parameters,
                     Locale locale);

Create a KlarosContext.

Parameters

context

Gets passed by the relating servlet.

authenticatedUserId

the authenticated user id

activeProjectId

the active project id

activeIterationId

the active iteration id

applicationUrl

the application url

factory

the factory

parameters

the parameters

locale

the locale

B.2.2. de.verit.klaros.scripting.context

B.2.2.1. IKlarosContext

The context object encapsulates the input/output interface a report script can access. <orderedlist> <listitem>

The parameters given before starting the report.

</listitem> <listitem>

An HQL query interface for retrieving model objects from the database.

</listitem>
<listitem>

A writable context for storing values for template access.

</listitem>
<listitem>

Access to current Klaros settings (current project, current iteration, locale settings)

</listitem>
<listitem>

URL conversions for generating URLs to attachments, page and print page objects inside the application.

</listitem>
</orderedlist>

The following entries are available

B.2.2.1.1. Synopsis
 public interface IKlarosContext {
// Public Methods  public abstract void add(String name,
                           Object value);

  public abstract boolean containsParameter(String parameterName);
  public abstract List<?> executeParameterizedQuery(String query);
  public abstract List<?> executeQuery(String query);
  public abstract KlarosIteration getActiveIteration();
  public abstract KlarosConfiguration getActiveProject();
  public abstract String getAttachmentUrl(String attachmentId);
  public abstract String getAttachmentUrl(String attachmentId,
                                          String revision);

  public abstract String getAttachmentUrl(UUID attachmentId);
  public abstract String getAttachmentUrl(UUID attachmentId,
                                          String revision);

  public abstract String getBrowsePageUrl(KlarosLabeledObject<?, ?> artifact);
  public abstract Locale getLocale();
  public abstract Parameter getParameter(String parameterName);
  public abstract Object getParameterValue(String name);
  public abstract String getPrintPageUrl(KlarosLabeledObject<?, ?> artifact);
  public abstract void setLocale(Locale locale);
}
B.2.2.1.2. add(String, Object)
public abstract void add(String name,
                         Object value);

Add a new object with the give key to the event context.

Parameters

name

the name

value

the value

B.2.2.1.3. containsParameter(String)
public abstract boolean containsParameter(String parameterName);

Checks if the parameter is available in the context.

Parameters

parameterName

the parameter name

return

true, if successful

B.2.2.1.4. executeParameterizedQuery(String)
public abstract List<?> executeParameterizedQuery(String query);

Execute the given query with the Parameters from the ParameterContext.

Parameters

query

The HQL query to execute.

return

A KlarosList of the selected objects.

B.2.2.1.5. executeQuery(String)
public abstract List<?> executeQuery(String query);

Execute the given query.

Parameters

query

The HQL query to execute.

return

A KlarosList of the selected objects.

B.2.2.1.6. getActiveIteration()
public abstract KlarosIteration getActiveIteration();

Gets the active iteration.

Parameters

return

the active iteration

B.2.2.1.7. getActiveProject()
public abstract KlarosConfiguration getActiveProject();

Gets the active project.

Parameters

return

the active project

B.2.2.1.8. getAttachmentUrl(String)
public abstract String getAttachmentUrl(String attachmentId);

Return an URL string to retrieve the attachment with given attachment id.

Parameters

attachmentId

the attachment id

return

the attachment url

B.2.2.1.9. getAttachmentUrl(String, String)
public abstract String getAttachmentUrl(String attachmentId,
                                        String revision);

Return an URL string to retrieve the attachment with given attachment id string and revision.

Parameters

attachmentId

the attachment id

revision

the revision

return

the attachment url

B.2.2.1.10. getAttachmentUrl(UUID)
public abstract String getAttachmentUrl(UUID attachmentId);

Return an URL string to retrieve the attachment with given attachment UUID.

Parameters

attachmentId

the attachment id

return

the attachment url

B.2.2.1.11. getAttachmentUrl(UUID, String)
public abstract String getAttachmentUrl(UUID attachmentId,
                                        String revision);

Return an URL string to retrieve the attachment with given attachment UUID and revision.

Parameters

attachmentId

the attachment id

revision

the revision string

return

the attachment url

B.2.2.1.12. getBrowsePageUrl(KlarosLabeledObject<?, ?>)
public abstract String getBrowsePageUrl(KlarosLabeledObject<?, ?> artifact);

Gets the browse page url to the given klaros artifact. Will return null if the artifact type is not supported.

Parameters

artifact

the artifact

return

the browse page url

B.2.2.1.13. getLocale()
public abstract Locale getLocale();

/** Returns the active Java Locale setting.

Parameters

return

the Java Locale

B.2.2.1.14. getParameter(String)
public abstract Parameter getParameter(String parameterName);

Gets the parameter.

Parameters

parameterName

the parameter name

return

The parameter with the given name

Exceptions

KlarosIllegalArgumentException

if the parameter is not available.

B.2.2.1.15. getParameterValue(String)
public abstract Object getParameterValue(String name);

Gets the parameter value.

Parameters

name

the name

return

The parameter with the given name

Exceptions