GetUnsynchronisedJobs
From
(Difference between revisions)
| Line 1: | Line 1: | ||
| − | |||
== Method == | == Method == | ||
| − | + | [[GetUnsynchronisedJobsResult]] getUnsynchronisedJobs([[UserIDBean]] userID, String synchronisationID, [[Calendar]] createdOnOrAfter) | |
== Description == | == Description == | ||
| − | + | Gets the list of jobs that have not been synchronised by the external system identified by synchronisationID. If an interface is uninterested in old jobs, the createdOnOrAfter parameter should be set, otherwise it should be left null. After a job is synchronised, [[ackJobSynchronisation]] should be called. | |
| + | |||
| + | There is a limit on the number of jobs that will be returned in one call, so the process of calling getUnsynchronisedJobs, perform external synchronize tasks, [[ackJobSynchronisation]] should be repeated until no more jobs are returned. | ||
== Parameters == | == Parameters == | ||
| Line 16: | Line 17: | ||
|The admin username and password. | |The admin username and password. | ||
|---- bgcolor=#EDEDFF | |---- bgcolor=#EDEDFF | ||
| − | |[[ | + | |String |
| − | | | + | |synchronisationID |
| − | | | + | |The string indicating the name of the "flag" to use to mark this record as synchronized. |
| + | |---- bgcolor=#EDEDFF | ||
| + | |[[Calendar]] | ||
| + | |createdOnOrAfter | ||
| + | |The earliest date and time in which the interface is interested in receiving jobs that have not been synchronised. | ||
|} | |} | ||
== Return Value == | == Return Value == | ||
| − | [[ | + | [[GetUnsynchronisedJobsResult]] |
Revision as of 02:26, 3 June 2005
Contents |
Method
GetUnsynchronisedJobsResult getUnsynchronisedJobs(UserIDBean userID, String synchronisationID, Calendar createdOnOrAfter)
Description
Gets the list of jobs that have not been synchronised by the external system identified by synchronisationID. If an interface is uninterested in old jobs, the createdOnOrAfter parameter should be set, otherwise it should be left null. After a job is synchronised, ackJobSynchronisation should be called.
There is a limit on the number of jobs that will be returned in one call, so the process of calling getUnsynchronisedJobs, perform external synchronize tasks, ackJobSynchronisation should be repeated until no more jobs are returned.
Parameters
| Type | Name | Description |
|---|---|---|
| UserIDBean | userID | The admin username and password. |
| String | synchronisationID | The string indicating the name of the "flag" to use to mark this record as synchronized. |
| Calendar | createdOnOrAfter | The earliest date and time in which the interface is interested in receiving jobs that have not been synchronised. |
