Package io.meeds.gamification.service

Class BadgeService

java.lang.Object

io.meeds.gamification.service.BadgeService

public class BadgeService
extends Object

Field Summary

Fields

Modifier and Type	Field	Description
protected final BadgeDAO	badgeDAO
protected final ProgramStorage	programStorage

Constructor Summary

Constructors

Constructor	Description
BadgeService(ProgramStorage programStorage, BadgeDAO badgeDAO)

Method Summary

Modifier and Type	Method	Description
BadgeDTO	addBadge(BadgeDTO badgeDTO)	Add Badge to DB
void	deleteBadge(Long id)	Delete a BadgeEntity using the id
BadgeDTO	findBadgeById(Long badgeId)	Find a BadgeEntity by id
BadgeDTO	findBadgeByTitle(String badgeTitle)	Find a BadgeEntity by title
BadgeDTO	findBadgeByTitleAndProgramId(String badgeTitle, long programId)	Find a BadgeEntity by title
List<BadgeDTO>	findBadgesByProgramId(long programId)
List<BadgeDTO>	findEnabledBadgesByProgramId(long programId)
List<BadgeDTO>	getAllBadges()	Return all badges within the DB
BadgeDTO	updateBadge(BadgeDTO badgeDTO)	Update Badge to DB

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

programStorage

protected final ProgramStorage programStorage

badgeDAO

protected final BadgeDAO badgeDAO

Constructor Details

BadgeService

public BadgeService(ProgramStorage programStorage,
 BadgeDAO badgeDAO)

Method Details

findBadgeByTitle

public BadgeDTO findBadgeByTitle(String badgeTitle)

Find a BadgeEntity by title

Parameters:

badgeTitle - : badge title

Returns:

an instance BadgeDTO

findBadgeById

public BadgeDTO findBadgeById(Long badgeId)

Find a BadgeEntity by id

Parameters:

badgeId - : badge id

Returns:

an instance BadgeDTO

findBadgeByTitleAndProgramId

public BadgeDTO findBadgeByTitleAndProgramId(String badgeTitle,
 long programId)

Find a BadgeEntity by title

Parameters:

badgeTitle - : badge title

programId - : badge program id

Returns:

an instance BadgeDTO

getAllBadges

public List<BadgeDTO> getAllBadges()

Return all badges within the DB

Returns:

a list of BadgeDTO

addBadge

public BadgeDTO addBadge(BadgeDTO badgeDTO)
                  throws org.exoplatform.commons.ObjectAlreadyExistsException

Add Badge to DB

Parameters:

badgeDTO - : an object of type RuleDTO

Returns:

BadgeDTO object

Throws:

org.exoplatform.commons.ObjectAlreadyExistsException - when badge already exists

updateBadge

public BadgeDTO updateBadge(BadgeDTO badgeDTO)
                     throws org.exoplatform.commons.ObjectAlreadyExistsException

Update Badge to DB

Parameters:

badgeDTO - : an instance of type BadgeDTO

Returns:

BadgeDTO object

Throws:

org.exoplatform.commons.ObjectAlreadyExistsException - when badge already exists

deleteBadge

public void deleteBadge(Long id)
                 throws org.exoplatform.commons.exception.ObjectNotFoundException

Delete a BadgeEntity using the id

Parameters:

id - : badge id

Throws:

org.exoplatform.commons.exception.ObjectNotFoundException - when badge doesn't exist

findBadgesByProgramId

public List<BadgeDTO> findBadgesByProgramId(long programId)

findEnabledBadgesByProgramId

public List<BadgeDTO> findEnabledBadgesByProgramId(long programId)