LprService (Kuali Student Contract Documentation Generator 1.0.12 Test API)

All Superinterfaces:

StateService, TypeService
```
public interface LprService
extends TypeService, StateService
```
The Lui Person Relationship (LPR) Service Maintains the relationship between a Learning Unit Instance and a Person. Depending on the type this service maintains relationships such as:
- a student's registration in a course
- a student's enrollment in a program (major or minor)
- an instructor's assignment to teach a course
- a faculty member's assignment as an advisor for a program
Version:

1.0 (Dev)

Method Summary

Methods
Modifier and Type	Method and Description
`List<String>`	`createBulkRelationshipsForLui(String luiId, List<String> personIdList, String relationState, String luiPersonRelationTypeKey, LprInfo luiPersonRelationInfo, ContextInfo context)` Creates bulk relationships for one specified LUI.
`List<String>`	`createBulkRelationshipsForPerson(String personId, List<String> luiIdList, String relationState, String luiPersonRelationTypeKey, LprInfo luiPersonRelationInfo, ContextInfo context)` Creates bulk relationships for one specified person.
`String`	`createLuiPersonRelation(String personId, String luiId, String luiPersonRelationTypeKey, LprInfo luiPersonRelationInfo, ContextInfo context)` Creates relation between the specified Person and LUI
`StatusInfo`	`deleteLuiPersonRelation(String luiPersonRelationId, ContextInfo context)` Deletes relation between the specified Person and LUI
`LprInfo`	`fetchLuiPersonRelation(String luiPersonRelationId, ContextInfo context)` Retrieves the Relation for the specified LUI Person Relation
`List<String>`	`findAllValidLuisForPerson(String personId, String luiPersonRelationTypeKey, String relationState, String atpId, ContextInfo context)` Retrieves LUIs for an academic time period where the specified relation type and state would be valid for the specified person
`List<String>`	`findLuiIdsRelatedToPerson(String personId, String luiPersonRelationTypeKey, String relationState, ContextInfo context)` Retrieves the LUI Ids for Person related to LUI
`List<String>`	`findLuiPersonRelationIds(String personId, String luiId, ContextInfo context)` Retrieves LUI Person Relation Ids
`List<String>`	`findLuiPersonRelationIdsForLui(String luiId, ContextInfo context)` Retrieves LUIPersonRelation for LUI
`List<String>`	`findLuiPersonRelationIdsForPerson(String personId, ContextInfo context)` Retrieves LUI Person Relation Ids for Person
`List<LprInfo>`	`findLuiPersonRelations(String personId, String luiId, ContextInfo context)` Retrieves Person Relation for LUI
`List<LprInfo>`	`findLuiPersonRelationsByIdList(List<String> luiPersonRelationIdList, ContextInfo context)` Retrieves the Relation for the specified list of LUI Person Relation Ids
`List<LprInfo>`	`findLuiPersonRelationsForLui(String luiId, ContextInfo context)` Retrieves LUI Person Relation for a specified LUI
`List<LprInfo>`	`findLuiPersonRelationsForPerson(String personId, ContextInfo context)` Retrieves LUI Person Relation for Person
`List<String>`	`findPersonIdsRelatedToLui(String luiId, String luiPersonRelationTypeKey, String relationState, ContextInfo context)` Retrieves Person Ids related to the specified LUI
`LprInfo`	`updateLuiPersonRelation(String luiPersonRelationId, LprInfo luiPersonRelationInfo, ContextInfo context)` Update relation between Person and LUI
`List<ValidationResultInfo>`	`validateLuiPersonRelation(String validationType, LprInfo luiPersonRelationInfo, ContextInfo context)` Validates the particular relation in a state for a Person and LUI

Methods inherited from interface org.kuali.student.contract.model.test.source.TypeService
getAllowedTypesForType, getType, getTypeRelationsByOwnerType, getTypesByRefObjectURI

Methods inherited from interface org.kuali.student.contract.model.test.source.StateService
getInitialValidStates, getNextHappyState, getProcessKeys, getState, getStatesByProcess

Method Detail

fetchLuiPersonRelation

LprInfo fetchLuiPersonRelation(String luiPersonRelationId,
                             ContextInfo context)
                               throws DoesNotExistException,
                                      InvalidParameterException,
                                      MissingParameterException,
                                      OperationFailedException,
                                      PermissionDeniedException

Retrieves the Relation for the specified LUI Person Relation

Parameters:: luiPersonRelationId - Identifier for the LUI Person Relation; context - Context information containing the principalId and locale information about the caller of service operation
Returns:: LUI Person Relation information
Throws:: DoesNotExistException - luiPersonRelationId not found; InvalidParameterException - invalid luiPersonRelationId; MissingParameterException - missing luiPersonRelationId; OperationFailedException - unable to complete request; PermissionDeniedException - authorization failure

findLuiPersonRelationsByIdList

List<LprInfo> findLuiPersonRelationsByIdList(List<String> luiPersonRelationIdList,
                                           ContextInfo context)
                                             throws DoesNotExistException,
                                                    InvalidParameterException,
                                                    MissingParameterException,
                                                    OperationFailedException,
                                                    PermissionDeniedException

Retrieves the Relation for the specified list of LUI Person Relation Ids

Parameters:: luiPersonRelationIdList - List of identifiers for LUI Person Relations; context - Context information containing the principalId and locale information about the caller of service operation
Returns:: List of LUI Person Relation information
Throws:: DoesNotExistException - One or more luiPersonRelationIds not found; InvalidParameterException - One or more invalid luiPersonRelationIds; MissingParameterException - missing luiPersonRelationIdList; OperationFailedException - unable to complete request; PermissionDeniedException - authorization failure

findLuiIdsRelatedToPerson

List<String> findLuiIdsRelatedToPerson(String personId,
                                     String luiPersonRelationTypeKey,
                                     String relationState,
                                     ContextInfo context)
                                       throws DoesNotExistException,
                                              DisabledIdentifierException,
                                              InvalidParameterException,
                                              MissingParameterException,
                                              OperationFailedException,
                                              PermissionDeniedException

Retrieves the LUI Ids for Person related to LUI

Parameters:: personId - Identifier for the LUI Person Relation; luiPersonRelationTypeKey - Type of LUI Person Relation; relationState - Relation State; context - Context information containing the principalId and locale information about the caller of service operation
Returns:: Simple list of LUI Ids
Throws:: 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

findPersonIdsRelatedToLui

List<String> findPersonIdsRelatedToLui(String luiId,
                                     String luiPersonRelationTypeKey,
                                     String relationState,
                                     ContextInfo context)
                                       throws DoesNotExistException,
                                              InvalidParameterException,
                                              MissingParameterException,
                                              OperationFailedException,
                                              PermissionDeniedException

Retrieves Person Ids related to the specified LUI

Parameters:: luiId - Identifier for the LUI; luiPersonRelationTypeKey - Type of LUI Person Relation; relationState - Relation State; context - Context information containing the principalId and locale information about the caller of service operation
Returns:: Simple list of Person Ids
Throws:: 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

findLuiPersonRelations

List<LprInfo> findLuiPersonRelations(String personId,
                                   String luiId,
                                   ContextInfo context)
                                     throws DoesNotExistException,
                                            DisabledIdentifierException,
                                            InvalidParameterException,
                                            MissingParameterException,
                                            OperationFailedException,
                                            PermissionDeniedException

Retrieves Person Relation for LUI

Parameters:: personId - Identifier for person; luiId - Identifier for LUI; context - Context information containing the principalId and locale information about the caller of service operation
Returns:: List of LUI Person Relation info
Throws:: 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

findLuiPersonRelationIds

List<String> findLuiPersonRelationIds(String personId,
                                    String luiId,
                                    ContextInfo context)
                                      throws DoesNotExistException,
                                             DisabledIdentifierException,
                                             InvalidParameterException,
                                             MissingParameterException,
                                             OperationFailedException,
                                             PermissionDeniedException

Retrieves LUI Person Relation Ids

Parameters:: personId - Identifier for person; luiId - Identifier for LUI; context - Context information containing the principalId and locale information about the caller of service operation
Returns:: List of LUI Person Relation display info
Throws:: 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

findLuiPersonRelationsForPerson

List<LprInfo> findLuiPersonRelationsForPerson(String personId,
                                            ContextInfo context)
                                              throws DoesNotExistException,
                                                     DisabledIdentifierException,
                                                     InvalidParameterException,
                                                     MissingParameterException,
                                                     OperationFailedException,
                                                     PermissionDeniedException

Retrieves LUI Person Relation for Person

Parameters:: personId - Identifier for person; context - Context information containing the principalId and locale information about the caller of service operation
Returns:: List of LUI Person Relation info
Throws:: 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

findLuiPersonRelationIdsForPerson

List<String> findLuiPersonRelationIdsForPerson(String personId,
                                             ContextInfo context)
                                               throws DoesNotExistException,
                                                      DisabledIdentifierException,
                                                      InvalidParameterException,
                                                      MissingParameterException,
                                                      OperationFailedException,
                                                      PermissionDeniedException

Retrieves LUI Person Relation Ids for Person

Parameters:: personId - Identifier for person; context - Context information containing the principalId and locale information about the caller of service operation
Returns:: Simple list of person relation identifiers
Throws:: 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

findLuiPersonRelationsForLui

List<LprInfo> findLuiPersonRelationsForLui(String luiId,
                                         ContextInfo context)
                                           throws DoesNotExistException,
                                                  InvalidParameterException,
                                                  MissingParameterException,
                                                  OperationFailedException,
                                                  PermissionDeniedException

Retrieves LUI Person Relation for a specified LUI

Parameters:: luiId - Identifier for LUI; context - Context information containing the principalId and locale information about the caller of service operation
Returns:: List of LUI Person Relation info
Throws:: DoesNotExistException - luiId not found; InvalidParameterException - invalid luiId; MissingParameterException - missing luiId; OperationFailedException - unable to complete request; PermissionDeniedException - authorization failure

findLuiPersonRelationIdsForLui

List<String> findLuiPersonRelationIdsForLui(String luiId,
                                          ContextInfo context)
                                            throws DoesNotExistException,
                                                   InvalidParameterException,
                                                   MissingParameterException,
                                                   OperationFailedException,
                                                   PermissionDeniedException

Retrieves LUIPersonRelation for LUI

Parameters:: luiId - Identifier for LUI; context - Context information containing the principalId and locale information about the caller of service operation
Returns:: Simple list of LUI Person Relation identifiers
Throws:: DoesNotExistException - luiId not found; InvalidParameterException - invalid luiId; MissingParameterException - missing luiId; OperationFailedException - unable to complete request; PermissionDeniedException - authorization failure

validateLuiPersonRelation

List<ValidationResultInfo> validateLuiPersonRelation(String validationType,
                                                   LprInfo luiPersonRelationInfo,
                                                   ContextInfo context)
                                                     throws DoesNotExistException,
                                                            InvalidParameterException,
                                                            MissingParameterException,
                                                            OperationFailedException,
                                                            PermissionDeniedException

Validates the particular relation in a state for a Person and LUI

Parameters:: validationType - Identifier of the extent of validation; luiPersonRelationInfo - LuiPersonRelation to be validated; context - Context information containing the principalId and locale information about the caller of service operation
Returns:: list of validation results, list should be be zero length if no validation rsults are generated
Throws:: DoesNotExistException - luiPersonRelationInfo not found; InvalidParameterException - invalid luiPersonRelationInfo relationState; MissingParameterException - missing luiPersonRelationInfo; OperationFailedException - unable to complete request; PermissionDeniedException - authorization failure

findAllValidLuisForPerson

List<String> findAllValidLuisForPerson(String personId,
                                     String luiPersonRelationTypeKey,
                                     String relationState,
                                     String atpId,
                                     ContextInfo context)
                                       throws DoesNotExistException,
                                              DisabledIdentifierException,
                                              InvalidParameterException,
                                              MissingParameterException,
                                              OperationFailedException,
                                              PermissionDeniedException

Retrieves LUIs for an academic time period where the specified relation type and state would be valid for the specified person

Parameters:: personId - Identifier for person; luiPersonRelationTypeKey - Type of luiPersonRelationI; relationState - Relation State; atpId - Identifier for academic time period; context - Context information containing the principalId and locale information about the caller of service operation
Returns:: List of LUIs
Throws:: 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

createLuiPersonRelation

String createLuiPersonRelation(String personId,
                             String luiId,
                             String luiPersonRelationTypeKey,
                             LprInfo luiPersonRelationInfo,
                             ContextInfo context)
                               throws DataValidationErrorException,
                                      AlreadyExistsException,
                                      DoesNotExistException,
                                      DisabledIdentifierException,
                                      ReadOnlyException,
                                      InvalidParameterException,
                                      MissingParameterException,
                                      OperationFailedException,
                                      PermissionDeniedException

Creates relation between the specified Person and LUI

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

createBulkRelationshipsForPerson

List<String> createBulkRelationshipsForPerson(String personId,
                                            List<String> luiIdList,
                                            String relationState,
                                            String luiPersonRelationTypeKey,
                                            LprInfo luiPersonRelationInfo,
                                            ContextInfo context)
                                              throws DataValidationErrorException,
                                                     AlreadyExistsException,
                                                     DoesNotExistException,
                                                     DisabledIdentifierException,
                                                     ReadOnlyException,
                                                     InvalidParameterException,
                                                     MissingParameterException,
                                                     OperationFailedException,
                                                     PermissionDeniedException

Creates bulk relationships for one specified person. This is an all or nothing transaction - any error will invalidate the entire transaction.

Parameters:: personId - Identifier for Person; luiIdList - Simple list of LUI identifiers; relationState - Relation state; luiPersonRelationTypeKey - Type of LUI Person relation; luiPersonRelationInfo - Information required to create the LUI Person relation; context - Context information containing the principalId and locale information about the caller of service operation
Returns:: Structure containing LUI Person relation identifiers
Throws:: AlreadyExistsException - relation already exists; DataValidationErrorException - if luiPeronsRelationInfo is not valid; ReadOnlyException - attempt to update a read only attribute; DoesNotExistException - personId, luiId, relationState, luiPersonRelationTypeKey does not exist; DisabledIdentifierException - personId found, but has been retired; InvalidParameterException - invalid personId, luiId, relationState, luiPersonRelationTypeKey, luiPersonRelationInfo; MissingParameterException - missing personId, luiId, relationState, luiPersonRelationTypeKey, luiPersonRelationInfo; OperationFailedException - unable to complete request; PermissionDeniedException - authorization failure

createBulkRelationshipsForLui

List<String> createBulkRelationshipsForLui(String luiId,
                                         List<String> personIdList,
                                         String relationState,
                                         String luiPersonRelationTypeKey,
                                         LprInfo luiPersonRelationInfo,
                                         ContextInfo context)
                                           throws AlreadyExistsException,
                                                  DataValidationErrorException,
                                                  DoesNotExistException,
                                                  DisabledIdentifierException,
                                                  ReadOnlyException,
                                                  InvalidParameterException,
                                                  MissingParameterException,
                                                  OperationFailedException,
                                                  PermissionDeniedException

Creates bulk relationships for one specified LUI. This is an all or nothing transaction - any error will invalidate the entire transaction.

Parameters:: luiId - Identifier for Lui; personIdList - Simple list of Person identifiers; relationState - Relation state; luiPersonRelationTypeKey - Type of LUI Person relation; luiPersonRelationInfo - Information required to create the LUI Person relation; context - Context information containing the principalId and locale information about the caller of service operation
Returns:: Structure containing LUI Person relation identifiers
Throws:: AlreadyExistsException - relation already exists; DoesNotExistException - personId, luiId, relationState, luiPersonRelationTypeKey does not exist; DisabledIdentifierException - personId found, but has been retired; DataValidationErrorException - errors validating luiPersonRelationInfo with all data filled in; InvalidParameterException - invalid personId, luiId, relationState, luiPersonRelationTypeKey, luiPersonRelationInfo; MissingParameterException - missing personId, luiId, relationState, luiPersonRelationTypeKey, luiPersonRelationInfo; OperationFailedException - unable to complete request; ReadOnlyException - attempt to update a read only attribute; PermissionDeniedException - authorization failure

updateLuiPersonRelation

LprInfo updateLuiPersonRelation(String luiPersonRelationId,
                              LprInfo luiPersonRelationInfo,
                              ContextInfo context)
                                throws DoesNotExistException,
                                       DataValidationErrorException,
                                       InvalidParameterException,
                                       MissingParameterException,
                                       ReadOnlyException,
                                       OperationFailedException,
                                       PermissionDeniedException,
                                       VersionMismatchException

Update relation between Person and LUI

Parameters:: luiPersonRelationId - Identifier for the LUI Person Relation; luiPersonRelationInfo - Changed information about the LUI Person Relation; context - Context information containing the principalId and locale information about the caller of service operation
Returns:: Updated information about the LUI Person Relation
Throws:: DataValidationErrorException - if luiPersonRelationInfo is not valid; DoesNotExistException - luiPersonRelationId does not exist; 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

deleteLuiPersonRelation

StatusInfo deleteLuiPersonRelation(String luiPersonRelationId,
                                 ContextInfo context)
                                   throws DoesNotExistException,
                                          InvalidParameterException,
                                          MissingParameterException,
                                          OperationFailedException,
                                          PermissionDeniedException

Deletes relation between the specified Person and LUI

Parameters:: luiPersonRelationId - Identifier for the LUI Person Relation; context - Context information containing the principalId and locale information about the caller of service operation
Returns:: status of the operation (success, failed)
Throws:: DoesNotExistException - luiPersonRelationId does not exist; InvalidParameterException - invalid luiPersonRelationId; MissingParameterException - missing luiPersonRelationId; OperationFailedException - unable to complete request; PermissionDeniedException - authorization failure

Interface LprService