org.kuali.kpme.core.service.group

Interface KPMEGroupService

All Known Implementing Classes:

KPMEGroupServiceImpl

public interface KPMEGroupService

Method Summary

Methods

Modifier and Type	Method and Description
boolean	isMemberOfGroup(String principalId, String groupName, org.joda.time.DateTime asOfDate) Checks whether the given principalId is a member of the group groupName.
boolean	isMemberOfGroupWithId(String principalId, String groupId, org.joda.time.DateTime asOfDate)
boolean	isMemberOfSystemAdministratorGroup(String principalId, org.joda.time.DateTime asOfDate) Checks whether the given principalId is a system administrator.
boolean	isMemberOfSystemViewOnlyGroup(String principalId, org.joda.time.DateTime asOfDate) Checks whether the given principalId is a system view only user.

Method Detail

isMemberOfGroup

@Cacheable(value="http://rice.kuali.org/kim/v2_0/GroupMemberType",
           key="\'{KPME|isMemberOfGroup}\' + \'principal=\' + #p0 + \'|\' + \'groupName=\' + #p1 + \'|\' + \'asOfDate=\' + #p2")
boolean isMemberOfGroup(String principalId,
                                String groupName,
                                org.joda.time.DateTime asOfDate)

Checks whether the given principalId is a member of the group groupName.

Parameters:

principalId - The person to check the group membership for

groupName - The name of the group

asOfDate - The effective date of the group membership

Returns:

true if principalId is a member of the group groupName, false otherwise.

isMemberOfGroupWithId

@Cacheable(value="http://rice.kuali.org/kim/v2_0/GroupMemberType",
           key="\'{KPME|isMemberOfGroupWithId}\' + \'principal=\' + #p0 + \'|\' + \'groupId=\' + #p1 + \'|\' + \'asOfDate=\' + #p2")
boolean isMemberOfGroupWithId(String principalId,
                                      String groupId,
                                      org.joda.time.DateTime asOfDate)

isMemberOfSystemAdministratorGroup

@Cacheable(value="http://rice.kuali.org/kim/v2_0/GroupMemberType",
           key="\'{KPME|isMemberOfSystemAdministratorGroup}\' + \'principal=\' + #p0 + \'|\' + \'asOfDate=\' + #p1")
boolean isMemberOfSystemAdministratorGroup(String principalId,
                                                   org.joda.time.DateTime asOfDate)

Checks whether the given principalId is a system administrator.

Parameters:

principalId - The person to check the group membership for

asOfDate - The effective date of the group membership

Returns:

true if principalId is a system administrator, false otherwise

isMemberOfSystemViewOnlyGroup

@Cacheable(value="http://rice.kuali.org/kim/v2_0/GroupMemberType",
           key="\'{KPME|isMemberOfSystemViewOnlyGroup}\' + \'principal=\' + #p0 + \'|\' + \'asOfDate=\' + #p1")
boolean isMemberOfSystemViewOnlyGroup(String principalId,
                                              org.joda.time.DateTime asOfDate)

Checks whether the given principalId is a system view only user.

Parameters:

principalId - The person to check the group membership for

asOfDate - The effective date of the group membership

Returns:

true if principalId is a system view only user, false otherwise