01: // THIS SOFTWARE IS PROVIDED BY SOFTARIS PTY.LTD. AND OTHER METABOSS
02: // CONTRIBUTORS ``AS IS'' AND ANY EXPRESSED OR IMPLIED WARRANTIES, INCLUDING,
03: // BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
04: // FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL SOFTARIS PTY.LTD.
05: // OR OTHER METABOSS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
06: // INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
07: // LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA,
08: // OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
09: // LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
10: // NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE,
11: // EVEN IF SOFTARIS PTY.LTD. OR OTHER METABOSS CONTRIBUTORS ARE ADVISED OF THE
12: // POSSIBILITY OF SUCH DAMAGE.
13: //
14: // Copyright 2000-2005 © Softaris Pty.Ltd. All Rights Reserved.
15: package com.metaboss.enterprise.ps;
16:
17: import java.io.Serializable;
18:
19: /** This structure contains the details of the single ordering instruction.
20: * It (or more precisely array of these) is passed to a storage record retrieval methods,
21: * like getAll(). Passing it is in effect adds ordering instruction to the retrieval request.
22: * Note that the ordering attribute is identified by the model ref,
23: * so underlying storage implementation needs to use addtional entity metadata
24: * (either at generation time or at run time or both).
25: */
26: public final class STOrderingDetails implements Serializable {
27: /** Describes ascending ordering direction */
28: public final static String DIRECTION_ASCENDING = "Ascending";
29:
30: /** Describes descending ordering direction */
31: public final static String DIRECTION_DESCENDING = "Descending";
32:
33: /** Model reference of the attribute, which we are ordering by. */
34: public String ByAttributeRef;
35:
36: /** Mandatory direction instruction. */
37: public String Direction;
38:
39: /** Default constructor */
40: public STOrderingDetails() {
41: // Set all field values to null
42: ByAttributeRef = null;
43: Direction = null;
44: }
45: }
|