Index (Rice KIM Framework 2.5.10 API)

C D E G H I K O P R S V

C

convertQualificationForMemberRoles(String, String, String, String, Map<String, String>) - Method in interface org.kuali.rice.kim.framework.role.RoleTypeService: Deprecated.
use convertQualificationForMemberRolesAndMemberAttributes
convertQualificationForMemberRolesAndMemberAttributes(String, String, String, String, Map<String, String>, Map<String, String>) - Method in interface org.kuali.rice.kim.framework.role.RoleTypeService: Takes the passed in qualifications and converts them, if necessary, for any downstream roles which may be present.

D

DelegationTypeService - Interface in org.kuali.rice.kim.framework.common.delegate: A KimTypeService with specific methods for Delegations.
doesDelegationQualifierMatchQualification(Map<String, String>, Map<String, String>) - Method in interface org.kuali.rice.kim.framework.common.delegate.DelegationTypeService: Gets whether a role assignment with the given qualifier is applicable for the given qualification.
doesRoleQualifierMatchQualification(Map<String, String>, Map<String, String>) - Method in interface org.kuali.rice.kim.framework.role.RoleTypeService: Gets whether a role assignment with the given qualifier is applicable for the given qualification.
dynamicRoleMembership(String, String) - Method in interface org.kuali.rice.kim.framework.role.RoleTypeService: Determines if the role specified by the given namespace and role name has a dynamic role membership.

E

EntityAddressTypeContractEbo - Interface in org.kuali.rice.kim.framework.identity.address
EntityAddressTypeEbo - Interface in org.kuali.rice.kim.framework.identity.address: TODO: Likely should remove all methods from this interface after KULRICE-7170 is fixed
EntityAffiliationTypeEbo - Interface in org.kuali.rice.kim.framework.identity.affiliation: TODO: Likely should remove all methods from this interface after KULRICE-7170 is fixed
EntityCitizenshipChangeTypeEbo - Interface in org.kuali.rice.kim.framework.identity.citizenship: TODO: Likely should remove all methods from this interface after KULRICE-7170 is fixed
EntityCitizenshipStatusContractEbo - Interface in org.kuali.rice.kim.framework.identity.citizenship
EntityCitizenshipStatusEbo - Interface in org.kuali.rice.kim.framework.identity.citizenship: TODO: Likely should remove all methods from this interface after KULRICE-7170 is fixed
EntityEmailTypeContractEbo - Interface in org.kuali.rice.kim.framework.identity.email
EntityEmailTypeEbo - Interface in org.kuali.rice.kim.framework.identity.email: TODO: Likely should remove all methods from this interface after KULRICE-7170 is fixed
EntityEmploymentStatusContractEbo - Interface in org.kuali.rice.kim.framework.identity.employment
EntityEmploymentStatusEbo - Interface in org.kuali.rice.kim.framework.identity.employment: TODO: Likely should remove all methods from this interface after KULRICE-7170 is fixed
EntityEmploymentTypeContractEbo - Interface in org.kuali.rice.kim.framework.identity.employment
EntityEmploymentTypeEbo - Interface in org.kuali.rice.kim.framework.identity.employment: TODO: Likely should remove all methods from this interface after KULRICE-7170 is fixed
EntityExternalIdentifierTypeEbo - Interface in org.kuali.rice.kim.framework.identity.external: TODO: Likely should remove all methods from this interface after KULRICE-7170 is fixed
EntityNameTypeContractEbo - Interface in org.kuali.rice.kim.framework.identity.name
EntityNameTypeEbo - Interface in org.kuali.rice.kim.framework.identity.name: TODO: Likely should remove all methods from this interface after KULRICE-7170 is fixed
EntityPhoneTypeContractEbo - Interface in org.kuali.rice.kim.framework.identity.phone
EntityPhoneTypeEbo - Interface in org.kuali.rice.kim.framework.identity.phone: TODO: Likely should remove all methods from this interface after KULRICE-7170 is fixed
EntityTypeContractEbo - Interface in org.kuali.rice.kim.framework.identity
EntityTypeEbo - Interface in org.kuali.rice.kim.framework.identity: TODO: Likely should remove all methods from this interface after KULRICE-7170 is fixed

G

getAttributeDefinitions(String) - Method in interface org.kuali.rice.kim.framework.type.KimTypeService: Gets a List of KimAttributeField for a kim type id.
getAttributes() - Method in interface org.kuali.rice.kim.framework.group.GroupEbo: This is a set of Attributes for a Group.
getCode() - Method in interface org.kuali.rice.kim.framework.identity.address.EntityAddressTypeEbo: The code value for this object.
getCode() - Method in interface org.kuali.rice.kim.framework.identity.affiliation.EntityAffiliationTypeEbo: The code value for this object.
getCode() - Method in interface org.kuali.rice.kim.framework.identity.citizenship.EntityCitizenshipChangeTypeEbo: The code value for this object.
getCode() - Method in interface org.kuali.rice.kim.framework.identity.citizenship.EntityCitizenshipStatusEbo: The code value for this object.
getCode() - Method in interface org.kuali.rice.kim.framework.identity.email.EntityEmailTypeEbo: The code value for this object.
getCode() - Method in interface org.kuali.rice.kim.framework.identity.employment.EntityEmploymentStatusEbo: The code value for this object.
getCode() - Method in interface org.kuali.rice.kim.framework.identity.employment.EntityEmploymentTypeEbo: The code value for this object.
getCode() - Method in interface org.kuali.rice.kim.framework.identity.EntityTypeEbo: The code value for this object.
getCode() - Method in interface org.kuali.rice.kim.framework.identity.external.EntityExternalIdentifierTypeEbo: The code value for this object.
getCode() - Method in interface org.kuali.rice.kim.framework.identity.name.EntityNameTypeEbo: The code value for this object.
getCode() - Method in interface org.kuali.rice.kim.framework.identity.phone.EntityPhoneTypeEbo: The code value for this object.
getDescription() - Method in interface org.kuali.rice.kim.framework.group.GroupEbo: This a description for the Group.
getDescription() - Method in interface org.kuali.rice.kim.framework.role.RoleEbo: A full textual description of this role.
getId() - Method in interface org.kuali.rice.kim.framework.group.GroupEbo: The unique identifier for an object.
getId() - Method in interface org.kuali.rice.kim.framework.role.RoleEbo: The unique identifier for an object.
getKimTypeId() - Method in interface org.kuali.rice.kim.framework.group.GroupEbo: This a Kim Type Id for the Group.
getKimTypeId() - Method in interface org.kuali.rice.kim.framework.role.RoleEbo: Provides the associated KimType identifier for this role.
getKimTypeService(KimType) - Static method in class org.kuali.rice.kim.framework.services.KimFrameworkServiceLocator: Fetches the KimTypeService for the given KimType If the kimType passed in is null then this method will return null.
getKimTypeService(QName) - Static method in class org.kuali.rice.kim.framework.services.KimFrameworkServiceLocator: Fetches the KimTypeService for the given kim type service name.
getMatchingPermissions(Map<String, String>, List<Permission>) - Method in interface org.kuali.rice.kim.framework.permission.PermissionTypeService: Gets whether a permission assignment with the given details is applicable for the given request details.
getMatchingResponsibilities(Map<String, String>, List<Responsibility>) - Method in interface org.kuali.rice.kim.framework.responsibility.ResponsibilityTypeService: Gets whether a responsibility assignment with the given details is applicable for the given request details.
getMatchingRoleMemberships(Map<String, String>, List<RoleMembership>) - Method in interface org.kuali.rice.kim.framework.role.RoleTypeService: Gets whether a role membership with the given details is applicable for the given qualification.
getName() - Method in interface org.kuali.rice.kim.framework.group.GroupEbo: This is the name for the Group.
getName() - Method in interface org.kuali.rice.kim.framework.identity.address.EntityAddressTypeEbo: This the name for the AddressType.
getName() - Method in interface org.kuali.rice.kim.framework.identity.affiliation.EntityAffiliationTypeEbo: This the name for the AddressType.
getName() - Method in interface org.kuali.rice.kim.framework.identity.citizenship.EntityCitizenshipChangeTypeEbo: This the name for the EntityCitizenshipChangeType.
getName() - Method in interface org.kuali.rice.kim.framework.identity.citizenship.EntityCitizenshipStatusEbo: This the name for the AddressType.
getName() - Method in interface org.kuali.rice.kim.framework.identity.email.EntityEmailTypeEbo: This the name for the AddressType.
getName() - Method in interface org.kuali.rice.kim.framework.identity.employment.EntityEmploymentStatusEbo: This the name for the AddressType.
getName() - Method in interface org.kuali.rice.kim.framework.identity.employment.EntityEmploymentTypeEbo: This the name for the AddressType.
getName() - Method in interface org.kuali.rice.kim.framework.identity.EntityTypeEbo: This the name for the AddressType.
getName() - Method in interface org.kuali.rice.kim.framework.identity.external.EntityExternalIdentifierTypeEbo: This the name for the AddressType.
getName() - Method in interface org.kuali.rice.kim.framework.identity.name.EntityNameTypeEbo: This the name for the AddressType.
getName() - Method in interface org.kuali.rice.kim.framework.identity.phone.EntityPhoneTypeEbo: This the name for the AddressType.
getName() - Method in interface org.kuali.rice.kim.framework.role.RoleEbo: The human readable name for this role.
getNamespaceCode() - Method in interface org.kuali.rice.kim.framework.group.GroupEbo: This is the namespace code for the Group.
getNamespaceCode() - Method in interface org.kuali.rice.kim.framework.role.RoleEbo: A namespace for this role.
getObjectId() - Method in interface org.kuali.rice.kim.framework.group.GroupEbo: Return the globally unique object id of this object.
getObjectId() - Method in interface org.kuali.rice.kim.framework.identity.address.EntityAddressTypeEbo: Return the globally unique object id of this object.
getObjectId() - Method in interface org.kuali.rice.kim.framework.identity.affiliation.EntityAffiliationTypeEbo: Return the globally unique object id of this object.
getObjectId() - Method in interface org.kuali.rice.kim.framework.identity.citizenship.EntityCitizenshipChangeTypeEbo: Return the globally unique object id of this object.
getObjectId() - Method in interface org.kuali.rice.kim.framework.identity.citizenship.EntityCitizenshipStatusEbo: Return the globally unique object id of this object.
getObjectId() - Method in interface org.kuali.rice.kim.framework.identity.email.EntityEmailTypeEbo: Return the globally unique object id of this object.
getObjectId() - Method in interface org.kuali.rice.kim.framework.identity.employment.EntityEmploymentStatusEbo: Return the globally unique object id of this object.
getObjectId() - Method in interface org.kuali.rice.kim.framework.identity.employment.EntityEmploymentTypeEbo: Return the globally unique object id of this object.
getObjectId() - Method in interface org.kuali.rice.kim.framework.identity.EntityTypeEbo: Return the globally unique object id of this object.
getObjectId() - Method in interface org.kuali.rice.kim.framework.identity.external.EntityExternalIdentifierTypeEbo: Return the globally unique object id of this object.
getObjectId() - Method in interface org.kuali.rice.kim.framework.identity.name.EntityNameTypeEbo: Return the globally unique object id of this object.
getObjectId() - Method in interface org.kuali.rice.kim.framework.identity.phone.EntityPhoneTypeEbo: Return the globally unique object id of this object.
getObjectId() - Method in interface org.kuali.rice.kim.framework.role.RoleEbo: Return the globally unique object id of this object.
getQualifiersForExactMatch() - Method in interface org.kuali.rice.kim.framework.role.RoleTypeService: Roles whose memberships may be matched exactly by qualifiers, this method returns the list of such qualifier names.
getRoleMembersFromDerivedRole(String, String, Map<String, String>) - Method in interface org.kuali.rice.kim.framework.role.RoleTypeService
getSortCode() - Method in interface org.kuali.rice.kim.framework.identity.address.EntityAddressTypeEbo: This the sort code for the AddressType.
getSortCode() - Method in interface org.kuali.rice.kim.framework.identity.affiliation.EntityAffiliationTypeEbo: This the sort code for the AddressType.
getSortCode() - Method in interface org.kuali.rice.kim.framework.identity.citizenship.EntityCitizenshipChangeTypeEbo: This the sort code for the EntityCitizenshipChangeType.
getSortCode() - Method in interface org.kuali.rice.kim.framework.identity.citizenship.EntityCitizenshipStatusEbo: This the sort code for the AddressType.
getSortCode() - Method in interface org.kuali.rice.kim.framework.identity.email.EntityEmailTypeEbo: This the sort code for the AddressType.
getSortCode() - Method in interface org.kuali.rice.kim.framework.identity.employment.EntityEmploymentStatusEbo: This the sort code for the AddressType.
getSortCode() - Method in interface org.kuali.rice.kim.framework.identity.employment.EntityEmploymentTypeEbo: This the sort code for the AddressType.
getSortCode() - Method in interface org.kuali.rice.kim.framework.identity.EntityTypeEbo: This the sort code for the AddressType.
getSortCode() - Method in interface org.kuali.rice.kim.framework.identity.external.EntityExternalIdentifierTypeEbo: This the sort code for the AddressType.
getSortCode() - Method in interface org.kuali.rice.kim.framework.identity.name.EntityNameTypeEbo: This the sort code for the AddressType.
getSortCode() - Method in interface org.kuali.rice.kim.framework.identity.phone.EntityPhoneTypeEbo: This the sort code for the AddressType.
getVersionNumber() - Method in interface org.kuali.rice.kim.framework.group.GroupEbo: Returns the version number for this object.
getVersionNumber() - Method in interface org.kuali.rice.kim.framework.identity.address.EntityAddressTypeEbo: Returns the version number for this object.
getVersionNumber() - Method in interface org.kuali.rice.kim.framework.identity.affiliation.EntityAffiliationTypeEbo: Returns the version number for this object.
getVersionNumber() - Method in interface org.kuali.rice.kim.framework.identity.citizenship.EntityCitizenshipChangeTypeEbo: Returns the version number for this object.
getVersionNumber() - Method in interface org.kuali.rice.kim.framework.identity.citizenship.EntityCitizenshipStatusEbo: Returns the version number for this object.
getVersionNumber() - Method in interface org.kuali.rice.kim.framework.identity.email.EntityEmailTypeEbo: Returns the version number for this object.
getVersionNumber() - Method in interface org.kuali.rice.kim.framework.identity.employment.EntityEmploymentStatusEbo: Returns the version number for this object.
getVersionNumber() - Method in interface org.kuali.rice.kim.framework.identity.employment.EntityEmploymentTypeEbo: Returns the version number for this object.
getVersionNumber() - Method in interface org.kuali.rice.kim.framework.identity.EntityTypeEbo: Returns the version number for this object.
getVersionNumber() - Method in interface org.kuali.rice.kim.framework.identity.external.EntityExternalIdentifierTypeEbo: Returns the version number for this object.
getVersionNumber() - Method in interface org.kuali.rice.kim.framework.identity.name.EntityNameTypeEbo: Returns the version number for this object.
getVersionNumber() - Method in interface org.kuali.rice.kim.framework.identity.phone.EntityPhoneTypeEbo: Returns the version number for this object.
getVersionNumber() - Method in interface org.kuali.rice.kim.framework.role.RoleEbo: Returns the version number for this object.
getWorkflowDocumentTypeName() - Method in interface org.kuali.rice.kim.framework.type.KimTypeService: Gets the name of a workflow document type that should be passed to kew when resolving responsibilities for routing.
getWorkflowRoutingAttributes(String) - Method in interface org.kuali.rice.kim.framework.type.KimTypeService: Gets an unmodifiable list of attribute names identifying the attribute qualifiers that are provided to the KIM responsibility service when resolving responsibility-based routing at the node with the given name.
GroupEbo - Interface in org.kuali.rice.kim.framework.group: TODO: Likely should remove all methods from this interface after KULRICE-7170 is fixed
GroupTypeService - Interface in org.kuali.rice.kim.framework.group: A KimTypeService with specific methods for Groups.

