Package org.ametys.odf.course

Class ShareableCourseHelper

java.lang.Object

org.ametys.runtime.plugin.component.AbstractLogEnabled

org.ametys.odf.course.ShareableCourseHelper

All Implemented Interfaces:

LogEnabled, Component, Configurable, Serviceable

public class ShareableCourseHelper
extends AbstractLogEnabled
implements Component, Serviceable, Configurable

Helper for shareable course

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
private static class	ShareableCourseHelper.ShareableConfiguration
private static class	ShareableCourseHelper.ShareableField

Field Summary

Fields

Modifier and Type	Field	Description
private static String	__OWN_KEY
protected ODFHelper	_odfHelper	The ODF helper
protected OdfReferenceTableHelper	_odfRefTableHelper	The ODF reference table helper
protected AmetysObjectResolver	_resolver	The Ametys object resolver
protected ShareableCourseHelper.ShareableConfiguration	_shareableCourseConfiguration	The shareable course configuration
protected ShareableCourseStatusHelper	_shareableCourseStatus	The shareable course status
static String	ROLE	The component role.

Constructor Summary

Constructors

Constructor	Description
ShareableCourseHelper()

Method Summary

Modifier and Type	Method	Description
private String	_getItemIdFromCDM(String cdmValue, String contentType)
private boolean	_isContentExist(String contentId)
protected boolean	_parseAutoValidated(Configuration configuration)	Parse configuration to know if courses are validated after initialization
protected ShareableCourseHelper.ShareableConfiguration	_parseConfiguration(Configuration configuration)	Parse configuration to create a shareable course configuration
protected ShareableCourseHelper.ShareableField	_parseDegreeField(Configuration configuration)	Parse configuration to get degree field
protected ShareableCourseHelper.ShareableField	_parseOrgUnitField(Configuration configuration)	Parse configuration to get orgUnit field
protected ShareableCourseHelper.ShareableField	_parsePeriodField(Configuration configuration)	Parse configuration to get period field
protected ShareableCourseHelper.ShareableField	_parseProgramField(Configuration configuration)	Parse configuration to get program field
void	configure(Configuration configuration)
Set<String>	getDegrees(Set<Program> programs)	Get degrees from programs
Set<String>	getOrgUnits(Set<Program> programs)	Get orgUnits from programs
Set<String>	getPeriods(Set<Container> containers)	Get periods from containers
Set<String>	getProgramIds(Set<Program> programs)	Get programs ids from programs
AmetysObjectIterable<Course>	getShareableCourses(String programId, String degreeId, String periodId, String orgUnitId)	Get the Courses with shareable filters matching the given arguments
boolean	handleShareableCourse()	Return true if shareable course are handled
boolean	initializeShareableFields(Course courseContent, List<CourseList> courseListContents, UserIdentity user, boolean ignoreRights)	Initialize the shareable course fields
boolean	initializeShareableFields(Course courseContent, CourseList courseListContent, UserIdentity user, boolean ignoreRights)	Initialize the shareable course fields
boolean	isShareableFieldsMatch(Course courseContent, CourseList courseList)	True if shareable course fields match with the course list
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 Detail

ROLE

public static final String ROLE

The component role.

__OWN_KEY

private static final String __OWN_KEY

See Also:

Constant Field Values

_shareableCourseConfiguration

protected ShareableCourseHelper.ShareableConfiguration _shareableCourseConfiguration

The shareable course configuration

_odfRefTableHelper

protected OdfReferenceTableHelper _odfRefTableHelper

The ODF reference table helper

_shareableCourseStatus

protected ShareableCourseStatusHelper _shareableCourseStatus

The shareable course status

_odfHelper

protected ODFHelper _odfHelper

The ODF helper

_resolver

protected AmetysObjectResolver _resolver

The Ametys object resolver

Constructor Detail

ShareableCourseHelper

public ShareableCourseHelper()

Method Detail

service

public void service(ServiceManager manager)
             throws ServiceException

Specified by:

