View Javadoc
1 /* ====================================================================
2 * License:
3 *
4 * Redistribution and use in source and binary forms, with or without
5 * modification, are permitted provided that the following conditions
6 * are met:
7 *
8 * 1. Redistributions of source code must retain the above copyright
9 * notice, this list of conditions and the following disclaimer.
10 *
11 * 2. Redistributions in binary form must reproduce the above copyright
12 * notice, this list of conditions and the following disclaimer in
13 * the documentation and/or other materials provided with the
14 * distribution.
15 *
16 * 3. The end-user documentation included with the redistribution,
17 * if any, must include the following acknowledgment:
18 * "This product includes software developed by
19 * Robert Half International (http://www.rhi.com/)."
20 * Alternately, this acknowledgment may appear in the software itself,
21 * if and wherever such third-party acknowledgments normally appear.
22 *
23 * 4. The names "Parc", "RHI", and "Robert Half International" must
24 * not be used to endorse or promote products derived from this
25 * software without prior written permission. For written
26 * permission, please contact pete.mckinstry@rhi.com.
27 *
28 * 5. Products derived from this software may not be called "PARC",
29 * nor may "PARC" appear in their name, without prior written
30 * permission of Robert Half International.
31 *
32 * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
33 * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
34 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
35 * DISCLAIMED. IN NO EVENT SHALL THE APACHE SOFTWARE FOUNDATION OR
36 * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
37 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
38 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
39 * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
40 * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
41 * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
42 * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
43 * SUCH DAMAGE.
44 * ====================================================================
45 *
46 */
47 package com.rhi.architecture.parc;
48
49 import java.util.List;
50
51 /***
52 * Record type used for data being passed through the Pipeline.
53 *
54 * @author Pete McKinstry
55 * @copyright 2002, Robert Half Int'l., Inc. All rights reserved.
56 *
57 * @since 1.0
58 */
59 public interface Record {
60
61 /***
62 * Return the source id of this record. This is used to track
63 * records through the system so that effective auditing can be
64 * done on records when they reach the end of the pipeline.
65 *
66 * @return Object - the key for the source record. It may be the
67 * actual source record itself.
68 *
69 * @since 1.0
70 */
71 public Object getSourceKey();
72
73 /***
74 * Is the Record valid. What isValid() really means, is up to
75 * the concrete record class. Normally, isValid() & isErrored()
76 * should return opposite values.
77 *
78 * @return boolean True/False
79 *
80 * @since 1.0
81 */
82 public boolean isValid();
83
84 /***
85 * Is the Record in an errored state. What isErrored()
86 * really means is up to the concrete record class. Normally
87 * isValid() and isErrored() should return opposite boolean
88 * values.
89 * <br/>
90 * If isErrored() returns true, the getErrors() method should
91 * return a List w/ size() > 1. If the error list is empty,
92 * isErrored should be false.
93 *
94 * @return boolean True/False
95 *
96 * @since 1.0
97 */
98 public boolean isErrored();
99
100 /***
101 * Return the list of errors attached to this record.
102 * Allows a cummulative process for attaching errors
103 * to the record where the first error in the list is
104 * the first error found during processing.
105 *
106 * @return List - the list of errors attached to this
107 * record.
108 *
109 * @since 1.0
110 */
111 public List getErrors();
112
113 /***
114 * Add error to this record.
115 *
116 * @param error msg
117 *
118 * @since 1.0
119 */
120 public void addError(Error error);
121
122 /***
123 * Return a String representation of this Record.
124 *
125 * @return boolean True/False
126 *
127 * @since 1.0
128 */
129 public String toString();
130
131 }
This page was automatically generated by Maven