org.sakaiproject.api.common.edu.person

Interface SakaiPersonManager

public interface SakaiPersonManager

Author:

Lance Speelmon

Method Summary

Methods

Modifier and Type	Method and Description
SakaiPerson	create(String agentUuid, Type recordType) Creates a persistent SakaiPerson record.
void	delete(SakaiPerson sakaiPerson) Removes SakaiPerson from persistent state.
List<SakaiPerson>	findAllFerpaEnabled() Find all SakaiPerson objects where ferpaEnabled == TRUE.
List<SakaiPerson>	findSakaiPerson(SakaiPerson queryByExample) Query-by-Example finder signature.
List<SakaiPerson>	findSakaiPerson(String simpleSearchCriteria) Search the "common" SakaiPerson fields for a given String.
List<SakaiPerson>	findSakaiPersonByUid(String uid) Retrieve SakaiPerson by uid (username).
SakaiPerson	getPrototype() Get a new instantiation of an empty SakaiPerson object (has no persistent state).
SakaiPerson	getSakaiPerson(String agentUuid, Type recordType) Find all SakaiPerson objects with specified type.
SakaiPerson	getSakaiPerson(Type recordType) Assumes current user.
Map<String,SakaiPerson>	getSakaiPersons(Set<String> userIds, Type userMutableType) Finds all SakaiPerson objects with the specified type, whos IDs are contained in the userIds collection.
Type	getSystemMutableType() Returns the systemMutableType constant.
Type	getUserMutableType() Returns the userMutableType constant.
List<String>	isFerpaEnabled(Collection<String> agentUuids) Composite call to determine if a Set of Agents have the FERPA flag enabled.
void	save(SakaiPerson sakaiPerson) Save or update the SakaiPerson bean.

Method Detail

create

SakaiPerson create(String agentUuid,
                 Type recordType)

Creates a persistent SakaiPerson record.

Parameters:

agentUuid -

recordType - getSystemMutableType() or getUserMutableType()

Returns:

getPrototype

SakaiPerson getPrototype()

Get a new instantiation of an empty SakaiPerson object (has no persistent state). For example, useful if you query-by-example finder method.

Returns:

findSakaiPersonByUid

List<SakaiPerson> findSakaiPersonByUid(String uid)

Retrieve SakaiPerson by uid (username).

Parameters:

uid - username

Returns:

List of SakaiPerson objects incuding both system and user mutable Types.

findSakaiPerson

List<SakaiPerson> findSakaiPerson(SakaiPerson queryByExample)

Query-by-Example finder signature.

Parameters:

queryByExample - A SakaiPerson protoype. All non-null preoperties will be searched using a logical AND.

Returns:

getSakaiPerson

SakaiPerson getSakaiPerson(Type recordType)

Assumes current user. If you would like to specify the user, see #findSakaiPerson(String, Type).

Parameters:

recordType - See getSystemMutableType() or getUserMutableType().

Returns:

getSakaiPerson

SakaiPerson getSakaiPerson(String agentUuid,
                         Type recordType)

Find all SakaiPerson objects with specified type. Types should be obtained through the Type constant getter methods.

Parameters:

agent -

recordType - See getSystemMutableType() or getUserMutableType().

Returns:

getSakaiPersons

Map<String,SakaiPerson> getSakaiPersons(Set<String> userIds,
                                      Type userMutableType)

Finds all SakaiPerson objects with the specified type, whos IDs are contained in the userIds collection.

Parameters:

userIds -

userMutableType -

Returns:

getUserMutableType

Type getUserMutableType()

Returns the userMutableType constant. SakaiPerson's of this Type allow the user to modify all attributes.

Returns:

getSystemMutableType

Type getSystemMutableType()

Returns the systemMutableType constant. SakaiPerson's of this Type can only be modified by the "system", i.e. not the end user, and would normally consist of enterprise data (e.g. LDAP, etc).

Returns:

save

void save(SakaiPerson sakaiPerson)

Save or update the SakaiPerson bean.

Parameters:

sakaiPerson -

delete

void delete(SakaiPerson sakaiPerson)

Removes SakaiPerson from persistent state.

Parameters:

sakaiPerson -

findSakaiPerson

List<SakaiPerson> findSakaiPerson(String simpleSearchCriteria)

Search the "common" SakaiPerson fields for a given String.

Parameters:

simpleSearchCriteria - String used to search for SakaiPerson objects where the following properties are like this String: uid, givenName, surname.

Returns:

isFerpaEnabled

List<String> isFerpaEnabled(Collection<String> agentUuids)

Composite call to determine if a Set of Agents have the FERPA flag enabled.

Parameters:

agentUuids -

Returns:

A List of agentUuid Strings where FERPA is enabled.

findAllFerpaEnabled

List<SakaiPerson> findAllFerpaEnabled()

Find all SakaiPerson objects where ferpaEnabled == TRUE.

Returns:

A List of SakaiPerson objects where ferpaEnabled == TRUE.