LuiService

Name	Lui
Version	1.0 (Dev)
Included Services	TypeService, DataDictionaryService

Learning Unit Insntance (LUI) Service Managages the creation of Instances of the cannonical Learning unit. An instance is associated with a particular time period during which is is offered. This includes course and section offerings as well as program offerings

Main Message Structures

Method getLui

Description Retrieves information about a LUI.

Parameters String luiId identifier of the LUI

ContextInfo context Context information containing the principalId
and locale information about the caller of service
operation

Return LuiInfo information about a LUI

Errors DoesNotExistException lui not found

InvalidParameterException invalid luiId

MissingParameterException missing luiId

OperationFailedException unable to complete request

Method	getLui
Description	Retrieves information about a LUI.
Parameters	String	luiId	identifier of the LUI
ContextInfo	context	Context information containing the principalId and locale information about the caller of service operation
Return	LuiInfo	information about a LUI
Errors	DoesNotExistException	lui not found
InvalidParameterException	invalid luiId
MissingParameterException	missing luiId
OperationFailedException	unable to complete request

Method	getLuisByIdList
Description	Retrieves information about LUIs from a list of Ids.
Parameters	StringList	luiIdList	List of LUI identifiers
Parameters	ContextInfo	context	Context information containing the principalId and locale information about the caller of service operation
Return	LuiInfoList		information about a list of LUIs
Errors	DoesNotExistException		One or more luis not found
	InvalidParameterException		One or more invalid luiIds
	MissingParameterException		missing luiIdList
	OperationFailedException		unable to complete request

Method	getLuisInAtpByCluId
Description	Retrieves the list of LUIs for the specified CLU and period.
Parameters	String	cluId	identifier of the CLU
	String	atpKey	identifier for the academic time period
	ContextInfo	context	Context information containing the principalId and locale information about the caller of service operation
Return	LuiInfoList		list of LUI information
Errors	DoesNotExistException		clu, atp not found
	InvalidParameterException		invalid cluId, atpKey
	MissingParameterException		missing cluId, atpKey
	OperationFailedException		unable to complete request

Method	getLuiIdsByCluId
Description	Retrieves the list of LUI ids for the specified CLU.
Parameters	String	cluId	identifier of the CLU
Parameters	ContextInfo	context	Context information containing the principalId and locale information about the caller of service operation
Return	StringList		list of LUI identifiers
Errors	DoesNotExistException		clu not found
	InvalidParameterException		invalid cluId
	MissingParameterException		missing cluId
	OperationFailedException		unable to complete request

Method	getLuisByRelation
Description	Retrieves the list of LUI information for the LUIs related to the specified LUI Id with a certain LU to LU relation type. (getRelatedLuisByLuiId from the other direction)
Parameters	String	relatedLuiId	identifier of the LUI
	String	luLuRelationTypeKey	the LU to LU relation type
	ContextInfo	context	Context information containing the principalId and locale information about the caller of service operation
Return	LuiInfoList		list of LUI information, empty list if none
Errors	InvalidParameterException		invalid relatedLuiId, luLuRelationTypeKey
	MissingParameterException		missing relatedLuiId, luLuRelationTypeKey
	OperationFailedException		unable to complete request

Method	getRelatedLuisByLuiId
Description	Retrieves the list of related LUI information for the specified LUI Id and LU to LU relation type (getLuisByRelation from the other direction).
Parameters	String	luiId	identifier of the LUI
	String	luLuRelationTypeKey	the LU to LU relation type
	ContextInfo	context	Context information containing the principalId and locale information about the caller of service operation
Return	LuiInfoList		list of LUI information, empty list if none found
Errors	InvalidParameterException		invalid luiId, luLuRelationTypeKey
	MissingParameterException		missing luiId, luLuRelationTypeKey
	OperationFailedException		unable to complete request

Method	getRelatedLuiIdsByLuiId
Description	Retrieves the list of related LUI Ids for the specified LUI Id and LU to LU relation type. (getLuiIdsByRelation from the other direction).
Parameters	String	luiId	identifier of the LUI
	String	luLuRelationTypeKey	the LU to LU relation type
	ContextInfo	context	Context information containing the principalId and locale information about the caller of service operation
Return	StringList		list of LUI identifier, empty list if none found
Errors	InvalidParameterException		invalid luiId, luLuRelationTypeKey
	MissingParameterException		missing luiId, luLuRelationTypeKey
	OperationFailedException		unable to complete request

Method	getLuiLuiRelation
Description	Retrieves the relationship information between LUIs given a specific relation instance.
Parameters	String	luiLuiRelationId	identifier of LUI to LUI relatio
Parameters	ContextInfo	context	Context information containing the principalId and locale information about the caller of service operation
Return	LuiLuiRelationInfo		information on the relation between two LUIs
Errors	DoesNotExistException		luiLuiRelation not found
	InvalidParameterException		invalid luiLuiRelationId
	MissingParameterException		missing luiLuiRelationId
	OperationFailedException		unable to complete request

Method	getLuiLuiRelationsByLui
Description	Retrieves the list of relationship information for the specified LUI.
Parameters	String	luiId	identifier of the LUI
Parameters	ContextInfo	context	Context information containing the principalId and locale information about the caller of service operation
Return	LuiLuiRelationInfoList		list of LUI to LUI relation information
Errors	DoesNotExistException		lui not found
	InvalidParameterException		invalid luiId
	MissingParameterException		missing luiId
	OperationFailedException		unable to complete request

