Project

General

Profile

Revision 4a93959c

ID4a93959c5f03c5bbc5ca2ff4a4c76e9df7d14e43
Parent cfbac3ec
Child 5d585cce

Added by Andreas Kohlbecker over 2 years ago

java doc and formatting

View differences:

cdmlib-services/src/main/java/eu/etaxonomy/cdm/api/service/IRegistrationService.java
27 27
public interface IRegistrationService extends IAnnotatableService<Registration> {
28 28

  
29 29
    /**
30
     * Returns a sublist of Registration instances stored in the database. A maximum
31
     * of 'limit' objects are returned, starting at object with index 'start'.
32
     * The bean properties specified by the parameter <code>propertyPaths</code>
33
     * and recursively initialized for each of the entities in the resultset
30
     * Returns a sublist of Registration instances stored in the database. A
31
     * maximum of 'limit' objects are returned, starting at object with index
32
     * 'start'. The bean properties specified by the parameter
33
     * <code>propertyPaths</code> and recursively initialized for each of the
34
     * entities in the resultset
34 35
     *
35 36
     * For detailed description and examples regarding
36 37
     * <code>propertyPaths</code> <b>please refer to:</b>
37 38
     * {@link IBeanInitializer#initialize(Object, List)}
38 39
     *
39
     * @param pageSize The maximum number of objects returned (can be null for all matching objects)
40
     * @param pageNumber The offset (in pageSize chunks) from the start of the result set (0 - based,
41
     *                   can be null, equivalent of starting at the beginning of the recordset)
40
     * @param pageSize
41
     *            The maximum number of objects returned (can be null for all
42
     *            matching objects)
43
     * @param pageNumber
44
     *            The offset (in pageSize chunks) from the start of the result
45
     *            set (0 - based, can be null, equivalent of starting at the
46
     *            beginning of the recordset)
42 47
     * @param reference
43
     *            filters the Registration by the reference of the nomenclatural act for which the
44
     *            Registration as been created. The name and all type designations associated with
45
     *            the Registration are sharing the same  citation.
46
     *            If the Optional itself is <code>null</code> the parameter is neglected.
47
     *            If Optional contains the value <code>null</code> all registrations with a name
48
     *            or type designation that has no reference are returned.
49
     *            Also those registrations having no name and type designation at all.
48
     *            filters the Registration by the reference of the nomenclatural
49
     *            act for which the Registration as been created. The name and
50
     *            all type designations associated with the Registration are
51
     *            sharing the same citation. If the Optional itself is
52
     *            <code>null</code> the parameter is neglected. If Optional
53
     *            contains the value <code>null</code> all registrations with a
54
     *            name or type designation that has no reference are returned.
55
     *            Also those registrations having no name and type designation
56
     *            at all.
50 57
     * @param includedStatus
51
     *            filters the Registration by the RegistrationStatus. Only Registration having one of the
52
     *            supplied status will included.
53
//     * @param orderHints
54
//     *            Supports path like <code>orderHints.propertyNames</code> which
55
//     *            include *-to-one properties like createdBy.username or
56
//     *            authorTeam.persistentTitleCache
58
     *            filters the Registration by the RegistrationStatus. Only
59
     *            Registration having one of the supplied status will included.
60
     *            // * @param orderHints // * Supports path like
61
     *            <code>orderHints.propertyNames</code> which // * include
62
     *            *-to-one properties like createdBy.username or // *
63
     *            authorTeam.persistentTitleCache
57 64
     * @param propertyPaths
58 65
     * @return
59 66
     * @throws DataAccessException
......
62 69
            Integer pageSize, Integer pageIndex, List<String> propertyPaths);
63 70

  
64 71
    /**
65
     * Returns a sublist of Registration instances stored in the database. A maximum
66
     * of 'limit' objects are returned, starting at object with index 'start'.
67
     * The bean properties specified by the parameter <code>propertyPaths</code>
68
     * and recursively initialized for each of the entities in the resultset
72
     * Returns a sublist of Registration instances stored in the database. A
73
     * maximum of 'limit' objects are returned, starting at object with index
74
     * 'start'. The bean properties specified by the parameter
75
     * <code>propertyPaths</code> and recursively initialized for each of the
76
     * entities in the resultset
69 77
     *
70 78
     * For detailed description and examples regarding
71 79
     * <code>propertyPaths</code> <b>please refer to:</b>
72 80
     * {@link IBeanInitializer#initialize(Object, List)}
73 81
     *
74
     * @param pageSize The maximum number of objects returned (can be null for all matching objects)
75
     * @param pageNumber The offset (in pageSize chunks) from the start of the result set (0 - based,
76
     *                   can be null, equivalent of starting at the beginning of the recordset)
77 82
     * @param submitter
78
     *            Limits the result set to Registrations having the given submitter. This filter is ignored if set to <code>null</code>.
83
     *            Limits the result set to Registrations having the given
84
     *            submitter. This filter is ignored if set to <code>null</code>.
79 85
     * @param includedStatus
80
     *            filters the Registration by the RegistrationStatus. Only Registration having one of
81
     *            the supplied status will included.
86
     *            filters the Registration by the RegistrationStatus. Only
87
     *            Registration having one of the supplied status will included.
88
     * @param identifierFilterPattern
89
     *            filters the Registration by this pattern, The asterisk can be used
90
     *            * as wildcard in any position of the pattern string
91
     * @param taxonNameFilterPattern
92
     *            filters the registered taxon name by this pattern, The asterisk can be used
93
     *            * as wildcard in any position of the pattern string
94
     * @param pageSize
95
     *            The maximum number of objects returned (can be null for all
96
     *            matching objects)
97
     * @param pageNumber
98
     *            The offset (in pageSize chunks) from the start of the result
99
     *            set (0 - based, can be null, equivalent of starting at the
100
     *            beginning of the recordset)
82 101
     * @param orderHints
83 102
     *            Supports path like <code>orderHints.propertyNames</code> which
84 103
     *            include *-to-one properties like createdBy.username or
......
88 107
     * @throws DataAccessException
89 108
     */
90 109
    public Pager<Registration> page(User submitter, Collection<RegistrationStatus> includedStatus,
91
            String identifierFilterPattern, String taxonNameFilterPattern,
92
            Integer pageSize, Integer pageIndex, List<OrderHint> orderHints, List<String> propertyPaths);
93

  
94

  
110
            String identifierFilterPattern, String taxonNameFilterPattern, Integer pageSize, Integer pageIndex,
111
            List<OrderHint> orderHints, List<String> propertyPaths);
95 112

  
96 113
}

Also available in: Unified diff

Add picture from clipboard (Maximum size: 40 MB)