com.webmethods.portal.service.view
Interface IListView

All Superinterfaces:

Collection, Iterable, List, Serializable

public interface IListView
extends List, Serializable

Base interface for a paged list view. Modifications are not persistant: modifing a list view or its contents does not modify the underlying resource(s). Instances can contain only IViews.

Method Summary

IPagingCookie	getCookie() Gets the paging cookie associated with this list.
void	setCookie(IPagingCookie cookie) Sets the paging cookie associated with this list.
void	sort() Sorts objects in this view according to paging cookie sort order.
void	sort(Comparator comp) Sorts the list using the given Comparator.

Methods inherited from interface java.util.List

add, add, addAll, addAll, clear, contains, containsAll, equals, get, hashCode, indexOf, isEmpty, iterator, lastIndexOf, listIterator, listIterator, remove, remove, removeAll, retainAll, set, size, subList, toArray, toArray

Method Detail

getCookie

IPagingCookie getCookie()

Gets the paging cookie associated with this list.

Returns:

Paging cookie associated with this list or null.

setCookie

void setCookie(IPagingCookie cookie)

Sets the paging cookie associated with this list.

Parameters:

cookie - Cookie to associate with this list. May be null.

sort

void sort(Comparator comp)
          throws PortalException

Sorts the list using the given Comparator.

Parameters:

comp - Comparator to use when sorting the list.

Throws:

PortalException - if an error occured while sorting.

sort

void sort()
          throws PortalException

Sorts objects in this view according to paging cookie sort order. Important: IView property to be sorted should implement Comparable

Throws:

PortalException