Method	validateLui
Description	Validates a LUI. 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 LUI (and/or one of its contained sub-objects) and a record is found for that identifier, the validation checks if the LUI 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
	LuiInfo	luiInfo	LUI 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, luiInfo
	MissingParameterException		missing validationTypeKey, luiInfo
	OperationFailedException		unable to complete request

Method	createLui
Description	Creates a new LUI.
Parameters	String	cluId	identifier of the CLU for the LUI being created
	String	atpKey	identifier of the academic time period for the LUI being created
	LuiInfo	luiInfo	information about the LUI being created
	ContextInfo	context	Context information containing the principalId and locale information about the caller of service operation
Return	LuiInfo		the created LUI information
Errors	AlreadyExistsException		LUI already exists
	DataValidationErrorException		One or more values invalid for this operation
	DoesNotExistException		clu, atp not found
	InvalidParameterException		invalid cluId, atpKey, luiInfo
	MissingParameterException		missing cluId, atpKey, luiInfo
	OperationFailedException		unable to complete request
	PermissionDeniedException		authorization failure

Method	updateLui
Description	Updates an existing LUI.
Parameters	String	luiId	identifier for the LUI to be updated
	LuiInfo	luiInfo	updated information about the LUI
	ContextInfo	context	Context information containing the principalId and locale information about the caller of service operation
Return	LuiInfo		the updated LUI information
Errors	DataValidationErrorException		One or more values invalid for this operation
	DoesNotExistException		lui not found
	InvalidParameterException		invalid luiId, luiInfo
	MissingParameterException		missing luiId, luiInfo
	OperationFailedException		unable to complete request
	PermissionDeniedException		authorization failure
	VersionMismatchException		The action was attempted on an out of date version.

Method	deleteLui
Description	Deletes a LUI record.
Parameters	String	luiId	identifier for the LUI to be deleted
Parameters	ContextInfo	context	Context information containing the principalId and locale information about the caller of service operation
Return	StatusInfo		status of the operation
Errors	DependentObjectsExistException		delete would leave orphaned objects or violate integrity constraints
	DoesNotExistException		lui not found
	InvalidParameterException		invalid luiId
	MissingParameterException		missing luiId
	OperationFailedException		unable to complete request
	PermissionDeniedException		authorization failure

Method	updateLuiState
Description	Updates the state of the LUI.
Parameters	String	luiId	identifier for the LUI to be updated
	String	luState	New state for LUI. Value is expected to be constrained to those in the luState enumeration.
	ContextInfo	context	Context information containing the principalId and locale information about the caller of service operation
Return	LuiInfo		the updated LUI information
Errors	DataValidationErrorException		New state not valid for existing state of LUI
	DoesNotExistException		lui, luState not found
	InvalidParameterException		invalid luiId, luState
	MissingParameterException		missing luiId, luState
	OperationFailedException		unable to complete request
	PermissionDeniedException		authorization failure

Method	validateLuiLuiRelation
Description	Validates a relationship between LUIs. 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 relationship (and/or one of its contained sub-objects) and a record is found for that identifier, the validation checks if the relationship 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
	LuiLuiRelationInfo	luiLuiRelationInfo	LUI to LUI relationship 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, luiLuiRelationInfo
	MissingParameterException		missing validationTypeKey, luiLuiRelationInfo
	OperationFailedException		unable to complete request

Method	createLuiLuiRelation
Description	Create a relationship between two LUIs.
Parameters	String	luiId	identifier of the first LUI in the relationship
	String	relatedLuiId	identifier of the second LUI in the relationship to be related to
	String	luLuRelationTypeKey	the LU to LU relationship type of the relationship
	LuiLuiRelationInfo	luiLuiRelationInfo	information about the relationship between the two LUIs
	ContextInfo	context	Context information containing the principalId and locale information about the caller of service operation
Return	LuiLuiRelationInfo		the created LUI to LUI relation information
Errors	AlreadyExistsException		relationship already exists
	CircularRelationshipException		luiId equals relatedLuiId
	DataValidationErrorException		One or more values invalid for this operation
	DoesNotExistException		luiId, relatedLuiId, luLuRelationTypeKey not found
	InvalidParameterException		invalid luiIds, luLuRelationTypeKey, luiLuiRelationInfo
	MissingParameterException		missing luiIds, luLuRelationTypeKey, luiLuiRelationInfo
	OperationFailedException		unable to complete request
	PermissionDeniedException		authorization failure

Method	updateLuiLuiRelation
Description	Updates a relationship between two LUIs.
Parameters	String	luiLuiRelationId	identifier of the LUI to LUI relation to update
	LuiLuiRelationInfo	luiLuiRelationInfo	changed information about the relationship between the two LUIs
	ContextInfo	context	Context information containing the principalId and locale information about the caller of service operation
Return	LuiLuiRelationInfo		the update LUI to LUI relation information
Errors	DataValidationErrorException		One or more values invalid for this operation
	DoesNotExistException		luiLuiRelation not found
	InvalidParameterException		invalid luiLuiRelationId, luiLuiRelationInfo
	MissingParameterException		missing luiLuiRelationId, luiLuiRelationInfo
	OperationFailedException		unable to complete request
	PermissionDeniedException		authorization failure
	VersionMismatchException		The action was attempted on an out of date version.

Method	deleteLuiLuiRelation
Description	Deletes a relationship between two LUIs.
Parameters	String	luiLuiRelationId	identifier of the LUI to LUI relation to delete
Parameters	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		luiLuiRelation not found
	InvalidParameterException		invalid luiLuiRelationId
	MissingParameterException		missing luiLuiRelationId
	OperationFailedException		unable to complete request
	PermissionDeniedException		authorization failure