Package org.ametys.odf.ose.export.utils

Class ElementRetriever

java.lang.Object

org.ametys.runtime.plugin.component.AbstractLogEnabled

org.ametys.plugins.odfpilotage.helper.PilotageHelper

org.ametys.odf.ose.export.utils.ElementRetriever

All Implemented Interfaces:

LogEnabled, Initializable, Component, Serviceable

public class ElementRetriever
extends PilotageHelper

A retriever used like a helper to retrieve some ODF elements from ODF items.

Nested Class Summary

Nested classes/interfaces inherited from class org.ametys.plugins.odfpilotage.helper.PilotageHelper

PilotageHelper.StepHolderStatus

Field Summary

Fields

Modifier and Type	Field	Description
protected AmetysObjectResolver	_resolver	The resolver
static final String	ROLE	Avalon Role

Fields inherited from class org.ametys.plugins.odfpilotage.helper.PilotageHelper

_ametysResolver, _cacheManager, _odfHelper, _refTableHelper, COMPATIBLE_REGIMES_ATTRIBUTE_NAME, CONTAINER_MCC_NUMBER_OF_SESSIONS, CONTAINER_MCC_REGIME, COURSE_MCC_REGIME, MCC_MODALITE_SESSION1, MCC_MODALITE_SESSION2, MCC_SESSION_NATURE, NORME

Constructor Summary

Constructors

Constructor	Description
ElementRetriever()

Method Summary

Modifier and Type	Method	Description
protected String	_getStepsHolderByItemCacheId()	Get the id for steps holder by item cache.
protected Set<Container>	_getStepsToCache(ProgramItem programItem, String yearId)	Get the steps to add to the cache.
Optional<String>	getSemesterId()	Get the semester container nature identifier.
Set<OdfReferenceTableEntry>	retrieveDegree(Container container)	Retrieve the degrees of a given Container
Set<OrgUnit>	retrieveOrgUnits(ProgramItem programItem)	Retrieve the OrgUnits of a given ProgramItem
Set<OdfReferenceTableEntry>	retrievePeriodTypes(ProgramItem programItem)	Get the potential period types of the program item.
Set<Container>	retrieveStepsHolder(ProgramItem programItem)	Get the potential steps holder of the program item.
void	service(ServiceManager manager)

Methods inherited from class org.ametys.plugins.odfpilotage.helper.PilotageHelper

_getSteps, _getStepsHolder, canWriteMccRestrictions, getCompatibleModalityInSession2, getCompatibleRegimes, getContentFromName, getContentsFromPath, getDisplayablePath, getMCCConfiguration, getMCCNbSessionsPolicy, getMCCRegimePolicy, getParentYears, getStepHolder, getSteps, getYearId, getYears, initialize, invalidateAllCaches, isContainerOfNature, isContainerOfTypeYear, isContainerOfTypeYear, isContainerOfTypeYear, transformEqTD2Double

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

Avalon Role

_resolver

protected AmetysObjectResolver _resolver

The resolver

Constructor Details

ElementRetriever

public ElementRetriever()

Method Details

service

public void service(ServiceManager manager)
             throws ServiceException

Specified by:

service in interface Serviceable

Overrides:

service in class PilotageHelper

Throws:

ServiceException

_getStepsHolderByItemCacheId

protected String _getStepsHolderByItemCacheId()

Description copied from class: PilotageHelper

Get the id for steps holder by item cache.

Overrides:

_getStepsHolderByItemCacheId in class PilotageHelper

Returns:

the cache id

_getStepsToCache

protected Set<Container> _getStepsToCache(ProgramItem programItem,
 String yearId)

Description copied from class: PilotageHelper

Get the steps to add to the cache.

Overrides:

_getStepsToCache in class PilotageHelper

Parameters:

programItem - The program item to search on

yearId - The identifier of the year container nature

Returns:

A Set of Container corresponding to the steps of the given program item.

retrieveOrgUnits

public Set<OrgUnit> retrieveOrgUnits(ProgramItem programItem)

Retrieve the OrgUnits of a given ProgramItem

Parameters:

programItem - The program item

Returns:

the OrgUnits of the given program item

retrieveDegree

public Set<OdfReferenceTableEntry> retrieveDegree(Container container)

Retrieve the degrees of a given Container

Parameters:

container - The container

Returns:

the degrees of the given container

retrieveStepsHolder

public Set<Container> retrieveStepsHolder(ProgramItem programItem)

Get the potential steps holder of the program item. A step is a container of year type and it can be set manually on intermediate courses.

Parameters:

programItem - The ProgramItem on which we have to retrieve the potential steps holder

Returns:

the potential steps holder of the program item

retrievePeriodTypes

public Set<OdfReferenceTableEntry> retrievePeriodTypes(ProgramItem programItem)

Get the potential period types of the program item. It can be retrieved on courses or containers. The algorithm doesn't search in the parent of semester containers.

Parameters:

programItem - The ProgramItem on which we have to retrieve the potential period types

Returns:

the potential period types of the program item

getSemesterId

public Optional<String> getSemesterId()

Get the semester container nature identifier.

Returns:

an Optional of the semester identifier