LuiService

Name	Lui
Version	1.0 (Dev)
Included Services
Java Package	org.kuali.student.enrollment.lui.service

Main Message Structures

Method getLui

Description Retrieves a single Lui by a Lui Id.

Parameters String luiId the identifier for the Lui to be retrieved

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

Return LuiInfo the Lui requested

Errors DoesNotExistException luiId not found

InvalidParameterException contextInfo is not valid

MissingParameterException luiId or contextInfo is
missing or null

OperationFailedException unable to complete request

PermissionDeniedException an authorization failure occurred

Method	getLui
Description	Retrieves a single Lui by a Lui Id.
Parameters	String	luiId	the identifier for the Lui to be retrieved
ContextInfo	contextInfo	information containing the principalId and locale information about the caller of service operation
Return	LuiInfo	the Lui requested
Errors	DoesNotExistException	luiId not found
InvalidParameterException	contextInfo is not valid
MissingParameterException	luiId or contextInfo is missing or null
OperationFailedException	unable to complete request
PermissionDeniedException	an authorization failure occurred

Method	getLuisByIds
Description	Retrieves a list of Luis from a list of Lui Ids. The returned list may be in any order and if duplicates Ids are supplied, a unique set may or may not be returned.
Parameters	StringList	luiIds	a list of Lui identifiers
Parameters	ContextInfo	contextInfo	information containing the principalId and locale information about the caller of service operation
Return	LuiInfoList		a list of Luis
Errors	DoesNotExistException		a luiId in the list was not found
	InvalidParameterException		contextInfo is not valid
	MissingParameterException		luiIds, an Id in luiIds, or contextInfo is missing or null
	OperationFailedException		unable to complete request
	PermissionDeniedException		an authorization failure occurred

Method	getLuiIdsByType
Description	Retrieves a list of Lui Ids by Lui Type.
Parameters	String	luiTypeKey	an identifier for a Lui Type
Parameters	ContextInfo	contextInfo	information containing the principalId and locale information about the caller of service operation
Return	StringList		a list of Lui identifiers matching luiTypeKey or an empty list if none found
Errors	InvalidParameterException		contextInfo is not valid
	MissingParameterException		luiTypeKey or contextInfo is missing or null
	OperationFailedException		unable to complete request
	PermissionDeniedException		an authorization failure occurred

Method	getLuiIdsByClu
Description	Retrieves a list of Lui Ids by Clu. (the pattern says this should return the objects).
Parameters	String	cluId	an identifier for the Clu
Parameters	ContextInfo	contextInfo	information containing the principalId and locale information about the caller of service operation
Return	StringList		list of Lui Ids for the Clu
Errors	InvalidParameterException		contextInfo is not valid
	MissingParameterException		cluId or contextInfo is missing or null
	OperationFailedException		unable to complete request
	PermissionDeniedException		an authorization failure occurred

Method	getLuiIdsByAtpAndType
Description	Retrieves the list of Lui Ids for the specified atp and Lui Type.
Parameters	String	atpId	an identifier for the Atp
	String	luiTypeKey	an identifier for the Lui Type
	ContextInfo	contextInfo	information containing the principalId and locale information about the caller of service operation
Return	StringList		a list of identifiers of Luis offered in the given Atp of the specified luiType
Errors	InvalidParameterException		contextInfo is not valid
	MissingParameterException		atpId, luiTypeKey, or contextInfo is missing or null
	OperationFailedException		unable to complete request
	PermissionDeniedException		an authorization failure occurred

Method	getLuisByAtpAndClu
Description	Retrieves the list of Luis for the specified Clu and Atp.
Parameters	String	cluId	an identifier for the Clu
	String	atpId	an identifier for the Atp
	ContextInfo	contextInfo	information containing the principalId and locale information about the caller of service operation
Return	LuiInfoList		a list of Luis offered in atpId and related to cluId
Errors	InvalidParameterException		contextInfo is not valid
	MissingParameterException		cluId, atpId, or contextInfo is missing or null
	OperationFailedException		unable to complete request
	PermissionDeniedException		an authorization failure occurred

Method	searchForLuiIds
Description	Searches for Luis that meet the given search criteria and returns a list of Lui identifiers that meet the criteria.
Parameters	QueryByCriteria	criteria	the search criteria
Parameters	ContextInfo	contextInfo	information containing the principalId and locale information about the caller of service operation
Return	StringList		a list of Lui Ids matching the criteria
Errors	InvalidParameterException		criteria or contextInfo is not valid
	MissingParameterException		criteria or contextInfo is missing or null
	OperationFailedException		unable to complete request
	PermissionDeniedException		an authorization failure occurred

Method	validateLui
Description	Validates a Lui. Depending on the value of validationType, this validation could be limited to tests on just the current Lui and its directly contained sub-objects or expanded to perform all tests related to this Lui. 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 updated to the new values. If an identifier is not present or a record does not exist, the validation checks if the object with the given data can be created.
Parameters	String	validationTypeKey	the identifier for the validation Type
	String	cluId	the identifier for the Clu to which the Lui is attached
	String	atpId	the identifier for the Atp to which the Lui if offered
	String	luiTypeKey	the identifier for the Lui Type
	LuiInfo	luiInfo	the object to be validated
	ContextInfo	contextInfo	information containing the principalId and locale information about the caller of service operation
Return	ValidationResultInfoList		a list of validation results or an empty list if validation succeeded
Errors	DoesNotExistException		validationTypeKey, cluId, atpId, or luiTypeKey is not found
	InvalidParameterException		luiInfo or contextInfo is not valid
	MissingParameterException		validationTypeKey, cluId, atpId, luiTypeKey, luiInfo, or contextInfo is missing or null
	OperationFailedException		unable to complete request
	PermissionDeniedException		an authorization failure occurred

Method	createLui
Description	Creates a new LUI. The Lui Id, Type, Clu Id, Atp Id, and Meta information may not be set in the supplied data.
Parameters	String	cluId	the identifier for the Clu
	String	atpId	the identifier for the Atp
	String	luiTypeKey	an identifier for the Type of the new Lui
	LuiInfo	luiInfo	the data with which to create the Lui
	ContextInfo	contextInfo	information containing the principalId and locale information about the caller of service operation
Return	LuiInfo		the new Lui
Errors	DataValidationErrorException		supplied data is invalid
	DoesNotExistException		cluId, atpId, or luiTypeKey is not found
	InvalidParameterException		luiInfo or contextInfo is not valid
	MissingParameterException		cluId, atpId, luiTypeKey, luiInfo, 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

Method	updateLui
Description	Updates an existing Lui. The Lui Id, Type, Clu Id, Atp Id, and Meta information may not be changed.
Parameters	String	luiId	the identifier for the LUI to be updated
	LuiInfo	luiInfo	the new data for the Lui
	ContextInfo	contextInfo	information containing the principalId and locale information about the caller of service operation
Return	LuiInfo		the updated Lui
Errors	DataValidationErrorException		supplied data is invalid
	DoesNotExistException		luiId not found
	InvalidParameterException		luiInfo or contextInfo is not valid
	MissingParameterException		luiId, luiInfo, or contextInfo is missing or null
	OperationFailedException		unable to complete request
	PermissionDeniedException		an authorization failure occurred
	ReadOnlyException		an attempt at changing information designated as read only
	VersionMismatchException		optimistic locking failure or the action was attempted on an out of date version

Method	deleteLui
Description	Deletes an existing Lui.
Parameters	String	luiId	the identifier for the LUI to be deleted
Parameters	ContextInfo	contextInfo	information containing the principalId and locale information about the caller of service operation
Return	StatusInfo		the status of the delete operation. This must always be true.
Errors	DependentObjectsExistException		the delete operation would leave orphaned objects or violate integrity constraints
	DoesNotExistException		luiId not found
	InvalidParameterException		contextInfo is not valid
	MissingParameterException		luiId or contextInfo is missing or null
	OperationFailedException		unable to complete request
	PermissionDeniedException		an authorization failure occurred

Method	getLuiLuiRelation
Description	Retrieves a single LuiLuiRelation by a LuiLuiRelation Id.
Parameters	String	luiLuiRelationId	a unique identifier for the LuiLuiRelation to be retrieved
Parameters	ContextInfo	contextInfo	information containing the principalId and locale information about the caller of service operation
Return	LuiLuiRelationInfo		the LuiLuiRelation requested
Errors	DoesNotExistException		luiLuiRelationId is not found
	InvalidParameterException		contextInfo is not valid
	MissingParameterException		luiLuiRetaionId or contextInfo is missing or null
	OperationFailedException		unable to complete request
	PermissionDeniedException		an authorization failure occurred

Method	getLuiLuiRelationsByIds
Description	Retrieves a list of LuiLuiRelations from a list of LuiLuiRelation Ids. The returned list may be in any order and if duplicates Ids are supplied, a unique set may or may not be returned.
Parameters	StringList	luiLuiRelationIds	a list of LuiLuiRelation identifiers
Parameters	ContextInfo	contextInfo	Context information containing the principalId and locale information about the caller of service operation
Return	LuiLuiRelationInfoList		information about a list of LuiLuiRelations
Errors	DoesNotExistException		a luiLuiRelationId in the list was not found
	InvalidParameterException		contextInfo is not valid
	MissingParameterException		luiLuiRelationIds, a luiLuiRelationId in luiLuiRelationIds, or contextInfo is missing or null
	OperationFailedException		unable to complete request
	PermissionDeniedException		an authorization failure occurred

Method	getLuiLuiRelationIdsByType
Description	Retrieves a list of LuiLuiRelation Ids by a LuiLuiRelation Type.
Parameters	String	luiLuiRelationTypeKey	an identifier for a LuiLuiRelation Type
Parameters	ContextInfo	contextInfo	information containing the principalId and locale information about the caller of service operation
Return	StringList		a list of LuiLuiRelation identifiers
Errors	InvalidParameterException		contextInfo is not valid
	MissingParameterException		luiLuiRelationTypeKey or contextInfo is missing or null
	OperationFailedException		unable to complete request
	PermissionDeniedException		an authorization failure occurred

Method	getLuiLuiRelationsByLui
Description	Retrieves all LuiLuiRelations to the given Lui.
Parameters	String	luiId	a unique identifier of the LUI
Parameters	ContextInfo	contextInfo	information containing the principalId and locale information about the caller of service operation
Return	LuiLuiRelationInfoList		the LuiLuiRelations to the Lui
Errors	InvalidParameterException		contextInfo is not valid
	MissingParameterException		luiId or contextInfo is missing or null
	OperationFailedException		unable to complete request
	PermissionDeniedException		an authorization failure occurred

Method	getLuiLuiRelationsByLuiAndRelatedLui
Description	Retrieves all LuiLuiRelations between the given Luis.
Parameters	String	luiId	a unique identifier of the LUI
	String	relatedLuiId	a unique identifier of another LUI
	ContextInfo	contextInfo	information containing the principalId and locale information about the caller of service operation
Return	LuiLuiRelationInfoList		the LuiLuiRelations between the given Luis
Errors	InvalidParameterException		contextInfo is not valid
	MissingParameterException		luiId, relatedLuiId, or contextInfo is missing or null
	OperationFailedException		unable to complete request
	PermissionDeniedException		an authorization failure occurred

Method	getLuiIdsByRelatedLuiAndRelationType
Description	Retrieves a list of LUI Ids for the specified related LUI Id and LU to LU relation type (getRelatedLuiIdsByLuiId from the other direction). (??? this method seems unnecessary)
Parameters	String	relatedLuiId	identifier of the LUI
	String	luiLuiRelationTypeKey	the LU to LU relation type
	ContextInfo	contextInfo	Context information containing the principalId and locale information about the caller of service operation
Return	StringList		list of LUI identifiers, empty list of none found
Errors	InvalidParameterException		invalid parameter
	MissingParameterException		missing parameter
	OperationFailedException		unable to complete request
	PermissionDeniedException		an authorization failure occurred

Method	getLuisByRelatedLuiAndRelationType
Description	TODO 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	luiLuiRelationTypeKey	the LU to LU relation type
	ContextInfo	contextInfo	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 parameter
	MissingParameterException		missing paremeter
	OperationFailedException		unable to complete request
	PermissionDeniedException		an authorization failure occurred

Method	getLuiIdsByLuiAndRelationType
Description	TODO ??? Retrieves the list of related LUI Ids for the specified LUI Id and LU to LU relation type. (getLuiIdsByRelatedLuiAndRelationType from the other direction).
Parameters	String	luiId	identifier of the LUI
	String	luiLuiRelationTypeKey	the LU to LU relation type
	ContextInfo	contextInfo	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 parameter
	MissingParameterException		missing parameter
	OperationFailedException		unable to complete request
	PermissionDeniedException		an authorization failure occurred

Method	getLuiLuiRelationsByLuiAndRelatedLuiType
Description	Retrieves all LuiLuiRelations between a Lui and Luis of the given Lui Type.
Parameters	String	luiId	a unique identifier for the Lui
	String	relatedLuiTypeKey	a unique identifier for a Lui Type
	ContextInfo	contextInfo	information containing the principalId and locale information about the caller of service operation
Return	LuiInfoList		a list of LuiLuiRelations between luiId and Luis of relatedLuiTypeKey
Errors	InvalidParameterException		contextInfo is not valid
	MissingParameterException		luiId, relatedLuiTypeKey, or contextInfo is missing or null
	OperationFailedException		unable to complete request
	PermissionDeniedException		an authorization failure occurred

Method	searchForLuiLuiRelationIds
Description	Searches for LuiLuiRelations that meet the search criteria and returns a list of LuiLuiRelation identifiers that meet the criteria.
Parameters	QueryByCriteria	criteria	the search criteria
Parameters	ContextInfo	contextInfo	information containing the principalId and locale information about the caller of service operation
Return	StringList		list of LuiLuiRelationIds
Errors	InvalidParameterException		criteria or contextInfo is not valid
	MissingParameterException		criteria or contextInfo is missing os null
	OperationFailedException		unable to complete request
	PermissionDeniedException		an authorization failure occurred

Method	validateLuiLuiRelation
Description	Validates a LuiLuiRelations. Depending on the value of validationType, this validation could be limited to tests on just the current LuiLuiRelation and its directly contained sub-objects or expanded to perform all tests related to this LuiLuiRelation. If an identifier is present for the LuiLuiRelation (and/or one of its contained sub-objects) and a record is found for that identifier, the validation checks if the LuiLuiRelation can be updated to the new values. If an identifier is not present or a record does not exist, the validation checks if the object with the given data can be created.
Parameters	String	validationTypeKey	the identifier for the validation Type
	String	luiId	the identifier for the Lui
	String	relatedLuiId	the identifier for the related Lui
	String	luiLuiRelationTypeKey	the identifier for LuiLuiRelation Type
	LuiLuiRelationInfo	luiLuiRelationInfo	the LuiLuiRelation to ve validated
	ContextInfo	contextInfo	information containing the principalId and locale information about the caller of service operation
Return	ValidationResultInfoList		a list of validation results or an empty list if validation succeeded
Errors	DoesNotExistException		validationTypeKey, luiId, relatedLuiId, or luiLuiRelationTypeKey is not found
	InvalidParameterException		luiLuiRelationInfo or contextInfo is missing or null
	MissingParameterException		validationTypeKey, luiId, relatedLuiId, luiLuiRelationTypeKey, luiLuiRelationInfo, or contextInfo is missing or null
	OperationFailedException		unable to complete request
	PermissionDeniedException		an authorization failure occurred

Method	createLuiLuiRelation
Description	Create new LuiLuiRelation. The LuiLuiRelation Id, Type, luiId, relatedLuiId, and Meta information may not be set in the supplied data.
Parameters	String	luiId	identifier of the first LUI in the relationship
	String	relatedLuiId	identifier of the second LUI in the relationship to be related
	String	luiLuiRelationTypeKey	a unique key fo rthe Type or new LuiLuiRelation
	LuiLuiRelationInfo	luiLuiRelationInfo	the data with which to create the LuiLuiRelation
	ContextInfo	contextInfo	information containing the principalId and locale information about the caller of service operation
Return	LuiLuiRelationInfo		the new LuiLuiRelation
Errors	CircularRelationshipException		luiId equals relatedLuiId (why is this a contract failure?)
	DataValidationErrorException		supplied data is invalid
	DoesNotExistException		luiId, relatedLuiId, or luiLuiRelationTypeKey is not found
	InvalidParameterException		luiLuiRelationInfo ro contextInfo is not valid
	MissingParameterException		luiId, relatedLuiId, luiLuiRelationTypeKey, luiLuiRelationInfo, 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

Method	updateLuiLuiRelation
Description	Updates an existing LuiLuiRelation. The LuiLuiRelation Id, luiId, relatedLuiId, and Meta information may not be changed.
Parameters	String	luiLuiRelationId	the identifier for the LuiLuiRelation to be updated
	LuiLuiRelationInfo	luiLuiRelationInfo	the new data for the LuiLuiRelation
	ContextInfo	contextInfo	information containing the principalId and locale information about the caller of service operation
Return	LuiLuiRelationInfo		the updated LuiLuiRelation
Errors	DataValidationErrorException		supplied data is invalid
	DoesNotExistException		luiLuiRelationId is not found
	InvalidParameterException		luiLuiRelationInfo or contextInfo is not valid
	MissingParameterException		luiLuiRelationId, luiLuiRelationInfo, or contextInfo is missing or null
	OperationFailedException		unable to complete request
	PermissionDeniedException		an authorization failure occurred
	ReadOnlyException		an attempt at changing information designated as read only
	VersionMismatchException		optimistic locking failure or the action was attempted on an out of date version

Method	deleteLuiLuiRelation
Description	Deletes an existing LuiLuiRelation.
Parameters	String	luiLuiRelationId	identifier or the LuiLuiRelation to be deleted
Parameters	ContextInfo	contextInfo	information containing the principalId and locale information about the caller of service operation
Return	StatusInfo		the status of the delete operation. This must always be true.
Errors	DoesNotExistException		luiLuiRelationId not found
	InvalidParameterException		contextInfo is not valid
	MissingParameterException		luiLuiRelationId or contextInfo is missing or null
	OperationFailedException		unable to complete request
	PermissionDeniedException		an authorization failure occurred

Method	getLuiCapacity
Description	Retrieves a single LuiCapacity by a LuiCapacity Id.
Parameters	String	luiCapacityId	the identifier for the LuiCapacity to be retrieved
Parameters	ContextInfo	contextInfo	information containing the principalId and locale information about the caller of service operation
Return	LuiCapacityInfo		the LuiCapacity requested
Errors	DoesNotExistException		luiCapacityId not found
	InvalidParameterException		contextInfo is not valid
	MissingParameterException		luiCapacityId or contextInfo is missing or null
	OperationFailedException		unable to complete request
	PermissionDeniedException		an authorization failure occurred

Method	getLuiCapacitiesByIds
Description	Retrieves a list of LuiCapacity from a list of LuiCapacity Ids. The returned list may be in any order and if duplicate Ids are supplied, a unique set may or may not be returned.
Parameters	StringList	luiCapacityIds	a list of LuiCapacity identifiers
Parameters	ContextInfo	contextInfo	information containing the principalId and locale information about the caller of service operation
Return	LuiCapacityInfoList		a list of LuiCapacities
Errors	DoesNotExistException		a luiCapacityId in the list was not found
	InvalidParameterException		contextInfo is not valid
	MissingParameterException		luiCapacityIds, an Id in luiCapacityIds, or contextInfo is missing or null
	OperationFailedException		unable to complete request
	PermissionDeniedException		an authorization failure occurred

Method	getLuiCapacityIdsByType
Description	Retrieves a list of LuiCapacity Ids by LuiCapacity Type.
Parameters	String	luiCapacityTypeKey	a unique identifier for a LuiCapacity Type
Parameters	ContextInfo	contextInfo	information containing the principalId and locale information about the caller of service operation
Return	StringList		information about a list of Lui Capacities
Errors	InvalidParameterException		contextInfo is not valid
	MissingParameterException		luiCapacityTypeKey or contextInfo is missing or null
	OperationFailedException		unable to complete request
	PermissionDeniedException		an authorization failure occurred

Method	getLuiCapacitiesByLui
Description	Retrieves LuiCapacities associated with a Lui.
Parameters	String	luiId	a unique identifier for a Lui
Parameters	ContextInfo	contextInfo	information containing the principalId and locale information about the caller of service operation
Return	LuiCapacityInfoList		a list of LuiCapacities associated with the given Lui
Errors	InvalidParameterException		contextInfo is not valid
	MissingParameterException		luiId or contextInfo is missing or null
	OperationFailedException		unable to complete request
	PermissionDeniedException		an authorization failure occurred

Method	searchForLuiCapacityIds
Description	Searches for LuiCapacities that meet the search criteria and returns a list of LuiCapacity identifiers that meet the criteria.
Parameters	QueryByCriteria	criteria	the search criteria
Parameters	ContextInfo	contextInfo	information containing the principalId and locale information about the caller of service operation
Return	StringList		list of LuiCapacity Ids
Errors	InvalidParameterException		criteria or contextInfo is not valid
	MissingParameterException		criteria or contextInfo is missing or null
	OperationFailedException		unable to complete request
	PermissionDeniedException		an authorization failure occurred

Method	validateLuiCapacity
Description	Validates a LuiCapacity. Depending on the value of validationType, this validation could be limited to tests on just the current LuiCapacity and its directly contained sub-objects or expanded to perform all tests related to this LuiCapacity. If an identifier is present for the LuiCapacity (and/or one of its contained sub-objects) and a record is found for that identifier, the validation checks if the LuiCpacity can be updated to the new values. If an identifier is not present or a record does not exist, the validation checks if the object with the given data can be created.
Parameters	String	validationTypeKey	the identifier for the validation Type
	String	luiCapacityTypeKey	???
	LuiCapacityInfo	luiCapacityInfo	the LuiCapacity to be validated
	ContextInfo	contextInfo	information containing the principalId and locale information about the caller of service operation
Return	ValidationResultInfoList		a list of validation results or an empty list if validation succeeded
Errors	DoesNotExistException		validationTypeKey or luiCapacityTypeKey not found
	InvalidParameterException		luiInfo or contextInfo is not valid
	MissingParameterException		validationTypeKey, luiInfo, or contextInfo is missing or null
	OperationFailedException		???
	PermissionDeniedException		an authorization failure occurred