All Classes Namespaces Functions Properties Pages
Public Member Functions | List of all members
ChecklistService Class Reference

Provides methods to work with checklist variables. Currently only the ReviewChecklistVariables method is exposed. More...

Public Member Functions

void ReviewChecklistVariables (string sessionId, JobIdentity jobIdentity, VariableIdentityCollection checklistVariables)
 Review checklist variables. This entails setting the state of the specified variables to ready for review. More...
 

Description

Provides methods to work with checklist variables. Currently only the ReviewChecklistVariables method is exposed.

Member Functions

void ReviewChecklistVariables ( string  sessionId,
JobIdentity  jobIdentity,
VariableIdentityCollection  checklistVariables 
)

Review checklist variables. This entails setting the state of the specified variables to ready for review.

Parameters
sessionIdA string that uniquely identifies the Session for the current logged on user. If the SessionId is invalid then an exception will be raised.
jobIdentityA JobIdentity identity object that is used to identify the job whose checklist variables are to be reviewed. Cannot be null
Name Type Comment Required
Id String The job id Yes
checklistVariablesA VariableIdentityCollection collection of VariableIdentity objects identifying the checklist variables. Cannot be null but may be empty

VariableIdentity members.
Name Type Comment Required
Id String The rule id Yes
Name String The rule name No
Security
No restrictions apply.