Package org.ametys.odf.skill

Class ODFSkillsHelper

java.lang.Object

org.ametys.runtime.plugin.component.AbstractLogEnabled

org.ametys.odf.skill.ODFSkillsHelper

All Implemented Interfaces:

LogEnabled, Component, Serviceable

public class ODFSkillsHelper
extends AbstractLogEnabled
implements Serviceable, Component

ODF skills helper

Field Summary

Fields

Modifier and Type	Field	Description
protected ContentWorkflowHelper	_contentWorkflowHelper	The content workflow helper
protected CurrentUserProvider	_currentUserProvider	The current user provider
protected ObservationManager	_observationManager	The observation manager
protected ODFHelper	_odfHelper	The ODF helper
protected AmetysObjectResolver	_resolver	The ametys object resolver
protected SolrIndexHelper	_solrIndexHelper	The Solr index helper
static final String	ROLE	The avalon role.
static final String	SKILLS_EXCLUDED_INTERNAL_ATTRIBUTE_NAME	The internal attribute name to excluded from skills

Constructor Summary

Constructors

Constructor	Description
ODFSkillsHelper()

Method Summary

Modifier and Type	Method	Description
String	getCatalog(String contentId)	Get the name of the catalog of a skill content
AmetysObjectIterable<Content>	getMicroSkills(String catalog)	Get all micro skills of a requested catalog
String	getOdfRootContentPath()	Get the path of the ODF root content
Map<Content,Map<Content,Set<Content>>>	getSkillsDistribution(AbstractProgram abstractProgram)	Get the skills distribution by courses over a AbstractProgram Distribution is computed over the course of first level only
Map<Content,Map<Content,Set<Content>>>	getSkillsDistribution(AbstractProgram abstractProgram, int maxDepth)	Get the skills distribution by courses over a AbstractProgram Distribution is computed over the course of first level only
Map<Content,Map<Content,Set<Content>>>	getSkillsDistribution(Program parentProgram, AbstractProgram program, int maxDepth)	Get the skills distribution by courses over a ProgramItem
boolean	isExcluded(ProgramItem programItem)	true if the program item is excluded from skills display
static boolean	isSkillsEnabled()	Determines if rules are enabled
void	service(ServiceManager manager)
Map<String,Object>	setProgramItemsExclusion(List<String> programItemIds, boolean excluded)	Exclude or include the program items from skills display

Methods inherited from class org.ametys.runtime.plugin.component.AbstractLogEnabled

getLogger, setLogger

Methods inherited from class java.lang.Object

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

Field Details

ROLE

public static final String ROLE

The avalon role.

SKILLS_EXCLUDED_INTERNAL_ATTRIBUTE_NAME

public static final String SKILLS_EXCLUDED_INTERNAL_ATTRIBUTE_NAME

The internal attribute name to excluded from skills

See Also:

• Constant Field Values

_contentWorkflowHelper

protected ContentWorkflowHelper _contentWorkflowHelper

The content workflow helper

_resolver

protected AmetysObjectResolver _resolver

The ametys object resolver

_odfHelper

protected ODFHelper _odfHelper

The ODF helper

_observationManager

protected ObservationManager _observationManager

The observation manager

_solrIndexHelper

protected SolrIndexHelper _solrIndexHelper

The Solr index helper

_currentUserProvider

protected CurrentUserProvider _currentUserProvider

The current user provider

Constructor Details

ODFSkillsHelper

public ODFSkillsHelper()

Method Details

service

public void service(ServiceManager manager)
             throws ServiceException

Specified by:

service in interface Serviceable

Throws:

ServiceException

isSkillsEnabled

public static boolean isSkillsEnabled()

Determines if rules are enabled

Returns:

true if rules are enabled

getCatalog

public String getCatalog(String contentId)

Get the name of the catalog of a skill content

Parameters:

contentId - The id of content

Returns:

The catalog's name or null if the content does not have a catalog

getOdfRootContentPath

public String getOdfRootContentPath()

Get the path of the ODF root content

Returns:

The path of the ODF root content

setProgramItemsExclusion

public Map<String,Object> setProgramItemsExclusion(List<String> programItemIds,
 boolean excluded)

Exclude or include the program items from skills display

Parameters:

programItemIds - the list of program item ids

excluded - true if the program items need to be excluded.

Returns:

the map of changed program items properties

isExcluded

public boolean isExcluded(ProgramItem programItem)

true if the program item is excluded from skills display

Parameters:

programItem - the program item

Returns:

true if the program item is excluded from skills display

getSkillsDistribution

public Map<Content,Map<Content,Set<Content>>> getSkillsDistribution(AbstractProgram abstractProgram)

Get the skills distribution by courses over a AbstractProgram Distribution is computed over the course of first level only

Parameters:

abstractProgram - The program or subProgram for which to get the skills distribution

Returns:

the skills distribution or null if the content is not a program or a compatible subProgram

getSkillsDistribution

public Map<Content,Map<Content,Set<Content>>> getSkillsDistribution(AbstractProgram abstractProgram,
 int maxDepth)

Get the skills distribution by courses over a AbstractProgram Distribution is computed over the course of first level only

Parameters:

abstractProgram - The program or subProgram for which to get the skills distribution

maxDepth - the max depth of courses. For example, set to 1 to compute distribution over UE only, set 2 to compute distribution over UE and EC, ...

Returns:

the skills distribution or null if the content is not a program or a compatible subProgram

getSkillsDistribution

public Map<Content,Map<Content,Set<Content>>> getSkillsDistribution(Program parentProgram,
 AbstractProgram program,
 int maxDepth)

Get the skills distribution by courses over a ProgramItem

Parameters:

parentProgram - The parent program that contains the skills

program - the program

maxDepth - the max depth of courses. For example, set to 1 to compute distribution over UE only, set 2 to compute distribution over UE and EC, ...

Returns:

the skills distribution as Map<MacroSkill, Map<MicroSkill, Set<Course>>>

getMicroSkills

public AmetysObjectIterable<Content> getMicroSkills(String catalog)

Get all micro skills of a requested catalog

Parameters:

catalog - The catalog

Returns:

The micro skills