|
1
|
/**
|
|
2
|
* Copyright (C) 2015 EDIT
|
|
3
|
* European Distributed Institute of Taxonomy
|
|
4
|
* http://www.e-taxonomy.eu
|
|
5
|
*
|
|
6
|
* The contents of this file are subject to the Mozilla Public License Version 1.1
|
|
7
|
* See LICENSE.TXT at the top of this package for the full license terms.
|
|
8
|
*/
|
|
9
|
package eu.etaxonomy.cdm.api.service.config;
|
|
10
|
|
|
11
|
import java.util.UUID;
|
|
12
|
|
|
13
|
import eu.etaxonomy.cdm.model.occurrence.SpecimenOrObservationBase;
|
|
14
|
import eu.etaxonomy.cdm.model.occurrence.SpecimenOrObservationType;
|
|
15
|
|
|
16
|
/**
|
|
17
|
* @author pplitzner
|
|
18
|
* @date Apr 13, 2015
|
|
19
|
*
|
|
20
|
*/
|
|
21
|
public class FindOccurrencesConfigurator extends IdentifiableServiceConfiguratorImpl<SpecimenOrObservationBase>{
|
|
22
|
|
|
23
|
private static final long serialVersionUID = 1L;
|
|
24
|
|
|
25
|
private SpecimenOrObservationType specimenType;
|
|
26
|
private UUID associatedTaxonUuid;
|
|
27
|
private UUID associatedTaxonNameUuid;
|
|
28
|
private String significantIdentifier;
|
|
29
|
private boolean retrieveIndirectlyAssociatedSpecimens;
|
|
30
|
public static enum AssignmentStatus{
|
|
31
|
ALL_SPECIMENS,
|
|
32
|
ASSIGNED_SPECIMENS,
|
|
33
|
UNASSIGNED_SPECIMENS
|
|
34
|
}
|
|
35
|
private AssignmentStatus assignmentStatus = AssignmentStatus.ALL_SPECIMENS;
|
|
36
|
|
|
37
|
/**
|
|
38
|
* Enum to indicate if the retrieved specimens are associated to a taxon. Default is <code>ALL_SPECIMEN</code>.<br>
|
|
39
|
* <br>
|
|
40
|
* <b>Note:</b>This status is <b>ignored</b> if the configurator has either a name
|
|
41
|
* or a taxon set via {@link #setAssociatedTaxonNameUuid(UUID)} or
|
|
42
|
* {@link #setAssociatedTaxonUuid(UUID)}
|
|
43
|
*
|
|
44
|
* @param associatedWithTaxon
|
|
45
|
*/
|
|
46
|
|
|
47
|
public void setAssignmentStatus(AssignmentStatus assignmentStatus) {
|
|
48
|
this.assignmentStatus = assignmentStatus;
|
|
49
|
}
|
|
50
|
public AssignmentStatus getAssignmentStatus() {
|
|
51
|
return assignmentStatus;
|
|
52
|
}
|
|
53
|
|
|
54
|
public String getSignificantIdentifier() {
|
|
55
|
return significantIdentifier;
|
|
56
|
}
|
|
57
|
public void setSignificantIdentifier(String significantIdentifier) {
|
|
58
|
this.significantIdentifier = significantIdentifier;
|
|
59
|
}
|
|
60
|
public SpecimenOrObservationType getSpecimenType() {
|
|
61
|
return specimenType;
|
|
62
|
}
|
|
63
|
public void setSpecimenType(SpecimenOrObservationType specimenType) {
|
|
64
|
this.specimenType = specimenType;
|
|
65
|
}
|
|
66
|
public UUID getAssociatedTaxonUuid() {
|
|
67
|
return associatedTaxonUuid;
|
|
68
|
}
|
|
69
|
public void setAssociatedTaxonUuid(UUID associatedTaxonUuid) {
|
|
70
|
this.associatedTaxonUuid = associatedTaxonUuid;
|
|
71
|
}
|
|
72
|
public UUID getAssociatedTaxonNameUuid() {
|
|
73
|
return associatedTaxonNameUuid;
|
|
74
|
}
|
|
75
|
public void setAssociatedTaxonNameUuid(UUID associatedTaxonNameUuid) {
|
|
76
|
this.associatedTaxonNameUuid = associatedTaxonNameUuid;
|
|
77
|
}
|
|
78
|
|
|
79
|
/**
|
|
80
|
* if set to <code>true</code> the complete derivative hierarchy including
|
|
81
|
* all parent and child derivatives is returned of the associated specimen
|
|
82
|
* is retrieved
|
|
83
|
*
|
|
84
|
* @return the value of this flag
|
|
85
|
*/
|
|
86
|
public boolean isRetrieveIndirectlyAssociatedSpecimens() {
|
|
87
|
return retrieveIndirectlyAssociatedSpecimens;
|
|
88
|
}
|
|
89
|
/**
|
|
90
|
* if set to <code>true</code> the complete derivative hierarchy including
|
|
91
|
* all parent and child derivatives is returned of the associated specimen
|
|
92
|
* is retrieved
|
|
93
|
*
|
|
94
|
* @param retrieveIndirectlyAssociatedSpecimens the value of this flag
|
|
95
|
*/
|
|
96
|
public void setRetrieveIndirectlyAssociatedSpecimens(boolean retrieveIndirectlyAssociatedSpecimens) {
|
|
97
|
this.retrieveIndirectlyAssociatedSpecimens = retrieveIndirectlyAssociatedSpecimens;
|
|
98
|
}
|
|
99
|
|
|
100
|
}
|