IBM WebSphereTM eXtreme Scale, Release 8.6
API Specification

com.ibm.websphere.projector.annotations
Annotation Type OrderBy


@Target(value={FIELD,METHOD})
@Retention(value=RUNTIME)
public @interface OrderBy

Specifies the ordering of the elements of a collection valued association at the point when the association is retrieved.

The syntax of the value ordering element is an orderby_list, as follows:

 orderby_list::= orderby_item [,orderby_item]*
 orderby_item::= property_or_field_name [ASC | DESC]
 

If ASC or DESC is not specified, ASC (ascending order) is assumed.

If the ordering element is not specified, ordering by the primary key of the associated entity is assumed. The property or field name must correspond to that of a persistent property or field of the associated class. The properties or fields used in the ordering must correspond to columns for which comparison operators are supported.

Since:
WAS XD 6.1

Optional Element Summary
 String value
          The ordering element string.
 

value

public abstract String value
The ordering element string. Example:
 "salary DESC, dept ASC"
 

Returns:
the ordering element string.
Default:
""

IBM WebSphereTM eXtreme Scale, Release 8.6
API Specification

© Copyright International Business Machines Corp 2005,2012. All rights reserved.