H

hasDerivedRole(String, List<String>, String, String, Map<String, String>) - Method in interface org.kuali.rice.kim.framework.role.RoleTypeService: This method can be used to check if the given principal has this derived role.

I

isActive() - Method in interface org.kuali.rice.kim.framework.group.GroupEbo: The active indicator for an object.
isActive() - Method in interface org.kuali.rice.kim.framework.identity.address.EntityAddressTypeEbo: The active indicator for an object.
isActive() - Method in interface org.kuali.rice.kim.framework.identity.affiliation.EntityAffiliationTypeEbo: The active indicator for an object.
isActive() - Method in interface org.kuali.rice.kim.framework.identity.citizenship.EntityCitizenshipChangeTypeEbo: The active indicator for an object.
isActive() - Method in interface org.kuali.rice.kim.framework.identity.citizenship.EntityCitizenshipStatusEbo: The active indicator for an object.
isActive() - Method in interface org.kuali.rice.kim.framework.identity.email.EntityEmailTypeEbo: The active indicator for an object.
isActive() - Method in interface org.kuali.rice.kim.framework.identity.employment.EntityEmploymentStatusEbo: The active indicator for an object.
isActive() - Method in interface org.kuali.rice.kim.framework.identity.employment.EntityEmploymentTypeEbo: The active indicator for an object.
isActive() - Method in interface org.kuali.rice.kim.framework.identity.EntityTypeEbo: The active indicator for an object.
isActive() - Method in interface org.kuali.rice.kim.framework.identity.external.EntityExternalIdentifierTypeEbo: The active indicator for an object.
isActive() - Method in interface org.kuali.rice.kim.framework.identity.name.EntityNameTypeEbo: The active indicator for an object.
isActive() - Method in interface org.kuali.rice.kim.framework.identity.phone.EntityPhoneTypeEbo: The active indicator for an object.
isActive() - Method in interface org.kuali.rice.kim.framework.role.RoleEbo: The active indicator for an object.
isDerivedRoleType() - Method in interface org.kuali.rice.kim.framework.role.RoleTypeService: Returns true if this role type represents a "derived" role type.
isEmploymentAffiliationType() - Method in interface org.kuali.rice.kim.framework.identity.affiliation.EntityAffiliationTypeEbo: This value determines if the Affiliation Type is an employment type.
isEncryptionRequired() - Method in interface org.kuali.rice.kim.framework.identity.external.EntityExternalIdentifierTypeEbo: This value determines if the encryption is required for this type.

K

KimFrameworkServiceLocator - Class in org.kuali.rice.kim.framework.services
KimFrameworkServiceLocator() - Constructor for class org.kuali.rice.kim.framework.services.KimFrameworkServiceLocator
KimTypeService - Interface in org.kuali.rice.kim.framework.type: This is the base service interface for handling type-specific behavior.

O

org.kuali.rice.kim.framework.common.delegate - package org.kuali.rice.kim.framework.common.delegate: Copyright 2005-2016 The Kuali Foundation Licensed under the Educational Community License, Version 2.0 (the "License"); you may not use this file except in compliance with the License.
org.kuali.rice.kim.framework.group - package org.kuali.rice.kim.framework.group: Copyright 2005-2016 The Kuali Foundation Licensed under the Educational Community License, Version 2.0 (the "License"); you may not use this file except in compliance with the License.
org.kuali.rice.kim.framework.identity - package org.kuali.rice.kim.framework.identity
org.kuali.rice.kim.framework.identity.address - package org.kuali.rice.kim.framework.identity.address
org.kuali.rice.kim.framework.identity.affiliation - package org.kuali.rice.kim.framework.identity.affiliation
org.kuali.rice.kim.framework.identity.citizenship - package org.kuali.rice.kim.framework.identity.citizenship
org.kuali.rice.kim.framework.identity.email - package org.kuali.rice.kim.framework.identity.email
org.kuali.rice.kim.framework.identity.employment - package org.kuali.rice.kim.framework.identity.employment
org.kuali.rice.kim.framework.identity.external - package org.kuali.rice.kim.framework.identity.external
org.kuali.rice.kim.framework.identity.name - package org.kuali.rice.kim.framework.identity.name
org.kuali.rice.kim.framework.identity.phone - package org.kuali.rice.kim.framework.identity.phone
org.kuali.rice.kim.framework.permission - package org.kuali.rice.kim.framework.permission: Copyright 2005-2016 The Kuali Foundation Licensed under the Educational Community License, Version 2.0 (the "License"); you may not use this file except in compliance with the License.
org.kuali.rice.kim.framework.responsibility - package org.kuali.rice.kim.framework.responsibility: Copyright 2005-2016 The Kuali Foundation Licensed under the Educational Community License, Version 2.0 (the "License"); you may not use this file except in compliance with the License.
org.kuali.rice.kim.framework.role - package org.kuali.rice.kim.framework.role: Copyright 2005-2016 The Kuali Foundation Licensed under the Educational Community License, Version 2.0 (the "License"); you may not use this file except in compliance with the License.
org.kuali.rice.kim.framework.services - package org.kuali.rice.kim.framework.services
org.kuali.rice.kim.framework.type - package org.kuali.rice.kim.framework.type: Copyright 2005-2016 The Kuali Foundation Licensed under the Educational Community License, Version 2.0 (the "License"); you may not use this file except in compliance with the License.

