com.wewebu.ow.server.ecm

Interface OwObjectCollection

All Superinterfaces:

Collection, Iterable, List, OwAttributeBag

All Known Implementing Classes:

OwIterableObjectCollectionConverter, OwObjectCollectionDelegator, OwQueriedCollection, OwStandardObjectCollection

public interface OwObjectCollection
extends List, OwAttributeBag

Base interface for object class descriptions. Interface for objects lists from the network. Implements the SUN value list pattern.

To be implemented with the specific ECM system.

Alfresco Workdesk
Copyright (c) Alfresco Software, Inc.
All rights reserved.

For licensing information read the license.txt file or
go to: http://wiki.alfresco.com

Field Summary

Fields

Modifier and Type	Field and Description
static String	ATTRIBUTE_IS_COMPLETE predefined attribute for attribute bag in object list
static String	ATTRIBUTE_SIZE predefined attribute for attribute bag in object list
static String	ATTRIBUTE_SQL predefined attribute for attribute bag in object list returns the SQL statement used to generate the list !!! FOR DEBUGGING ONLY !!!

Method Summary

Methods

Modifier and Type	Method and Description
void	getNext() retrieve further objects, than currently added.
void	getPrev() retrieve further objects, than currently added.
boolean	hasNext() check if object list has access to more next objects, than currently added.
boolean	hasPrev() check if object list has access to more previous objects, than currently added.
boolean	isComplete() check if object list has retrieved all objects If false, there are more objects available, but it is not guaranteed that you can retrieve them with the next / prev functions.
void	sort(OwSort sortCriteria_p) sort the list by the given criteria.

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

Methods inherited from interface com.wewebu.ow.server.util.OwAttributeBag

attributecount, getAttribute, getAttribute, getAttributeNames, getSafeAttribute, hasAttribute

Field Detail

ATTRIBUTE_SIZE

static final String ATTRIBUTE_SIZE

predefined attribute for attribute bag in object list

See Also:

Constant Field Values

ATTRIBUTE_IS_COMPLETE

static final String ATTRIBUTE_IS_COMPLETE

predefined attribute for attribute bag in object list

See Also:

Constant Field Values

ATTRIBUTE_SQL

static final String ATTRIBUTE_SQL

predefined attribute for attribute bag in object list returns the SQL statement used to generate the list !!! FOR DEBUGGING ONLY !!!

See Also:

Constant Field Values

Method Detail

isComplete

boolean isComplete()
                   throws Exception

check if object list has retrieved all objects If false, there are more objects available, but it is not guaranteed that you can retrieve them with the next / prev functions. I.e. hasNext / Prev might still return false.

Returns:

boolean true = all available objects have been added to the list

Throws:

Exception

hasNext

boolean hasNext()
                throws Exception

check if object list has access to more next objects, than currently added. I.e. if it could do another SQL Query and obtain more objects from the ECM System.

Returns:

boolean true = there are more objects available, call getNext() to retrieve additional objects.

Throws:

Exception

hasPrev

boolean hasPrev()
                throws Exception

check if object list has access to more previous objects, than currently added. I.e. if it could do another SQL Query and obtain more objects from the ECM System.

Returns:

boolean true = there are more objects available, call getPrev() to retrieve additional objects.

Throws:

Exception

getNext

void getNext()
             throws Exception

retrieve further objects, than currently added. I.e. submit another SQL Query and obtain more objects from the ECM System. NOTE: The retrieved objects will replace the current objects in the list

Throws:

Exception

getPrev

void getPrev()
             throws Exception

retrieve further objects, than currently added. I.e. submit another SQL Query and obtain more objects from the ECM System. NOTE: The retrieved objects will replace the current objects in the list

Throws:

Exception

sort

void sort(OwSort sortCriteria_p)
          throws Exception

sort the list by the given criteria. The default implementation sorts on the cached objects in the application server. The function may be overloaded to sort by the ECM System with SQL sort statements.

Parameters:

sortCriteria_p - list of sort criteria

Throws:

Exception