hu.ibello.requirements.model

Interface Requirements

public interface Requirements

Model interface for an object which contains requirements. The requirements containing this object should have some common reason / theme.

Author:

Kornél Simon

Method Summary

Modifier and Type	Method and Description
default int	getActiveRequirementCount() How many active requirements are in this requirement list?
String	getBaseId() The id of all requirements in this list should start with this text.
String	getDescription() Description of the requirement list.
List<String>	getLinks() List of links (eg. identifiers of related tasks from a task management system).
String	getRelativePath() The path to the requirements file, relative to the ibello requirements directory.
List<? extends Requirement>	getRequirements() Lisst of individual requirements.
String	getTitle() Title of the requirement list.
default boolean	hasTitle() Return true if this object has non-empty a title.

Method Detail

getRelativePath

String getRelativePath()

The path to the requirements file, relative to the ibello requirements directory.

Returns:

the relative path to the file

getTitle

String getTitle()

Title of the requirement list. This describes the main purpose of the containing requirements.

Returns:

title of the requirement list

hasTitle

default boolean hasTitle()

Return true if this object has non-empty a title.

Returns:

true if the oobject has a title

getDescription

String getDescription()

Description of the requirement list. This describes the purpose of the containing requirements.

Returns:

description of the requirement list

getBaseId

String getBaseId()

The id of all requirements in this list should start with this text.

Returns:

prefix of the requirement ids

getLinks

List<String> getLinks()

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

Returns:

list of links

getRequirements

List<? extends Requirement> getRequirements()

Lisst of individual requirements.

Returns:

requirement list

getActiveRequirementCount

default int getActiveRequirementCount()

How many active requirements are in this requirement list?

Returns:

number of active requirements