Package org.ametys.plugins.odforientation

Class ProgramFlowHelper

java.lang.Object

org.ametys.runtime.plugin.component.AbstractLogEnabled

org.ametys.plugins.odforientation.ProgramFlowHelper

All Implemented Interfaces:

LogEnabled, Component, Serviceable

public class ProgramFlowHelper
extends AbstractLogEnabled
implements Component, Serviceable

Helper for program flow data This class is used to provide data for the students flow by degrees and study fields.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	ROLE	The component role.
static final String	STUDY_FIELD	Study field
static final String	STUDY_FIELD_ATTRIBUTE_NAME	Study field

Constructor Summary

Constructors

Constructor	Description
ProgramFlowHelper()

Method Summary

Modifier and Type	Method	Description
Map<String,Object>	getProgramFlowByDegrees()	Get the students flow by degrees
Map<String,Object>	getProgramFlowData(String catalogName, String lang)	Get the data for programs pathways, including the flow and the study fields.
void	service(ServiceManager manager)

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 component role.

STUDY_FIELD

public static final String STUDY_FIELD

Study field

See Also:

• Constant Field Values

STUDY_FIELD_ATTRIBUTE_NAME

public static final String STUDY_FIELD_ATTRIBUTE_NAME

Study field

See Also:

• Constant Field Values

Constructor Details

ProgramFlowHelper

public ProgramFlowHelper()

Method Details

service

public void service(ServiceManager manager)
             throws ServiceException

Specified by:

service in interface Serviceable

Throws:

ServiceException

getProgramFlowData

public Map<String,Object> getProgramFlowData(String catalogName,
 String lang)

Get the data for programs pathways, including the flow and the study fields.

Parameters:

catalogName - The name of the catalog. If null the default catalog will be used.

lang - The program's language. Cannot not be null nor empty.

Returns:

the data for programs pathways as json

getProgramFlowByDegrees

public Map<String,Object> getProgramFlowByDegrees()

Get the students flow by degrees

Returns:

the students flow