org.kuali.rice.kim.service
Interface UiDocumentService

All Known Implementing Classes:

LdapUiDocumentServiceImpl, UiDocumentServiceImpl

public interface UiDocumentService

This is a description of what this class does - shyu don't forget to fill this in.

Author:

Kuali Rice Team (rice.collab@kuali.org)

Method Summary

boolean	canModifyEntity(String currentUserPrincipalId, String toModifyPrincipalId)
boolean	canOverrideEntityPrivacyPreferences(String currentUserPrincipalId, String toModifyPrincipalId)
void	clearRestrictedRoleMembersSearchResults(IdentityManagementRoleDocument identityManagementRoleDocument) This method loads a document's original role members
Map<String,Object>	getAttributeEntries(List<KimAttributeField> definitions) This method is to set up the DD attribute entry map for role qualifiers, so it can be rendered.
List<EntityEmployment>	getEntityEmploymentInformationInfo(String entityId)
KimDocumentRoleMember	getKimDocumentRoleMember(MemberType memberType, String memberId, String roleId)
BusinessObject	getMember(MemberType memberType, String memberId)
String	getMemberIdByName(MemberType memberType, String memberNamespaceCode, String memberName)
String	getMemberName(MemberType memberType, BusinessObject member)
String	getMemberName(MemberType memberType, String memberId)
String	getMemberNamespaceCode(MemberType memberType, BusinessObject member)
String	getMemberNamespaceCode(MemberType memberType, String memberId)
List<org.kuali.rice.kim.impl.common.delegate.DelegateTypeBo>	getRoleDelegations(String roleId)
org.kuali.rice.kim.impl.role.RoleMemberBo	getRoleMember(String roleMemberId)
List<org.kuali.rice.kim.impl.role.RoleResponsibilityActionBo>	getRoleMemberResponsibilityActionImpls(String roleMemberId)
List<KimDocumentRoleMember>	getRoleMembers(Map<String,String> fieldValues)
void	loadEntityToPersonDoc(IdentityManagementPersonDocument identityManagementPersonDocument, String principalId) This method is to load identity to person document pending Bos when user 'initiate' a document for 'editing' identity.
void	loadGroupDoc(IdentityManagementGroupDocument identityManagementGroupDocument, Group kimGroup) This method loads a role document
void	loadRoleDoc(IdentityManagementRoleDocument identityManagementRoleDocument, Role kimRole) This method loads a role document
void	loadRoleMembersBasedOnSearch(IdentityManagementRoleDocument identityManagementRoleDocument, String memberSearchValue) This method loads a role document members based on search criteria
void	saveEntityPerson(IdentityManagementPersonDocument identityManagementPersonDocument) This method to populate Entity tables from person document pending tables when it is approved.
void	saveGroup(IdentityManagementGroupDocument identityManagementGroupDocument) This method ...
void	saveRole(IdentityManagementRoleDocument identityManagementRoleDocument) This method ...
void	setDelegationMembersInDocument(IdentityManagementRoleDocument identityManagementRoleDocument)
void	setMembersInDocument(IdentityManagementRoleDocument identityManagementRoleDocument)

Method Detail

saveEntityPerson

@CacheEvict(value={"http://rice.kuali.org/kim/v2_0/EntityType","http://rice.kuali.org/kim/v2_0/EntityDefaultType","http://rice.kuali.org/kim/v2_0/PrincipalType","http://rice.kuali.org/kim/v2_0/GroupMemberType","http://rice.kuali.org/kim/v2_0/RoleMemberType"},
            allEntries=true)
void saveEntityPerson(IdentityManagementPersonDocument identityManagementPersonDocument)

This method to populate Entity tables from person document pending tables when it is approved.

Parameters:

identityManagementPersonDocument -

getAttributeEntries

Map<String,Object> getAttributeEntries(List<KimAttributeField> definitions)

This method is to set up the DD attribute entry map for role qualifiers, so it can be rendered.

Parameters:

definitions -

loadEntityToPersonDoc

