EnrichmentService (Eduix Service Platform: Generic Export 1.5.1-SNAPSHOT API)

All Known Implementing Classes:

AbstractEnrichmentService, BaseEnrichmentService, BaseEnrichmentService, CategoryEnrichmentService, CourseUnitEnrichmentService, CourseUnitRealizationEnrichmentService, NoopEnrichmentService, OfferingEnrichmentService, ProgrammeEnrichmentService, RealizationQuotaEnrichmentService, RealizationQuotaEnrichmentService, RegistrationPackageEnrichmentService, StudyModuleEnrichmentService
```
public interface EnrichmentService
```
An interface for study element enrichment services.

Author:

Jarkko Leponiemi

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method	Description
`EnrichmentContext`	`enrich(EnrichmentContext enrichmentContext, boolean inPlace)`	Enrich the study element in the given enrichment context
`ElementDeleteMarker`	`getElementDeleteMarker()`
`String`	`getName()`
`Map<String,Class<?>>`	`getTypeClassMappings()`
`boolean`	`isApplicable(String type)`
`boolean`	`isProcessable(EnrichmentContext enrichmentContext)`

- Method Detail
  - getName
```
String getName()
```
    Returns:
    
    the name of the enrichment service
  - getTypeClassMappings
```
Map<String,Class<?>> getTypeClassMappings()
```
  - isApplicable
```
boolean isApplicable(String type)
```
    Parameters:
    
    type - study element typ
    
    Returns:
    
    true, if enrichment service is applicable for given study elemenrt type
  - isProcessable
```
boolean isProcessable(EnrichmentContext enrichmentContext)
```
    Parameters:
    
    enrichmentContext - the current enrichment context
    
    Returns:
    
    true, if enrichment service is currently processable for given context
  - enrich
```
EnrichmentContext enrich(EnrichmentContext enrichmentContext,
                         boolean inPlace)
```
    Enrich the study element in the given enrichment context
    
    Parameters:
    
    enrichmentContext - the current enrichment context
    
    inPlace - true, in enrichment does not create a new context
    
    Returns:
    
    the updated enrichment context
  - getElementDeleteMarker
```
ElementDeleteMarker getElementDeleteMarker()
```
    Returns:
    
    the deletion marker for this enrichment service