cz.cuni.mff.procasor.core.helper
Class UseCaseHelper

java.lang.Object
  extended bycz.cuni.mff.procasor.core.helper.UseCaseHelper

public class UseCaseHelper
extends java.lang.Object

Helper class for UseCase

Author:
Jirka

Method Summary
static UseCase create(java.lang.String name, java.lang.String description, UseCaseModel useCaseModel)
          Create use case wiht specified parameters
static TypeSentence getStepByMark(UseCase useCase, java.lang.String mark)
          Get step with specified mark
static boolean isAcronymCorrect(UseCase useCase, java.lang.String name, UseCaseModel model)
          Check if the acronym of use case is correct.
static boolean isNameCorrect(UseCase useCase, java.lang.String name, UseCaseModel model)
          Check if name of use case is correct (if is unique).
static boolean remove(UseCase useCase, Project project)
          Remove useCase from the whole project.
static void removeEntityFromUseCase(UseCase useCase, Entity entity)
          Remove entity form all steps in useCase.
static void save(UseCase useCase)
          Sets id for useCase and adds useCase to to model.
static void setAcronym(UseCase useCase, java.lang.String acronym)
          Sets acronym to the use case
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Method Detail

getStepByMark

public static TypeSentence getStepByMark(UseCase useCase,
                                         java.lang.String mark)
Get step with specified mark

Parameters:
useCase - use case, step are finding in
mark - specified mark
Returns:
step, if exist, null otherwise

create

public static UseCase create(java.lang.String name,
                             java.lang.String description,
                             UseCaseModel useCaseModel)
Create use case wiht specified parameters

Parameters:
name - name of the use case
description - descrition of the use case
useCaseModel - model use case belongs to
Returns:
newly created use case

save

public static void save(UseCase useCase)
Sets id for useCase and adds useCase to to model.

Parameters:
useCase - uset case to be added to model

remove

public static boolean remove(UseCase useCase,
                             Project project)
Remove useCase from the whole project.

Parameters:
useCase - use case to be removed

removeEntityFromUseCase

public static void removeEntityFromUseCase(UseCase useCase,
                                           Entity entity)
Remove entity form all steps in useCase. From subject, indirect object. From actors and from entity registered.

Parameters:
useCase - use case, entity (actor) is removed from
entity - actor to be removed

isAcronymCorrect

public static boolean isAcronymCorrect(UseCase useCase,
                                       java.lang.String name,
                                       UseCaseModel model)
Check if the acronym of use case is correct. (if is unique and contains specified letters)

Parameters:
useCase - use case, which is checked
name - acronym
Returns:
true if acronym is correct, false otherwise

isNameCorrect

public static boolean isNameCorrect(UseCase useCase,
                                    java.lang.String name,
                                    UseCaseModel model)
Check if name of use case is correct (if is unique).

Parameters:
useCase - use case, which name is checked
model - model, use case belong to
Returns:
true if name is correct, false otherwise

setAcronym

public static void setAcronym(UseCase useCase,
                              java.lang.String acronym)
Sets acronym to the use case

Parameters:
useCase - use casa, which is modified
acronym - new acronym