Package org.ametys.odf.ose.export.utils
Class ElementRetriever
java.lang.Object
org.ametys.runtime.plugin.component.AbstractLogEnabled
org.ametys.odf.ose.export.utils.ElementRetriever
- All Implemented Interfaces:
LogEnabled
,Component
,Serviceable
A retriever used like a helper to retrieve some ODF elements from ODF items.
-
Field Summary
Modifier and TypeFieldDescriptionprotected ODFHelper
The helper for ODF contentsprotected OdfReferenceTableHelper
The helper for reference tables from ODFprotected AmetysObjectResolver
The resolverstatic final String
Avalon Role -
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionretrieveDegree
(Container container) Retrieve the degrees of a givenContainer
retrieveOrgUnits
(ProgramItem programItem) Retrieve theOrgUnit
s of a givenProgramItem
retrievePeriodTypes
(ProgramItem programItem) Get the potential period types of the program item.retrieveSteps
(ProgramItem programItem) Retrieve the steps (Container
s of nature 'annee') of a givenProgramItem
retrieveStepsHolder
(ProgramItem programItem) Get the potential steps holder of the program item.void
service
(ServiceManager manager) Methods inherited from class org.ametys.runtime.plugin.component.AbstractLogEnabled
getLogger, setLogger
-
Field Details
-
ROLE
Avalon Role -
_odfHelper
The helper for ODF contents -
_refTableHelper
The helper for reference tables from ODF -
_resolver
The resolver
-
-
Constructor Details
-
ElementRetriever
public ElementRetriever()
-
-
Method Details
-
service
- Specified by:
service
in interfaceServiceable
- Throws:
ServiceException
-
retrieveSteps
Retrieve the steps (Container
s of nature 'annee') of a givenProgramItem
- Parameters:
programItem
- The program item- Returns:
- the steps (
Container
s of nature 'annee') of the given program item
-
retrieveOrgUnits
Retrieve theOrgUnit
s of a givenProgramItem
- Parameters:
programItem
- The program item- Returns:
- the
OrgUnit
s of the given program item
-
retrieveDegree
Retrieve the degrees of a givenContainer
- Parameters:
container
- The container- Returns:
- the degrees of the given container
-
retrieveStepsHolder
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
- TheProgramItem
on which we have to retrieve the potential steps holder- Returns:
- the potential steps holder of the program item
-
retrievePeriodTypes
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
- TheProgramItem
on which we have to retrieve the potential period types- Returns:
- the potential period types of the program item
-