|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface SyndicationResult
The SyndicationResult
class contains the results of a particular
syndication event at the time it was generated. It is a container which
holds information regarding the items that were modified, updated, removed
or created.
For example:
Update Summary: | |
37 total updates sent | getTotalUpdatesSent() |
37 updates succeeded | getTotalUpdatesSucceeded() |
0 updates failed | getTotalUpdatesFailed() |
Update Details : | |
35 item updates attempted | getTotalUpdatesAttempted() |
33 items did not require updating | getItemsNotRequiringUpdates() |
1 items created | getItemsCreated() |
1 items updated | getItemsUpdated() |
0 updates failed | getItemUpdatesFailed() |
2 item removals attempted | getTotalRemovesAttempted() |
0 items were already removed | getItemsAlreadyRemoved() |
2 items removed | getItemsRemoved() |
0 item failed to be removed | getItemsFailedToRemove() |
Method Summary | |
---|---|
int |
getItemsAlreadyRemoved()
Returns the total number of items that were to be removed, but did not exist on the subscriber. |
int |
getItemsCreated()
Returns the total number of items that were created by the update. |
int |
getItemsFailedToRemove()
Returns the total number of items for which the remove failed. |
int |
getItemsNotRequiringUpdates()
Returns the total number of updates that were sent, but not processed because the item was already up to date on the subscriber. |
int |
getItemsRemoved()
Returns the number of items successfully removed on the subscriber. |
int |
getItemsUpdated()
Returns the total number of item updates to pre-existing items on the subscriber. |
int |
getItemUpdatesFailed()
Returns the total number of items for which the update failed. |
int |
getTotalRemovesAttempted()
Returns the total number of items that were marked for removal. |
int |
getTotalUpdatesAttempted()
Returns the total number of updates attempted. |
int |
getTotalUpdatesFailed()
Returns the total number of modifications that failed. |
int |
getTotalUpdatesSent()
Returns the total number of items that was sent in this syndication run. |
int |
getTotalUpdatesSucceeded()
Returns the total number of modifications that succeeded. |
Method Detail |
---|
int getTotalUpdatesSent()
int getTotalUpdatesSucceeded()
int getTotalUpdatesFailed()
int getTotalUpdatesAttempted()
int getItemsNotRequiringUpdates()
int getItemsCreated()
int getItemsUpdated()
int getItemUpdatesFailed()
int getTotalRemovesAttempted()
int getItemsAlreadyRemoved()
int getItemsRemoved()
int getItemsFailedToRemove()
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |