LuiPersonRelationService

• fetchLuiPersonRelation
• findLuiPersonRelationsByIdList
• findLuiIdsRelatedToPerson
• findPersonIdsRelatedToLui
• findLuiPersonRelations
• findLuiPersonRelationIds
• findLuiPersonRelationsForPerson
• findLuiPersonRelationIdsForPerson
• findLuiPersonRelationsForLui
• findLuiPersonRelationIdsForLui
• validateLuiPersonRelation
• findAllValidLuisForPerson
• searchForLuiPersonRelationIds
• createLuiPersonRelation
• createBulkRelationshipsForPerson
• createBulkRelationshipsForLui
• updateLuiPersonRelation
• deleteLuiPersonRelation

• LuiPersonRelationInfo
• CriteriaInfo
• StatusInfo

Method	fetchLuiPersonRelation
Description	Retrieves the Relation for the specified LUI Person Relation
Parameters	String	luiPersonRelationId	Identifier for the LUI Person Relation
	ContextInfo	context	Context information containing the principalId and locale information about the caller of service operation
Return	LuiPersonRelationInfo		LUI Person Relation information
Errors	DoesNotExistException		luiPersonRelationId not found
	InvalidParameterException		invalid luiPersonRelationId
	MissingParameterException		missing luiPersonRelationId
	OperationFailedException		unable to complete request
	PermissionDeniedException		authorization failure

Back to Operations

Method	findLuiPersonRelationsByIdList
Description	Retrieves the Relation for the specified list of LUI Person Relation Ids
Parameters	StringList	luiPersonRelationIdList	List of identifiers for LUI Person Relations
	ContextInfo	context	Context information containing the principalId and locale information about the caller of service operation
Return	LuiPersonRelationInfoList		List of LUI Person Relation information
Errors	DoesNotExistException		One or more luiPersonRelationIds not found
	InvalidParameterException		One or more invalid luiPersonRelationIds
	MissingParameterException		missing luiPersonRelationIdList
	OperationFailedException		unable to complete request
	PermissionDeniedException		authorization failure

Back to Operations

Method	findLuiIdsRelatedToPerson
Description	Retrieves the LUI Ids for Person related to LUI
Parameters	String	personId	Identifier for the LUI Person Relation
	String	luiPersonRelationTypeKey	Type of LUI Person Relation
	String	relationState	Relation State
	ContextInfo	context	Context information containing the principalId and locale information about the caller of service operation
Return	StringList		Simple list of LUI Ids
Errors	DoesNotExistException		personId, luiPersonRelationTypeKey, relationState, person to LUI relationship not found
	DisabledIdentifierException		personId found, but has been retired
	InvalidParameterException		invalid personId, luiPersonRelationTypeKey, relationState
	MissingParameterException		missing personId, luiPersonRelationTypeKey, relationState
	OperationFailedException		unable to complete request
	PermissionDeniedException		authorization failure

Back to Operations

Method	findPersonIdsRelatedToLui
Description	Retrieves Person Ids related to the specified LUI
Parameters	String	luiId	Identifier for the LUI
	String	luiPersonRelationTypeKey	Type of LUI Person Relation
	String	relationState	Relation State
	ContextInfo	context	Context information containing the principalId and locale information about the caller of service operation
Return	StringList		Simple list of Person Ids
Errors	DoesNotExistException		luiId, luiPersonRelationTypeKey, relationState, LUI to person relationship not found
	InvalidParameterException		invalid luiId, luiPersonRelationTypeKey, relationState
	MissingParameterException		missing luiId, luiPersonRelationTypeKey, relationState
	OperationFailedException		unable to complete request
	PermissionDeniedException		authorization failure

Back to Operations

Method	findLuiPersonRelations
Description	Retrieves Person Relation for LUI
Parameters	String	personId	Identifier for person
	String	luiId	Identifier for LUI
	ContextInfo	context	Context information containing the principalId and locale information about the caller of service operation
Return	LuiPersonRelationInfoList		List of LUI Person Relation info
Errors	DoesNotExistException		personId, luiId not found
	DisabledIdentifierException		personId found, but has been retired
	InvalidParameterException		invalid personId, luiId
	MissingParameterException		missing personId, luiId
	OperationFailedException		unable to complete request
	PermissionDeniedException		authorization failure

Back to Operations

Method	findLuiPersonRelationIds
Description	Retrieves LUI Person Relation Ids
Parameters	String	personId	Identifier for person
	String	luiId	Identifier for LUI
	ContextInfo	context	Context information containing the principalId and locale information about the caller of service operation
Return	StringList		List of LUI Person Relation display info
Errors	DoesNotExistException		personId, luiId not found
	DisabledIdentifierException		personId found, but has been retired
	InvalidParameterException		invalid personId, luiId
	MissingParameterException		missing personId, luiId
	OperationFailedException		unable to complete request
	PermissionDeniedException		authorization failure

Back to Operations

Method	findLuiPersonRelationsForPerson
Description	Retrieves LUI Person Relation for Person
Parameters	String	personId	Identifier for person
	ContextInfo	context	Context information containing the principalId and locale information about the caller of service operation
Return	LuiPersonRelationInfoList		List of LUI Person Relation info
Errors	DoesNotExistException		personId not found
	DisabledIdentifierException		personId found, but has been retired
	InvalidParameterException		invalid personId
	MissingParameterException		missing personId
	OperationFailedException		unable to complete request
	PermissionDeniedException		authorization failure

Back to Operations

Method	findLuiPersonRelationIdsForPerson
Description	Retrieves LUI Person Relation Ids for Person
Parameters	String	personId	Identifier for person
	ContextInfo	context	Context information containing the principalId and locale information about the caller of service operation
Return	StringList		Simple list of person relation identifiers
Errors	DoesNotExistException		personId not found
	DisabledIdentifierException		personId found, but has been retired
	InvalidParameterException		invalid personId
	MissingParameterException		missing personId
	OperationFailedException		unable to complete request
	PermissionDeniedException		authorization failure

Back to Operations

Method	findLuiPersonRelationsForLui
Description	Retrieves LUI Person Relation for a specified LUI
Parameters	String	luiId	Identifier for LUI
	ContextInfo	context	Context information containing the principalId and locale information about the caller of service operation
Return	LuiPersonRelationInfoList		List of LUI Person Relation info
Errors	DoesNotExistException		luiId not found
	InvalidParameterException		invalid luiId
	MissingParameterException		missing luiId
	OperationFailedException		unable to complete request
	PermissionDeniedException		authorization failure

Back to Operations

Method	findLuiPersonRelationIdsForLui
Description	Retrieves LUIPersonRelation for LUI
Parameters	String	luiId	Identifier for LUI
	ContextInfo	context	Context information containing the principalId and locale information about the caller of service operation
Return	StringList		Simple list of LUI Person Relation identifiers
Errors	DoesNotExistException		luiId not found
	InvalidParameterException		invalid luiId
	MissingParameterException		missing luiId
	OperationFailedException		unable to complete request
	PermissionDeniedException		authorization failure

Back to Operations

Method	validateLuiPersonRelation
Description	Validates the particular relation in a state for a Person and LUI
Parameters	String	validationType	Identifier of the extent of validation
	LuiPersonRelationInfo	luiPersonRelationInfo	LuiPersonRelation to be validated
	ContextInfo	context	Context information containing the principalId and locale information about the caller of service operation
Return	ValidationResultInfoList		list of validation results, list should be be zero length if no validation rsults are generated
Errors	DoesNotExistException		luiPersonRelationInfo not found
	InvalidParameterException		invalid luiPersonRelationInfo relationState
	MissingParameterException		missing luiPersonRelationInfo
	OperationFailedException		unable to complete request
	PermissionDeniedException		authorization failure

Back to Operations

Method	findAllValidLuisForPerson
Description	Retrieves LUIs for an academic time period where the specified relation type and state would be valid for the specified person
Parameters	String	personId	Identifier for person
	String	luiPersonRelationTypeKey	Type of luiPersonRelationI
	String	relationState	Relation State
	String	atpId	Identifier for academic time period
	ContextInfo	context	Context information containing the principalId and locale information about the caller of service operation
Return	StringList		List of LUIs
Errors	DoesNotExistException		personId, luiPersonRelationTypeKey, relationState, atpId not found
	DisabledIdentifierException		personId found, but has been retired
	InvalidParameterException		invalid personId, luiPersonRelationTypeKey, relationState, atpId
	MissingParameterException		missing personId, luiPersonRelationTypeKey, relationState, atpId
	OperationFailedException		unable to complete request
	PermissionDeniedException		authorization failure

Back to Operations

Method	searchForLuiPersonRelationIds
Description	Retrieves detail of LUI Person Relation Ids
Parameters	CriteriaInfo	criteria	Criteria to be used for retrieval of multiple LUI Person Relation identifiers
	ContextInfo	context	Context information containing the principalId and locale information about the caller of service operation
Return	StringList		Simple list of LUI Person Relation identifiers
Errors	InvalidParameterException		invalid relation criteria
	MissingParameterException		missing relation criteria
	OperationFailedException		unable to complete request
	PermissionDeniedException		authorization failure

Back to Operations

Method	createLuiPersonRelation
Description	Creates relation between the specified Person and LUI
Parameters	String	personId	Person Identifier
	String	luiId	LUI Identifier
	String	luiPersonRelationTypeKey	Type of LUI to Person Relation
	LuiPersonRelationInfo	luiPersonRelationInfo	Information required to create the LUI Person relation
	ContextInfo	context	Context information containing the principalId and locale information about the caller of service operation
Return	String		Structure containing LUI Person relation identifiers
Errors	DataValidationErrorException		if luiPeronsRelationInfo is not valid
	AlreadyExistsException		relation already exists
	DoesNotExistException		personId, luiId, relationState, luiPersonRelationTypeKey does not exist
	DisabledIdentifierException		personId found, but has been retired
	ReadOnlyException		attempt to update a read only attribute
	InvalidParameterException		invalid personId, luiId, relationState, luiPersonRelationTypeKey, luiPersonRelationInfo
	MissingParameterException		missing personId, luiId, relationState, luiPersonRelationTypeKey, luiPersonRelationInfo
	OperationFailedException		unable to complete request
	PermissionDeniedException		authorization failure

Back to Operations

Method	createBulkRelationshipsForPerson
Description	Creates bulk relationships for one specified person. This is an all or nothing transaction - any error will invalidate the entire transaction.
Parameters	String	personId	Identifier for Person
	StringList	luiIdList	Simple list of LUI identifiers
	String	relationState	Relation state
	String	luiPersonRelationTypeKey	Type of LUI Person relation
	LuiPersonRelationInfo	luiPersonRelationInfo	Information required to create the LUI Person relation
	ContextInfo	context	Context information containing the principalId and locale information about the caller of service operation
Return	StringList		Structure containing LUI Person relation identifiers
Errors	DataValidationErrorException		if luiPeronsRelationInfo is not valid
	AlreadyExistsException		relation already exists
	DoesNotExistException		personId, luiId, relationState, luiPersonRelationTypeKey does not exist
	DisabledIdentifierException		personId found, but has been retired
	ReadOnlyException		attempt to update a read only attribute
	InvalidParameterException		invalid personId, luiId, relationState, luiPersonRelationTypeKey, luiPersonRelationInfo
	MissingParameterException		missing personId, luiId, relationState, luiPersonRelationTypeKey, luiPersonRelationInfo
	OperationFailedException		unable to complete request
	PermissionDeniedException		authorization failure

Back to Operations

Method	createBulkRelationshipsForLui
Description	Creates bulk relationships for one specified LUI. This is an all or nothing transaction - any error will invalidate the entire transaction.
Parameters	String	luiId	Identifier for Lui
	StringList	personIdList	Simple list of Person identifiers
	String	relationState	Relation state
	String	luiPersonRelationTypeKey	Type of LUI Person relation
	LuiPersonRelationInfo	luiPersonRelationInfo	Information required to create the LUI Person relation
	ContextInfo	context	Context information containing the principalId and locale information about the caller of service operation
Return	StringList		Structure containing LUI Person relation identifiers
Errors	AlreadyExistsException		relation already exists
	DataValidationErrorException		errors validating luiPersonRelationInfo with all data filled in
	DoesNotExistException		personId, luiId, relationState, luiPersonRelationTypeKey does not exist
	DisabledIdentifierException		personId found, but has been retired
	ReadOnlyException		attempt to update a read only attribute
	InvalidParameterException		invalid personId, luiId, relationState, luiPersonRelationTypeKey, luiPersonRelationInfo
	MissingParameterException		missing personId, luiId, relationState, luiPersonRelationTypeKey, luiPersonRelationInfo
	OperationFailedException		unable to complete request
	PermissionDeniedException		authorization failure

Back to Operations

Method	updateLuiPersonRelation
Description	Update relation between Person and LUI
Parameters	String	luiPersonRelationId	Identifier for the LUI Person Relation
	LuiPersonRelationInfo	luiPersonRelationInfo	Changed information about the LUI Person Relation
	ContextInfo	context	Context information containing the principalId and locale information about the caller of service operation
Return	LuiPersonRelationInfo		Updated information about the LUI Person Relation
Errors	DoesNotExistException		luiPersonRelationId does not exist
	DataValidationErrorException		if luiPersonRelationInfo is not valid
	InvalidParameterException		invalid luiPersonRelationId, luiPersonRelationInfo
	MissingParameterException		missing luiPersonRelationId, luiPersonRelationInfo
	ReadOnlyException		attempt to update a read only attribute
	OperationFailedException		unable to complete request
	PermissionDeniedException		authorization failure
	VersionMismatchException		if optimistic lock version ind has changed

Back to Operations

Method	deleteLuiPersonRelation
Description	Deletes relation between the specified Person and LUI
Parameters	String	luiPersonRelationId	Identifier for the LUI Person Relation
	ContextInfo	context	Context information containing the principalId and locale information about the caller of service operation
Return	StatusInfo		status of the operation (success, failed)
Errors	DoesNotExistException		luiPersonRelationId does not exist
	InvalidParameterException		invalid luiPersonRelationId
	MissingParameterException		missing luiPersonRelationId
	OperationFailedException		unable to complete request
	PermissionDeniedException		authorization failure

Back to Operations