ProcessService

• getProcessCategory
• getProcessCategoriesByIds
• getProcessCategoryIdsByType
• getProcessCategoriesForProcess
• searchForProcessCategoryIds
• searchForProcessCategories
• validateProcessCategory
• createProcessCategory
• updateProcessCategory
• deleteProcessCategory
• addProcessToProcessCategory
• removeProcessFromProcessCategory
• getProcess
• getProcessesByKeys
• getProcessKeysByType
• getProcessesForProcessCategory
• searchForProcessKeys
• searchForProcess
• validateProcess
• createProcess
• updateProcess
• deleteProcess
• getCheck
• getChecksByIds
• getCheckIdsByType
• searchForCheckIds
• searchForChecks
• validateCheck
• createCheck
• updateCheck
• deleteCheck
• getInstruction
• getInstructionsByIds
• getInstructionIdsByType
• getInstructionsByProcess
• getInstructionsByCheck
• getInstructionsByProcessAndCheck
• searchForInstructionIds
• searchForInstructions
• validateInstruction
• createInstruction
• updateInstruction
• reorderInstructions
• deleteInstruction
• getInstructionsForEvaluation

• ProcessCategoryInfo
• QueryByCriteria
• ValidationResultInfo
• StatusInfo
• ProcessInfo
• CheckInfo
• InstructionInfo

Method	getProcessCategory
Description	Retrieves a ProcessCategory.
Parameters	String	processCategoryId	a unique Id of a ProcessCategory
	ContextInfo	contextInfo	Context information containing the principalId and locale information about the caller of service operation
Return	ProcessCategoryInfo		a ProcessCategory
Errors	DoesNotExistException		processCategoryId not found
	InvalidParameterException		invalid processCategoryId or contextInfo
	MissingParameterException		missing processCategoryId or contextInfo
	OperationFailedException		unable to complete request
	PermissionDeniedException		authorization failure

Back to Operations

Method	getProcessCategoriesByIds
Description	Retrieves a list of ProcessCategorys corresponding to the given list of ProcessCategory Ids.
Parameters	StringList	processCategoryIds	list of ProcessCategories to be retrieved
	ContextInfo	contextInfo	Context information containing the principalId and locale information about the caller of service operation
Return	ProcessCategoryInfoList		a list of ProcessCategory Ids of the given type
Errors	DoesNotExistException		an processCategoryId in list not found
	InvalidParameterException		invalid processCategoryId or contextInfo
	MissingParameterException		missing processCategoryId or contextInfo
	OperationFailedException		unable to complete request
	PermissionDeniedException		authorization failure

Back to Operations

Method	getProcessCategoryIdsByType
Description	Retrieves a list of ProcessCategory Ids of the specified type.
Parameters	String	processTypeKey	a ProcessCategory type to be retrieved
	ContextInfo	contextInfo	Context information containing the principalId and locale information about the caller of service operation
Return	StringList		a list of ProcessCategory Ids
Errors	InvalidParameterException		invalid processTypeKey or contextInfo
	MissingParameterException		missing processTypeKey or contextInfo
	OperationFailedException		unable to complete request
	PermissionDeniedException		authorization failure

Back to Operations

Method	getProcessCategoriesForProcess
Description	Retrieves a list of ProcessCategories in which the given Process is related.
Parameters	String	processKey	a Process key
	ContextInfo	contextInfo	Context information containing the principalId and locale information about the caller of service operation
Return	ProcessCategoryInfoList		a list of ProcessCategories
Errors	InvalidParameterException		invalid processKey or contextInfo
	MissingParameterException		missing processKey or contextInfo
	OperationFailedException		unable to complete request
	PermissionDeniedException		authorization failure

Back to Operations

Method	searchForProcessCategoryIds
Description	Searches for ProcessCategories based on the criteria and returns a list of ProcessCategory identifiers which match the search criteria.
Parameters	QueryByCriteria	criteria	the search criteria
	ContextInfo	contextInfo	Context information containing the principalId and locale information about the caller of service operation
Return	StringList		list of ProcessCategory Ids
Errors	InvalidParameterException		invalid criteria or contextInfo
	MissingParameterException		missing criteria or contextInfo
	OperationFailedException		unable to complete request
	PermissionDeniedException		authorization failure

Back to Operations

Method	searchForProcessCategories
Description	Searches for ProcessCategories based on the criteria and returns a list of ProcessCategories which match the search criteria.
Parameters	QueryByCriteria	criteria	the search criteria
	ContextInfo	contextInfo	Context information containing the principalId and locale information about the caller of service operation
Return	ProcessCategoryInfoList		list of ProcessCategories
Errors	InvalidParameterException		invalid criteria or contextInfo
	MissingParameterException		missing criteria or contextInfo
	OperationFailedException		unable to complete request
	PermissionDeniedException		authorization failure

Back to Operations

Method	validateProcessCategory
Description	Validates a ProcessCategory. Depending on the value of validationType, this validation could be limited to tests on just the current object and its directly contained sub-objects or expanded to perform all tests related to this object. If an identifier is present for the ProcessCategory and a record is found for that identifier, the validation checks if the ProcessCategory can be shifted to the new values. If a record cannot be found for the identifier, it is assumed that the record does not exist and as such, the checks performed will be much shallower, typically mimicking those performed by setting the validationType to the current object. This is a slightly different pattern from the standard validation as the caller provides the identifier in the create statement instead of the server assigning an identifier.
Parameters	String	validationTypeKey	the identifier of the extent of validation
	String	processCategoryTypeKey	the ProcessCategory type key
	ProcessCategoryInfo	processCategoryInfo	the ProcessCategory information to be tested
	ContextInfo	contextInfo	Context information containing the principalId and locale information about the caller of service operation
Return	ValidationResultInfoList		Results from performing the validation
Errors	DoesNotExistException		validationTypeKey not found
	InvalidParameterException		invalid validationTypeKey, processInfo, or contextInfo
	MissingParameterException		missing validationTypeKey, processInfo, or contextInfo
	OperationFailedException		unable to complete request
	PermissionDeniedException		authorization failure

Back to Operations

Method	createProcessCategory
Description	Creates a new ProcessCategory.
Parameters	String	processCategoryTypeKey	the ProcessCategory type key
	ProcessCategoryInfo	processCategoryInfo	the details of ProcessCategory to be created
	ContextInfo	contextInfo	Context information containing the principalId and locale information about the caller of service operation
Return	ProcessCategoryInfo		the ProcessCategory just created
Errors	DataValidationErrorException		one or more values invalid for this operation
	InvalidParameterException		invalid processInfo or contextInfo
	MissingParameterException		missing processInfo or contextInfo
	OperationFailedException		unable to complete request
	PermissionDeniedException		authorization failure
	ReadOnlyException		an attempt at supplying information designated as read-only

Back to Operations

Method	updateProcessCategory
Description	Updates an existing ProcessCategory.
Parameters	String	processCategoryId	the Id of ProcessCategory to be updated
	ProcessCategoryInfo	processInfo	the details of updates to ProcessCategory being updated
	ContextInfo	contextInfo	Context information containing the principalId and locale information about the caller of service operation
Return	ProcessCategoryInfo		the details of ProcessCategory just updated
Errors	DataValidationErrorException		One or more values invalid for this operation
	DoesNotExistException		processCategoryId not found
	InvalidParameterException		invalid processCategoryId, processInfo, or contextInfo
	MissingParameterException		missing processCategoryId, processInfo, or contextInfo
	OperationFailedException		unable to complete request
	PermissionDeniedException		authorization failure
	ReadOnlyException		an attempt at supplying information designated as read-only
	VersionMismatchException		The action was attempted on an out of date version.

Back to Operations

Method	deleteProcessCategory
Description	Deletes an existing ProcessCategory.
Parameters	String	processCategoryId	the Id of the ProcessCategory to be deleted
	ContextInfo	contextInfo	Context information containing the principalId and locale information about the caller of service operation
Return	StatusInfo		status of the operation (success, failed)
Errors	DoesNotExistException		processCategoryId not found
	InvalidParameterException		invalid processCategoryId or contextInfo
	MissingParameterException		missing processCategoryId or contextInfo
	OperationFailedException		unable to complete request
	PermissionDeniedException		authorization failure
	DependentObjectsExistException		???

Back to Operations

Method	addProcessToProcessCategory
Description	Adds Process to a ProcessCategory.
Parameters	String	processKey	a unique identifier for a Process
	String	processCategoryId	a unique identifier for a ProcessCategory
	ContextInfo	contextInfo	Context information containing the principalId and locale information about the caller of service operation
Return	StatusInfo		status
Errors	AlreadyExistsException		processKey already related to processCategoryId
	DoesNotExistException		processKey or processCategoryId not found
	InvalidParameterException		invalid processKey, processCategoryId, or contextInfo
	MissingParameterException		missing processKey, processCategoryId, or contextInfo
	OperationFailedException		unable to complete request
	PermissionDeniedException		authorization failure

Back to Operations

Method	removeProcessFromProcessCategory
Description	Removes Process from a ProcessCategory.
Parameters	String	processKey	a unique identifier for a Process
	String	processCategoryId	a unique identifier for a ProcessCategory
	ContextInfo	contextInfo	Context information containing the principalId and locale information about the caller of service operation
Return	StatusInfo		status
Errors	DoesNotExistException		processKey or processCategoryId not found or unrelated
	InvalidParameterException		invalid processKey, processCategoryId, or contextInfo
	MissingParameterException		missing processKey, processCategoryId, or contextInfo
	OperationFailedException		unable to complete request
	PermissionDeniedException		authorization failure

Back to Operations

Method	getProcess
Description	Retrieves a Process.
Parameters	String	processKey	a unique key of a Process
	ContextInfo	contextInfo	Context information containing the principalId and locale information about the caller of service operation
Return	ProcessInfo		a Process
Errors	DoesNotExistException		processKey not found
	InvalidParameterException		invalid processKey or contextInfo
	MissingParameterException		missing processKey or contextInfo
	OperationFailedException		unable to complete request
	PermissionDeniedException		authorization failure

Back to Operations

Method	getProcessesByKeys
Description	Retrieves a list of Processes corresponding to the given list of Process keys.
Parameters	StringList	processKeys	list of Processess to be retrieved
	ContextInfo	contextInfo	Context information containing the principalId and locale information about the caller of service operation
Return	ProcessInfoList		a list of Process keys of the given type
Errors	DoesNotExistException		an processKey in list not found
	InvalidParameterException		invalid processKey or contextInfo
	MissingParameterException		missing processKey or contextInfo
	OperationFailedException		unable to complete request
	PermissionDeniedException		authorization failure

Back to Operations

Method	getProcessKeysByType
Description	Retrieves a list of Process keys of the specified type.
Parameters	String	processTypeKey	a Process type to be retrieved
	ContextInfo	contextInfo	Context information containing the principalId and locale information about the caller of service operation
Return	StringList		a list of Process keys
Errors	InvalidParameterException		invalid processTypeKey or contextInfo
	MissingParameterException		missing processTypeKey or contextInfo
	OperationFailedException		unable to complete request
	PermissionDeniedException		authorization failure

Back to Operations

Method	getProcessesForProcessCategory
Description	Retrieves a list of Processes in which the given ProcessCategory is related.
Parameters	String	processCategoryId	a ProcessCategory Id
	ContextInfo	contextInfo	Context information containing the principalId and locale information about the caller of service operation
Return	ProcessInfoList		a list of Processes
Errors	InvalidParameterException		invalid processCategoryId or contextInfo
	MissingParameterException		missing processCategoryId or contextInfo
	OperationFailedException		unable to complete request
	PermissionDeniedException		authorization failure

Back to Operations

Method	searchForProcessKeys
Description	Searches for Processs based on the criteria and returns a list of Process identifiers which match the search criteria.
Parameters	QueryByCriteria	criteria	the search criteria
	ContextInfo	contextInfo	Context information containing the principalId and locale information about the caller of service operation
Return	StringList		list of Process Ids
Errors	InvalidParameterException		invalid criteria or contextInfo
	MissingParameterException		missing criteria or contextInfo
	OperationFailedException		unable to complete request
	PermissionDeniedException		authorization failure

Back to Operations

Method	searchForProcess
Description	Searches for Processs based on the criteria and returns a list of Processs which match the search criteria.
Parameters	QueryByCriteria	criteria	the search criteria
	ContextInfo	contextInfo	Context information containing the principalId and locale information about the caller of service operation
Return	ProcessInfoList		list of Processs
Errors	InvalidParameterException		invalid criteria or contextInfo
	MissingParameterException		missing criteria or contextInfo
	OperationFailedException		unable to complete request
	PermissionDeniedException		authorization failure

Back to Operations

Method	validateProcess
Description	Validates a Process. Depending on the value of validationType, this validation could be limited to tests on just the current object and its directly contained sub-objects or expanded to perform all tests related to this object. If an identifier is present for the Process and a record is found for that identifier, the validation checks if the Process can be shifted to the new values. If a record cannot be found for the identifier, it is assumed that the record does not exist and as such, the checks performed will be much shallower, typically mimicking those performed by setting the validationType to the current object. This is a slightly different pattern from the standard validation as the caller provides the identifier in the create statement instead of the server assigning an identifier.
Parameters	String	validationTypeKey	the identifier of the extent of validation
	String	processTypeKey	the identifier for the Process Type
	ProcessInfo	processInfo	the Process information to be tested
	ContextInfo	contextInfo	Context information containing the principalId and locale information about the caller of service operation
Return	ValidationResultInfoList		Results from performing the validation
Errors	DoesNotExistException		validationTypeKey not found
	InvalidParameterException		invalid validationTypeKey, processInfo, or contextInfo
	MissingParameterException		missing validationTypeKey, processInfo, or contextInfo
	OperationFailedException		unable to complete request
	PermissionDeniedException		authorization failure

Back to Operations

Method	createProcess
Description	Creates a new Process.
Parameters	String	processKey	the key of Process to be created
	String	processTypeKey	the identifier for the Process Type
	ProcessInfo	processInfo	the details of Process to be created
	ContextInfo	contextInfo	Context information containing the principalId and locale information about the caller of service operation
Return	ProcessInfo		the Process just created
Errors	AlreadyExistsException		the Process being created already exists
	DataValidationErrorException		one or more values invalid for this operation
	InvalidParameterException		invalid processKey, processInfo, or contextInfo
	MissingParameterException		missing processKey, processInfo, or contextInfo
	OperationFailedException		unable to complete request
	PermissionDeniedException		authorization failure
	ReadOnlyException		an attempt at supplying information designated as read-only

Back to Operations

Method	updateProcess
Description	Updates an existing Process.
Parameters	String	processKey	the key of Process to be updated
	ProcessInfo	processInfo	the details of updates to Process being updated
	ContextInfo	contextInfo	Context information containing the principalId and locale information about the caller of service operation
Return	ProcessInfo		the details of Process just updated
Errors	DataValidationErrorException		One or more values invalid for this operation
	DoesNotExistException		processKey not found
	InvalidParameterException		invalid processKey, processInfo, or contextInfo
	MissingParameterException		missing processKey, processInfo, or contextInfo
	OperationFailedException		unable to complete request
	PermissionDeniedException		authorization failure
	ReadOnlyException		an attempt at supplying information designated as read-only
	VersionMismatchException		The action was attempted on an out of date version.

Back to Operations

Method	deleteProcess
Description	Deletes an existing Process.
Parameters	String	processKey	the key of the Process to be deleted
	ContextInfo	contextInfo	Context information containing the principalId and locale information about the caller of service operation
Return	StatusInfo		status of the operation (success, failed)
Errors	DependentObjectsExistException		Instructions related to this Process
	DoesNotExistException		processKey not found
	InvalidParameterException		invalid processKey or contextInfo
	MissingParameterException		missing processKey or contextInfo
	OperationFailedException		unable to complete request
	PermissionDeniedException		authorization failure

Back to Operations

Method	getCheck
Description	Retrieves a Check.
Parameters	String	checkId	a unique Id of a Check
	ContextInfo	contextInfo	Context information containing the principalId and locale information about the caller of service operation
Return	CheckInfo		a Check
Errors	DoesNotExistException		checkId not found
	InvalidParameterException		contextInfo is not valid
	MissingParameterException		checkId or contextInfo is missing or null
	OperationFailedException		unable to complete request
	PermissionDeniedException		an authorization failure occurred

Back to Operations

Method	getChecksByIds
Description	Retrieves a list of Checks corresponding to the given list of Check Ids.
Parameters	StringList	checkIds	list of Checks to be retrieved
	ContextInfo	contextInfo	information containing the principalId and locale information about the caller of service operation
Return	CheckInfoList		a list of Check Ids of the given type
Errors	DoesNotExistException		a checkId in list not found
	InvalidParameterException		contextInfo is not valid
	MissingParameterException		checkId or contextInfo is missing or null
	OperationFailedException		unable to complete request
	PermissionDeniedException		authorization failure

Back to Operations

Method	getCheckIdsByType
Description	Retrieves a list of Check Ids of the specified type.
Parameters	String	checkTypeKey	a Check type to be retrieved
	ContextInfo	contextInfo	Context information containing the principalId and locale information about the caller of service operation
Return	StringList		a list of Check Ids
Errors	InvalidParameterException		invalid checkTypeKey or contextInfo
	MissingParameterException		missing checkTypeKey or contextInfo
	OperationFailedException		unable to complete request
	PermissionDeniedException		authorization failure

Back to Operations

Method	searchForCheckIds
Description	Searches for Checks based on the criteria and returns a list of Check identifiers which match the search criteria.
Parameters	QueryByCriteria	criteria	the search criteria
	ContextInfo	contextInfo	Context information containing the principalId and locale information about the caller of service operation
Return	StringList		list of Check Ids
Errors	InvalidParameterException		invalid criteria or contextInfo
	MissingParameterException		missing criteria or contextInfo
	OperationFailedException		unable to complete request
	PermissionDeniedException		authorization failure

Back to Operations

Method	searchForChecks
Description	Searches for Checks based on the criteria and returns a list of Checks which match the search criteria.
Parameters	QueryByCriteria	criteria	the search criteria
	ContextInfo	contextInfo	Context information containing the principalId and locale information about the caller of service operation
Return	CheckInfoList		list of Checks
Errors	InvalidParameterException		invalid criteria or contextInfo
	MissingParameterException		missing criteria or contextInfo
	OperationFailedException		unable to complete request
	PermissionDeniedException		authorization failure

Back to Operations

Method	validateCheck
Description	Validates a Check. Depending on the value of validationType, this validation could be limited to tests on just the current object and its directly contained sub-objects or expanded to perform all tests related to this object. If an identifier is present for the Check and a record is found for that identifier, the validation checks if the Check can be shifted to the new values. If a record cannot be found for the identifier, it is assumed that the record does not exist and as such, the checks performed will be much shallower, typically mimicking those performed by setting the validationType to the current object. This is a slightly different pattern from the standard validation as the caller provides the identifier in the create statement instead of the server assigning an identifier.
Parameters	String	validationTypeKey	the identifier of the extent of validation
	String	checkTypeKey	???
	CheckInfo	checkInfo	the Check information to be tested
	ContextInfo	contextInfo	Context information containing the principalId and locale information about the caller of service operation
Return	ValidationResultInfoList		Results from performing the validation
Errors	DoesNotExistException		validationTypeKey not found
	InvalidParameterException		invalid validationTypeKey, checkInfo, or contextInfo
	MissingParameterException		missing validationTypeKey, checkInfo, or contextInfo
	OperationFailedException		unable to complete request
	PermissionDeniedException		authorization failure

Back to Operations

Method	createCheck
Description	Creates a new Check.
Parameters	String	checkTypeKey	an identifier for the Check Type
	CheckInfo	checkInfo	the details of Check to be created
	ContextInfo	contextInfo	Context information containing the principalId and locale information about the caller of service operation
Return	CheckInfo		the Check just created
Errors	DataValidationErrorException		one or more values invalid for this operation
	InvalidParameterException		checkInfo or contextInfo is not valid
	MissingParameterException		checkTypeKey, checkInfo or contextInfo is missing or null
	OperationFailedException		unable to complete request
	PermissionDeniedException		an authorization failure occurred
	ReadOnlyException		an attempt at supplying information designated as read-only

Back to Operations

Method	updateCheck
Description	Updates an existing Check.
Parameters	String	checkId	the Id of Check to be updated
	CheckInfo	checkInfo	the details of updates to Check being updated
	ContextInfo	contextInfo	Context information containing the principalId and locale information about the caller of service operation
Return	CheckInfo		the details of Check just updated
Errors	DataValidationErrorException		One or more values invalid for this operation
	DoesNotExistException		checkId not found
	InvalidParameterException		checkInfo or contextInfo is not valid
	MissingParameterException		checkId, checkInfo, or contextInfo is missing or null
	OperationFailedException		unable to complete request
	PermissionDeniedException		an authorization failure occurred
	ReadOnlyException		an attempt at supplying information designated as read-only
	VersionMismatchException		The action was attempted on an out of date version.

Back to Operations

Method	deleteCheck
Description	Deletes an existing Check.
Parameters	String	checkId	the Id of the Check to be deleted
	ContextInfo	contextInfo	Context information containing the principalId and locale information about the caller of service operation
Return	StatusInfo		status of the operation (success, failed)
Errors	DependentObjectsExistException		Instructions related to this Check
	DoesNotExistException		checkIs not found
	InvalidParameterException		contextInfo is not valid
	MissingParameterException		checkId or contextInfo is missing or null
	OperationFailedException		unable to complete request
	PermissionDeniedException		authorization failure

Back to Operations

Method	getInstruction
Description	Retrieves an Instruction.
Parameters	String	instructionId	a unique Id of an Instruction
	ContextInfo	contextInfo	Context information containing the principalId and locale information about the caller of service operation
Return	InstructionInfo		an Instruction
Errors	DoesNotExistException		instructionId not found
	InvalidParameterException		invalid instructionId or contextInfo
	MissingParameterException		missing instructionId or contextInfo
	OperationFailedException		unable to complete request
	PermissionDeniedException		authorization failure

Back to Operations

Method	getInstructionsByIds
Description	Retrieves a list of Instructions corresponding to the given list of Instruction Ids.
Parameters	StringList	instructionIds	list of Instructioness to be retrieved
	ContextInfo	contextInfo	Context information containing the principalId and locale information about the caller of service operation
Return	InstructionInfoList		a list of Instruction Ids of the given type
Errors	DoesNotExistException		an instructionId in list not found
	InvalidParameterException		invalid instructionId or contextInfo
	MissingParameterException		missing instructionId or contextInfo
	OperationFailedException		unable to complete request
	PermissionDeniedException		authorization failure

Back to Operations

Method	getInstructionIdsByType
Description	Retrieves a list of Instruction Ids of the specified type.
Parameters	String	instructionTypeKey	an Instruction type to be retrieved
	ContextInfo	contextInfo	Context information containing the principalId and locale information about the caller of service operation
Return	StringList		a list of Instruction Ids
Errors	InvalidParameterException		invalid instructionTypeKey or contextInfo
	MissingParameterException		missing instructionTypeKey or contextInfo
	OperationFailedException		unable to complete request
	PermissionDeniedException		authorization failure

Back to Operations

Method	getInstructionsByProcess
Description	Retrieves a list of all Instructions relating to the given Process. This returns a list of Instructions ordered by position.
Parameters	String	processKey	a unique identfiier for a Process
	ContextInfo	contextInfo	Context information containing the principalId and locale information about the caller of service operation
Return	InstructionInfoList		a list of Instructions
Errors	InvalidParameterException		invalid processKey or contextInfo
	MissingParameterException		missing processKey or contextInfo
	OperationFailedException		unable to complete request
	PermissionDeniedException		authorization failure

Back to Operations

Method	getInstructionsByCheck
Description	Retrieves a list of Instructions relating to the given Check.
Parameters	String	checkId	a unique identfiier for a Check
	ContextInfo	contextInfo	Context information containing the principalId and locale information about the caller of service operation
Return	InstructionInfoList		a list of Instructions
Errors	InvalidParameterException		contextInfo is not valie
	MissingParameterException		checkId or contextInfo is misisng or null
	OperationFailedException		unable to complete request
	PermissionDeniedException		an authorization failure occurred

Back to Operations

Method	getInstructionsByProcessAndCheck
Description	Retrieves a list of Instructions relating to the given Process and Check.
Parameters	String	processKey	a unique identfiier for a Process
	String	checkId	a unique identfiier for a Check
	ContextInfo	contextInfo	Context information containing the principalId and locale information about the caller of service operation
Return	InstructionInfoList		a list of Instructions
Errors	DoesNotExistException		process and check and instruction relation does not exist
	InvalidParameterException		contextInfo is not valid
	MissingParameterException		processKey, checkId, or contextInfo is missing or null
	OperationFailedException		unable to complete request
	PermissionDeniedException		an authorization failure occuured

Back to Operations

Method	searchForInstructionIds
Description	Searches for Instructions based on the criteria and returns a list of Instruction identifiers which match the search criteria.
Parameters	QueryByCriteria	criteria	the search criteria
	ContextInfo	contextInfo	Context information containing the principalId and locale information about the caller of service operation
Return	StringList		list of Instruction Ids
Errors	InvalidParameterException		invalid criteria or contextInfo
	MissingParameterException		missing criteria or contextInfo
	OperationFailedException		unable to complete request
	PermissionDeniedException		authorization failure

Back to Operations

Method	searchForInstructions
Description	Searches for Instructions based on the criteria and returns a list of Instructions which match the search criteria.
Parameters	QueryByCriteria	criteria	the search criteria
	ContextInfo	contextInfo	Context information containing the principalId and locale information about the caller of service operation
Return	InstructionInfoList		list of Instructions
Errors	InvalidParameterException		invalid criteria or contextInfo
	MissingParameterException		missing criteria or contextInfo
	OperationFailedException		unable to complete request
	PermissionDeniedException		authorization failure

Back to Operations

Method	validateInstruction
Description	Validates an Instruction. Depending on the value of validationType, this validation could be limited to tests on just the current object and its directly contained sub-objects or expanded to perform all tests related to this object. If an identifier is present for the Instruction and a record is found for that identifier, the validation instructions if the Instruction can be shifted to the new values. If a record cannot be found for the identifier, it is assumed that the record does not exist and as such, the instructions performed will be much shallower, typically mimicking those performed by setting the validationType to the current object. This is a slightly different pattern from the standard validation as the caller provides the identifier in the create statement instead of the server assigning an identifier.
Parameters	String	validationTypeKey	the identifier of the extent of validation
	String	processKey	the identifier of the related Process
	String	checkId	the identifier of the related Check
	String	instructionTypeKey	the identifier of an Instruction Type
	InstructionInfo	instructionInfo	the Instruction information to be tested
	ContextInfo	contextInfo	information containing the principalId and locale information about the caller of service operation
Return	ValidationResultInfoList		Results from performing the validation
Errors	DoesNotExistException		validationTypeKey, processKey, or checkId not found
	InvalidParameterException		instructionInfo or contextInfo is invalid
	MissingParameterException		missing validationTypeKey, processKey, checkId, instructionTypeKey instructionInfo, or contextInfo
	OperationFailedException		unable to complete request
	PermissionDeniedException		an authorization failure occured

Back to Operations

Method	createInstruction
Description	Creates a new Instruction.
Parameters	String	processKey	the identifier of the related Process
	String	checkId	the identifier of the related Check
	String	instructionTypeKey	the identifier of an Instruction Type
	InstructionInfo	instructionInfo	the details of Instruction to be created
	ContextInfo	contextInfo	information containing the principalId and locale information about the caller of service operation
Return	InstructionInfo		the Instruction just created
Errors	DataValidationErrorException		one or more values invalid for this operation
	InvalidParameterException		instructionInfo or contextInfo is invalid
	MissingParameterException		checkId, instructionInfo, or contextInfo is missing or null
	OperationFailedException		unable to complete request
	PermissionDeniedException		an authorization failure occurred
	ReadOnlyException		an attempt at supplying information designated as read-only

Back to Operations

Method	updateInstruction
Description	Updates an existing Instruction.
Parameters	String	instructionId	the Id of Instruction to be updated
	InstructionInfo	instructionInfo	the details of updates to Instruction being updated
	ContextInfo	contextInfo	Context information containing the principalId and locale information about the caller of service operation
Return	InstructionInfo		the details of Instruction just updated
Errors	DataValidationErrorException		One or more values invalid for this operation
	DoesNotExistException		instructionId not found
	InvalidParameterException		invalid instructionId, instructionInfo, or contextInfo
	MissingParameterException		missing instructionId, instructionInfo, or contextInfo
	OperationFailedException		unable to complete request
	PermissionDeniedException		authorization failure
	ReadOnlyException		an attempt at supplying information designated as read-only
	VersionMismatchException		The action was attempted on an out of date version.

Back to Operations

Method	reorderInstructions
Description	Reorder Instructions Assigns sequential numbers to the instructions in the order they are supplied in the list of instruction ids. Any instructions not included in the list are added in an undetermined order after the ones that are listed.
Parameters	String	processKey	the process who's instructions are to be reordered
	StringList	instructionIds	the Ids of the Instruction to be reordered
	ContextInfo	contextInfo	Context information containing the principalId and locale information about the caller of service operation
Return	StatusInfo		the details of Instruction just updated
Errors	DataValidationErrorException		One or more values invalid for this operation
	DoesNotExistException		instructionId not found
	InvalidParameterException		invalid instructionId, instructionInfo, or contextInfo
	MissingParameterException		missing instructionId, instructionInfo, or contextInfo
	OperationFailedException		unable to complete request
	PermissionDeniedException		authorization failure

Back to Operations

Method	deleteInstruction
Description	Deletes an existing Instruction.
Parameters	String	instructionId	the Id of the Instruction to be deleted
	ContextInfo	contextInfo	Context information containing the principalId and locale information about the caller of service operation
Return	StatusInfo		status of the operation (success, failed)
Errors	DoesNotExistException		instructionId not found
	InvalidParameterException		invalid instructionId or contextInfo
	MissingParameterException		missing instructionId or contextInfo
	OperationFailedException		unable to complete request
	PermissionDeniedException		authorization failure

Back to Operations

Method	getInstructionsForEvaluation
Description	Retrieves a list of all Instructions ready to be evaluated in order. This method: 1. orders the Instructions for a Process 2. filters out Instructions whose state is not "active" 3. filters out Instructions whose effective dates are not current or the current context date does not apply (?)
Parameters	String	processKey	a unique identfiier for a Process
	ContextInfo	contextInfo	Context information containing the principalId and locale information about the caller of service operation
Return	InstructionInfoList		a list of Instructions
Errors	InvalidParameterException		invalid processKey or contextInfo
	MissingParameterException		missing processKey or contextInfo
	OperationFailedException		unable to complete request
	PermissionDeniedException		authorization failure

Back to Operations