|
Primavera Integration API 7.0 | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.primavera.integration.client.BOIteratorBase
com.primavera.integration.client.bo.BOIterator<T>
T
- Any business object typepublic class BOIterator<T extends BusinessObject>
An iterator over a business object collection. Loading multiple business objects always returns a BOIterator.
Not all business objects are necessarily loaded at one time. When many business objects are requested, the results are loaded from the server in subsets. Calling next() will therefore occasionally result in additional calls to the server when larger sets are requested.
Constructor Summary | |
---|---|
BOIterator(Session session,
com.primavera.bo.defs.BusinessObjectDef boDef,
com.primavera.infr.db.PrmRowSet rowSet,
com.primavera.bo.base.RemoteTXId txId)
Class constructor used for when an empty BOIterator is needed. |
|
BOIterator(Session session,
com.primavera.bo.defs.BusinessObjectDef boDef,
com.primavera.infr.db.PrmRowSet rowSet,
java.lang.String[] aIntgFieldName,
ObjectId[] objIds,
int iPageSize,
com.primavera.bo.common.PRequestOptions opts,
com.primavera.bo.base.RemoteTXId txId)
Class constructor used when loading by ObjectId. |
|
BOIterator(Session session,
com.primavera.bo.defs.BusinessObjectDef boDef,
com.primavera.infr.db.PrmRowSet rowSet,
java.lang.String[] aIntgFieldName,
java.lang.String sWhereClause,
java.lang.String sOrderBy,
com.primavera.bo.common.PRequestOptions opts,
com.primavera.bo.base.RemoteTXId txId)
Class constructor used when loading with where clause and order by clause. |
Method Summary | |
---|---|
T[] |
getAll()
Gets all business objects from loads that are known to have small result sets. |
int |
getCount()
Deprecated. As of release 6.0, use hasNext() and next() and iterate over the entire collection to determine the count. |
int |
getPageSize()
Returns the page size in use. |
boolean |
hasNext()
Indicates if the iterator has more elements. |
T |
next()
Gets the next business object in the iteration. |
void |
remove()
This method is not supported. |
Methods inherited from class java.lang.Object |
---|
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public BOIterator(Session session, com.primavera.bo.defs.BusinessObjectDef boDef, com.primavera.infr.db.PrmRowSet rowSet, com.primavera.bo.base.RemoteTXId txId) throws BusinessObjectException
session
- session objectboDef
- business object definitionrowSet
- row set returned from the first load
BusinessObjectException
java.lang.IllegalArgumentException
- if the input parameter is null or invalidpublic BOIterator(Session session, com.primavera.bo.defs.BusinessObjectDef boDef, com.primavera.infr.db.PrmRowSet rowSet, java.lang.String[] aIntgFieldName, java.lang.String sWhereClause, java.lang.String sOrderBy, com.primavera.bo.common.PRequestOptions opts, com.primavera.bo.base.RemoteTXId txId) throws BusinessObjectException
session
- session objectboDef
- business object definitionrowSet
- row set returned from the first loadaIntgFieldName
- array of field namessWhereClause
- where clausesOrderBy
- order byopts
- request options
BusinessObjectException
java.lang.IllegalArgumentException
- if the input parameter is null or invalidpublic BOIterator(Session session, com.primavera.bo.defs.BusinessObjectDef boDef, com.primavera.infr.db.PrmRowSet rowSet, java.lang.String[] aIntgFieldName, ObjectId[] objIds, int iPageSize, com.primavera.bo.common.PRequestOptions opts, com.primavera.bo.base.RemoteTXId txId) throws BusinessObjectException
session
- session objectboDef
- business object definitionrowSet
- row set returned from the first loadaIntgFieldName
- array of field namesobjIds
- array of ObjectIdiPageSize
- page sizeopts
- request options
BusinessObjectException
java.lang.IllegalArgumentException
- if the input parameter is null or invalidMethod Detail |
---|
public int getPageSize()
public boolean hasNext()
hasNext
in interface java.util.Iterator<T extends BusinessObject>
public T next()
next
in interface java.util.Iterator<T extends BusinessObject>
public T[] getAll() throws ServerException, NetworkException, BusinessObjectException
ServerException
- if a problem occurred on the server-side
NetworkException
- if a problem occurred in the network layer
BusinessObjectException
- if a problem occurred in the client-side business objects@Deprecated public int getCount()
public void remove()
remove
in interface java.util.Iterator<T extends BusinessObject>
|
Primavera Integration API 7.0 | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |