org.kuali.kra.service

Interface KcPersonService

All Known Implementing Classes:

KcPersonServiceImpl

public interface KcPersonService

Service for working with KcPerson objects.

Method Summary

Methods

Modifier and Type	Method and Description
List<KcPerson>	createKcPersonsFromPeople(List<org.kuali.rice.kim.api.identity.Person> people)
KcPerson	getKcPersonByPersonId(String personId) Gets a KcPerson from a person id (kim principal id).
KcPerson	getKcPersonByUserName(String userName) Gets a KcPerson from a user name (kim principal name).
List<KcPerson>	getKcPersons(Map<String,String> fieldValues) Gets a list of KcPerson based on KcPerson fieldValues.
void	modifyFieldValues(Map<String,String> fieldValues)

Method Detail

getKcPersons

List<KcPerson> getKcPersons(Map<String,String> fieldValues)

Gets a list of KcPerson based on KcPerson fieldValues.

Parameters:

fieldValues - the field values.

Returns:

the list of KcPersons. Will never return a null list.

Throws:

IllegalArgumentException - if the fieldValues is null

getKcPersonByUserName

KcPerson getKcPersonByUserName(String userName)

Gets a KcPerson from a user name (kim principal name).

Parameters:

userName - the user name

Returns:

the KcPerson

Throws:

IllegalArgumentException - if the userName is null or empty

getKcPersonByPersonId

KcPerson getKcPersonByPersonId(String personId)

Gets a KcPerson from a person id (kim principal id).

Parameters:

personId - the person id

Returns:

the KcPerson

Throws:

IllegalArgumentException - if the personId is null or empty

modifyFieldValues

void modifyFieldValues(Map<String,String> fieldValues)

createKcPersonsFromPeople

List<KcPerson> createKcPersonsFromPeople(List<org.kuali.rice.kim.api.identity.Person> people)