hu.ibello.requirements.model

Interface Requirement

public interface Requirement

Model interface for a requirement.

Author:

Kornél Simon

Method Summary

Modifier and Type	Method and Description
String	getDescription() Detailed description of the requirement.
String	getId() Generated identifier of the requirement.
RequirementKind	getKind() Type of the requirement.
List<String>	getLinks() List of links (eg. identifiers of related tasks from a task management system).
List<? extends Requirement>	getRequirements() List of child requirements.
String	getTitle() Human readable title / name of the requirement.
default boolean	isActive() Is the requirement active?
boolean	isArchived() Is the requirement archived?

Method Detail

getKind

RequirementKind getKind()

Type of the requirement.

Returns:

requirement kind

getId

String getId()

Generated identifier of the requirement. Can be used as scenario tag.

Returns:

requirement ID

getTitle

String getTitle()

Human readable title / name of the requirement.

Returns:

requirement title

getDescription

String getDescription()

Detailed description of the requirement.

Returns:

requirement description

getLinks

List<String> getLinks()

List of links (eg. identifiers of related tasks from a task management system). These links are related to this requirement and to each child requirement. If there are no links then this methos returns an empty list.

Returns:

list of links

getRequirements

List<? extends Requirement> getRequirements()

List of child requirements. If this requirement may have child requirements, then the returned value is a List. Otherwise, null is returned.

Returns:

the list of child requirements or null

isArchived

boolean isArchived()

Is the requirement archived? Archived requirements should not be used for any purpose.

Returns:

true if requirement is archived

isActive

default boolean isActive()

Is the requirement active? A requirement is active if it is not archived.

Returns:

true if requirement is active