AckJobSynchronisation
From
(Difference between revisions)
m |
|||
Line 1: | Line 1: | ||
− | |||
== Method == | == Method == | ||
− | + | [[AckJobSynchronisationResult]] ackJobSynchronisation([[UserIDBean]] userID, [[JobSynchronisationBean]][] jobs) | |
== Description == | == Description == | ||
− | + | Acknowleges the synchronization of the specified jobs. A record of the externalInterfaceID and the jobUpdateIndex is made for each job in the passed array. Future calls to [[getUnsynchronisedJobs]] will only return jobs that have never been acknowleged and those jobs who's update index differs from the update index passed in this method. | |
+ | |||
+ | Note that each synchronisation record will also contain an additional external reference field, and an external data field, to allow external system to easily maintain records with the syste,. | ||
== Parameters == | == Parameters == | ||
Line 16: | Line 17: | ||
|The admin username and password. | |The admin username and password. | ||
|---- bgcolor=#EDEDFF | |---- bgcolor=#EDEDFF | ||
− | |[[ | + | |[[JobSynchronisationBean]] |
− | | | + | |jobs |
− | | | + | |The data to be used to mark the specified jobs as (currently) synchronized. |
|} | |} | ||
== Return Value == | == Return Value == | ||
− | [[ | + | [[AckJobSynchronisationResult]] |
Revision as of 03:36, 1 June 2005
Contents |
Method
AckJobSynchronisationResult ackJobSynchronisation(UserIDBean userID, JobSynchronisationBean[] jobs)
Description
Acknowleges the synchronization of the specified jobs. A record of the externalInterfaceID and the jobUpdateIndex is made for each job in the passed array. Future calls to getUnsynchronisedJobs will only return jobs that have never been acknowleged and those jobs who's update index differs from the update index passed in this method.
Note that each synchronisation record will also contain an additional external reference field, and an external data field, to allow external system to easily maintain records with the syste,.
Parameters
Type | Name | Description |
---|---|---|
UserIDBean | userID | The admin username and password. |
JobSynchronisationBean | jobs | The data to be used to mark the specified jobs as (currently) synchronized. |