AckJobSynchronisation

From
(Difference between revisions)
Jump to: navigation, search
m
 
m (Reverted edits by TreltTacar (Talk) to last version by Tristan)
 
(122 intermediate revisions by 2 users not shown)
Line 1: Line 1:
******************Basic template for method description********************
 
 
== Method ==
 
== Method ==
Method
+
[[AckJobSynchronisationResult]] ackJobSynchronisation([[UserIDBean]] userID, [[JobSynchronisationBean]][] jobs)
  
 
== Description ==
 
== 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
|[[Type]]
+
|[[JobSynchronisationBean]]
|Name
+
|jobs
|Description.
+
|The data to be used to mark the specified jobs as (currently) synchronized.
 
|}
 
|}
  
 
== Return Value ==
 
== Return Value ==
[[ReturnValue]]
+
[[AckJobSynchronisationResult]]

Latest revision as of 04:25, 30 July 2009

Contents

[edit] Method

AckJobSynchronisationResult ackJobSynchronisation(UserIDBean userID, JobSynchronisationBean[] jobs)

[edit] 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,.

[edit] 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.

[edit] Return Value

AckJobSynchronisationResult

MediaWiki Appliance - Powered by TurnKey Linux