void loadEntityToPersonDoc(IdentityManagementPersonDocument identityManagementPersonDocument,
                           String principalId)

This method is to load identity to person document pending Bos when user 'initiate' a document for 'editing' identity.

Parameters:

identityManagementPersonDocument -

principalId -

loadRoleDoc

void loadRoleDoc(IdentityManagementRoleDocument identityManagementRoleDocument,
                 Role kimRole)

This method loads a role document

Parameters:

identityManagementRoleDocument -

loadRoleMembersBasedOnSearch

void loadRoleMembersBasedOnSearch(IdentityManagementRoleDocument identityManagementRoleDocument,
                                  String memberSearchValue)

This method loads a role document members based on search criteria

Parameters:

identityManagementRoleDocument -

clearRestrictedRoleMembersSearchResults

void clearRestrictedRoleMembersSearchResults(IdentityManagementRoleDocument identityManagementRoleDocument)

This method loads a document's original role members

Parameters:

identityManagementRoleDocument -

saveRole

@CacheEvict(value={"http://rice.kuali.org/kim/v2_0/RoleType","http://rice.kuali.org/kim/v2_0/RoleMemberType","http://rice.kuali.org/kim/v2_0/PermissionType"},
            allEntries=true)
void saveRole(IdentityManagementRoleDocument identityManagementRoleDocument)

This method ...

Parameters:

identityManagementRoleDocument -

loadGroupDoc

void loadGroupDoc(IdentityManagementGroupDocument identityManagementGroupDocument,
                  Group kimGroup)

This method loads a role document

Parameters:

identityManagementGroupDocument -

saveGroup

@CacheEvict(value={"http://rice.kuali.org/kim/v2_0/GroupType","http://rice.kuali.org/kim/v2_0/GroupMemberType","http://rice.kuali.org/kim/v2_0/RoleType"},
            allEntries=true)
void saveGroup(IdentityManagementGroupDocument identityManagementGroupDocument)

This method ...

Parameters:

identityManagementGroupDocument -

getMember

BusinessObject getMember(MemberType memberType,
                         String memberId)

getMemberName

String getMemberName(MemberType memberType,
                     String memberId)

getMemberNamespaceCode

String getMemberNamespaceCode(MemberType memberType,
                              String memberId)

getMemberName

String getMemberName(MemberType memberType,
                     BusinessObject member)

getMemberNamespaceCode

String getMemberNamespaceCode(MemberType memberType,
                              BusinessObject member)

getRoleMemberResponsibilityActionImpls

List<org.kuali.rice.kim.impl.role.RoleResponsibilityActionBo> getRoleMemberResponsibilityActionImpls(String roleMemberId)

getRoleDelegations

List<org.kuali.rice.kim.impl.common.delegate.DelegateTypeBo> getRoleDelegations(String roleId)

getKimDocumentRoleMember

KimDocumentRoleMember getKimDocumentRoleMember(MemberType memberType,
                                               String memberId,
                                               String roleId)

getMemberIdByName

String getMemberIdByName(MemberType memberType,
                         String memberNamespaceCode,
                         String memberName)

setDelegationMembersInDocument

void setDelegationMembersInDocument(IdentityManagementRoleDocument identityManagementRoleDocument)

setMembersInDocument

void setMembersInDocument(IdentityManagementRoleDocument identityManagementRoleDocument)

getRoleMember

org.kuali.rice.kim.impl.role.RoleMemberBo getRoleMember(String roleMemberId)

getRoleMembers

List<KimDocumentRoleMember> getRoleMembers(Map<String,String> fieldValues)

canModifyEntity

boolean canModifyEntity(String currentUserPrincipalId,
                        String toModifyPrincipalId)

canOverrideEntityPrivacyPreferences

boolean canOverrideEntityPrivacyPreferences(String currentUserPrincipalId,
                                            String toModifyPrincipalId)

getEntityEmploymentInformationInfo

List<EntityEmployment> getEntityEmploymentInformationInfo(String entityId)