Appendix B. 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.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. IKlarosIssue
B.1.1.8. IKlarosIssueManagement
B.1.1.9. IKlarosIteration
B.1.1.10. IKlarosJob
B.1.1.11. IKlarosJobDependency
B.1.1.12. IKlarosJobTimeBlock
B.1.1.13. IKlarosJobUpdateAction
B.1.1.14. IKlarosLabeledObject
B.1.1.15. IKlarosNamedEntity
B.1.1.16. IKlarosProperty
B.1.1.17. IKlarosRequirement
B.1.1.18. IKlarosRequirementManagement
B.1.1.19. IKlarosRevision
B.1.1.20. IKlarosSUTImplementation
B.1.1.21. IKlarosTag
B.1.1.22. IKlarosTestCase
B.1.1.23. IKlarosTestCaseResult
B.1.1.24. IKlarosTestCaseStep
B.1.1.25. IKlarosTestCaseStepResult
B.1.1.26. IKlarosTestEnvironment
B.1.1.27. IKlarosTestExecutable
B.1.1.28. IKlarosTestRun
B.1.1.29. IKlarosTestSegment
B.1.1.30. IKlarosTestStepContainer
B.1.1.31. IKlarosTestSuite
B.1.1.32. IKlarosTestSuiteResult
B.1.1.33. IKlarosUser
B.1.1.34. KlarosAttachment
B.1.1.35. KlarosCategoryNode
B.1.1.36. KlarosCategoryTree
B.1.1.37. KlarosConfiguration
B.1.1.38. KlarosEnumValue
B.1.1.39. KlarosIssue
B.1.1.40. KlarosIssueManagement
B.1.1.41. KlarosIteration
B.1.1.42. KlarosIterationCategoryNode
B.1.1.43. KlarosIterationCategoryTree
B.1.1.44. KlarosJob
B.1.1.45. KlarosJobDependency
B.1.1.46. KlarosJobTimeBlock
B.1.1.47. KlarosJobUpdateAction
B.1.1.48. KlarosLabeledObject
B.1.1.49. KlarosNamedEntity
B.1.1.50. KlarosProperty
B.1.1.51. KlarosRequirement
B.1.1.52. KlarosRequirementCategoryNode
B.1.1.53. KlarosRequirementCategoryTree
B.1.1.54. KlarosRequirementManagement
B.1.1.55. KlarosRevision
B.1.1.56. KlarosSUTImplementation
B.1.1.57. KlarosSUTImplementationCategoryNode
B.1.1.58. KlarosSUTImplementationCategoryTree
B.1.1.59. KlarosTestCase
B.1.1.60. KlarosTestCaseCategoryNode
B.1.1.61. KlarosTestCaseCategoryTree
B.1.1.62. KlarosTestCaseResult
B.1.1.63. KlarosTestCaseStep
B.1.1.64. KlarosTestCaseStepResult
B.1.1.65. KlarosTestEnvironment
B.1.1.66. KlarosTestEnvironmentCategoryNode
B.1.1.67. KlarosTestEnvironmentCategoryTree
B.1.1.68. KlarosTestExecutable
B.1.1.69. KlarosTestRun
B.1.1.70. KlarosTestSegment
B.1.1.71. KlarosTestStepContainer
B.1.1.72. KlarosTestSuite
B.1.1.73. KlarosTestSuiteCategoryNode
B.1.1.74. KlarosTestSuiteCategoryTree
B.1.1.75. KlarosTestSuiteResult
B.1.1.76. KlarosUser

B.1.1.1. IKlarosAttachment

This interface provides access to a binary attachment.

B.1.1.1.1. Synopsis

 public interface IKlarosAttachment {
// Public Methods  public abstract String getMimeType();
  public abstract String getName();
  public abstract long getSize();
  public abstract String getUuid();
  public abstract String getVersion();
}

B.1.1.1.2. getMimeType()

public abstract String getMimeType();

Gets the mime type of the attachment.

Parameters

return

the mime type

B.1.1.1.3. getName()

public abstract String getName();

Gets the name of the attachment.

Parameters

return

the name

B.1.1.1.4. getSize()

public abstract long getSize();

Gets the size in bytes of this attachment.

Parameters

return

the size

B.1.1.1.5. 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.1.6. getVersion()

public abstract String getVersion();

Gets the version of this attachment.

Parameters

return

the version

B.1.1.2. IKlarosCategoryNode

A Klaros Category Node.

B.1.1.2.1. Synopsis

 public interface IKlarosCategoryNode<I,T,W,P> {
// Public Methods  public abstract T getCategoryTree();
  public abstract String getDescription();
  public abstract W getParent();
  public abstract List<I> getReferences();
  public abstract String getShortname();
  public abstract List<W> getSubCategories();
}

B.1.1.2.2. getCategoryTree()

public abstract T 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 W getParent();

Gets the parent category node.

Parameters

return

the parent

B.1.1.2.5. getReferences()

public abstract List<I> getReferences();

Gets the references of this category.

Parameters

return

the references

B.1.1.2.6. getShortname()

public abstract String getShortname();

Gets the shortname.

Parameters

return

the shortname

B.1.1.2.7. getSubCategories()

public abstract List<W> getSubCategories();

Gets the sub categories.

Parameters

return

the sub categories

B.1.1.3. IKlarosCategoryTree

A generic category tree.