service in interface Serviceable

Throws:

ServiceException

configure

public void configure(Configuration configuration)
               throws ConfigurationException

Specified by:

configure in interface Configurable

Throws:

ConfigurationException

_parseConfiguration

protected ShareableCourseHelper.ShareableConfiguration _parseConfiguration(Configuration configuration)

Parse configuration to create a shareable course configuration

Parameters:

configuration - the configuration

Returns:

the shareable course configuration

_parseAutoValidated

protected boolean _parseAutoValidated(Configuration configuration)

Parse configuration to know if courses are validated after initialization

Parameters:

configuration - the configuration

Returns:

true if courses are validated after initialization

_parseProgramField

protected ShareableCourseHelper.ShareableField _parseProgramField(Configuration configuration)

Parse configuration to get program field

Parameters:

configuration - the configuration

Returns:

the program field

_parseDegreeField

protected ShareableCourseHelper.ShareableField _parseDegreeField(Configuration configuration)

Parse configuration to get degree field

Parameters:

configuration - the configuration

Returns:

the degree field

_parsePeriodField

protected ShareableCourseHelper.ShareableField _parsePeriodField(Configuration configuration)

Parse configuration to get period field

Parameters:

configuration - the configuration

Returns:

the period field

_parseOrgUnitField

protected ShareableCourseHelper.ShareableField _parseOrgUnitField(Configuration configuration)

Parse configuration to get orgUnit field

Parameters:

configuration - the configuration

Returns:

the orgUnit field

_getItemIdFromCDM

private String _getItemIdFromCDM(String cdmValue,
                                 String contentType)

_isContentExist

private boolean _isContentExist(String contentId)

initializeShareableFields

public boolean initializeShareableFields(Course courseContent,
                                         CourseList courseListContent,
                                         UserIdentity user,
                                         boolean ignoreRights)

Initialize the shareable course fields

Parameters:

courseContent - the course content to initialize

courseListContent - the course list parent. Can be null

user - the user who initialize the shareable fields

ignoreRights - true to ignore user rights

Returns:

true if there are changes

initializeShareableFields

public boolean initializeShareableFields(Course courseContent,
                                         List<CourseList> courseListContents,
                                         UserIdentity user,
                                         boolean ignoreRights)

Initialize the shareable course fields

Parameters:

courseContent - the course content to initialize

courseListContents - the list of course list parents. Can be empty

user - the user who initialize the shareable fields

ignoreRights - true to ignore user rights

Returns:

true if there are changes

isShareableFieldsMatch

public boolean isShareableFieldsMatch(Course courseContent,
                                      CourseList courseList)

True if shareable course fields match with the course list

Parameters:

courseContent - the shareable course

courseList - the course list

Returns:

true if shareable course fields match with the course list

getProgramIds

public Set<String> getProgramIds(Set<Program> programs)

Get programs ids from programs

Parameters:

programs - the list of programs

Returns:

the list of progam ids

getDegrees

public Set<String> getDegrees(Set<Program> programs)

Get degrees from programs

Parameters:

programs - the list of programs

Returns:

the list of degrees

getPeriods

public Set<String> getPeriods(Set<Container> containers)

Get periods from containers

Parameters:

containers - the list of containers

Returns:

the list of periods

getOrgUnits

public Set<String> getOrgUnits(Set<Program> programs)

Get orgUnits from programs

Parameters:

programs - the list of programs

Returns:

the list of orgUnits

handleShareableCourse

public boolean handleShareableCourse()

Return true if shareable course are handled

Returns:

true if shareable course are handled

getShareableCourses

public AmetysObjectIterable<Course> getShareableCourses(String programId,
                                                        String degreeId,
                                                        String periodId,
                                                        String orgUnitId)

Get the Courses with shareable filters matching the given arguments

Parameters:

programId - the program id. Can be null

degreeId - the degree id. Can be null

periodId - the period id. Can be null

orgUnitId - the orgUnit id. Can be null

Returns:

The matching courses