nsITransactionList

by 2 contributors:

Please add a summary to this article.
Inherits from: nsISupports Last changed in Gecko 1.7

Method overview

nsITransactionList getChildListForItem(in long aIndex);
nsITransaction getItem(in long aIndex);
long getNumChildrenForItem(in long aIndex);
boolean itemIsBatch(in long aIndex);

Attributes

Attribute Type Description
numItems long The number of transactions contained in this list. Read only.

Methods

getChildListForItem()

Returns the list of children associated with the item at aIndex. Implementations may return null if there are no children, or an empty list. The list returned is AddRef'd so it is up to the caller to Release the transaction when it is done.

nsITransactionList getChildListForItem(
  in long aIndex
);
Parameters
aIndex
The index of the item in the list.
Return value

The nsITransactionList of children associated with the item at aIndex.

getItem()

Returns the transaction at the given index in the list. Note that a null can be returned here if the item is a batch. The transaction returned is AddRef'd so it is up to the caller to Release the transaction when it is done.

nsITransaction getItem(
  in long aIndex
);
Parameters
aIndex
The index of the item in the list.
Return value

Missing Description

getNumChildrenForItem()

Returns the number of child (auto-aggreated) transactions the item at aIndex has.

long getNumChildrenForItem(
  in long aIndex
);
Parameters
aIndex
The index of the item in the list.
Return value

The number of child (auto-aggreated) transactions the item at aIndex has.

itemIsBatch()

Returns true if the item at aIndex is a batch. Note that currently there is no requirement for a TransactionManager implementation to associate a toplevel nsITransaction with a batch so it is possible for itemIsBatch to return true and getItem() to return null. However, you can still access the transactions contained in the batch with a call to getChildListForItem().

boolean itemIsBatch(
  in long aIndex
);
Parameters
aIndex
The index of the item in the list.
Return value

true if the item at aIndex is a batch.

See also

Document Tags and Contributors

Contributors to this page: Sheppy, trevorh
Last updated by: Sheppy,