|
Oracle Fusion Middleware Java API for Oracle WebLogic Portal 10g Release 3 (10.3.4) E14255-03 |
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface ISortablePagedList<T>
An IPagedList which can be sorted. This is an application of the com.bea.p13n.pagination.SortablePagedResult model to the IPagedList construct.
An overview of PagedList capabilities, including sorting and filtering, is provided
in the package documentation at com.bea.content.paging
Supports single-property sorting with a sort order and sort locale, plus queries to find the set of properties which can be used.
For example, you can construct a sort such as: 'name' property value ascending
Sortable properties can either be 'native' or 'non-native'. Native sortable properties will perform best.
Field Summary |
---|
Fields inherited from interface com.bea.content.paging.ContentListKeys |
---|
ALL_ITEMS, BATCH_LOADING_SIZE_KEY, CUSTOM_OBJECT_FILTER, CUSTOM_OBJECT_SORT, FILTER_CRITERIA_KEY, SORT_CRITERIA_KEY |
Method Summary | |
---|---|
Set<String> |
getAllSortableProperties()
Retrieve a list of all the possible properties which can be sorted on. |
Locale |
getCurrentSortLocale()
Retrieve the current locale (if any) used to sort. |
SortOrder |
getCurrentSortOrder()
Retrieve the current sort order (how the PagedList is currently ordered). |
String |
getCurrentSortProperty()
Retrieve the property we are currently sorting on. |
Set<String> |
getNativeSortableProperties()
Behaves the same as getAllSortableProperties(), except this method returns only high-performing (native) sort properties. |
void |
reSort(SortOrder sortOrder,
String sortByProperty,
Locale sortLocale)
Re-sort the results. |
Methods inherited from interface com.bea.content.paging.IPagedList |
---|
fullSize, getBatchLoadingSize, isFullyResolved, iterator, nativeSize, setBatchLoadingSize |
Method Detail |
---|
Set<String> getAllSortableProperties() throws RepositoryRuntimeException
Note: a special 'custom object sort' property as defined in ContentListKeys may be present in the returned values.
May NOT be null. If no properties are sortable, this method returns an empty set.
RepositoryRuntimeException
Set<String> getNativeSortableProperties() throws RepositoryRuntimeException
Note: a special 'custom object sort' property as defined in ContentListKeys may be present in the returned values.
RepositoryRuntimeException
SortOrder getCurrentSortOrder() throws RepositoryRuntimeException
RepositoryRuntimeException
String getCurrentSortProperty() throws RepositoryRuntimeException
Note: this method may return the special 'custom object sort' property as defined in ContentListKeys.
RepositoryRuntimeException
Locale getCurrentSortLocale() throws RepositoryRuntimeException
RepositoryRuntimeException
void reSort(SortOrder sortOrder, String sortByProperty, Locale sortLocale) throws UnsupportedOperationException, IllegalArgumentException, RepositoryRuntimeException
sortOrder
- the new order to use for sorting. Null is not allowed.sortByProperty
- the property of the result to use for sorting.
If sortOrder is UNSORTED, this property is probably ignored (and reSort is
not actually required to do anything at all). Must not be null or empty,
unless sortOrder is UNSORTED or the implementation chooses to ignore it.
Otherwise this must be one of the properties reported by getSortableProperties.
This can include the special 'custom object sort' property defined in
ContentListKeys.
sortLocale
- locale used to sort. Null implies that sorting should not
be based on Locale. Might be ignored if the bean or property being sorted
does not support locale-based sorting (i.e. the property is an Integer).
UnsupportedOperationException
- if the sort can not be performed on
the given property.
IllegalArgumentException
- if sortOrder is null, or if the sortProperty
is null or empty string when sortOrder is something other than UNSORTED.
RepositoryRuntimeException
|
Oracle Fusion Middleware Java API for Oracle WebLogic Portal 10g Release 3 (10.3.4) E14255-03 |
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |