org.kuali.rice.kns.kim.role
Class RoleTypeServiceBase

java.lang.Object
  extended by org.kuali.rice.kns.kim.type.DataDictionaryTypeServiceBase
      extended by org.kuali.rice.kns.kim.role.RoleTypeServiceBase
All Implemented Interfaces:
DelegationTypeService, RoleTypeService, KimTypeService
Direct Known Subclasses:
CampusRoleTypeServiceImpl, DerivedRoleTypeServiceBase

Deprecated. A krad integrated type service base class will be provided in the future.

@Deprecated
public class RoleTypeServiceBase
extends DataDictionaryTypeServiceBase
implements RoleTypeService, DelegationTypeService


Nested Class Summary
 
Nested classes/interfaces inherited from class org.kuali.rice.kns.kim.type.DataDictionaryTypeServiceBase
DataDictionaryTypeServiceBase.KimTypeAttributeException, DataDictionaryTypeServiceBase.KimTypeAttributeValidationException
 
Field Summary
 
Fields inherited from class org.kuali.rice.kns.kim.type.DataDictionaryTypeServiceBase
COMMA_SEPARATOR
 
Constructor Summary
RoleTypeServiceBase()
          Deprecated.  
 
Method Summary
 Map<String,String> convertQualificationForMemberRoles(String namespaceCode, String roleName, String memberRoleNamespaceCode, String memberRoleName, Map<String,String> qualification)
          Deprecated. This base implementation simply returns the passed in Attributes.
 boolean doesDelegationQualifierMatchQualification(Map<String,String> qualification, Map<String,String> roleQualifier)
          Deprecated. Performs a simple check that the qualifier on the delegation matches the qualification.
 boolean doesRoleQualifierMatchQualification(Map<String,String> qualification, Map<String,String> roleQualifier)
          Deprecated. Performs a simple check that the qualifier on the role matches the qualification.
 boolean dynamicRoleMembership(String namespaceCode, String roleName)
          Deprecated. Returns false as a default
 List<RoleMembership> getMatchingRoleMemberships(Map<String,String> qualification, List<RoleMembership> roleMemberList)
          Deprecated. Gets whether a role membership with the given details is applicable for the given qualification.
 List<String> getQualifiersForExactMatch()
          Deprecated. Roles whose memberships may be matched exactly by qualifiers, this method returns the list of such qualifier names.
 List<RoleMembership> getRoleMembersFromDerivedRole(String namespaceCode, String roleName, Map<String,String> qualification)
          Deprecated. Return an empty list since this method should not be called by the role service for this service type.
 boolean hasDerivedRole(String principalId, List<String> groupIds, String namespaceCode, String roleName, Map<String,String> qualification)
          Deprecated. This simple initial implementation just calls #getRoleMembersFromApplicationRole(String, String, Map) and checks the results.
 boolean isDerivedRoleType()
          Deprecated. Default to not being a derived role type.
 List<RoleMembership> sortRoleMembers(List<RoleMembership> roleMembers)
          Deprecated. Base implementation: no sorting.
 
Methods inherited from class org.kuali.rice.kns.kim.type.DataDictionaryTypeServiceBase
areAttributesEqual, extractErrorsFromGlobalVariablesErrorMap, getAttributeDefinitions, getAttributeFormatter, getAttributeMaxValue, getAttributeMinValue, getAttributeValidatingExpression, getAttributeValue, getBusinessObjectService, getClosestParentDocumentTypeName, getDataDictionaryAttributeDefinition, getDataDictionaryService, getDictionaryValidationService, getDocumentTypeService, getNonDataDictionaryAttributeDefinition, getRequiredAttributes, getTypeInfoService, getUniqueAttributes, getWorkflowDocumentTypeName, getWorkflowRoutingAttributes, isCheckRequiredAttributes, performMatch, translateInputAttributes, validateAttributeFormat, validateAttributeRequired, validateAttributes, validateAttributesAgainstExisting, validateDataDictionaryAttribute, validateDataDictionaryAttribute, validateNonDataDictionaryAttribute, validatePrimitiveFromDescriptor, validateReferencesExistAndActive, validateRequiredAttributesAgainstReceived, validateUniqueAttributes, validateUnmodifiableAttributes
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 
Methods inherited from interface org.kuali.rice.kim.framework.type.KimTypeService
getAttributeDefinitions, getWorkflowDocumentTypeName, getWorkflowRoutingAttributes, validateAttributes, validateAttributesAgainstExisting, validateUniqueAttributes, validateUnmodifiableAttributes
 

Constructor Detail

RoleTypeServiceBase

public RoleTypeServiceBase()
Deprecated. 
Method Detail

doesRoleQualifierMatchQualification

public boolean doesRoleQualifierMatchQualification(Map<String,String> qualification,
                                                   Map<String,String> roleQualifier)
Deprecated. 
Performs a simple check that the qualifier on the role matches the qualification. Extra qualification attributes are ignored.