B.1.1.3.1. Synopsis

 public interface IKlarosCategoryTree<I,W extends KlarosCategoryTree<I, W, P, X, Y>,P extends CategoryTree,X extends KlarosCategoryNode<I, W, X, Y>,Y extends CategoryNode> extends, IKlarosNamedEntity {
// Public Methods  public abstract String getDescription();
  public abstract KlarosCategoryNode<I, W, X, Y> 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<I, W, X, Y> 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 {
// Public Methods  public abstract String getDescription();
  public abstract Set<KlarosTestEnvironment> getEnvs();
  public abstract Set<KlarosIssueManagement> getIssueManagementSystems();
  public abstract Set<KlarosIterationCategoryTree> getIterationCategoryTrees();
  public abstract Set<KlarosIteration> getIterations();
  public abstract Set<KlarosJob> getJobs();
  public abstract Set<KlarosRequirementCategoryTree> getRequirementCategoryTrees();
  public abstract KlarosRequirementManagement getRequirementManagementSystems();
  public abstract Set<KlarosRequirement> getRequirements();
  public abstract Set<KlarosSUTImplementation> getSuts();
  public abstract Set<KlarosSUTImplementationCategoryTree> getSystemUnderTestCategoryTrees();
  public abstract Set<KlarosTestCaseCategoryTree> getTestCaseCategoryTrees();
  public abstract Set<KlarosTestCase> getTestCases();
  public abstract Set<KlarosTestEnvironmentCategoryTree> getTestEnvironmentCategoryTrees();
  public abstract Set<KlarosTestRun> getTestRuns();
  public abstract Set<KlarosTestSuiteCategoryTree> 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. getIterationCategoryTrees()

public abstract Set<KlarosIterationCategoryTree> getIterationCategoryTrees();

Returns the project requirement category trees.

Parameters

return

Set containing the iteration category trees of the project.

B.1.1.4.6. getIterations()

public abstract Set<KlarosIteration> getIterations();

Returns the project iteration.

Parameters

return

KlarosSet containing the iteration objects of the project.

B.1.1.4.7. getJobs()

public abstract Set<KlarosJob> getJobs();

Returns the project jobs.

Parameters

return

KlarosSet containing the job objects of the project.

B.1.1.4.8. getRequirementCategoryTrees()

public abstract Set<KlarosRequirementCategoryTree> getRequirementCategoryTrees();

Returns the project requirement category trees.

Parameters

return

Set containing the requirement category trees of the project.

B.1.1.4.9. getRequirementManagementSystems()

public abstract KlarosRequirementManagement getRequirementManagementSystems();

Returns the related requirement management systems.

Parameters

return

Set containing the related requirement management systems 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. 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.12. getSystemUnderTestCategoryTrees()

public abstract Set<KlarosSUTImplementationCategoryTree> 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.13. getTestCaseCategoryTrees()

public abstract Set<KlarosTestCaseCategoryTree> getTestCaseCategoryTrees();

Returns the project test case category trees.

Parameters

return

Set containing the test case category trees of the project.

B.1.1.4.14. 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.15. getTestEnvironmentCategoryTrees()

public abstract Set<KlarosTestEnvironmentCategoryTree> getTestEnvironmentCategoryTrees();

Returns the project test environment category trees.

Parameters

return

Set containing the test environment category trees of the project.

B.1.1.4.16. 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.17. getTestSuiteCategoryTrees()

public abstract Set<KlarosTestSuiteCategoryTree> getTestSuiteCategoryTrees();

Returns the project test suite category trees.

Parameters

return

Set containing the test suite category trees of the project.

B.1.1.4.18. 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.19. 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 {
// 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 {
// 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. IKlarosIssue

This interface provides access to a software issue.

B.1.1.7.1. Synopsis

 public interface IKlarosIssue {
// Public Methods  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 Date getLastUpdated();
  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<KlarosTestCase> getTestCases();
  public abstract boolean isResolved();
}

B.1.1.7.2. getAcceptedIn()

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.7.3. getCreationDate()

public abstract Date getCreationDate();

Gets the creation date of this issue.

Parameters

return

the creation date of this issue.

B.1.1.7.4. getDescription()

public abstract String getDescription();

Get the description.

Parameters

return

The description of this issue.

B.1.1.7.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.7.6. getIssueManagement()

public abstract KlarosIssueManagement getIssueManagement();

Gets the issue management this issue belongs to.

Parameters

return

the issue management

B.1.1.7.7. getLastSynched()

public abstract Date getLastSynched();

Gets the last synchronization date of this issue.

Parameters

return

the last synched date of this issue.

B.1.1.7.8. getLastUpdated()

public abstract Date getLastUpdated();

Gets the last update date.

Parameters

return

the last update date

B.1.1.7.9. 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.7.10. 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.7.11. 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.7.12. 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.7.13. 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.7.14. 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.7.15. getSubject()

public abstract String getSubject();

Gets the subject of this issue.

Parameters

return

the subject string of this issue.

B.1.1.7.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.7.17. isResolved()

public abstract boolean isResolved();

Checks if this issue is resolved.

Parameters

return

true, if resolved

B.1.1.8. IKlarosIssueManagement

The interface for accessing issue management systems.

B.1.1.8.1. Synopsis

 public interface IKlarosIssueManagement {
// Public Methods  public abstract String getDescription();
  public abstract Set<KlarosIssue> getIssues();
  public abstract String getName();
  public abstract String getProject();
  public abstract String getType();
  public abstract String getUrl();
}

B.1.1.8.2. getDescription()

public abstract String getDescription();

Get the description of this system.

Parameters

return

The description

B.1.1.8.3. getIssues()

public abstract Set<KlarosIssue> getIssues();

Gets the referenced issues of this system.

Parameters

return

the issues

B.1.1.8.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.8.5. getProject()

public abstract String getProject();

Get the optional project of this system.

Parameters

return

The project

B.1.1.8.6. getType()

public abstract String getType();

Get the type of this system.

Parameters

return

The type

B.1.1.8.7. getUrl()

public abstract String getUrl();

Get the base url of this system.

Parameters

return

The url

B.1.1.9. IKlarosIteration

An iteration in a project.

B.1.1.9.1. Synopsis

 public interface IKlarosIteration extends, IKlarosNamedEntity {
// Public Methods  public abstract Set<KlarosAttachment> getAttachments();
  public abstract Set<KlarosIterationCategoryNode> 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.9.2. getAttachments()

public abstract Set<KlarosAttachment> getAttachments();

Gets the attachments associated with this iteration.

Parameters

return

the attachments

B.1.1.9.3. getCategories()

public abstract Set<KlarosIterationCategoryNode> 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.9.4. getCurrentState()

public abstract StateDef getCurrentState();

Gets the current state.

Parameters

return

the current state

B.1.1.9.5. getDescription()

public abstract String getDescription();

Gets the description.

Parameters

return

the description

B.1.1.9.6. getDueDate()

public abstract Date getDueDate();

Gets the due date.

Parameters

return

the due date

B.1.1.9.7. getEnvs()

public abstract Set<KlarosTestEnvironment> getEnvs();

Gets the test environments associated with this iteration.

Parameters

return

the test environments

B.1.1.9.8. getJobs()

public abstract Set<KlarosJob> getJobs();

Gets the jobs associated with this iteration.

Parameters

return

the jobs

B.1.1.9.9. getShortname()

public abstract String getShortname();

Gets the short name.

Parameters

return

the short name

B.1.1.9.10. getStartDate()

public abstract Date getStartDate();

Gets the start date.

Parameters

return

the start date

B.1.1.9.11. getSuccessCriteria()

public abstract String getSuccessCriteria();

Gets the success criteria.

Parameters

return

the success criteria

B.1.1.9.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.9.13. getTestRuns()

public abstract Set<KlarosTestRun> getTestRuns();

Gets the test runs associated with this iteration.

Parameters

return

the test runs

B.1.1.10. IKlarosJob

This interface provides access to the data of a job.

B.1.1.10.1. Synopsis

 public interface IKlarosJob extends, IKlarosNamedEntity {
// 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.10.2. getAttachments()

public abstract Set<KlarosAttachment> getAttachments();

Gets the attachments associated with this job.

Parameters

return

the attachments

B.1.1.10.3. getDependentJobs()

public abstract Set<KlarosJobDependency> getDependentJobs();

Gets the jobs depending on this jobs state.

Parameters

return

the dependent jobs

B.1.1.10.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.10.5. getTestRuns()

public abstract Set<KlarosTestRun> getTestRuns();

Gets the test runs executed with this job.

Parameters

return

the test runs

B.1.1.10.6. getUpdateAction()

public abstract List<KlarosJobUpdateAction> getUpdateAction();

Gets the update action list.

Parameters

return

the update action

B.1.1.10.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.11. IKlarosJobDependency

This interface provides access to the data of a job.

B.1.1.11.1. Synopsis

 public interface IKlarosJobDependency {
// 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.11.2. getJobStates()

public abstract Set<JobStatus> getJobStates();

Gets the job states.

Parameters

return

the job states

B.1.1.11.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.11.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.11.5. getRequires()

public abstract KlarosJob getRequires();

Returns the job this dependency requires for evaluation.

Parameters

return

the job this dependency requires

B.1.1.11.6. getVerdicts()

public abstract Set<Verdict> getVerdicts();

Gets the verdicts.

Parameters

return

the verdicts

B.1.1.12. IKlarosJobTimeBlock

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

B.1.1.12.1. Synopsis

 public interface IKlarosJobTimeBlock {
// 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.12.2. getDescription()

public abstract String getDescription();

Gets the work description.

Parameters

return

the work description

B.1.1.12.3. getDoneAt()

public abstract Date getDoneAt();

Gets the date this work was done at.

Parameters

return

the start date

B.1.1.12.4. getDuration()

public abstract String getDuration();

Gets the work duration as a String.

Parameters

return

the duration

B.1.1.12.5. getDurationInMilliseconds()

public abstract Long getDurationInMilliseconds();

Gets the work duration in milliseconds.

Parameters

return

the work duration in hours

B.1.1.12.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.12.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.12.8. getJob()

public abstract KlarosJob getJob();

Gets the job this job time block belongs to.

Parameters

return

the job

B.1.1.12.9. getTestRun()

public abstract KlarosTestRun getTestRun();

Gets the test run this job time block belongs to.

Parameters

return

the test run

B.1.1.13. IKlarosJobUpdateAction

This interface provides access to the job update action.

B.1.1.13.1. Synopsis

 public interface IKlarosJobUpdateAction {
// Public Methods  public abstract String getChanges();
  public abstract String getDescription();
}

B.1.1.13.2. getChanges()

public abstract String getChanges();

Gets the changes.

Parameters

return

the changes

B.1.1.13.3. getDescription()

public abstract String getDescription();

Gets the description.

Parameters

return

the description

B.1.1.14. IKlarosLabeledObject

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

B.1.1.14.1. Synopsis

 public interface IKlarosLabeledObject {
// Public Methods  public abstract Iterable<?> 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.14.2. asIterable()

public abstract Iterable<?> asIterable();

Return this object as an iterable containing just this object.

Parameters

return

the iterable container

B.1.1.14.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.14.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.14.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.15. IKlarosNamedEntity

This interface provides access to data of a properties owner.

B.1.1.15.1. Synopsis

 public interface IKlarosNamedEntity extends, IKlarosLabeledObject {
// 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.15.2. getProperties()

public abstract List<IKlarosProperty> getProperties();

Gets the list of properties.

Parameters

return

the properties

B.1.1.15.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.15.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.16. IKlarosProperty

A user defined property.

B.1.1.16.1. Synopsis

 public interface IKlarosProperty {
// Public Methods  public abstract String getName();
  public abstract String getValue();
}

B.1.1.16.2. getName()

public abstract String getName();

Gets the property name.

Parameters

return

the property name

B.1.1.16.3. getValue()

public abstract String getValue();

Gets the property value.

Parameters

return

the property value

B.1.1.17. IKlarosRequirement

This interface provides access to data of a requirement.

B.1.1.17.1. Synopsis

 public interface IKlarosRequirement<T,S extends Revision> extends, IKlarosRevision<T, S> {
// Public Methods  public abstract Set<KlarosAttachment> getAttachments();
  public abstract Set<KlarosRequirementCategoryNode> 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.17.2. getAttachments()

public abstract Set<KlarosAttachment> getAttachments();

Gets the attachments associated with this requirement.

Parameters

return

the attachments

B.1.1.17.3. getCategories()

public abstract Set<KlarosRequirementCategoryNode> 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.17.4. getConfiguration()

public abstract KlarosConfiguration getConfiguration();

Get configuration.

Parameters

return

The related configuration.

B.1.1.17.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.17.6. getDescription()

public abstract String getDescription();

Get the description.

Parameters

return

the string

B.1.1.17.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.17.8. getExternalStatus()

public abstract String getExternalStatus();

Gets the external status.

Parameters

return

the external status

B.1.1.17.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.17.10. getPriority()

public abstract RequirementPriority getPriority();

Gets the priority.

Parameters

return

the priority

B.1.1.17.11. getShortname()

public abstract String getShortname();

Gets the shortname.

Parameters

return

the shortname

B.1.1.17.12. getState()

public abstract String getState();

Gets the state.

Parameters

return

the state

B.1.1.17.13. getSummary()

public abstract String getSummary();

Gets the summary.

Parameters

return

the summary

B.1.1.18. IKlarosRequirementManagement

The interface for accessing requirements management systems.

B.1.1.18.1. Synopsis

 public interface IKlarosRequirementManagement {
// Public Methods  public abstract String getDescription();
  public abstract String getName();
  public abstract String getProject();
  public abstract Set<KlarosRequirement> getRequirements();
  public abstract String getType();
  public abstract String getUrl();
}

B.1.1.18.2. getDescription()

public abstract String getDescription();

Get the description of this system.

Parameters

return

The description

B.1.1.18.3. 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.18.4. getProject()

public abstract String getProject();

Get the optional project of this system.

Parameters

return

The project

B.1.1.18.5. getRequirements()

public abstract Set<KlarosRequirement> getRequirements();

Gets the referenced requirements of this system.

Parameters

return

the issues

B.1.1.18.6. getType()

public abstract String getType();

Get the type of this system.

Parameters

return

The type

B.1.1.18.7. getUrl()

public abstract String getUrl();

Get the base url of this system.

Parameters

return

The url

B.1.1.19. IKlarosRevision

This interface provides access to a revisionable Klaros object.

B.1.1.19.1. Synopsis

 public interface IKlarosRevision<T,S extends Revision> extends, IKlarosNamedEntity {
// 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.19.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.19.3. getRevisionComment()

public abstract String getRevisionComment();

Get comment.

Parameters

return

The comment of the revision.

B.1.1.19.4. getRevisionId()

public abstract String getRevisionId();

Get the revision id.

Parameters

return

The revision id.

B.1.1.19.5. getRoot()

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

Get the root of the revision hierarchy.

Parameters

return

The root revision object.

B.1.1.19.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.20. IKlarosSUTImplementation

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

B.1.1.20.1. Synopsis

 public interface IKlarosSUTImplementation extends, IKlarosNamedEntity {
// Public Methods  public abstract Set<KlarosAttachment> getAttachments();
  public abstract Set<KlarosSUTImplementationCategoryNode> 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.20.2. getAttachments()

public abstract Set<KlarosAttachment> getAttachments();

Gets the attachments associated with this system under test.

Parameters

return

the attachments

B.1.1.20.3. getCategories()

public abstract Set<KlarosSUTImplementationCategoryNode> 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.20.4. getConfiguration()

public abstract KlarosConfiguration getConfiguration();

Get configuration.

Parameters

return

The related configuration.

B.1.1.20.5. getIssues()

public abstract Set<KlarosIssue> getIssues();

Gets the issues related to this system under test.

Parameters

return

the issues

B.1.1.20.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.20.7. getProductversion()

public abstract String getProductversion();

Get product version.

Parameters

return

The version id of the system under test.

B.1.1.20.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.21. IKlarosTag

This interface provides access to the data of a tag.

B.1.1.21.1. Synopsis

 public interface IKlarosTag {
// Public Methods  public abstract Set<KlarosRevision<?, ?>> getRevisions();
  public abstract String getTagId();
  public abstract Date getTimestamp();
}

B.1.1.21.2. getRevisions()

public abstract Set<KlarosRevision<?, ?>> getRevisions();

Get related revisions.

Parameters

return

Collection of revision objects which are related to this tag.

B.1.1.21.3. getTagId()

public abstract String getTagId();

Get tag id.

Parameters

return

The id of the tag.

B.1.1.21.4. getTimestamp()

public abstract Date getTimestamp();

Get timestamp.

Parameters

return

The time of the creation of the tag as a Date object.

B.1.1.22. IKlarosTestCase

This class provides access to data of a test case.

B.1.1.22.1. Synopsis

 public interface IKlarosTestCase<T,S extends Revision> extends, IKlarosRevision<T, S> {
// Public Methods  @Deprecated public abstract TestAreatopic getArea();
  public abstract Set<KlarosAttachment> getAttachments();
  public abstract Set<KlarosTestCaseCategoryNode> 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 String 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();
  @Deprecated public abstract String getStateName(KlarosSUTImplementation sut);
  public abstract String getTeam();
  public abstract List<KlarosTestStepContainer<?, ?>> getTestCaseSteps();
  public abstract TestAreatopic getTestType();
  public abstract String getTraceability();
  public abstract TestVariety getVariety();
}

B.1.1.22.2. getArea()

@Deprecated public abstract TestAreatopic getArea();

The test type of this test case.

Parameters

return

The test type.

B.1.1.22.3. getAttachments()

public abstract Set<KlarosAttachment> getAttachments();

Gets the attachments associated with this test case.

Parameters

return

the attachments

B.1.1.22.4. getCategories()

public abstract Set<KlarosTestCaseCategoryNode> 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.22.5. getConfiguration()

public abstract KlarosConfiguration getConfiguration();

Get the project configuration this test case revision belongs to.

Parameters

return

The related configuration.

B.1.1.22.6. getCovers()

public abstract Set<KlarosRequirement> getCovers();

Get covered requirements.

Parameters

return

Set of requirements which are covered by this test case.

B.1.1.22.7. getDependency()

public abstract String getDependency();

The dependency of this test case.

Parameters

return

The dependency.

B.1.1.22.8. getDescription()

public abstract String getDescription();

The description of this test case.

Parameters

return

The description.

B.1.1.22.9. getDesignTechnique()

public abstract TestDesignTechnique getDesignTechnique();

The design technique of this test case.

Parameters

return

The type.

B.1.1.22.10. 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.22.11. getDocbase()

public abstract String getDocbase();

The docbase of this test case.

Parameters

return

The docbase.

B.1.1.22.12. getEstimatedDuration()

public abstract Long getEstimatedDuration();

The estimated duration of this test case.

Parameters

return

The estimatedDuration.

B.1.1.22.13. getEvaluation()

public abstract String getEvaluation();

The evaluation of this test case.

Parameters

return

The evaluation.

B.1.1.22.14. getExecution()

public abstract TestExecutionMethod getExecution();

The execution method of this test case.

Parameters

return

The execution method.

B.1.1.22.15. getExpectedResult()

public abstract String getExpectedResult();

The expected result of this test case.

Parameters

return

The expected result.

B.1.1.22.16. 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.22.17. getJobs()

public abstract List<KlarosJob> getJobs();

Gets the jobs associated with this test case.

Parameters

return

the jobs

B.1.1.22.18. getLevel()

public abstract TestLevel getLevel();

The level of this test case.

Parameters

return

The level.

B.1.1.22.19. getNote()

public abstract String getNote();

The note of this test case.

Parameters

return

The note.

B.1.1.22.20. getPostcondition()

public abstract String getPostcondition();

The postcondition of this test case.

Parameters

return

The postcondition.

B.1.1.22.21. getPrecondition()

public abstract String getPrecondition();

The precondition of this test case.

Parameters

return

The precondition.

B.1.1.22.22. getPriority()

public abstract TestPriority getPriority();

The priority of this test case.

Parameters

return

The priority.

B.1.1.22.23. getResults()

public abstract Set<KlarosTestCaseResult> getResults();

Get test case results.

Parameters

return

Set of results of executions of this test case.

B.1.1.22.24. getShortname()

public abstract String getShortname();

The short name (title) of this test case.

Parameters

return

The short name.

B.1.1.22.25. getState()

public abstract String getState();

The type of this test case.

Parameters

return

The type.

B.1.1.22.26. getStateName(KlarosSUTImplementation)

@Deprecated public abstract String getStateName(KlarosSUTImplementation sut);

Get name of the state related to given SUT.

Parameters

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

B.1.1.22.27. getTeam()

public abstract String getTeam();

The team responsible for this test case.

Parameters

return

The team.

B.1.1.22.28. getTestCaseSteps()

public abstract List<KlarosTestStepContainer<?, ?>> getTestCaseSteps();

Get test case steps.

Parameters

return

list of steps of this test case.

B.1.1.22.29. getTestType()

public abstract TestAreatopic getTestType();

The test type of this test case.

Parameters

return

The test type.

B.1.1.22.30. getTraceability()

public abstract String getTraceability();

The traceability of this test case.

Parameters

return

The traceability.

B.1.1.22.31. getVariety()

public abstract TestVariety getVariety();

The variety of this test case.

Parameters

return

The variety.

B.1.1.23. IKlarosTestCaseResult

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

B.1.1.23.1. Synopsis

 public interface IKlarosTestCaseResult extends, IKlarosNamedEntity {
// Public Methods  public abstract Set<KlarosAttachment> getAttachments();
  public abstract String getDescription();
  public abstract long getExecutionTime();
  public abstract KlarosJob getJob();
  public abstract List<KlarosTestCaseStepResult> getStepResults();
  public abstract String getSummary();
  public abstract KlarosTestCase getTestCase();
  public abstract KlarosTestRun getTestRun();
  public abstract Integer getTestSuitePosition();
  public abstract KlarosTestSuiteResult getTestSuiteResult();
  public abstract boolean isError();
  public abstract boolean isFailure();
  public abstract boolean isPassed();
  public abstract boolean isPending();
  public abstract boolean isSkipped();
}

B.1.1.23.2. getAttachments()

public abstract Set<KlarosAttachment> getAttachments();

Gets the attachments associated with this test case result.

Parameters

return

the attachments

B.1.1.23.3. 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.23.4. getExecutionTime()

public abstract long getExecutionTime();

Get the test execution time in ms.

Parameters

return

The test execution time.

B.1.1.23.5. getJob()

public abstract KlarosJob getJob();

Gets the job this test case result belongs if one exists.

Parameters

return

the associated job

B.1.1.23.6. getStepResults()

public abstract List<KlarosTestCaseStepResult> getStepResults();

Get the associated step results.

Parameters

return

List of test case step results.

B.1.1.23.7. 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.23.8. 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.23.9. getTestRun()

public abstract KlarosTestRun getTestRun();

Get the associated test run.

Parameters

return

The test run that created this result.

B.1.1.23.10. getTestSuitePosition()

public abstract Integer getTestSuitePosition();

Return the position in the 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.23.11. 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.23.12. 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.23.13. 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.23.14. 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 'testCasePassed' with value 'true'.

Parameters

return

true if this results represents an error.

B.1.1.23.15. isPending()

public abstract boolean isPending();

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

Parameters

return

true, if the test case result is pending

B.1.1.23.16. 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.24. IKlarosTestCaseStep

This interface provides access to a test case step.

B.1.1.24.1. Synopsis

 public interface IKlarosTestCaseStep<T,S extends Revision> extends, IKlarosTestStepContainer<T, S> {
}

B.1.1.25. IKlarosTestCaseStepResult

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

B.1.1.25.1. Synopsis

 public interface IKlarosTestCaseStepResult extends, IKlarosNamedEntity {
// Public Methods  public abstract String getAction();
  public abstract String getDescription();
  public abstract long getExecutionTime();
  public abstract String getExpectedResult();
  public abstract String getPostcondition();
  public abstract String getPrecondition();
  public abstract String getSummary();
  public abstract KlarosTestCase getTestCase();
  public abstract KlarosTestCaseResult getTestCaseResult();
  public abstract KlarosTestRun getTestRun();
  public abstract boolean isError();
  public abstract boolean isFailure();
  public abstract boolean isPassed();
  public abstract boolean isSkipped();
}

B.1.1.25.2. getAction()

public abstract String getAction();

Get the action.

Parameters

return

The action of this test case step.

B.1.1.25.3. 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.25.4. getExecutionTime()

public abstract long getExecutionTime();

Get the test execution time in ms.

Parameters

return

The test execution time.

B.1.1.25.5. getExpectedResult()

public abstract String getExpectedResult();

Get the expected result.

Parameters

return

The expected result of this test case step.

B.1.1.25.6. getPostcondition()

public abstract String getPostcondition();

Get the postcondition.

Parameters

return

The postcondition of this test case step.

B.1.1.25.7. getPrecondition()

public abstract String getPrecondition();

Get the precondition.

Parameters

return

The precondition of this test case step.

B.1.1.25.8. 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.25.9. getTestCase()

public abstract KlarosTestCase getTestCase();

Get test case.

Parameters

return

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

B.1.1.25.10. 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.25.11. getTestRun()

public abstract KlarosTestRun getTestRun();

Get test run.

Parameters

return

The test run that created this result.

B.1.1.25.12. 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.25.13. 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.25.14. 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 'testCasePassed' with value 'true'.

Parameters

return

true if this results represents an error.

B.1.1.25.15. 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.26. IKlarosTestEnvironment

This interface provides access to data of a test environment.

B.1.1.26.1. Synopsis

 public interface IKlarosTestEnvironment extends, IKlarosNamedEntity {
// Public Methods  public abstract Set<KlarosAttachment> getAttachments();
  public abstract Set<KlarosTestEnvironmentCategoryNode> getCategories();
  public abstract String getDescription();
  public abstract Set<KlarosIteration> getIterations();
  public abstract Set<KlarosTestRun> getTestRuns();
}

B.1.1.26.2. getAttachments()

public abstract Set<KlarosAttachment> getAttachments();

Gets the attachments associated with this test environment.

Parameters

return

the attachments

B.1.1.26.3. getCategories()

public abstract Set<KlarosTestEnvironmentCategoryNode> 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.26.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.26.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.27. IKlarosTestExecutable

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

B.1.1.27.1. Synopsis

 public interface IKlarosTestExecutable {
}

B.1.1.28. IKlarosTestRun

This interface provides access to data of a test run.

B.1.1.28.1. Synopsis

 public interface IKlarosTestRun {
// 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 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.28.2. getConfiguration()

public abstract KlarosConfiguration getConfiguration();

Get configuration.

Parameters

return

The related configuration

B.1.1.28.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.28.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.28.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.28.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.28.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.28.8. 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.28.9. getNumberSkipped()

public abstract int getNumberSkipped();

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

Parameters

return

The number of skipped test cases

B.1.1.28.10. 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.28.11. getResults()

public abstract Set<KlarosTestCaseResult> getResults();

Get results.

Parameters

return

Set of results of test case executions.

B.1.1.28.12. getRunId()

public abstract String getRunId();

Get id of test run.

Parameters

return

The id of the test run

B.1.1.28.13. getSut()

public abstract KlarosSUTImplementation getSut();

Get the tested system version.

Parameters

return

The SUT version which has been tested

B.1.1.28.14. 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.28.15. getTimestamp()

public abstract Date getTimestamp();

Get timestamp.

Parameters

return

The time the test run has been executed as Date object

B.1.1.28.16. 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.28.17. 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.29. IKlarosTestSegment

This interface provides access to a test segment.

B.1.1.29.1. Synopsis

 public interface IKlarosTestSegment<T,S extends Revision> extends, IKlarosTestStepContainer<T, S> {
// Public Methods  public abstract String getDescription();
  public abstract String getNote();
  public abstract String getShortname();
  public abstract List<KlarosTestCaseStep> getSteps();
}

B.1.1.29.2. getDescription()

public abstract String getDescription();

Get the description.

Parameters

return

The description of this test segment.

B.1.1.29.3. getNote()

public abstract String getNote();

Get the note.

Parameters

return

The action of this test case segment.

B.1.1.29.4. getShortname()

public abstract String getShortname();

Get the shortname.

Parameters

return

The shortname of this test case segment.

B.1.1.29.5. getSteps()

public abstract List<KlarosTestCaseStep> getSteps();

Get the test case steps.

Parameters

return

list of steps of this test segment.

B.1.1.30. IKlarosTestStepContainer

This interface provides access to a test step containers.

B.1.1.30.1. Synopsis

 public interface IKlarosTestStepContainer<T,S extends Revision> extends, IKlarosRevision<T, S> {
// Public Methods  public abstract String getAction();
  public abstract String getExpectedResult();
  public abstract String getPostcondition();
  public abstract String getPrecondition();
}

B.1.1.30.2. getAction()

public abstract String getAction();

Get the action.

Parameters

return

The action of this test case step.

B.1.1.30.3. getExpectedResult()

public abstract String getExpectedResult();

Get the expected result.

Parameters

return

The expected result of this test case step.

B.1.1.30.4. getPostcondition()

public abstract String getPostcondition();

Get the postcondition.

Parameters

return

The postcondition of this test case step.

B.1.1.30.5. getPrecondition()

public abstract String getPrecondition();

Get the precondition.

Parameters

return

The precondition of this test case step.

B.1.1.31. IKlarosTestSuite

This interface provides access to data of a test suite.

B.1.1.31.1. Synopsis

 public interface IKlarosTestSuite<T,S extends Revision> extends, IKlarosRevision<T, S> {
// Public Methods  public abstract Set<KlarosAttachment> getAttachments();
  public abstract Set<KlarosTestSuiteCategoryNode> 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.31.2. getAttachments()

public abstract Set<KlarosAttachment> getAttachments();

Gets the attachments associated with this test suite.

Parameters

return

the attachments

B.1.1.31.3. getCategories()

public abstract Set<KlarosTestSuiteCategoryNode> 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.31.4. getConfiguration()

public abstract KlarosConfiguration getConfiguration();

Get configuration.

Parameters

return

The related configuration.

B.1.1.31.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.31.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.31.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.31.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.31.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.32. IKlarosTestSuiteResult

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

B.1.1.32.1. Synopsis

 public interface IKlarosTestSuiteResult extends, IKlarosNamedEntity {
// Public Methods  public abstract KlarosJob getJob();
  public abstract Set<KlarosTestCaseResult> getResults();
  public abstract KlarosTestRun getTestRun();
  public abstract KlarosTestSuite getTestSuite();
  public abstract boolean isPending();
}

B.1.1.32.2. getJob()

public abstract KlarosJob getJob();

Gets the job this test suite result belongs if one exists.

Parameters

return

the associated job

B.1.1.32.3. 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.32.4. getTestRun()

public abstract KlarosTestRun getTestRun();

Get the test run for this result.

Parameters

return

the test run

B.1.1.32.5. 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.32.6. isPending()

public abstract boolean isPending();

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

Parameters

return

true, if the test suite result is pending

B.1.1.33. IKlarosUser

The user object.

B.1.1.33.1. Synopsis

 public interface IKlarosUser {
// Public Methods  public abstract String getEmail();
  public abstract String getRole();
  public abstract String getUsername();
}

B.1.1.33.2. getEmail()

public abstract String getEmail();

The email address of this user.

Parameters

return

the email address

B.1.1.33.3. getRole()

public abstract String getRole();

The role name of this user.

Parameters

return

the role name

B.1.1.33.4. getUsername()

public abstract String getUsername();

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

Parameters

return

the user name

B.1.1.34. KlarosAttachment

This class provides access to binary attachment.

B.1.1.34.1. Synopsis

 public final class KlarosAttachment extends, 
                                KlarosLabeledObject<KlarosAttachment, Attachment>
                            
    implements, IKlarosAttachment {
// Public Methods  public String getMimeType();
  public String getName();
  public long getSize();
  public String getUuid();
  public String getVersion();
}

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.35. KlarosCategoryNode

A generic category node.

B.1.1.35.1. Synopsis

 public abstract class KlarosCategoryNode<I,T,W extends KlarosCategoryNode<I, T, W, P>,P extends CategoryNode> extends, KlarosWrapper<W, P>
    implements, IKlarosCategoryNode<I, T, W, P> {
// Public Constructors  public KlarosCategoryNode(P wrapped);
// Public Methods  public T getCategoryTree();
  public String getDescription();
  public W extends KlarosCategoryNode<I, T, W, P> getParent();
  public String getShortname();
  public List<W> getSubCategories();
}

Direct known subclasses: de.verit.klaros.core.model.KlarosIterationCategoryNode , de.verit.klaros.core.model.KlarosRequirementCategoryNode , de.verit.klaros.core.model.KlarosSUTImplementationCategoryNode , de.verit.klaros.core.model.KlarosTestCaseCategoryNode , de.verit.klaros.core.model.KlarosTestEnvironmentCategoryNode , de.verit.klaros.core.model.KlarosTestSuiteCategoryNode

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.35.2. KlarosCategoryNode(P)

public KlarosCategoryNode(P wrapped);

Instantiates a new klaros category node.

Parameters

wrapped

the wrapped class

B.1.1.36. KlarosCategoryTree

A generic category tree.

B.1.1.36.1. Synopsis

 public class KlarosCategoryTree<I,W extends KlarosCategoryTree<I, W, P, X, Y>,P extends CategoryTree,X extends KlarosCategoryNode<I, W, X, Y>,Y extends CategoryNode> extends, 
                                KlarosNamedEntity<W, P>
                            
    implements, IKlarosCategoryTree<I, W, P, X, Y> {
// Public Methods  public String getDescription();
  public KlarosCategoryNode<I, W, X, Y> getRootNode();
  public String getShortname();
}

Direct known subclasses: de.verit.klaros.core.model.KlarosIterationCategoryTree , de.verit.klaros.core.model.KlarosRequirementCategoryTree , de.verit.klaros.core.model.KlarosSUTImplementationCategoryTree , de.verit.klaros.core.model.KlarosTestCaseCategoryTree , de.verit.klaros.core.model.KlarosTestEnvironmentCategoryTree , de.verit.klaros.core.model.KlarosTestSuiteCategoryTree

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.37. KlarosConfiguration

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

B.1.1.37.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<KlarosIterationCategoryTree> getIterationCategoryTrees();
  public Set<KlarosIteration> getIterations();
  public Set<KlarosJob> getJobs();
  public Set<KlarosRequirementCategoryTree> getRequirementCategoryTrees();
  public KlarosRequirementManagement getRequirementManagementSystems();
  public Set<KlarosRequirement> getRequirements();
  public Set<KlarosSUTImplementation> getSuts();
  public Set<KlarosSUTImplementationCategoryTree> getSystemUnderTestCategoryTrees();
  public Set<KlarosTestCaseCategoryTree> getTestCaseCategoryTrees();
  public Set<KlarosTestCase> getTestCases();
  public Set<KlarosTestEnvironmentCategoryTree> getTestEnvironmentCategoryTrees();
  public Set<KlarosTestRun> getTestRuns();
  public Set<KlarosTestSuiteCategoryTree> 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.38. KlarosEnumValue

A Custom property enumeration value.

B.1.1.38.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.39. KlarosIssue

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

B.1.1.39.1. Synopsis

 public final class KlarosIssue extends, KlarosWrapper<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 Date getLastUpdated();
  public String getOwner();
  public String getPriority();
  public String getRemoteBrowseUrl();
  public String getReporter();
  public String getResolution();
  public String getState();
  public String getSubject();
  public Set<KlarosTestCase> getTestCases();
  public boolean isResolved();
}

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.40. KlarosIssueManagement

An issue management system.

B.1.1.40.1. Synopsis

 public class KlarosIssueManagement extends, KlarosWrapper<KlarosIssueManagement, IssueManagement>
    implements, IKlarosIssueManagement {
// Public Methods  public String getDescription();
  public Set<KlarosIssue> getIssues();
  public String getName();
  public String getProject();
  public String getType();
  public String getUrl();
}

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. KlarosIteration

An iteration in a project.

B.1.1.41.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<KlarosIterationCategoryNode> 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.42. KlarosIterationCategoryNode

An category node for iteration implementations.

B.1.1.42.1. Synopsis

 public final class KlarosIterationCategoryNode extends, 
                                KlarosCategoryNode<KlarosIteration, KlarosIterationCategoryTree, KlarosIterationCategoryNode, IterationCategoryNode>
                             {
// Public Constructors  public KlarosIterationCategoryNode(IterationCategoryNode wrapped);
// Public Methods  public List<KlarosIteration> getReferences();
}

Methods inherited from de.verit.klaros.core.model.KlarosCategoryNode: getCategoryTree , getDescription , getParent , getShortname , 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.42.2. KlarosIterationCategoryNode(IterationCategoryNode)

public KlarosIterationCategoryNode(IterationCategoryNode wrapped);

Instantiates a new klaros iteration category node.

Parameters

wrapped

the wrapped class

B.1.1.43. KlarosIterationCategoryTree

An category tree for Iteration implementations.

B.1.1.43.1. Synopsis

 public class KlarosIterationCategoryTree extends, 
                                KlarosCategoryTree<KlarosIteration, KlarosIterationCategoryTree, IterationCategoryTree, KlarosIterationCategoryNode, IterationCategoryNode>
                             {
}

Methods inherited from de.verit.klaros.core.model.KlarosCategoryTree: getDescription , getRootNode , 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.44. KlarosJob

This class provides access to the information stored for jobs.

B.1.1.44.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.45. KlarosJobDependency

This class provides access to the information stored for jobs.

B.1.1.45.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.46. KlarosJobTimeBlock

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

B.1.1.46.1. Synopsis

 public final class KlarosJobTimeBlock extends, KlarosWrapper<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.KlarosWrapper: equals , getWrapped , hashCode

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

B.1.1.47. KlarosJobUpdateAction

The model of a job comment.

B.1.1.47.1. Synopsis

 public final class KlarosJobUpdateAction extends, KlarosWrapper<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.KlarosWrapper: equals , getWrapped , hashCode

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

B.1.1.48. KlarosLabeledObject

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

B.1.1.48.1. Synopsis

 public abstract class KlarosLabeledObject<T,S extends LabeledObject> extends, KlarosWrapper<T, S>
    implements, IKlarosLabeledObject {
// 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.KlarosAttachment , de.verit.klaros.core.model.KlarosConfiguration , de.verit.klaros.core.model.KlarosNamedEntity , 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.49. KlarosNamedEntity

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

B.1.1.49.1. Synopsis

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

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. KlarosProperty

The Klaros property class.

B.1.1.50.1. Synopsis

 public final class KlarosPropertyimplements, IKlarosProperty {
// Public Methods  public String getName();
  public String getValue();
}

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

B.1.1.51. KlarosRequirement

This class provides access to the information stored for requirements.

B.1.1.51.1. Synopsis

 public final class KlarosRequirement extends, 
                                KlarosRevision<KlarosRequirement, Requirement>
                            
    implements, IKlarosRequirement<KlarosRequirement, Requirement> {
// Public Methods  public Set<KlarosAttachment> getAttachments();
  public Set<KlarosRequirementCategoryNode> 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.51.2. getExternalStatus()

public String getExternalStatus();

The external status of this requirement.

Parameters

return

the external status

B.1.1.52. KlarosRequirementCategoryNode

An category node for requirement implementations.

B.1.1.52.1. Synopsis

 public final class KlarosRequirementCategoryNode extends, 
                                KlarosCategoryNode<KlarosRequirement, KlarosRequirementCategoryTree, KlarosRequirementCategoryNode, RequirementCategoryNode>
                             {
// Public Constructors  public KlarosRequirementCategoryNode(RequirementCategoryNode wrapped);
// Public Methods  public List<KlarosRequirement> getReferences();
}

Methods inherited from de.verit.klaros.core.model.KlarosCategoryNode: getCategoryTree , getDescription , getParent , getShortname , 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.52.2. KlarosRequirementCategoryNode(RequirementCategoryNode)

public KlarosRequirementCategoryNode(RequirementCategoryNode wrapped);

Instantiates a new klaros requirement category node.

Parameters

wrapped

the wrapped object

B.1.1.53. KlarosRequirementCategoryTree

An category tree for Requirement implementations.

B.1.1.53.1. Synopsis

 public final class KlarosRequirementCategoryTree extends, 
                                KlarosCategoryTree<KlarosRequirement, KlarosRequirementCategoryTree, RequirementCategoryTree, KlarosRequirementCategoryNode, RequirementCategoryNode>
                             {
}

Methods inherited from de.verit.klaros.core.model.KlarosCategoryTree: getDescription , getRootNode , 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.54. KlarosRequirementManagement

A requirement management system.

B.1.1.54.1. Synopsis

 public class KlarosRequirementManagement extends, KlarosWrapper<KlarosRequirementManagement, RequirementManagement>
    implements, IKlarosRequirementManagement {
// Public Methods  public String getDescription();
  public String getName();
  public String getProject();
  public Set<KlarosRequirement> getRequirements();
  public String getType();
  public String getUrl();
}

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.55. KlarosRevision

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

B.1.1.55.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.KlarosTestStepContainer , 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.56. KlarosSUTImplementation

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

B.1.1.56.1. Synopsis

 public final class KlarosSUTImplementation extends, 
                                KlarosNamedEntity<KlarosSUTImplementation, SUTImplementation>
                            
    implements, IKlarosSUTImplementation, Comparable<KlarosSUTImplementation> {
// Public Methods  public int compareTo(KlarosSUTImplementation o);
  public boolean equals(Object o);
  public Set<KlarosAttachment> getAttachments();
  public Set<KlarosSUTImplementationCategoryNode> 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.57. KlarosSUTImplementationCategoryNode

An category node for SUT implementations.

B.1.1.57.1. Synopsis

 public final class KlarosSUTImplementationCategoryNode extends, 
                                KlarosCategoryNode<KlarosSUTImplementation, KlarosSUTImplementationCategoryTree, KlarosSUTImplementationCategoryNode, SUTCategoryNode>
                             {
// Public Constructors  public KlarosSUTImplementationCategoryNode(SUTCategoryNode wrapped);
// Public Methods  public List<KlarosSUTImplementation> getReferences();
}

Methods inherited from de.verit.klaros.core.model.KlarosCategoryNode: getCategoryTree , getDescription , getParent , getShortname , 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.57.2. KlarosSUTImplementationCategoryNode(SUTCategoryNode)

public KlarosSUTImplementationCategoryNode(SUTCategoryNode wrapped);

Instantiates a new klaros sut implementation category node.

Parameters

wrapped

the wrapped class

B.1.1.58. KlarosSUTImplementationCategoryTree

An category tree for SUT implementations.

B.1.1.58.1. Synopsis

 public final class KlarosSUTImplementationCategoryTree extends, 
                                KlarosCategoryTree<KlarosSUTImplementation, KlarosSUTImplementationCategoryTree, SUTCategoryTree, KlarosSUTImplementationCategoryNode, SUTCategoryNode>
                             {
}

Methods inherited from de.verit.klaros.core.model.KlarosCategoryTree: getDescription , getRootNode , 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.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<KlarosTestCase, TestCase>, Comparable<KlarosTestCase> {
// Public Methods  public int compareTo(KlarosTestCase o);
  public boolean equals(Object o);
  public TestAreatopic getArea();
  public Set<KlarosAttachment> getAttachments();
  public Set<KlarosTestCaseCategoryNode> 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 String 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();
  @Deprecated public String getStateName(KlarosSUTImplementation sut);
  public KlarosTestCase getSuccessor();
  public String getTeam();
  public List<KlarosTestStepContainer<?, ?>> 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. KlarosTestCaseCategoryNode

A category node for test cases.

B.1.1.60.1. Synopsis

 public final class KlarosTestCaseCategoryNode extends, 
                                KlarosCategoryNode<KlarosTestCase, KlarosTestCaseCategoryTree, KlarosTestCaseCategoryNode, TestCaseCategoryNode>
                             {
// Public Constructors  public KlarosTestCaseCategoryNode(TestCaseCategoryNode wrapped);
// Public Methods  public List<KlarosTestCase> getReferences();
}

Methods inherited from de.verit.klaros.core.model.KlarosCategoryNode: getCategoryTree , getDescription , getParent , getShortname , 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.60.2. KlarosTestCaseCategoryNode(TestCaseCategoryNode)

public KlarosTestCaseCategoryNode(TestCaseCategoryNode wrapped);

Instantiates a new klaros test case category node.

Parameters

wrapped

the wrapped class

B.1.1.61. KlarosTestCaseCategoryTree

A category node for test cases.

B.1.1.61.1. Synopsis

 public final class KlarosTestCaseCategoryTree extends, 
                                KlarosCategoryTree<KlarosTestCase, KlarosTestCaseCategoryTree, TestCaseCategoryTree, KlarosTestCaseCategoryNode, TestCaseCategoryNode>
                             {
}

Methods inherited from de.verit.klaros.core.model.KlarosCategoryTree: getDescription , getRootNode , 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.62. KlarosTestCaseResult

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

B.1.1.62.1. Synopsis

 public final class KlarosTestCaseResult extends, 
                                KlarosNamedEntity<KlarosTestCaseResult, TestCaseResult>
                            
    implements, IKlarosTestCaseResult, Comparable<KlarosTestCaseResult> {
// Public Methods  public int compareTo(KlarosTestCaseResult o);
  public boolean equals(Object o);
  public Set<KlarosAttachment> getAttachments();
  public String getDescription();
  public long getExecutionTime();
  public KlarosJob getJob();
  public List<KlarosTestCaseStepResult> getStepResults();
  public String getSummary();
  public KlarosTestCase getTestCase();
  public KlarosTestRun getTestRun();
  public Integer getTestSuitePosition();
  public KlarosTestSuiteResult getTestSuiteResult();
  public int hashCode();
  public boolean isError();
  public boolean isFailure();
  public boolean isPassed();
  public boolean isPending();
  public boolean 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. KlarosTestCaseStep

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

B.1.1.63.1. Synopsis

 public final class KlarosTestCaseStep extends, 
                                KlarosTestStepContainer<KlarosTestCaseStep, TestStep>
                            
    implements, IKlarosTestCaseStep<KlarosTestCaseStep, TestStep> {
// Public Methods  public KlarosRevision<KlarosTestCaseStep, TestStep> getPredecessor();
  public KlarosRevision<KlarosTestCaseStep, TestStep> getRoot();
  public KlarosRevision<KlarosTestCaseStep, TestStep> getSuccessor();
}

Methods inherited from de.verit.klaros.core.model.KlarosTestStepContainer: getAction , getExpectedResult , getPostcondition , getPrecondition

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.64. KlarosTestCaseStepResult

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

B.1.1.64.1. Synopsis

 public final class KlarosTestCaseStepResult extends, 
                                KlarosNamedEntity<KlarosTestCaseStepResult, TestCaseStepResult>
                            
    implements, IKlarosTestCaseStepResult, Comparable<KlarosTestCaseStepResult> {
// Public Methods  public int compareTo(KlarosTestCaseStepResult o);
  public boolean equals(Object o);
  public String getAction();
  public String getDescription();
  public long getExecutionTime();
  public String getExpectedResult();
  public String getPostcondition();
  public String getPrecondition();
  public String getSummary();
  public KlarosTestCase getTestCase();
  public KlarosTestCaseResult getTestCaseResult();
  public KlarosTestRun getTestRun();
  public int hashCode();
  public boolean isError();
  public boolean isFailure();
  public boolean isPassed();
  public boolean 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.65. KlarosTestEnvironment

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

B.1.1.65.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<KlarosTestEnvironmentCategoryNode> 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.66. KlarosTestEnvironmentCategoryNode

A category node for test environments.

B.1.1.66.1. Synopsis

 public final class KlarosTestEnvironmentCategoryNode extends, 
                                KlarosCategoryNode<KlarosTestEnvironment, KlarosTestEnvironmentCategoryTree, KlarosTestEnvironmentCategoryNode, TestEnvironmentCategoryNode>
                             {
// Public Constructors  public KlarosTestEnvironmentCategoryNode(TestEnvironmentCategoryNode wrapped);
// Public Methods  public List<KlarosTestEnvironment> getReferences();
}

Methods inherited from de.verit.klaros.core.model.KlarosCategoryNode: getCategoryTree , getDescription , getParent , getShortname , 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.66.2. KlarosTestEnvironmentCategoryNode(TestEnvironmentCategoryNode)

public KlarosTestEnvironmentCategoryNode(TestEnvironmentCategoryNode wrapped);

Instantiates a new klaros test environment category node.

Parameters

wrapped

the wrapped class

B.1.1.67. KlarosTestEnvironmentCategoryTree

A category node for test environments.

B.1.1.67.1. Synopsis

 public final class KlarosTestEnvironmentCategoryTree extends, 
                                KlarosCategoryTree<KlarosTestEnvironment, KlarosTestEnvironmentCategoryTree, TestEnvironmentCategoryTree, KlarosTestEnvironmentCategoryNode, TestEnvironmentCategoryNode>
                             {
}

Methods inherited from de.verit.klaros.core.model.KlarosCategoryTree: getDescription , getRootNode , 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.68. KlarosTestExecutable

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

B.1.1.68.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.69. KlarosTestRun

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

B.1.1.69.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 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.70. KlarosTestSegment

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

B.1.1.70.1. Synopsis

 public final class KlarosTestSegment extends, 
                                KlarosTestStepContainer<KlarosTestSegment, TestSegment>
                            
    implements, IKlarosTestSegment<KlarosTestSegment, TestSegment> {
// Public Methods  public String getDescription();
  public String getNote();
  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.KlarosTestStepContainer: getAction , getExpectedResult , getPostcondition , getPrecondition

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.71. KlarosTestStepContainer

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

B.1.1.71.1. Synopsis

 public abstract class KlarosTestStepContainer<T,S extends TestStepContainer> extends, 
                                KlarosRevision<T, S>
                            
    implements, IKlarosTestStepContainer<T, S> {
// Public Methods  public String getAction();
  public String getExpectedResult();
  public String getPostcondition();
  public String getPrecondition();
}

Direct known subclasses: de.verit.klaros.core.model.KlarosTestCaseStep , de.verit.klaros.core.model.KlarosTestSegment

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.72. KlarosTestSuite

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

B.1.1.72.1. Synopsis

 public final class KlarosTestSuite extends, 
                                KlarosRevision<KlarosTestSuite, TestSuite>
                            
    implements, IKlarosTestSuite<KlarosTestSuite, TestSuite> {
// Public Methods  public Set<KlarosAttachment> getAttachments();
  public Set<KlarosTestSuiteCategoryNode> 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.73. KlarosTestSuiteCategoryNode

A category node for test suites.

B.1.1.73.1. Synopsis

 public final class KlarosTestSuiteCategoryNode extends, 
                                KlarosCategoryNode<KlarosTestSuite, KlarosTestSuiteCategoryTree, KlarosTestSuiteCategoryNode, TestSuiteCategoryNode>
                             {
// Public Constructors  public KlarosTestSuiteCategoryNode(TestSuiteCategoryNode wrapped);
// Public Methods  public List<KlarosTestSuite> getReferences();
}

Methods inherited from de.verit.klaros.core.model.KlarosCategoryNode: getCategoryTree , getDescription , getParent , getShortname , 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.73.2. KlarosTestSuiteCategoryNode(TestSuiteCategoryNode)

public KlarosTestSuiteCategoryNode(TestSuiteCategoryNode wrapped);

Instantiates a new klaros test suite category node.

Parameters

wrapped

the wrapped class

B.1.1.74. KlarosTestSuiteCategoryTree

A category node for test suites.

B.1.1.74.1. Synopsis

 public final class KlarosTestSuiteCategoryTree extends, 
                                KlarosCategoryTree<KlarosTestSuite, KlarosTestSuiteCategoryTree, TestSuiteCategoryTree, KlarosTestSuiteCategoryNode, TestSuiteCategoryNode>
                             {
}

Methods inherited from de.verit.klaros.core.model.KlarosCategoryTree: getDescription , getRootNode , 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.75. KlarosTestSuiteResult

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

B.1.1.75.1. Synopsis

 public final class KlarosTestSuiteResult extends, 
                                KlarosNamedEntity<KlarosTestSuiteResult, TestSuiteResult>
                            
    implements, IKlarosTestSuiteResult, Comparable<KlarosTestSuiteResult> {
// Public Methods  public int compareTo(KlarosTestSuiteResult o);
  public boolean equals(Object o);
  public KlarosJob getJob();
  public Set<KlarosTestCaseResult> getResults();
  public KlarosTestRun getTestRun();
  public KlarosTestSuite getTestSuite();
  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.76. KlarosUser

The user object.

B.1.1.76.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 String 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.1.2.1. Deprecated Methods

de.verit.klaros.core.model.IKlarosTestCase.getStateName(de.verit.klaros.core.model.KlarosSUTImplementation)
de.verit.klaros.core.model.IKlarosTestCase.getArea()	This method has been deprecated, please use getTestType() instead.
de.verit.klaros.core.model.KlarosTestCase.getStateName(de.verit.klaros.core.model.KlarosSUTImplementation)

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.custom
B.2.4. de.verit.klaros.scripting.model
B.2.5. Constant field values

B.2.1. de.verit.klaros.scripting

B.2.1.1. KlarosContext
B.2.1.2. KlarosQueryFactory
B.2.1.3. KlarosScript

B.2.1.1. KlarosContext

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

B.2.1.1.1. Synopsis

 public class KlarosContextimplements, IKlarosContext {
// Public Constructors  public KlarosContext(Context context,
                       UUID authenticatedUserId,
                       UUID activeProjectId,
                       UUID activeIterationId,
                       String applicationUrl,
                       KlarosQueryFactory factory,
                       ParameterContext parameters);
  public KlarosContext(Context context,
                       UUID authenticatedUserId,
                       UUID activeProjectId,
                       UUID activeIterationId,
                       String applicationUrl,
                       KlarosQueryFactory factory,
                       ParameterContext parameters,
                       Locale locale);
// Public Methods  public void add(String name,
                  Object value);
  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.1.2. KlarosContext(Context, UUID, UUID, UUID, String, KlarosQueryFactory, ParameterContext)

public KlarosContext(Context context,
                     UUID authenticatedUserId,
                     UUID activeProjectId,
                     UUID activeIterationId,
                     String applicationUrl,
                     KlarosQueryFactory 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.1.3. KlarosContext(Context, UUID, UUID, UUID, String, KlarosQueryFactory, ParameterContext, Locale)

public KlarosContext(Context context,
                     UUID authenticatedUserId,
                     UUID activeProjectId,
                     UUID activeIterationId,
                     String applicationUrl,
                     KlarosQueryFactory 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.1.2. KlarosQueryFactory

This factory lets the user execute queries.

B.2.1.2.1. Synopsis

 public class KlarosQueryFactory {
// Public Static Fields  public static final String WRAPPER_PREFIX = "Klaros";
// Public Constructors  public KlarosQueryFactory(Session session);
// Public Methods  public List<?> execute(String query);
  public List<?> execute(String query,
                         ParameterContext params);
}

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

B.2.1.2.2. KlarosQueryFactory(Session)

public KlarosQueryFactory(Session session);

Create a KlarosQueryFactory.

Parameters

session

Passed by the relating servlet.

B.2.1.2.3. WRAPPER_PREFIX

public static final String WRAPPER_PREFIX = "Klaros";

The prefix for klaros interfaces.

B.2.1.2.4. execute(String)

public 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.2.5. execute(String, ParameterContext)

public 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.3. KlarosScript

Public interface that all seam-pdf template scripts must implement be work properly.

B.2.1.3.1. Synopsis

 public interface KlarosScript {
// Public Methods  public abstract void execute(KlarosContext context);
}

B.2.1.3.2. execute(KlarosContext)

public abstract void execute(KlarosContext context);

This functions gets called by the seam-pdf servlet to execute the script.

Parameters

context

The event context to provide all needed functions, properties and objects.

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

B.2.2.1. IKlarosContext
B.2.2.2. KlarosContextParameter

B.2.2.1. IKlarosContext

Describes the available actions in the scripting context.

B.2.2.1.1. Synopsis

 public interface IKlarosContext {
// Public Methods  public abstract void add(String name,
                           Object value);
  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 version);
  public abstract String getAttachmentUrl(UUID attachmentId);
  public abstract String getAttachmentUrl(UUID attachmentId,
                                          String version);
  public abstract String getBrowsePageUrl(KlarosLabeledObject<?, ?> artifact);
  public abstract Locale getLocale();
  public abstract Parameter getParameter(String name);
  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. 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.4. 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.5. getActiveIteration()

public abstract KlarosIteration getActiveIteration();

Gets the active iteration.

Parameters

return

the active iteration

B.2.2.1.6. getActiveProject()

public abstract KlarosConfiguration getActiveProject();

Gets the active project.

Parameters

return

the active project

B.2.2.1.7. getAttachmentUrl(String)

public abstract String getAttachmentUrl(String attachmentId);

Return the attachment url for the given attachment id.

Parameters

`attachmentId`	the attachment id
`return`	the attachment url

B.2.2.1.8. getAttachmentUrl(String, String)

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

Return the attachment url for the given attachment id.

Parameters

`attachmentId`	the attachment id
`version`	the version
`return`	the attachment url

B.2.2.1.9. getAttachmentUrl(UUID)

public abstract String getAttachmentUrl(UUID attachmentId);

Return the attachment url for the given attachment id.

Parameters

`attachmentId`	the attachment id
`return`	the attachment url

B.2.2.1.10. getAttachmentUrl(UUID, String)

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

Return the attachment url for the given attachment id.

Parameters

`attachmentId`	the attachment id
`version`	the version
`return`	the attachment url

B.2.2.1.11. 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.12. getParameter(String)

public abstract Parameter getParameter(String name);

Gets the parameter.

Parameters

`name`	the name
`return`	The parameter with the given name or `null`.

B.2.2.1.13. getParameterValue(String)

public abstract Object getParameterValue(String name);

Gets the parameter value.

Parameters

`name`	the name
`return`	The value of the parameter with the given name or `null`.

B.2.2.1.14. getPrintPageUrl(KlarosLabeledObject<?, ?>)

public abstract String getPrintPageUrl(KlarosLabeledObject<?, ?> artifact);

Gets the print page of the given klaros artifact. Will return null if the artifact type is not supported.

Parameters

`artifact`	the artifact
`return`	the print page url

B.2.2.1.15. setLocale(Locale)

public abstract void setLocale(Locale locale);

Parameters

locale

The locale to set.

B.2.2.2. KlarosContextParameter

The available context parameters.

B.2.2.2.1. Synopsis

 public final class KlarosContextParameter extends, Enum<KlarosContextParameter> {
// Public Static Fields  public static final KlarosContextParameter applicationBaseUrl ;
  public static final KlarosContextParameter date ;
  public static final KlarosContextParameter imageProvider ;
  public static final KlarosContextParameter parameters ;
  public static final KlarosContextParameter user ;
// Public Static Methods  public static KlarosContextParameter valueOf(String name);
  public static KlarosContextParameter[] values();
}

Methods inherited from java.lang.Enum: compareTo , equals , getDeclaringClass , hashCode , name , ordinal , toString , valueOf

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

B.2.2.2.2. applicationBaseUrl

public static final KlarosContextParameter applicationBaseUrl ;

The application base url.

B.2.2.2.3. date

public static final KlarosContextParameter date ;

The current date.

B.2.2.2.4. imageProvider

public static final KlarosContextParameter imageProvider ;

The image provider.

B.2.2.2.5. parameters

public static final KlarosContextParameter parameters ;

The parameters.

B.2.2.2.6. user

public static final KlarosContextParameter user ;

The current user.

B.2.3. de.verit.klaros.scripting.custom

B.2.3.1. IssueReport
B.2.3.2. IterationReport
B.2.3.3. JobDetailReport
B.2.3.4. JobDetailReport.Filter
B.2.3.5. JobReport
B.2.3.6. TestRunReport

B.2.3.1. IssueReport

The Class IssueReport.

B.2.3.1.1. Synopsis

 public class IssueReportimplements, KlarosScript {
// Public Constructors  public IssueReport();
// Public Methods  public Map<Date, Integer> createdDateCalculator(List<KlarosIssue> issues);
  public void execute(KlarosContext context);
  public String formatDate(Date date);
  public String getColor(int index);
  public Integer getColspanSize(int elements);
  public String getEnvName(KlarosTestEnvironment env);
  public List<KlarosIssue> getFilteredIssues(List<KlarosIssue> issues,
                                             boolean limitToUnresolvedIssues);
  public String getIterationName(IKlarosContext context);
  public String getLastResult(KlarosTestCase testCase);
  public List<KlarosIssue> getList(Set<KlarosIssue> issues);
  public Integer getNumberOfClosedIssues(List<KlarosIssue> issues);
  public String getProjectName(IKlarosContext context);
  public int getRate(int amount,
                     int total);
  public Map<String, Map<KlarosIssue, Set<KlarosTestCase>>> getRequirements(Map<KlarosTestCase, List<KlarosIssue>> testCases,
                                                                            boolean limitToUnresolvedIssues,
                                                                            KlarosContext context);
  public String getResultColor(String value);
  public Integer getResultStatistic(KlarosTestCase testCase);
  public String getStateColor(KlarosIssue issue);
  public String getSutName(KlarosSUTImplementation sut);
  public Object[] getTestCase(KlarosIssue issue);
  public Map<Date, Integer> lastModifiedDateCalculator(List<KlarosIssue> issues);
  public List<KlarosIssue> setToArray(Map<String, Map<KlarosIssue, Set<KlarosTestCase>>> getRequirements,
                                      String key);
  public Map<String, List<KlarosIssue>> sortByIM(List<KlarosIssue> issues);
  public Map<String, List<KlarosIssue>> sortBySut(List<KlarosIssue> issues,
                                                  KlarosContext context);
  public Map<KlarosTestCase, List<KlarosIssue>> sortByTestCase(List<KlarosIssue> issues,
                                                               Set<KlarosTestCase> testCases,
                                                               boolean limitToUnresolvedIssues);
}

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

B.2.3.1.2. createdDateCalculator(List<KlarosIssue>)

public Map<Date, Integer> createdDateCalculator(List<KlarosIssue> issues);

Prepares the information of the created date from the issues for the graph.

Parameters

`issues`	a list of issues
`return`	a map with the prepared dates

B.2.3.1.3. formatDate(Date)

public String formatDate(Date date);

Format a date to a string.

Parameters

`date`	a date
`return`	a string

B.2.3.1.4. getColor(int)

public String getColor(int index);

Get colors for the zebra-table.

Parameters

`index`	the index number of the array
`return`	a color

B.2.3.1.5. getColspanSize(int)

public Integer getColspanSize(int elements);

Calculates the colspan size for the document.

Parameters

`elements`	the amount of elements in the document
`return`	the size needed to fit the document

B.2.3.1.6. getEnvName(KlarosTestEnvironment)

public String getEnvName(KlarosTestEnvironment env);

Gets the test environment name and converts it into a string.

Parameters

`env`	test environment
`return`	a string

B.2.3.1.7. getFilteredIssues(List<KlarosIssue>, boolean)

public List<KlarosIssue> getFilteredIssues(List<KlarosIssue> issues,
                                           boolean limitToUnresolvedIssues);

Filter given issues by issue state.

Parameters

`issues`	the issues
`limitToUnresolvedIssues`	if true, limit result to unresolved issues only
`return`	the list of filtered issues

B.2.3.1.8. getIterationName(IKlarosContext)

public String getIterationName(IKlarosContext context);

Getting the iteration name and converting it into a string.

Parameters

`context`	to provide all methods to the user to add own objects to the event context
`return`	the iteration name in a string

B.2.3.1.9. getLastResult(KlarosTestCase)

public String getLastResult(KlarosTestCase testCase);

Gets the test case result of a test case and converts the result into a string.

Parameters

`testCase`	a test case
`return`	a string with the result

B.2.3.1.10. getList(Set<KlarosIssue>)

public List<KlarosIssue> getList(Set<KlarosIssue> issues);

Converts the set into a list.

Parameters

`issues`	a set with all relevant issues
`return`	a list with issues

B.2.3.1.11. getNumberOfClosedIssues(List<KlarosIssue>)

public Integer getNumberOfClosedIssues(List<KlarosIssue> issues);

Gets the number of resolved issues in the given list.

Parameters

`issues`	all issues
`return`	the number of resolved issues

B.2.3.1.12. getProjectName(IKlarosContext)

public String getProjectName(IKlarosContext context);

Get the active project name.

Parameters

`context`	the script context
`return`	the project name

B.2.3.1.13. getRate(int, int)

public int getRate(int amount,
                   int total);

Calculates the percentage of the given values.

Parameters

`amount`	the percentage
`total`	the total amount
`return`	percent or 0

B.2.3.1.14. getRequirements(Map<KlarosTestCase, List<KlarosIssue>>, boolean, KlarosContext)

public Map<String, Map<KlarosIssue, Set<KlarosTestCase>>> getRequirements(Map<KlarosTestCase, List<KlarosIssue>> testCases,
                                                                          boolean limitToUnresolvedIssues,
                                                                          KlarosContext context);

Sorts issues by requirements.

Parameters

`testCases`	a map of issues with there belongs test cases
`limitToUnresolvedIssues`	if set, limit results to unresolved issues
`context`	the context
`return`	a map with sorted issues by requirements

B.2.3.1.15. getResultColor(String)

public String getResultColor(String value);

Return matching color for a given test case result.

Parameters

`value`	the test case result in a string
`return`	the color string

B.2.3.1.16. getResultStatistic(KlarosTestCase)

public Integer getResultStatistic(KlarosTestCase testCase);

Calculates the success rate of the last 5 test case results.

Parameters

`testCase`	a test case
`return`	a number of passed test case results

B.2.3.1.17. getStateColor(KlarosIssue)

public String getStateColor(KlarosIssue issue);

Selects the color by issue status.

Parameters

`issue`	all issues
`return`	the color green or red

B.2.3.1.18. getSutName(KlarosSUTImplementation)

public String getSutName(KlarosSUTImplementation sut);

Gets the system under test name an converts it into a string.

Parameters

`sut`	a system under test
`return`	the system under test name in a string

B.2.3.1.19. getTestCase(KlarosIssue)

public Object[] getTestCase(KlarosIssue issue);

Gets the test case.

Parameters

`issue`	the issue
`return`	the test case

B.2.3.1.20. lastModifiedDateCalculator(List<KlarosIssue>)

public Map<Date, Integer> lastModifiedDateCalculator(List<KlarosIssue> issues);

Prepares the information of the last updated from the issues for the graph.

Parameters

`issues`	a list with all relevant issues
`return`	a map a data that is need for the graph

B.2.3.1.21. setToArray(Map<String, Map<KlarosIssue, Set<KlarosTestCase>>>, String)

public List<KlarosIssue> setToArray(Map<String, Map<KlarosIssue, Set<KlarosTestCase>>> getRequirements,
                                    String key);

Sets the to array.

Parameters

`getRequirements`	the get requirements
`key`	the key
`return`	the list

B.2.3.1.22. sortByIM(List<KlarosIssue>)

public Map<String, List<KlarosIssue>> sortByIM(List<KlarosIssue> issues);

Sort issues by Issue management.

Parameters

`issues`	a list of issues
`return`	a map that is sorted by issue managements

B.2.3.1.23. sortBySut(List<KlarosIssue>, KlarosContext)

public Map<String, List<KlarosIssue>> sortBySut(List<KlarosIssue> issues,
                                                KlarosContext context);

Sorts issues by system under test.

Parameters

`issues`	a list of issues
`context`	the context
`return`	a map with issues sorted by system under tests

B.2.3.1.24. sortByTestCase(List<KlarosIssue>, Set<KlarosTestCase>, boolean)

public Map<KlarosTestCase, List<KlarosIssue>> sortByTestCase(List<KlarosIssue> issues,
                                                             Set<KlarosTestCase> testCases,
                                                             boolean limitToUnresolvedIssues);

Sorts issues by there belonging test cases.

Parameters

`issues`	all test cases
`testCases`	the test cases
`limitToUnresolvedIssues`	limit the result to unresolved issues
`return`	a sorted map by test cases

B.2.3.2. IterationReport

The Class IterationsReport. A Java snippet to create an Iteration Report Template.

B.2.3.2.1. Synopsis

 public class IterationReportimplements, KlarosScript {
// Public Constructors  public IterationReport();
// Public Methods  public void addResult(String verdict,
                        KlarosTestCaseResult testResult,
                        Map<String, List<KlarosTestCaseResult>> resultMap);
  public void execute(KlarosContext context);
  public List<?> getAsList(Set<?> set);
  public String getColor(int index);
  public String getDate(Date d);
  public String getTestCase(KlarosTestRun testrun);
}

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

B.2.3.2.2. addResult(String, KlarosTestCaseResult, Map<String, List<KlarosTestCaseResult>>)

public void addResult(String verdict,
                      KlarosTestCaseResult testResult,
                      Map<String, List<KlarosTestCaseResult>> resultMap);

Adds a result to the results map.

Parameters

`verdict`	the verdict of the result
`testResult`	the test result
`resultMap`	the result map

B.2.3.2.3. getAsList(Set<?>)

public List<?> getAsList(Set<?> set);

Returns the given set as a list to allow index operations.

Parameters

`set`	the set to convert
`return`	the list

B.2.3.2.4. getColor(int)

public String getColor(int index);

Gets the color.

Parameters

`index`	the index
`return`	the color

B.2.3.2.5. getDate(Date)

public String getDate(Date d);

Gets the date.

Parameters

`d`	the date
`return`	the date

B.2.3.2.6. getTestCase(KlarosTestRun)

public String getTestCase(KlarosTestRun testrun);

Gets the test case.

Parameters

`testrun`	the Test Run
`return`	the Test Case Name

B.2.3.3. JobDetailReport

The Class JobDetailReport.

B.2.3.3.1. Synopsis

 public class JobDetailReportimplements, KlarosScript {
// Public Static Fields  public static final String DATE_FORMAT = "MMM dd, yyyy";
  public static final int MAX_PERCENT = 100;
  public static final int NOTICE_TIME_SPAN_IN_DAYS = 7;
  public static final int STYLING_SIZE_2 = 2;
  public static final int STYLING_SIZE_3 = 3;
  public static final int STYLING_SIZE_4 = 4;
  public static final int STYLING_SIZE_5 = 5;
  public static final int TIME_RANGE_IN_DAYS = 30;
// Public Constructors  public JobDetailReport();
// Public Methods  public Date convertDate(String date);
  public Map<Date, Integer> dueDateTimeLineCalculator(List<IKlarosJob> jobs);
  public void execute(KlarosContext context);
  public String formatDate(Date date);
  public List<IKlarosJob> getClosedJobs(List<IKlarosJob> jobs);
  public String getColor(int index);
  public String getEnvName(KlarosTestEnvironment env);
  public String getIterationName(IKlarosContext context);
  public String getJobNameToString(List<String> jobNames);
  public String getJobStateToString(List<String> jobConditions);
  public List<IKlarosJob> getOpenJobs(List<IKlarosJob> jobs);
  public String getProjectName(IKlarosContext context);
  public int getRate(int total,
                     int amount);
  public Set<JobStatus> getStatus(List<String> jobConditions);
  public String getSutName(KlarosSUTImplementation sut);
  public String getSutSortClosedSize(SortedMap<KlarosSUTImplementation, Map<KlarosTestEnvironment, List<IKlarosJob>>> sutSortedJobs,
                                     KlarosSUTImplementation sut);
  public String getSutSortOpenSize(SortedMap<KlarosSUTImplementation, Map<KlarosTestEnvironment, List<IKlarosJob>>> sutSortedJobs,
                                   KlarosSUTImplementation sut);
  public void getTimeProgress(List<IKlarosJob> closedJobs,
                              List<IKlarosJob> openJobs,
                              KlarosContext context);
  public Set<JobType> getType(List<String> jobNames);
  public String getValid(IKlarosJob job);
  public Map<Date, Integer> lastModifiedTimeLineCalculator(List<IKlarosJob> jobs);
  public void mapStatus(KlarosContext context,
                        List<IKlarosJob> jobs);
  public String milliToTime(long milli);
  public void sortJobsBySut(KlarosContext context,
                            List<IKlarosJob> jobs);
}

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

B.2.3.3.2. convertDate(String)

public Date convertDate(String date);

Convert a string to a date.

Parameters

`date`	a date that must be converted into a string
`return`	a converted date

B.2.3.3.3. dueDateTimeLineCalculator(List<IKlarosJob>)

public Map<Date, Integer> dueDateTimeLineCalculator(List<IKlarosJob> jobs);

Preparing data for the due date graphic.

Parameters

`jobs`	a list of jobs
`return`	a map with sorted information that is needed for the due date graph

B.2.3.3.4. formatDate(Date)

public String formatDate(Date date);

Convert a date to a string.

Parameters

`date`	chosen date that will be converted
`return`	a date in a string format

B.2.3.3.5. getClosedJobs(List<IKlarosJob>)

public List<IKlarosJob> getClosedJobs(List<IKlarosJob> jobs);

Get list with only closed jobs.

Parameters

`jobs`	a list of all jobs
`return`	a list with closed jobs

B.2.3.3.6. getColor(int)

public String getColor(int index);

Get color for zebra tables.

Parameters

`index`	the number of current index of the list
`return`	black or white for the zebra table

B.2.3.3.7. getEnvName(KlarosTestEnvironment)

public String getEnvName(KlarosTestEnvironment env);

Test environment to string.

Parameters

`env`	a test environment
`return`	the test environment name in a string

B.2.3.3.8. getIterationName(IKlarosContext)

public String getIterationName(IKlarosContext context);

Iteration name to String.

Parameters

`context`	to provide all methods to the user to add own objects to the event context
`return`	a string with the iteration name

B.2.3.3.9. getJobNameToString(List<String>)

public String getJobNameToString(List<String> jobNames);

All chosen jobNames to one string.

Parameters

`jobNames`	a list of chosen job names
`return`	all job names in one string

B.2.3.3.10. getJobStateToString(List<String>)

public String getJobStateToString(List<String> jobConditions);

All chosen jobStates to one string.

Parameters

`jobConditions`	a list of chosen job status
`return`	a string with all job status

B.2.3.3.11. getOpenJobs(List<IKlarosJob>)

public List<IKlarosJob> getOpenJobs(List<IKlarosJob> jobs);

Get list with only open jobs.

Parameters

`jobs`	a list of all jobs
`return`	a list with open jobs

B.2.3.3.12. getProjectName(IKlarosContext)

public String getProjectName(IKlarosContext context);

Project name to String.

Parameters

`context`	to provide all methods to the user to add own objects to the event context
`return`	a sting with the project name

B.2.3.3.13. getRate(int, int)

public int getRate(int total,
                   int amount);

Calculates percentage of two numbers.

Parameters

`total`	Total number
`amount`	needs to be < finished
`return`	percentage of these two numbers

B.2.3.3.14. getStatus(List<String>)

public Set<JobStatus> getStatus(List<String> jobConditions);

Gets the enum values of the job status.

Parameters

`jobConditions`	a list of chosen job status
`return`	a set with job states

B.2.3.3.15. getSutName(KlarosSUTImplementation)

public String getSutName(KlarosSUTImplementation sut);

System under test name to a string.

Parameters

`sut`	a system under test
`return`	the system under test name in a string

B.2.3.3.16. getSutSortClosedSize(SortedMap<KlarosSUTImplementation, Map<KlarosTestEnvironment, List<IKlarosJob>>>, KlarosSUTImplementation)

public String getSutSortClosedSize(SortedMap<KlarosSUTImplementation, Map<KlarosTestEnvironment, List<IKlarosJob>>> sutSortedJobs,
                                   KlarosSUTImplementation sut);

Closed jobs sorted by system under tests.

Parameters

`sutSortedJobs`	a map where the jobs are sorted by system under test and test environment
`sut`	a system under test
`return`	size of map

B.2.3.3.17. getSutSortOpenSize(SortedMap<KlarosSUTImplementation, Map<KlarosTestEnvironment, List<IKlarosJob>>>, KlarosSUTImplementation)

public String getSutSortOpenSize(SortedMap<KlarosSUTImplementation, Map<KlarosTestEnvironment, List<IKlarosJob>>> sutSortedJobs,
                                 KlarosSUTImplementation sut);

Open jobs sorted by system under Tests.

Parameters

`sutSortedJobs`	a map where the jobs are sorted by system under test and test environment
`sut`	a system under test
`return`	the size of the map

B.2.3.3.18. getTimeProgress(List<IKlarosJob>, List<IKlarosJob>, KlarosContext)

public void getTimeProgress(List<IKlarosJob> closedJobs,
                            List<IKlarosJob> openJobs,
                            KlarosContext context);

Extracts time information about jobs.

Parameters

`closedJobs`	a list of closed jobs
`openJobs`	a list of open jobs
`context`	to provide all methods to the user to add own objects to the event context

B.2.3.3.19. getType(List<String>)

public Set<JobType> getType(List<String> jobNames);

Gets the enum values of the job types.

Parameters

`jobNames`	a list of chosen job types
`return`	a set with job types

B.2.3.3.20. getValid(IKlarosJob)

public String getValid(IKlarosJob job);

Get color depending of the date.

Parameters

`job`	a job
`return`	a color that defines if the jobs date is due, expired or in time

B.2.3.3.21. lastModifiedTimeLineCalculator(List<IKlarosJob>)

public Map<Date, Integer> lastModifiedTimeLineCalculator(List<IKlarosJob> jobs);

Preparing data for last modified graphics.

Parameters

`jobs`	a list of jobs
`return`	a map with sorted information that is needed for the last modified graph

B.2.3.3.22. mapStatus(KlarosContext, List<IKlarosJob>)

public void mapStatus(KlarosContext context,
                      List<IKlarosJob> jobs);

Map that counts the status of the jobs.

Parameters

`context`	to provide all methods to the user to add own objects to the event context
`jobs`	a list of jobs

B.2.3.3.23. milliToTime(long)

public String milliToTime(long milli);

Converts long milliseconds to a string.

Parameters

`milli`	time in milliseconds
`return`	converted string

B.2.3.3.24. sortJobsBySut(KlarosContext, List<IKlarosJob>)

public void sortJobsBySut(KlarosContext context,
                          List<IKlarosJob> jobs);

jobs sorted by system under tests.

Parameters

`context`	to provide all methods to the user to add own objects to the event context
`jobs`	a list of jobs

B.2.3.4. JobDetailReport.Filter

Filters jobs by given filter.

B.2.3.4.1. Synopsis

 public static class JobDetailReport.Filter {
// Public Constructors  public Filter(Set<JobStatus> jobStatus,
                Set<JobType> jobTypes,
                Date startDate,
                Date endDate);
// Public Methods  public List<IKlarosJob> filter(Iterable<IKlarosJob> jobs);
}

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

B.2.3.4.2. Filter(Set<JobStatus>, Set<JobType>, Date, Date)

public Filter(Set<JobStatus> jobStatus,
              Set<JobType> jobTypes,
              Date startDate,
              Date endDate);

Create a filter.

Parameters

`jobStatus`	a set with chosen job status
`jobTypes`	a set with chosen job types
`startDate`	a start date when the report should start
`endDate`	a end date when the report should end

B.2.3.4.3. filter(Iterable<IKlarosJob>)

public List<IKlarosJob> filter(Iterable<IKlarosJob> jobs);

Filter filters the job list with given parameters.

Parameters

`jobs`	a list with all Klaros jobs
`return`	the filtered list

B.2.3.5. JobReport

The Class JobReport. A Java snippet to create an Job Report Template.

B.2.3.5.1. Synopsis

 public class JobReportimplements, KlarosScript {
// Public Constructors  public JobReport();
// Public Methods  public void execute(KlarosContext context);
  public String getColor(int index);
  public final List<?> getConverter(Set<?> testrun);
  public String getDate(Date date);
}

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

B.2.3.5.2. getColor(int)

public String getColor(int index);

Return the background color code for the given table row index. This method implements a zebra color schema with alternating colors for odd and even rows.

Parameters

`index`	the row index
`return`	the HTML color code string

B.2.3.5.3. getConverter(Set<?>)

public final List<?> getConverter(Set<?> testrun);

Converts Collections into a ArrayList.

Parameters

`testrun`	the testrun
`return`	the converter

B.2.3.5.4. getDate(Date)

public String getDate(Date date);

Return the formatted date string of the given date.

Parameters

`date`	the date
`return`	the formatted date string

B.2.3.6. TestRunReport

The Class TestRunReport. A Java snippet to create an Test Run Report Template.

B.2.3.6.1. Synopsis

 public class TestRunReportimplements, KlarosScript {
// Public Constructors  public TestRunReport();
// Public Methods  public void addResult(String verdict,
                        KlarosTestCaseResult testResult,
                        Map<String, List<KlarosTestCaseResult>> resultMap);
  public final void execute(KlarosContext context);
  public final String getColor(int index);
  public final List<?> getConverter(Set<?> testrun);
  public final String getDate(String s);
  public final String getDate(Date d);
  public final String getDateOnly(String s);
  public final String getDateOnly(long d);
  public final List<?> getSortTestRuns(List<?> testRuns,
                                       KlarosContext context);
  public final int getTestCaseError(KlarosTestCaseResult result);
  public final String getTestCaseResult(KlarosTestCaseResult result);
  public final int getTestCaseStepError(KlarosTestCaseStepResult result);
  public final String getTestCaseStepResult(KlarosTestCaseStepResult result);
}

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

B.2.3.6.2. addResult(String, KlarosTestCaseResult, Map<String, List<KlarosTestCaseResult>>)

public void addResult(String verdict,
                      KlarosTestCaseResult testResult,
                      Map<String, List<KlarosTestCaseResult>> resultMap);

Adds the result to the results map.

Parameters

`verdict`	the verdict of the result
`testResult`	the test result
`resultMap`	the result map

B.2.3.6.3. getColor(int)

public final String getColor(int index);

Gets the color.

Parameters

`index`	the index
`return`	the color

B.2.3.6.4. getConverter(Set<?>)

public final List<?> getConverter(Set<?> testrun);

Gets the converter.

Parameters

`testrun`	the Test Run
`return`	the converter

B.2.3.6.5. getDate(Date)

public final String getDate(Date d);

Gets the date.

Parameters

`d`	the d
`return`	the date

B.2.3.6.6. getDate(String)

public final String getDate(String s);

Formats the date. This method exists to correct an error introduced by the UI representation of the date component.

Parameters

`s`	the string representation of a date
`return`	the date

B.2.3.6.7. getDateOnly(long)

public final String getDateOnly(long d);

Gets the date only.

Parameters

`d`	the d
`return`	the date only

B.2.3.6.8. getDateOnly(String)

public final String getDateOnly(String s);

Formats the date. This method exists to correct an error introduced by the UI representation of the date component.

Parameters

`s`	the string representation of a date
`return`	the date

B.2.3.6.9. getSortTestRuns(List<?>, KlarosContext)

public final List<?> getSortTestRuns(List<?> testRuns,
                                     KlarosContext context);

Gets the sort test runs.

Parameters

`testRuns`	the test runs
`context`	the context
`return`	the sort test runs

B.2.3.6.10. getTestCaseError(KlarosTestCaseResult)

public final int getTestCaseError(KlarosTestCaseResult result);

Gets the error.

Parameters

`result`	the result
`return`	the error

B.2.3.6.11. getTestCaseResult(KlarosTestCaseResult)

public final String getTestCaseResult(KlarosTestCaseResult result);

Gets the result.

Parameters

`result`	the result
`return`	the result

B.2.3.6.12. getTestCaseStepError(KlarosTestCaseStepResult)

public final int getTestCaseStepError(KlarosTestCaseStepResult result);

Gets the error.

Parameters

`result`	the result
`return`	the error

B.2.3.6.13. getTestCaseStepResult(KlarosTestCaseStepResult)

public final String getTestCaseStepResult(KlarosTestCaseStepResult result);

Gets the result.

Parameters

`result`	the result
`return`	the result

B.2.4. de.verit.klaros.scripting.model

B.2.4.1. Parameter
B.2.4.2. ParameterContext
B.2.4.3. ParameterType

B.2.4.1. Parameter

The Parameter class encapsulates a report query parameter.

B.2.4.1.1. Synopsis

 public class Parameterimplements, Serializable {
// Public Constructors  public Parameter(ScriptParameter source);
// Public Methods  public String getDefaultValue();
  public List<String> getDefaultValues();
  public String getDescription();
  public String getLabel();
  public String getName();
  public List<String> getOptions();
  public String getOptionsString();
  public ScriptParameterType getType();
  public String getValue();
  public List<String> getValues();
  public boolean isMandatory();
}

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

B.2.4.1.2. Parameter(ScriptParameter)

public Parameter(ScriptParameter source);

Instantiates a new parameter.

Parameters

source

the source script parameter

B.2.4.1.3. getDefaultValue()

public String getDefaultValue();

Gets the default value.

Parameters

return

the default value

B.2.4.1.4. getDefaultValues()

public List<String> getDefaultValues();

Gets the default values.

Parameters

return

the default values

B.2.4.1.5. getDescription()

public String getDescription();

Gets the description.

Parameters

return

the description

B.2.4.1.6. getLabel()

public String getLabel();

Gets the label.

Parameters

return

the label

B.2.4.1.7. getName()

public String getName();

Gets the name.

Parameters

return

the name

B.2.4.1.8. getOptions()

public List<String> getOptions();

Gets the options.

Parameters

return

the options

B.2.4.1.9. getOptionsString()

public String getOptionsString();

Gets the options string.

Parameters

return

the options string

B.2.4.1.10. getType()

public ScriptParameterType getType();

Gets the type.

Parameters

return

the type

B.2.4.1.11. getValue()

public String getValue();

Gets the value.

Parameters

return

the value

B.2.4.1.12. getValues()

public List<String> getValues();

Gets the value.

Parameters

return

the value

B.2.4.1.13. isMandatory()

public boolean isMandatory();

Checks if is mandatory.

Parameters

return

true, if is mandatory

B.2.4.2. ParameterContext

The context for script parameters.

B.2.4.2.1. Synopsis

 public class ParameterContext {
// Public Constructors  public ParameterContext(List<ScriptParameter> parameters);
// Public Methods  public Map<String, Parameter> getParameters();
}

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

B.2.4.2.2. ParameterContext(List<ScriptParameter>)

public ParameterContext(List<ScriptParameter> parameters);

Create a ParameterContext.

Parameters

parameters

the jcr script parameters

B.2.4.3. ParameterType

The possible script parameter types.

B.2.4.3.1. Synopsis

 public final class ParameterType extends, Enum<ParameterType>
    implements, IKlarosEnum {
// Public Static Fields  public static final ParameterType BOOLEAN ;
  public static final ParameterType DATE ;
  public static final ParameterType INTEGER ;
  public static final ParameterType LIST ;
  public static final ParameterType MULTI_LIST ;
  public static final ParameterType STRING ;
// Public Static Methods  public static ParameterType fromName(String name);
  public static ParameterType parse(String name);
  public static ParameterType valueOf(int value);
  public static ParameterType valueOf(String name);
  public static ParameterType[] values();
// Public Methods  public int getCode();
  public String getResourceKey();
  public boolean isListType();
  public String toLocaleString(Locale locale);
}

Methods inherited from java.lang.Enum: compareTo , equals , getDeclaringClass , hashCode , name , ordinal , toString , valueOf

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

B.2.4.3.2. fromName(String)

public static ParameterType fromName(String name);

Create enum from a name string.

Parameters

`name`	the name
`return`	An enum by its name.

B.2.4.3.3. getResourceKey()

public String getResourceKey();

Gets the resource key.

Parameters

return

the resource key

B.2.4.3.4. isListType()

public boolean isListType();

Checks if this type is a list type.

Parameters

return

true, if list type

B.2.4.3.5. parse(String)

public static ParameterType parse(String name);

Parse an instance from a name string.

Parameters

`name`	the name of the enumeration as returned from toString() or name() methods.
`return`	The enumeration or null if no match.

B.2.4.3.6. valueOf(int)

public static ParameterType valueOf(int value);

Create from a code value.

Parameters

`value`	the code value
`return`	Returns the value of the given code.

B.2.5. Constant field values

B.2.5.1. de.verit.klaros.scripting.*
B.2.5.2. de.verit.klaros.scripting.custom.*

B.2.5.1. de.verit.klaros.scripting.*

WRAPPER_PREFIX

"Klaros"

Table B.1. KlarosQueryFactory

B.2.5.2. de.verit.klaros.scripting.custom.*

DATE_FORMAT	"MMM dd, yyyy"
MAX_PERCENT	100
NOTICE_TIME_SPAN_IN_DAYS	7
STYLING_SIZE_2	2
STYLING_SIZE_3	3
STYLING_SIZE_4	4
STYLING_SIZE_5	5
TIME_RANGE_IN_DAYS	30

Table B.2. JobDetailReport


Appendix A. Role Permission Overview		Appendix C. Test Case Import File Specification