B - class that represents the rolepublic class PersonRoleHandler<B> extends ReferenceableHandler<B>
auditLog, beanClass, converter, defaultZones, errorHandler, invalidParameterHandler, localServerUserId, publishZones, repositoryHandler, repositoryHelper, securityVerifier, serverName, serviceName, supportedZones| Constructor and Description |
|---|
PersonRoleHandler(OpenMetadataAPIGenericConverter<B> converter,
Class<B> beanClass,
String serviceName,
String serverName,
InvalidParameterHandler invalidParameterHandler,
RepositoryHandler repositoryHandler,
OMRSRepositoryHelper repositoryHelper,
String localServerUserId,
OpenMetadataServerSecurityVerifier securityVerifier,
List<String> supportedZones,
List<String> defaultZones,
List<String> publishZones,
AuditLog auditLog)
Construct the handler with information needed to work with B objects.
|
| Modifier and Type | Method and Description |
|---|---|
void |
addTeamLeader(String userId,
String externalSourceGUID,
String externalSourceName,
String teamLeaderRoleGUID,
String teamLeaderRoleGUIDParameterName,
String teamGUID,
String teamGUIDParameterName,
String position,
String methodName)
Link a team leader role to a team profile.
|
void |
addTeamMember(String userId,
String externalSourceGUID,
String externalSourceName,
String teamMemberRoleGUID,
String teamMemberRoleGUIDParameterName,
String teamGUID,
String teamGUIDParameterName,
String position,
String methodName)
Link a team member role to a team profile.
|
String |
appointPersonToRole(String userId,
String externalSourceGUID,
String externalSourceName,
String profileGUID,
String profileGUIDParameterName,
String roleGUID,
String roleGUIDParameterName,
boolean isPublic,
Date startDate,
String methodName)
Link a person role with a Person profile to show that the person has been appointed to role.
|
String |
createPersonRole(String userId,
String externalSourceGUID,
String externalSourceName,
String qualifiedName,
String name,
String description,
String scope,
int headCount,
Map<String,String> additionalProperties,
String suppliedTypeName,
Map<String,Object> extendedProperties,
String methodName)
Create the description of a role.
|
String |
createPersonRoleFromTemplate(String userId,
String externalSourceGUID,
String externalSourceName,
String templateGUID,
String qualifiedName,
String name,
String description,
int headCount,
String methodName)
Create a new metadata element to represent a role using an existing metadata element as a template.
|
List<B> |
findPersonRoles(String userId,
String searchString,
String searchStringParameterName,
int startFrom,
int pageSize,
String methodName)
Retrieve the list of role metadata elements that contain the search string.
|
List<B> |
getPersonRolesByName(String userId,
String name,
String nameParameterName,
int startFrom,
int pageSize,
String methodName)
Retrieve the list of role metadata elements with a matching qualified or display name.
|
List<B> |
getPersonRolesForDomainId(String userId,
int domainIdentifier,
int startFrom,
int pageSize,
String methodName)
Retrieve the list of role metadata elements with a matching qualified or display name.
|
List<B> |
getPersonRolesForRoleId(String userId,
String name,
String nameParameterName,
int startFrom,
int pageSize,
String methodName)
Retrieve the list of role metadata elements with a matching qualified or display name.
|
List<B> |
getPersonRolesForTitle(String userId,
String name,
String nameParameterName,
int startFrom,
int pageSize,
String methodName)
Retrieve the list of role metadata elements with a matching qualified or display name.
|
void |
relievePersonFromRole(String userId,
String externalSourceGUID,
String externalSourceName,
String profileGUID,
String profileGUIDParameterName,
String roleGUID,
String roleGUIDParameterName,
String appointmentGUID,
String appointmentGUIDParameterName,
Date endDate,
String methodName)
Unlink two team profiles from the hierarchy.
|
void |
removePersonRole(String userId,
String roleGUID,
String roleGUIDParameterName,
String methodName)
Remove the metadata element representing a role.
|
void |
removeTeamLeader(String userId,
String externalSourceGUID,
String externalSourceName,
String teamLeaderRoleGUID,
String teamLeaderRoleGUIDParameterName,
String teamGUID,
String teamGUIDParameterName,
String methodName)
Unlink a team leader role from a team profile.
|
void |
removeTeamMember(String userId,
String externalSourceGUID,
String externalSourceName,
String teamMemberRoleGUID,
String teamMemberRoleGUIDParameterName,
String teamGUID,
String teamGUIDParameterName,
String methodName)
Unlink a team member role from a team profile.
|
void |
updatePersonRole(String userId,
String externalSourceGUID,
String externalSourceName,
String roleGUID,
String roleGUIDParameterName,
String qualifiedName,
String name,
String description,
String scope,
int headCount,
Map<String,String> additionalProperties,
String typeName,
Map<String,Object> extendedProperties,
boolean isMergeUpdate,
String methodName)
Update the anchor object that all elements in a role (terms and categories) are linked to.
|
addOwner, addSecurityTags, addTemplateClassification, clearBusinessSignificant, findBeanGUIDsByQualifiedName, findBeanGUIDsByQualifiedName, findBeansByQualifiedName, findBeansByQualifiedName, getBeanByQualifiedName, getBeanByQualifiedName, getBeanGUIDByQualifiedName, getBeanGUIDByQualifiedName, getBeanGUIDsByQualifiedName, getBeanGUIDsByQualifiedName, getBeansByQualifiedName, getBeansByQualifiedName, getCollectionMembers, getEntityByUniqueQualifiedName, getMoreInformation, getMoreInformation, getVendorProperties, linkElementsAsDuplicates, removeOwner, removeResourceListMember, removeSecurityTags, removeSemanticAssignment, removeTemplateClassification, saveResourceListMember, saveSemanticAssignment, saveSemanticAssignment, setBusinessSignificant, unlinkElementsAsDuplicatesarchiveBeanInRepository, archiveBeanInRepository, countAttachments, createBeanFromTemplate, createBeanInRepository, deleteBeanInRepository, deleteBeanInRepository, findAttachmentLinks, findBeanGUIDs, findBeans, findBeans, findBeans, findBeans, findEntities, getAllAttachmentLinks, getAnchorsForAttachedElements, getAttachedElement, getAttachedElement, getAttachedElementGUID, getAttachedElementGUID, getAttachedElementGUIDs, getAttachedElementGUIDs, getAttachedElements, getAttachedElements, getAttachedElements, getAttachedElements, getAttachedEntities, getAttachedEntities, getAttachedEntities, getAttachedEntity, getAttachedEntity, getAttachmentLinks, getAttachmentLinks, getAttachmentLinks, getBeanByUniqueName, getBeanByUniqueName, getBeanByValue, getBeanFromEntity, getBeanFromRepository, getBeanFromRepository, getBeanGUIDByUniqueName, getBeanGUIDByUniqueName, getBeanGUIDsByClassification, getBeanGUIDsByType, getBeanGUIDsByType, getBeanGUIDsByValue, getBeansByClassification, getBeansByCreator, getBeansByIntValue, getBeansByType, getBeansByType, getBeansByValue, getBeansByValue, getBeansByValue, getBeansByValue, getBeansByValue, getEntitiesByIntValue, getEntitiesByType, getEntitiesByValue, getEntitiesByValue, getEntitiesByValue, getEntitiesByValue, getEntityByValue, getEntityFromRepository, getEntityFromRepository, getEntityFromRepository, getEntityFromRepository, getEntityGUIDByValue, getEntityGUIDsByValue, getRepositoryHelper, getServiceName, getUniqueAttachmentLink, getUniqueAttachmentLink, linkElementToElement, linkElementToElement, maintainSupplementaryProperties, relinkElementToNewElement, relinkElementToNewElement, removeClassificationFromRepository, setClassificationInRepository, setClassificationInRepository, setSecurityVerifier, unlinkAllElements, unlinkAllElements, unlinkConnectedElement, unlinkConnectedElement, unlinkElementFromElement, unlinkElementFromElement, unlinkElementFromElement, unlinkElementFromElement, updateBeanEffectivityDates, updateBeanInRepository, updateBeanInRepository, updateBeanPropertyInRepository, updateBeanStatusInRepository, updateBeanStatusInRepository, updateClassificationEffectivityDates, updateElementToElementLink, updateElementToElementLink, updateRelationshipEffectivityDates, updateRelationshipProperties, validateAnchorEntity, validateAnchorEntity, verifyExternalSourceIdentitypublic PersonRoleHandler(OpenMetadataAPIGenericConverter<B> converter, Class<B> beanClass, String serviceName, String serverName, InvalidParameterHandler invalidParameterHandler, RepositoryHandler repositoryHandler, OMRSRepositoryHelper repositoryHelper, String localServerUserId, OpenMetadataServerSecurityVerifier securityVerifier, List<String> supportedZones, List<String> defaultZones, List<String> publishZones, AuditLog auditLog)
converter - specific converter for this bean classbeanClass - name of bean class that is represented by the generic class BserviceName - name of this serviceserverName - name of the local serverinvalidParameterHandler - handler for managing parameter errorsrepositoryHandler - manages calls to the repository servicesrepositoryHelper - provides utilities for manipulating the repository services objectslocalServerUserId - userId for this serversecurityVerifier - open metadata security services verifiersupportedZones - list of zones that the access service is allowed to serve B instances fromdefaultZones - list of zones that the access service should set in all new B instancespublishZones - list of zones that the access service sets up in published B instancesauditLog - destination for audit log eventspublic String createPersonRole(String userId, String externalSourceGUID, String externalSourceName, String qualifiedName, String name, String description, String scope, int headCount, Map<String,String> additionalProperties, String suppliedTypeName, Map<String,Object> extendedProperties, String methodName) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
userId - calling userexternalSourceGUID - unique identifier of software server capability representing the callerexternalSourceName - unique name of software server capability representing the callerqualifiedName - unique name for the role - used in other configurationname - short display name for the roledescription - description of the rolescope - the scope of the roleheadCount - number of individuals that can be appointed to this roleadditionalProperties - additional properties for a rolesuppliedTypeName - type name from the caller (enables creation of subtypes)extendedProperties - properties for a governance role subtypemethodName - calling methodInvalidParameterException - qualifiedName or userId is nullPropertyServerException - problem accessing property serverUserNotAuthorizedException - security access problempublic String createPersonRoleFromTemplate(String userId, String externalSourceGUID, String externalSourceName, String templateGUID, String qualifiedName, String name, String description, int headCount, String methodName) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
userId - calling userexternalSourceGUID - unique identifier of software server capability representing the callerexternalSourceName - unique name of software server capability representing the callertemplateGUID - unique identifier of the metadata element to copyqualifiedName - unique name for the role - used in other configurationname - short display name for the roledescription - description of the governance roleheadCount - number of individuals that can be appointed to this rolemethodName - calling methodInvalidParameterException - one of the parameters is invalidUserNotAuthorizedException - the user is not authorized to issue this requestPropertyServerException - there is a problem reported in the open metadata server(s)public String appointPersonToRole(String userId, String externalSourceGUID, String externalSourceName, String profileGUID, String profileGUIDParameterName, String roleGUID, String roleGUIDParameterName, boolean isPublic, Date startDate, String methodName) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
userId - calling userexternalSourceGUID - unique identifier of software server capability representing the callerexternalSourceName - unique name of software server capability representing the callerprofileGUID - unique identifier of actor profileprofileGUIDParameterName - parameter name supplying profileGUIDroleGUID - unique identifier of the person roleroleGUIDParameterName - parameter name supplying roleGUIDisPublic - is this appointment visible to othersstartDate - the official start date of the appointment - null means effective immediatelymethodName - calling methodInvalidParameterException - entity not known, null userId or guidPropertyServerException - problem accessing property serverUserNotAuthorizedException - security access problempublic void relievePersonFromRole(String userId, String externalSourceGUID, String externalSourceName, String profileGUID, String profileGUIDParameterName, String roleGUID, String roleGUIDParameterName, String appointmentGUID, String appointmentGUIDParameterName, Date endDate, String methodName) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
userId - calling userexternalSourceGUID - unique identifier of software server capability representing the callerexternalSourceName - unique name of software server capability representing the callerprofileGUID - unique identifier of person profileprofileGUIDParameterName - parameter name supplying profileGUIDroleGUID - unique identifier of the person roleroleGUIDParameterName - parameter name supplying roleGUIDappointmentGUID - unique identifier (guid) of the appointment relationshipappointmentGUIDParameterName - parameter name supplying appointmentGUIDendDate - the official end of the appointment - null means effective immediatelymethodName - calling methodInvalidParameterException - entity not known, null userId or guidPropertyServerException - problem accessing property serverUserNotAuthorizedException - security access problempublic void addTeamLeader(String userId, String externalSourceGUID, String externalSourceName, String teamLeaderRoleGUID, String teamLeaderRoleGUIDParameterName, String teamGUID, String teamGUIDParameterName, String position, String methodName) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
userId - calling userexternalSourceGUID - unique identifier of software server capability representing the callerexternalSourceName - unique name of software server capability representing the callerteamLeaderRoleGUID - unique identifier of TeamLeader roleteamLeaderRoleGUIDParameterName - parameter name supplying teamLeaderRoleGUIDteamGUID - unique identifier of the user identityteamGUIDParameterName - parameter name supplying teamGUIDposition - optional name of positionmethodName - calling methodInvalidParameterException - entity not known, null userId or guidPropertyServerException - problem accessing property serverUserNotAuthorizedException - security access problempublic void removeTeamLeader(String userId, String externalSourceGUID, String externalSourceName, String teamLeaderRoleGUID, String teamLeaderRoleGUIDParameterName, String teamGUID, String teamGUIDParameterName, String methodName) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
userId - calling userexternalSourceGUID - unique identifier of software server capability representing the callerexternalSourceName - unique name of software server capability representing the callerteamLeaderRoleGUID - unique identifier of TeamLeader roleteamLeaderRoleGUIDParameterName - parameter name supplying teamLeaderRoleGUIDteamGUID - unique identifier of the user identityteamGUIDParameterName - parameter name supplying teamGUIDmethodName - calling methodInvalidParameterException - entity not known, null userId or guidPropertyServerException - problem accessing property serverUserNotAuthorizedException - security access problempublic void addTeamMember(String userId, String externalSourceGUID, String externalSourceName, String teamMemberRoleGUID, String teamMemberRoleGUIDParameterName, String teamGUID, String teamGUIDParameterName, String position, String methodName) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
userId - calling userexternalSourceGUID - unique identifier of software server capability representing the callerexternalSourceName - unique name of software server capability representing the callerteamMemberRoleGUID - unique identifier of TeamMember roleteamMemberRoleGUIDParameterName - parameter name supplying teamMemberRoleGUIDteamGUID - unique identifier of the user identityteamGUIDParameterName - parameter name supplying teamGUIDposition - optional name of positionmethodName - calling methodInvalidParameterException - entity not known, null userId or guidPropertyServerException - problem accessing property serverUserNotAuthorizedException - security access problempublic void removeTeamMember(String userId, String externalSourceGUID, String externalSourceName, String teamMemberRoleGUID, String teamMemberRoleGUIDParameterName, String teamGUID, String teamGUIDParameterName, String methodName) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
userId - calling userexternalSourceGUID - unique identifier of software server capability representing the callerexternalSourceName - unique name of software server capability representing the callerteamMemberRoleGUID - unique identifier of TeamMember roleteamMemberRoleGUIDParameterName - parameter name supplying teamMemberRoleGUIDteamGUID - unique identifier of the user identityteamGUIDParameterName - parameter name supplying teamGUIDmethodName - calling methodInvalidParameterException - entity not known, null userId or guidPropertyServerException - problem accessing property serverUserNotAuthorizedException - security access problempublic void updatePersonRole(String userId, String externalSourceGUID, String externalSourceName, String roleGUID, String roleGUIDParameterName, String qualifiedName, String name, String description, String scope, int headCount, Map<String,String> additionalProperties, String typeName, Map<String,Object> extendedProperties, boolean isMergeUpdate, String methodName) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
userId - calling userexternalSourceGUID - unique identifier of software server capability representing the callerexternalSourceName - unique name of software server capability representing the callerroleGUID - unique identifier of the role to updateroleGUIDParameterName - parameter passing the roleGUIDqualifiedName - unique name for the role - used in other configurationname - short display name for the roledescription - description of the rolescope - the scope of the roleheadCount - number of individuals that can be appointed to this roleadditionalProperties - additional properties for a governance roletypeName - type of roleextendedProperties - properties for a governance role subtypeisMergeUpdate - should the supplied properties be merged with existing properties (true) only replacing the properties with
matching names, or should the entire properties of the instance be replaced?methodName - calling methodInvalidParameterException - qualifiedName or userId is nullPropertyServerException - problem accessing property serverUserNotAuthorizedException - security access problempublic void removePersonRole(String userId, String roleGUID, String roleGUIDParameterName, String methodName) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
userId - calling userroleGUID - unique identifier of the metadata element to removeroleGUIDParameterName - parameter supplying the roleGUIDmethodName - calling methodInvalidParameterException - one of the parameters is invalidUserNotAuthorizedException - the user is not authorized to issue this requestPropertyServerException - there is a problem reported in the open metadata server(s)public List<B> findPersonRoles(String userId, String searchString, String searchStringParameterName, int startFrom, int pageSize, String methodName) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
userId - calling usersearchString - string to find in the propertiessearchStringParameterName - name of parameter supplying the search stringstartFrom - paging start pointpageSize - maximum results that can be returnedmethodName - calling methodInvalidParameterException - one of the parameters is invalidUserNotAuthorizedException - the user is not authorized to issue this requestPropertyServerException - there is a problem reported in the open metadata server(s)public List<B> getPersonRolesByName(String userId, String name, String nameParameterName, int startFrom, int pageSize, String methodName) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
userId - calling username - name to search fornameParameterName - parameter supplying namestartFrom - paging start pointpageSize - maximum results that can be returnedmethodName - calling methodInvalidParameterException - one of the parameters is invalidUserNotAuthorizedException - the user is not authorized to issue this requestPropertyServerException - there is a problem reported in the open metadata server(s)public List<B> getPersonRolesForRoleId(String userId, String name, String nameParameterName, int startFrom, int pageSize, String methodName) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
userId - calling username - name to search fornameParameterName - parameter supplying namestartFrom - paging start pointpageSize - maximum results that can be returnedmethodName - calling methodInvalidParameterException - one of the parameters is invalidUserNotAuthorizedException - the user is not authorized to issue this requestPropertyServerException - there is a problem reported in the open metadata server(s)public List<B> getPersonRolesForTitle(String userId, String name, String nameParameterName, int startFrom, int pageSize, String methodName) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
userId - calling username - name to search fornameParameterName - parameter supplying namestartFrom - paging start pointpageSize - maximum results that can be returnedmethodName - calling methodInvalidParameterException - one of the parameters is invalidUserNotAuthorizedException - the user is not authorized to issue this requestPropertyServerException - there is a problem reported in the open metadata server(s)public List<B> getPersonRolesForDomainId(String userId, int domainIdentifier, int startFrom, int pageSize, String methodName) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
userId - calling userdomainIdentifier - domain of interest - 0 means all domainsstartFrom - paging start pointpageSize - maximum results that can be returnedmethodName - calling methodInvalidParameterException - one of the parameters is invalidUserNotAuthorizedException - the user is not authorized to issue this requestPropertyServerException - there is a problem reported in the open metadata server(s)Copyright © 2018–2021 LF AI & Data Foundation. All rights reserved.