Specified by:
doesRoleQualifierMatchQualification in interface RoleTypeService
Parameters:
qualification - the qualification. cannot be null.
roleQualifier - the role qualifier. cannot be null.
Returns:
true if the qualifications match

getMatchingRoleMemberships

public List<RoleMembership> getMatchingRoleMemberships(Map<String,String> qualification,
                                                       List<RoleMembership> roleMemberList)
Deprecated. 
Description copied from interface: RoleTypeService
Gets whether a role membership with the given details is applicable for the given qualification.

Specified by:
getMatchingRoleMemberships in interface RoleTypeService
Parameters:
qualification - the qualification. cannot be null.
roleMemberList - the list of roleMemberships to check for matches. cannot be null.
Returns:
an immutable list of matched roleMemberships. will not return null.

getRoleMembersFromDerivedRole

public List<RoleMembership> getRoleMembersFromDerivedRole(String namespaceCode,
                                                          String roleName,
                                                          Map<String,String> qualification)
Deprecated. 
Return an empty list since this method should not be called by the role service for this service type. Subclasses which are application role types should override this method.

Specified by:
getRoleMembersFromDerivedRole in interface RoleTypeService

hasDerivedRole

public boolean hasDerivedRole(String principalId,
                              List<String> groupIds,
                              String namespaceCode,
                              String roleName,
                              Map<String,String> qualification)
Deprecated. 
This simple initial implementation just calls #getRoleMembersFromApplicationRole(String, String, Map) and checks the results.

Specified by:
hasDerivedRole in interface RoleTypeService
Parameters:
principalId - the principalId. cannot be null or blank.
groupIds - the groupIds the principal is a member of. cannot be null.
namespaceCode - the namespace code the role is in. cannot be blank or null.
roleName - the name of the role. cannot be blank or null.
qualification - the qualification. cannot be null.
Returns:
if the principal has a derived role.

isDerivedRoleType

public boolean isDerivedRoleType()
Deprecated. 
Default to not being a derived role type. Always returns false.

Specified by:
isDerivedRoleType in interface RoleTypeService
Returns:
true if derived type
See Also:
RoleTypeService.isDerivedRoleType()

convertQualificationForMemberRoles

public Map<String,String> convertQualificationForMemberRoles(String namespaceCode,
                                                             String roleName,
                                                             String memberRoleNamespaceCode,
                                                             String memberRoleName,
                                                             Map<String,String> qualification)
Deprecated. 
This base implementation simply returns the passed in Attributes.

Specified by:
convertQualificationForMemberRoles in interface RoleTypeService
Parameters:
namespaceCode - the namespace code the role is in. cannot be blank or null.
roleName - the name of the role. cannot be blank or null.
memberRoleNamespaceCode - the namespace code the member role is in. cannot be blank or null.
memberRoleName - the name of the member role. cannot be blank or null.
qualification - the qualification. cannot be null.
Returns:
an immutable map of qualifiers. Will never return null.
See Also:
org.kuali.rice.kim.framework.role.RoleTypeService#convertQualificationForMemberRoles(String, String, String, String, Map)

doesDelegationQualifierMatchQualification

public boolean doesDelegationQualifierMatchQualification(Map<String,String> qualification,
                                                         Map<String,String> roleQualifier)
Deprecated. 
Performs a simple check that the qualifier on the delegation matches the qualification. Extra qualification attributes are ignored.

Specified by:
doesDelegationQualifierMatchQualification in interface DelegationTypeService
Parameters:
qualification - the qualification. cannot be null.
roleQualifier - the delegation qualifier. cannot be null.
Returns:
true if the qualifications match

dynamicRoleMembership

public boolean dynamicRoleMembership(String namespaceCode,
                                     String roleName)
Deprecated. 
Returns false as a default

Specified by:
dynamicRoleMembership in interface RoleTypeService
Parameters:
namespaceCode - the namespace code of the role. cannot be null or blank
roleName - the name of the role. cannot be null or blank.
Returns:
true if the membership results of the Role are dynamic, false otherwise
See Also:
RoleTypeService.dynamicRoleMembership(java.lang.String, java.lang.String)

getQualifiersForExactMatch

public List<String> getQualifiersForExactMatch()
Deprecated. 
Description copied from interface: RoleTypeService
Roles whose memberships may be matched exactly by qualifiers, this method returns the list of such qualifier names.

Specified by:
getQualifiersForExactMatch in interface RoleTypeService
Returns:
immutable list of qualifier names that can be used for exact match. Will never return null.

sortRoleMembers

public List<RoleMembership> sortRoleMembers(List<RoleMembership> roleMembers)
                                     throws RiceIllegalArgumentException
Deprecated. 
Base implementation: no sorting. Just returns the input list.

Specified by:
sortRoleMembers in interface RoleTypeService
Returns:
an immutable list of matched roleMemberships. will not return null.
Throws:
RiceIllegalArgumentException - if the roleMemberships is null.


Copyright © 2005-2012 The Kuali Foundation. All Rights Reserved.