eu.etaxonomy.cdm.api.service

Interface IWorkingSetService

All Superinterfaces:

IAnnotatableService<WorkingSet>, IService<WorkingSet>, IVersionableService<WorkingSet>

All Known Implementing Classes:

WorkingSetService

public interface IWorkingSetService
extends IAnnotatableService<WorkingSet>

Method Summary

Modifier and Type	Method and Description
java.util.Map<DescriptionBase,java.util.Set<DescriptionElementBase>>	getDescriptionElements(WorkingSet workingSet, java.util.Set<Feature> features, java.lang.Integer pageSize, java.lang.Integer pageNumber, java.util.List<java.lang.String> propertyPaths) Returns a Map of descriptions each with the descriptionelements that match the supplied features (or all description elements if no features are supplied)
<T extends DescriptionElementBase> java.util.Map<UuidAndTitleCache,java.util.Map<java.util.UUID,java.util.Set<T>>>	getTaxonFeatureDescriptionElementMap(java.lang.Class<T> clazz, java.util.UUID workingSetUuid, DescriptiveSystemRole role)
java.util.List<UuidAndTitleCache<WorkingSet>>	getWorkingSetUuidAndTitleCache(java.lang.Integer limitOfInitialElements, java.lang.String pattern)

Methods inherited from interface eu.etaxonomy.cdm.api.service.IAnnotatableService

countMarkers, getAnnotations, getMarkers, groupMarkers

Methods inherited from interface eu.etaxonomy.cdm.api.service.IVersionableService

getNextAuditEvent, getPreviousAuditEvent, isDeletable, pageAuditEvents, pageAuditEvents

Methods inherited from interface eu.etaxonomy.cdm.api.service.IService

clear, count, delete, delete, delete, exists, find, find, find, findById, findWithoutFlush, getSession, group, list, list, load, load, load, load, loadByIds, loadWithUpdate, lock, merge, merge, merge, merge, page, refresh, refresh, rows, save, save, saveOrUpdate, saveOrUpdate, update

Method Detail

getDescriptionElements

java.util.Map<DescriptionBase,java.util.Set<DescriptionElementBase>> getDescriptionElements(WorkingSet workingSet,
                                                                                            java.util.Set<Feature> features,
                                                                                            java.lang.Integer pageSize,
                                                                                            java.lang.Integer pageNumber,
                                                                                            java.util.List<java.lang.String> propertyPaths)

Returns a Map of descriptions each with the descriptionelements that match the supplied features (or all description elements if no features are supplied)

Parameters:

workingSet - the working set which the descriptions belong to

features - restrict the returned description elements to those which have features in this set

pageSize - The maximum number of descriptions returned (can be null for all descriptions that belong to the working set)

pageNumber - The offset (in pageSize chunks) from the start of the result set (0 - based, can be null, equivalent of starting at the beginning of the recordset). Descriptions are sorted by titleCache

propertyPaths - properties to be initialized (applied to the descriptionElements)

Returns:

getTaxonFeatureDescriptionElementMap

<T extends DescriptionElementBase> java.util.Map<UuidAndTitleCache,java.util.Map<java.util.UUID,java.util.Set<T>>> getTaxonFeatureDescriptionElementMap(java.lang.Class<T> clazz,
                                                                                                                                                        java.util.UUID workingSetUuid,
                                                                                                                                                        DescriptiveSystemRole role)

getWorkingSetUuidAndTitleCache

java.util.List<UuidAndTitleCache<WorkingSet>> getWorkingSetUuidAndTitleCache(java.lang.Integer limitOfInitialElements,
                                                                             java.lang.String pattern)

Parameters:

limitOfInitialElements -

pattern -

Returns: