LearningResultRecordService

• getLearningResultRecord
• getLearningResultRecordsForLpr
• getLearningResultRecordsForLprAndType
• getLearningResultRecordsForLprIds
• getLearningResultRecordsBySourceId
• createLearningResultRecord
• updateLearningResultRecord
• deleteLearningResultRecord
• validateLearningResultRecord
• getResultSource
• getResultSourcesByIds
• getResultSourcesByType
• createResultSource
• updateResultSource
• deleteResultSource
• validateResultSource

• LearningResultRecordInfo
• StatusInfo
• ValidationResultInfo
• ResultSourceInfo

Method	getLearningResultRecord
Description	Retrieves a learning result record by its identifier
Parameters	String	learningResultRecordId	learning result record identifier
	ContextInfo	context	Context information containing the principalId and locale information about the caller of service operation
Return	LearningResultRecordInfo		learning result record information
Errors	DoesNotExistException		learning result record not found
	InvalidParameterException		invalid learningResultRecordId
	MissingParameterException		learningResultRecordId not specified
	OperationFailedException		unable to complete request
	PermissionDeniedException		authorization failure

Back to Operations

Method	getLearningResultRecordsForLpr
Description	Retrieves a list of learning result records for a Lui Person Relation
Parameters	String	lprId	Lui person relation identifier
Return	LearningResultRecordInfoList		list of learning result record information
Errors	DoesNotExistException		person not found
	InvalidParameterException		invalid personId
	MissingParameterException		personId not specified
	OperationFailedException		unable to complete request

Back to Operations

Method	getLearningResultRecordsForLprAndType
Description	Retrieves a list of learning result records based on LPR and the type of LRR
Parameters	String	lprId	???
	String	lrrType	???
Return	LearningResultRecordInfoList		???
Errors	DoesNotExistException		???
	InvalidParameterException		???
	MissingParameterException		???
	OperationFailedException		???

Back to Operations

Method	getLearningResultRecordsForLprIds
Description	Retrieves a list of learning result records for Lui Person Relation Ids
Parameters	StringList	lprIds	List of Lui person relation identifier
	ContextInfo	context	Context information containing the principalId and locale information about the caller of service operation
Return	LearningResultRecordInfoList		list of learning result record information
Errors	DoesNotExistException		person not found
	InvalidParameterException		invalid personId
	MissingParameterException		personId not specified
	OperationFailedException		unable to complete request

Back to Operations

Method	getLearningResultRecordsBySourceId
Description	Retrieves a list of learning result records by source Id
Parameters	StringList	sourceIds	???
	ContextInfo	context	Context information containing the principalId and locale information about the caller of service operation
Return	LearningResultRecordInfoList		list of learning result record information
Errors	DoesNotExistException		person not found
	InvalidParameterException		invalid personId
	MissingParameterException		personId not specified
	OperationFailedException		unable to complete request

Back to Operations

Method	createLearningResultRecord
Description	Creates an learning result record.
Parameters	LearningResultRecordInfo	learningResultRecord	???
	ContextInfo	context	Context information containing the principalId and locale information about the caller of service operation
Return	LearningResultRecordInfo		information about the newly created learning result record
Errors	AlreadyExistsException		Learning result record already exists
	DataValidationErrorException		One or more values invalid for this operation
	InvalidParameterException		one or more parameters invalid
	MissingParameterException		one or more parameters missing
	OperationFailedException		unable to complete request
	PermissionDeniedException		authorization failure

Back to Operations

Method	updateLearningResultRecord
Description	Updates an learning result record
Parameters	String	learningResultRecordId	identifier of the learning result record to be updated
	LearningResultRecordInfo	learningResultRecordInfo	information about the learningResultRecord to be updated
	ContextInfo	context	Context information containing the principalId and locale information about the caller of service operation
Return	LearningResultRecordInfo		the updated learning result record information
Errors	DataValidationErrorException		One or more values invalid for this operation
	DoesNotExistException		learning result record not found
	InvalidParameterException		one or more parameters invalid
	MissingParameterException		one or more parameters missing
	OperationFailedException		unable to complete request
	PermissionDeniedException		authorization failure
	VersionMismatchException		The action was attempted on an out of date version.

Back to Operations

Method	deleteLearningResultRecord
Description	Deletes an learning result record
Parameters	String	learningResultRecordId	identifier of the learning result record to delete
	ContextInfo	context	Context information containing the principalId and locale information about the caller of service operation
Return	StatusInfo		status of the operation (success or failure)
Errors	DoesNotExistException		learning result record not found
	InvalidParameterException		invalid learningResultRecordId
	MissingParameterException		missing learningResultRecordId
	OperationFailedException		unable to complete request
	PermissionDeniedException		authorization failure

Back to Operations

Method	validateLearningResultRecord
Description	Validates an learning result record. 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 learning result record (and/or one of its contained sub-objects) and a record is found for that identifier, the validation checks if the learning result record can be shifted to the new values. If an identifier is not present or 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.
Parameters	String	validationType	identifier of the extent of validation
	LearningResultRecordInfo	learningResultRecordInfo	learning result record information to be tested.
	ContextInfo	context	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, learningResultRecordInfo
	MissingParameterException		missing validationTypeKey, learningResultRecordInfo
	OperationFailedException		unable to complete request

Back to Operations

Method	getResultSource
Description	Retrieves a result source for a given identifier
Parameters	String	resultSourceId	result source id
	ContextInfo	context	Context information containing the principalId and locale information about the caller of service operation
Return	ResultSourceInfo		learning result record information
Errors	DoesNotExistException		result source not found
	InvalidParameterException		invalid resultSourceId
	MissingParameterException		resultSourceId not specified
	OperationFailedException		unable to complete request
	PermissionDeniedException		authorization failure

Back to Operations

Method	getResultSourcesByIds
Description	Retrieves a list of result sources for a list of Ids
Parameters	StringList	resultSourceIds	result source Id list
	ContextInfo	context	Context information containing the principalId and locale information about the caller of service operation
Return	ResultSourceInfoList		list of result sources
Errors	DoesNotExistException		result source not found
	InvalidParameterException		invalid resultSourceIds
	MissingParameterException		resultSourceIds not specified
	OperationFailedException		unable to complete request
	PermissionDeniedException		authorization failure

Back to Operations

Method	getResultSourcesByType
Description	Retrieves a list of result sources by type
Parameters	String	resultSourceTypeKey	result source type key
	ContextInfo	context	Context information containing the principalId and locale information about the caller of service operation
Return	ResultSourceInfoList		list of result sources
Errors	DoesNotExistException		result source not found
	InvalidParameterException		invalid resultSourceTypeKey
	MissingParameterException		resultSourceTypeKey not specified
	OperationFailedException		unable to complete request
	PermissionDeniedException		authorization failure

Back to Operations

Method	createResultSource
Description	Create a new result source
Parameters	ResultSourceInfo	sourceInfo	source information
	ContextInfo	context	Context information containing the principalId and locale information about the caller of service operation
Return	ResultSourceInfo		???
Errors	AlreadyExistsException		the result source being created already exists
	DataValidationErrorException		One or more values invalid for this operation
	InvalidParameterException		One or more parameters invalid
	MissingParameterException		One or more parameters missing
	OperationFailedException		unable to complete request
	PermissionDeniedException		authorization failure

Back to Operations

Method	updateResultSource
Description	Updates a result source
Parameters	String	resultSourceId	source identifier
	ResultSourceInfo	resultSourceInfo	source information
	ContextInfo	context	Context information containing the principalId and locale information about the caller of service operation
Return	ResultSourceInfo		updated result source information
Errors	DataValidationErrorException		One or more values invalid for this operation
	DoesNotExistException		result source not found
	InvalidParameterException		invalid resultSourceId or resultSourceInfo
	MissingParameterException		resultSourceId or resultSourceInfo not specified
	OperationFailedException		unable to complete request
	PermissionDeniedException		authorization failure
	VersionMismatchException		The action was attempted on an out of date version

Back to Operations

Method	deleteResultSource
Description	Delete a result source. The result source should not be deleteable if it is still being referenced by any LRR
Parameters	String	resultSourceId	???
	ContextInfo	context	Context information containing the principalId and locale information about the caller of service operation
Return	StatusInfo		status
Errors	DoesNotExistException		the result source does not exist
	InvalidParameterException		One or more parameters invalid
	MissingParameterException		One or more parameters missing
	OperationFailedException		unable to complete request
	PermissionDeniedException		authorization failure

Back to Operations

Method	validateResultSource
Description	Validates a result source
Parameters	String	validationType	identifier of the extent of validation
	ResultSourceInfo	resultSourceInfo	result source information to be tested.
	ContextInfo	context	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, resultSourceInfo
	MissingParameterException		missing validationTypeKey, resultSourceInfo
	OperationFailedException		unable to complete request

Back to Operations