GetJobsBySynchronisation
From
(Difference between revisions)
(added information about scrolling through a large result) |
|||
| (12 intermediate revisions by one user not shown) | |||
| Line 1: | Line 1: | ||
== Method == | == Method == | ||
| − | [[ | + | [[GetJobsBySynchronisationResult]] getJobsBySynchronisation([[UserIDBean]] userID, String synchronisationID, String synchronisationReference, String afterPK) |
== Description == | == Description == | ||
| − | + | Retrieve the job(s), referenced by the ID of the job(s) in the external application data to which they are synchronised to, from the job synchronisation table. If the afterPK parameter is not null, the job record(s) retrieved must have a PK greater than that value. The number of objects returned by a single call is limited, to aquire a complete list, this method should be called repeatedly with the afterPK parameter set to the primary key of the last element in the result of the previous call, until an empty result is returned. | |
| − | If the | + | |
== Parameters == | == Parameters == | ||
| Line 18: | Line 17: | ||
|String | |String | ||
|synchronisationID | |synchronisationID | ||
| − | |The ID of the organisation to which the | + | |The ID of the organisation to which the job record(s) have been synchronised to. It is usually the name of the organisation. |
|---- bgcolor=#EDEDFF | |---- bgcolor=#EDEDFF | ||
|String | |String | ||
|synchronisationReference | |synchronisationReference | ||
| − | |The ID of the | + | |The ID of the job record (that has been synchronised) in the external record. |
|---- bgcolor=#EDEDFF | |---- bgcolor=#EDEDFF | ||
|String | |String | ||
|afterPK | |afterPK | ||
| − | |The lower bound of the PK of the | + | |The lower bound of the PK of the job record(s) that can be retrieved. |
|} | |} | ||
== Return Value == | == Return Value == | ||
| − | [[ | + | [[GetJobsBySynchronisationResult ]] |
Latest revision as of 23:22, 14 February 2006
Contents |
[edit] Method
GetJobsBySynchronisationResult getJobsBySynchronisation(UserIDBean userID, String synchronisationID, String synchronisationReference, String afterPK)
[edit] Description
Retrieve the job(s), referenced by the ID of the job(s) in the external application data to which they are synchronised to, from the job synchronisation table. If the afterPK parameter is not null, the job record(s) retrieved must have a PK greater than that value. The number of objects returned by a single call is limited, to aquire a complete list, this method should be called repeatedly with the afterPK parameter set to the primary key of the last element in the result of the previous call, until an empty result is returned.
[edit] Parameters
| Type | Name | Description |
|---|---|---|
| UserIDBean | userID | The admin username and password. |
| String | synchronisationID | The ID of the organisation to which the job record(s) have been synchronised to. It is usually the name of the organisation. |
| String | synchronisationReference | The ID of the job record (that has been synchronised) in the external record. |
| String | afterPK | The lower bound of the PK of the job record(s) that can be retrieved. |