P

PermissionTypeService - Interface in org.kuali.rice.kim.framework.permission: A KimTypeService with specific methods for Permissions.

R

ResponsibilityTypeService - Interface in org.kuali.rice.kim.framework.responsibility: A KimTypeService with specific methods for Responsibilities.
RoleEbo - Interface in org.kuali.rice.kim.framework.role: TODO: Likely should remove all methods from this interface after KULRICE-7170 is fixed
roleMemberRemoved(RoleMember) - Method in interface org.kuali.rice.kim.framework.role.RoleTypeService
RoleTypeService - Interface in org.kuali.rice.kim.framework.role: A KimTypeService with specific methods for Roles.

S

shouldValidateQualifiersForMemberType(MemberType) - Method in interface org.kuali.rice.kim.framework.role.RoleTypeService: Returns whether a membertype should have its qualifiers validated
sortRoleMembers(List<RoleMembership>) - Method in interface org.kuali.rice.kim.framework.role.RoleTypeService: For roles where the order of members returned may be meaningful, this method provides a hook to sort the results before they are returned from getRoleMembers on the RoleService.

V

validateAttributes(String, Map<String, String>) - Method in interface org.kuali.rice.kim.framework.type.KimTypeService: This method validates the passed in attributes for a kimTypeId generating a List of RemotableAttributeError.
validateAttributesAgainstExisting(String, Map<String, String>, Map<String, String>) - Method in interface org.kuali.rice.kim.framework.type.KimTypeService: This method validates the passed in attributes for a kimTypeId generating a List of RemotableAttributeError.
validateUniqueAttributes(String, Map<String, String>, Map<String, String>) - Method in interface org.kuali.rice.kim.framework.type.KimTypeService: This method validates the passed in attributes for a kimTypeId generating a List of RemotableAttributeError.
validateUnmodifiableAttributes(String, Map<String, String>, Map<String, String>) - Method in interface org.kuali.rice.kim.framework.type.KimTypeService: This method validates the passed in attributes for a kimTypeId generating a List of RemotableAttributeError.

C D E G H I K O P R S V