Package org.odpi.openmetadata.accessservices.communityprofile.client

Class OrganizationManagement

java.lang.Object

org.odpi.openmetadata.accessservices.communityprofile.client.CommunityProfileBaseClient

org.odpi.openmetadata.accessservices.communityprofile.client.OrganizationManagement

All Implemented Interfaces:

org.odpi.openmetadata.accessservices.communityprofile.api.OrganizationManagementInterface, org.odpi.openmetadata.accessservices.communityprofile.api.RelatedElementsManagementInterface

public class OrganizationManagement
extends CommunityProfileBaseClient
implements org.odpi.openmetadata.accessservices.communityprofile.api.OrganizationManagementInterface

OrganizationManagement is the client used by the Organization Integrator OMIS that is responsible with synchronizing organizational structures, profiles rules and users with open metadata.

Constructor Summary

Constructors

Constructor	Description
OrganizationManagement(String serverName, String serverPlatformURLRoot, int maxPageSize)	Create a new client with no authentication embedded in the HTTP request.
OrganizationManagement(String serverName, String serverPlatformURLRoot, String userId, String password, int maxPageSize)	Create a new client that passes userId and password in each HTTP request.
OrganizationManagement(String serverName, String serverPlatformURLRoot, String userId, String password, org.odpi.openmetadata.frameworks.auditlog.AuditLog auditLog, int maxPageSize)	Create a new client that passes userId and password in each HTTP request.
OrganizationManagement(String serverName, String serverPlatformURLRoot, CommunityProfileRESTClient restClient, int maxPageSize)	Create a new client that passes userId and password in each HTTP request.
OrganizationManagement(String serverName, String serverPlatformURLRoot, org.odpi.openmetadata.frameworks.auditlog.AuditLog auditLog, int maxPageSize)	Create a new client with no authentication embedded in the HTTP request.

Method Summary

Modifier and Type	Method	Description
String	addContactMethod(String userId, String externalSourceGUID, String externalSourceName, String actorProfileGUID, org.odpi.openmetadata.accessservices.communityprofile.properties.ContactMethodProperties properties)	Add a new contact method to the profile.
String	createActorProfile(String userId, String externalSourceGUID, String externalSourceName, org.odpi.openmetadata.accessservices.communityprofile.properties.ActorProfileProperties properties, org.odpi.openmetadata.accessservices.communityprofile.properties.ContributionRecord contributionRecord)	Create a definition of an actor profile.
String	createPersonRole(String userId, String externalSourceGUID, String externalSourceName, org.odpi.openmetadata.accessservices.communityprofile.properties.PersonRoleProperties properties)	Create a definition of a person role.
void	deleteActorProfile(String userId, String externalSourceGUID, String externalSourceName, String actorProfileGUID)	Remove the definition of an actor profile.
void	deleteContactMethod(String userId, String externalSourceGUID, String externalSourceName, String contactMethodGUID)	Remove an obsolete contact method from the profile.
void	deletePersonRole(String userId, String externalSourceGUID, String externalSourceName, String personRoleGUID)	Remove the definition of a person role.
List<org.odpi.openmetadata.accessservices.communityprofile.metadataelements.ActorProfileElement>	findActorProfiles(String userId, String searchString, int startFrom, int pageSize)	Retrieve the list of matching profiles for the search string.
List<org.odpi.openmetadata.accessservices.communityprofile.metadataelements.PersonRoleElement>	findPersonRoles(String userId, String searchString, int startFrom, int pageSize)	Retrieve the list of matching roles for the search string.
org.odpi.openmetadata.accessservices.communityprofile.metadataelements.ActorProfileElement	getActorProfileByGUID(String userId, String actorProfileGUID)	Return information about a specific actor profile.
org.odpi.openmetadata.accessservices.communityprofile.metadataelements.ActorProfileElement	getActorProfileByUserId(String userId, String actorProfileUserId)	Return information about a specific actor profile.
List<org.odpi.openmetadata.accessservices.communityprofile.metadataelements.ActorProfileElement>	getActorProfiles(String userId, int startFrom, int pageSize)	Return information about all actor profiles.
List<org.odpi.openmetadata.accessservices.communityprofile.metadataelements.ActorProfileElement>	getActorProfilesByLocation(String userId, String locationGUID, int startFrom, int pageSize)	Return information about the actor profiles associated with a location.
List<org.odpi.openmetadata.accessservices.communityprofile.metadataelements.ActorProfileElement>	getActorProfilesByName(String userId, String name, int startFrom, int pageSize)	Return information about a named actor profile.
List<org.odpi.openmetadata.accessservices.communityprofile.metadataelements.PersonRoleAppointee>	getAppointees(String userId, String personRoleGUID, Date effectiveTime, int startFrom, int pageSize)	Return the list of people appointed to a particular role.
List<org.odpi.openmetadata.accessservices.communityprofile.metadataelements.PersonRoleElement>	getLeadershipRolesForTeam(String userId, String teamGUID, int startFrom, int pageSize)	Return information about the leadership person roles linked to a team.
List<org.odpi.openmetadata.accessservices.communityprofile.metadataelements.PersonRoleElement>	getMembershipRolesForTeam(String userId, String teamGUID, int startFrom, int pageSize)	Return information about the membership person roles linked to a team.
org.odpi.openmetadata.accessservices.communityprofile.metadataelements.PersonRoleElement	getPersonRoleByGUID(String userId, String personRoleGUID)	Return information about a specific person role.
List<org.odpi.openmetadata.accessservices.communityprofile.metadataelements.PersonRoleElement>	getPersonRolesByName(String userId, String name, int startFrom, int pageSize)	Return information about a named person role.
String	linkPersonRoleToProfile(String userId, String externalSourceGUID, String externalSourceName, String personRoleGUID, String personProfileGUID, org.odpi.openmetadata.accessservices.communityprofile.properties.AppointmentProperties properties)	Link a person role to a person profile to show that that person is performing the role.
void	linkTeamPlayer(String userId, String externalSourceGUID, String externalSourceName, String teamRoleGUID, String teamProfileGUID, String position, boolean leadershipPosition)	Link a team leader person role or team member person role to a team profile.
void	linkTeamsInHierarchy(String userId, String externalSourceGUID, String externalSourceName, String superTeamProfileGUID, String subTeamProfileGUID, boolean delegationEscalationAuthority, Date effectiveFrom, Date effectiveTo)	Link two related team/organization actor profiles together as part of a hierarchy.
void	unlinkPersonRoleFromProfile(String userId, String externalSourceGUID, String externalSourceName, String appointmentGUID)	Remove the link between a person role and a person profile.
void	unlinkTeamPlayer(String userId, String externalSourceGUID, String externalSourceName, String teamRoleGUID, String teamProfileGUID, boolean leadershipPosition)	Remove the link between a person role and a team profile.
void	unlinkTeamsInHierarchy(String userId, String externalSourceGUID, String externalSourceName, String superTeamProfileGUID, String subTeamProfileGUID)	Remove the link between two actor profiles in the actor profile hierarchy.
void	updateActorProfile(String userId, String externalSourceGUID, String externalSourceName, String actorProfileGUID, boolean isMergeUpdate, org.odpi.openmetadata.accessservices.communityprofile.properties.ActorProfileProperties properties, org.odpi.openmetadata.accessservices.communityprofile.properties.ContributionRecord contributionRecord)	Update the definition of an actor profile.
void	updateAppointment(String userId, String externalSourceGUID, String externalSourceName, String appointmentGUID, boolean isMergeUpdate, org.odpi.openmetadata.accessservices.communityprofile.properties.AppointmentProperties properties)	Update the properties for the appointment of a person to a role.
void	updatePersonRole(String userId, String externalSourceGUID, String externalSourceName, String personRoleGUID, boolean isMergeUpdate, org.odpi.openmetadata.accessservices.communityprofile.properties.PersonRoleProperties properties)	Update the definition of a person role.

Methods inherited from class org.odpi.openmetadata.accessservices.communityprofile.client.CommunityProfileBaseClient

clearAssignmentScope, clearMoreInformation, clearResource, clearStakeholder, getAssignedActors, getAssignedScopes, getDescriptiveElements, getMoreInformation, getResourceList, getStakeholderCommissionedElements, getStakeholders, getSupportedByResource, removeReferenceable, setupAssignmentScope, setupMoreInformation, setupResource, setupStakeholder, updateRelationship

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

OrganizationManagement

public OrganizationManagement(String serverName,
 String serverPlatformURLRoot,
 int maxPageSize)
                       throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException

Create a new client with no authentication embedded in the HTTP request.

Parameters:

serverName - name of the server to connect to

serverPlatformURLRoot - the network address of the server running the OMAS REST services

maxPageSize - maximum value allowed for page size

Throws:

org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - bad input parameters

OrganizationManagement

public OrganizationManagement(String serverName,
 String serverPlatformURLRoot,
 org.odpi.openmetadata.frameworks.auditlog.AuditLog auditLog,
 int maxPageSize)
                       throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException

Create a new client with no authentication embedded in the HTTP request.

Parameters:

serverName - name of the server to connect to

serverPlatformURLRoot - the network address of the server running the OMAS REST services

auditLog - logging destination

maxPageSize - maximum value allowed for page size

Throws:

org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - there is a problem creating the client-side components to issue any REST API calls.

OrganizationManagement

public OrganizationManagement(String serverName,
 String serverPlatformURLRoot,
 String userId,
 String password,
 int maxPageSize)
                       throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException

Create a new client that passes userId and password in each HTTP request. This is the userId/password of the calling server. The end user's userId is sent on each request.

Parameters:

serverName - name of the server to connect to

serverPlatformURLRoot - the network address of the server running the OMAS REST services

userId - caller's userId embedded in all HTTP requests

password - caller's userId embedded in all HTTP requests

maxPageSize - maximum value allowed for page size

Throws:

org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - bad input parameters

OrganizationManagement

public OrganizationManagement(String serverName,
 String serverPlatformURLRoot,
 String userId,
 String password,
 org.odpi.openmetadata.frameworks.auditlog.AuditLog auditLog,
 int maxPageSize)
                       throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException

Create a new client that passes userId and password in each HTTP request. This is the userId/password of the calling server. The end user's userId is sent on each request.

Parameters:

serverName - name of the server to connect to

serverPlatformURLRoot - the network address of the server running the OMAS REST services

userId - caller's userId embedded in all HTTP requests

password - caller's userId embedded in all HTTP requests

auditLog - logging destination

maxPageSize - maximum value allowed for page size

Throws:

org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - bad input parameters

OrganizationManagement

public OrganizationManagement(String serverName,
 String serverPlatformURLRoot,
 CommunityProfileRESTClient restClient,
 int maxPageSize)
                       throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException

Create a new client that passes userId and password in each HTTP request. This is the userId/password of the calling server. The end user's userId is sent on each request.

Parameters:

serverName - name of the server to connect to

serverPlatformURLRoot - the network address of the server running the OMAS REST services

restClient - pre-initialized REST client

maxPageSize - pre-initialized parameter limit

Throws:

org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - there is a problem with the information about the remote OMAS

Method Details

createActorProfile

public String createActorProfile(String userId,
 String externalSourceGUID,
 String externalSourceName,
 org.odpi.openmetadata.accessservices.communityprofile.properties.ActorProfileProperties properties,
 org.odpi.openmetadata.accessservices.communityprofile.properties.ContributionRecord contributionRecord)
                          throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException,
org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException,
org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException

Create a definition of an actor profile. This could be for the whole organization, a team, a person or a system.

Specified by:

createActorProfile in interface org.odpi.openmetadata.accessservices.communityprofile.api.OrganizationManagementInterface

Parameters:

userId - calling user

externalSourceGUID - guid of the software server capability entity that represented the external source - null for local

externalSourceName - name of the software server capability entity that represented the external source

properties - properties for a actor profile

contributionRecord - optional properties for the contribution record

Returns:

unique identifier of actor profile

Throws:

org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - qualifiedName or userId is null; qualifiedName is not unique

org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - problem accessing property server

org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - security access problem

updateActorProfile

public void updateActorProfile(String userId,
 String externalSourceGUID,
 String externalSourceName,
 String actorProfileGUID,
 boolean isMergeUpdate,
 org.odpi.openmetadata.accessservices.communityprofile.properties.ActorProfileProperties properties,
 org.odpi.openmetadata.accessservices.communityprofile.properties.ContributionRecord contributionRecord)
                        throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException,
org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException,
org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException

Update the definition of an actor profile.

Specified by:

updateActorProfile in interface org.odpi.openmetadata.accessservices.communityprofile.api.OrganizationManagementInterface

Parameters:

userId - calling user

externalSourceGUID - guid of the software server capability entity that represented the external source - null for local

externalSourceName - name of the software server capability entity that represented the external source

actorProfileGUID - unique identifier of actor profile

isMergeUpdate - are unspecified properties unchanged (true) or replaced with null?

properties - properties to change

contributionRecord - additional properties for contribution record.

Throws:

org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - guid, qualifiedName or userId is null; qualifiedName is not unique; guid is not known

org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - problem accessing property server

org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - security access problem

deleteActorProfile

public void deleteActorProfile(String userId,
 String externalSourceGUID,
 String externalSourceName,
 String actorProfileGUID)
                        throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException,
org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException,
org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException

Remove the definition of an actor profile.

Specified by:

deleteActorProfile in interface org.odpi.openmetadata.accessservices.communityprofile.api.OrganizationManagementInterface

Parameters:

userId - calling user

externalSourceGUID - guid of the software server capability entity that represented the external source - null for local

externalSourceName - name of the software server capability entity that represented the external source

actorProfileGUID - unique identifier of actor profile

Throws:

org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - guid or userId is null; guid is not known

org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - problem accessing property server

org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - security access problem

addContactMethod

public String addContactMethod(String userId,
 String externalSourceGUID,
 String externalSourceName,
 String actorProfileGUID,
 org.odpi.openmetadata.accessservices.communityprofile.properties.ContactMethodProperties properties)
                        throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException,
org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException,
org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException

Add a new contact method to the profile.

Specified by:

addContactMethod in interface org.odpi.openmetadata.accessservices.communityprofile.api.OrganizationManagementInterface

Parameters:

userId - the name of the calling user.

externalSourceGUID - guid of the software server capability entity that represented the external source - null for local

externalSourceName - name of the software server capability entity that represented the external source

actorProfileGUID - identifier of the profile to update.

properties - properties of contact method.

Returns:

unique identifier (guid) for the new contact method.

Throws:

org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - the userId is null or invalid. Another property is invalid.

org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - there is a problem retrieving information from the property server(s).

org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - the requesting user is not authorized to issue this request.

deleteContactMethod

public void deleteContactMethod(String userId,
 String externalSourceGUID,
 String externalSourceName,
 String contactMethodGUID)
                         throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException,
org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException,
org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException

Remove an obsolete contact method from the profile.

Specified by:

deleteContactMethod in interface org.odpi.openmetadata.accessservices.communityprofile.api.OrganizationManagementInterface

Parameters:

userId - the name of the calling user.

externalSourceGUID - guid of the software server capability entity that represented the external source - null for local

externalSourceName - name of the software server capability entity that represented the external source

contactMethodGUID - unique identifier (guid) for the obsolete contact method.

Throws:

org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - the userId is null or invalid. Another property is invalid.

org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - there is a problem retrieving information from the property server(s).

org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - the requesting user is not authorized to issue this request.

linkTeamsInHierarchy

public void linkTeamsInHierarchy(String userId,
 String externalSourceGUID,
 String externalSourceName,
 String superTeamProfileGUID,
 String subTeamProfileGUID,
 boolean delegationEscalationAuthority,
 Date effectiveFrom,
 Date effectiveTo)
                          throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException,
org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException,
org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException

Link two related team/organization actor profiles together as part of a hierarchy. A team/organization actor profile can only have one parent but many child actor profiles.

Specified by:

linkTeamsInHierarchy in interface org.odpi.openmetadata.accessservices.communityprofile.api.OrganizationManagementInterface

Parameters:

userId - calling user

externalSourceGUID - guid of the software server capability entity that represented the external source - null for local

externalSourceName - name of the software server capability entity that represented the external source

superTeamProfileGUID - unique identifier of the parent team profile

subTeamProfileGUID - unique identifier of the child team profile

delegationEscalationAuthority - can workflows delegate/escalate through this link?

effectiveFrom - start date for the team relationship

effectiveTo - end date for the team relationship

Throws:

org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - one of the guids is null or not known

org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - problem accessing property server

org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - security access problem

unlinkTeamsInHierarchy

public void unlinkTeamsInHierarchy(String userId,
 String externalSourceGUID,
 String externalSourceName,
 String superTeamProfileGUID,
 String subTeamProfileGUID)
                            throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException,
org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException,
org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException

Remove the link between two actor profiles in the actor profile hierarchy.

Specified by:

unlinkTeamsInHierarchy in interface org.odpi.openmetadata.accessservices.communityprofile.api.OrganizationManagementInterface

Parameters:

userId - calling user

externalSourceGUID - guid of the software server capability entity that represented the external source - null for local

externalSourceName - name of the software server capability entity that represented the external source

superTeamProfileGUID - unique identifier of the parent actor profile

subTeamProfileGUID - unique identifier of the child actor profile

Throws:

org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - one of the guids is null or not known

org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - problem accessing property server

org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - security access problem

getActorProfileByGUID

public org.odpi.openmetadata.accessservices.communityprofile.metadataelements.ActorProfileElement getActorProfileByGUID(String userId,
 String actorProfileGUID)
                                                                                                                 throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException,
org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException,
org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException

Return information about a specific actor profile.

Specified by:

getActorProfileByGUID in interface org.odpi.openmetadata.accessservices.communityprofile.api.OrganizationManagementInterface

Parameters:

userId - calling user

actorProfileGUID - unique identifier for the actor profile

Returns:

properties of the actor profile

Throws:

org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - actorProfileGUID or userId is null

org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - problem accessing property server

org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - security access problem

getActorProfileByUserId

public org.odpi.openmetadata.accessservices.communityprofile.metadataelements.ActorProfileElement getActorProfileByUserId(String userId,
 String actorProfileUserId)
                                                                                                                   throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException,
org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException,
org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException

Return information about a specific actor profile.

Specified by:

getActorProfileByUserId in interface org.odpi.openmetadata.accessservices.communityprofile.api.OrganizationManagementInterface

Parameters:

userId - calling user

actorProfileUserId - unique identifier for the actor profile

Returns:

properties of the actor profile

Throws:

org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - actorProfileUserId or userId is null

org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - problem accessing property server

org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - security access problem

getActorProfilesByName

public List<org.odpi.openmetadata.accessservices.communityprofile.metadataelements.ActorProfileElement> getActorProfilesByName(String userId,
 String name,
 int startFrom,
 int pageSize)
                                                                                                                        throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException,
org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException,
org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException

Return information about a named actor profile.

Specified by:

getActorProfilesByName in interface org.odpi.openmetadata.accessservices.communityprofile.api.OrganizationManagementInterface

Parameters:

userId - calling user

name - unique name for the actor profile

startFrom - index of the list to start from (0 for start)

pageSize - maximum number of elements to return.

Returns:

list of matching actor profiles (hopefully only one)

Throws:

org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - name or userId is null

org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - problem accessing property server

org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - security access problem

getActorProfiles

public List<org.odpi.openmetadata.accessservices.communityprofile.metadataelements.ActorProfileElement> getActorProfiles(String userId,
 int startFrom,
 int pageSize)
                                                                                                                  throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException,
org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException,
org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException

Return information about all actor profiles.

Specified by:

getActorProfiles in interface org.odpi.openmetadata.accessservices.communityprofile.api.OrganizationManagementInterface

Parameters:

userId - calling user

startFrom - index of the list to start from (0 for start)

pageSize - maximum number of elements to return.

Returns:

list of matching actor profiles (hopefully only one)

Throws:

org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - name or userId is null

org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - problem accessing property server

org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - security access problem

getActorProfilesByLocation

public List<org.odpi.openmetadata.accessservices.communityprofile.metadataelements.ActorProfileElement> getActorProfilesByLocation(String userId,
 String locationGUID,
 int startFrom,
 int pageSize)
                                                                                                                            throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException,
org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException,
org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException

Return information about the actor profiles associated with a location.

Specified by:

getActorProfilesByLocation in interface org.odpi.openmetadata.accessservices.communityprofile.api.OrganizationManagementInterface

Parameters:

userId - calling user

locationGUID - unique identifier for the location

startFrom - index of the list to start from (0 for start)

pageSize - maximum number of elements to return.

Returns:

list of matching actor profiles (hopefully only one)

Throws:

org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - locationGUID or userId is null

org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - problem accessing property server

org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - security access problem

findActorProfiles

public List<org.odpi.openmetadata.accessservices.communityprofile.metadataelements.ActorProfileElement> findActorProfiles(String userId,
 String searchString,
 int startFrom,
 int pageSize)
                                                                                                                   throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException,
org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException,
org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException

Retrieve the list of matching profiles for the search string.

Specified by:

findActorProfiles in interface org.odpi.openmetadata.accessservices.communityprofile.api.OrganizationManagementInterface

Parameters:

userId - the name of the calling user.

searchString - RegEx string to search for

startFrom - index of the list to start from (0 for start)

pageSize - maximum number of elements to return.

Returns:

list of matching actor profiles

Throws:

org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - guid invalid or the external references are not correctly specified, or are null.

org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - the server is not available.

org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - the calling user is not authorized to issue the call.

createPersonRole

public String createPersonRole(String userId,
 String externalSourceGUID,
 String externalSourceName,
 org.odpi.openmetadata.accessservices.communityprofile.properties.PersonRoleProperties properties)
                        throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException,
org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException,
org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException

Create a definition of a person role.

Specified by:

createPersonRole in interface org.odpi.openmetadata.accessservices.communityprofile.api.OrganizationManagementInterface

Parameters:

userId - calling user

externalSourceGUID - guid of the software server capability entity that represented the external source - null for local

externalSourceName - name of the software server capability entity that represented the external source

properties - properties for a person role

Returns:

unique identifier of person role

Throws:

org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - qualifiedName or userId is null; qualifiedName is not unique

org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - problem accessing property server

org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - security access problem

updatePersonRole

public void updatePersonRole(String userId,
 String externalSourceGUID,
 String externalSourceName,
 String personRoleGUID,
 boolean isMergeUpdate,
 org.odpi.openmetadata.accessservices.communityprofile.properties.PersonRoleProperties properties)
                      throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException,
org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException,
org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException

Update the definition of a person role.

Specified by:

updatePersonRole in interface org.odpi.openmetadata.accessservices.communityprofile.api.OrganizationManagementInterface

Parameters:

userId - calling user

externalSourceGUID - guid of the software server capability entity that represented the external source - null for local

externalSourceName - name of the software server capability entity that represented the external source

personRoleGUID - unique identifier of person role

isMergeUpdate - are unspecified properties unchanged (true) or replaced with null?

properties - properties to change

Throws:

org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - guid, qualifiedName or userId is null; qualifiedName is not unique; guid is not known

org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - problem accessing property server

org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - security access problem

deletePersonRole

public void deletePersonRole(String userId,
 String externalSourceGUID,
 String externalSourceName,
 String personRoleGUID)
                      throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException,
org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException,
org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException

Remove the definition of a person role.

Specified by:

deletePersonRole in interface org.odpi.openmetadata.accessservices.communityprofile.api.OrganizationManagementInterface

Parameters:

userId - calling user

externalSourceGUID - guid of the software server capability entity that represented the external source - null for local

externalSourceName - name of the software server capability entity that represented the external source

personRoleGUID - unique identifier of person role

Throws:

org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - guid or userId is null; guid is not known

org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - problem accessing property server

org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - security access problem

linkPersonRoleToProfile

public String linkPersonRoleToProfile(String userId,
 String externalSourceGUID,
 String externalSourceName,
 String personRoleGUID,
 String personProfileGUID,
 org.odpi.openmetadata.accessservices.communityprofile.properties.AppointmentProperties properties)
                               throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException,
org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException,
org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException

Link a person role to a person profile to show that that person is performing the role.

Specified by:

linkPersonRoleToProfile in interface org.odpi.openmetadata.accessservices.communityprofile.api.OrganizationManagementInterface

Parameters:

userId - calling user

externalSourceGUID - guid of the software server capability entity that represented the external source - null for local

externalSourceName - name of the software server capability entity that represented the external source

personRoleGUID - unique identifier of the person role

personProfileGUID - unique identifier of the person profile

properties - optional properties for the appointment

Throws:

org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - one of the guids is null or not known

org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - problem accessing property server

org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - security access problem

getAppointees

public List<org.odpi.openmetadata.accessservices.communityprofile.metadataelements.PersonRoleAppointee> getAppointees(String userId,
 String personRoleGUID,
 Date effectiveTime,
 int startFrom,
 int pageSize)
                                                                                                               throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException,
org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException,
org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException

Return the list of people appointed to a particular role.

Specified by:

getAppointees in interface org.odpi.openmetadata.accessservices.communityprofile.api.OrganizationManagementInterface

Parameters:

userId - calling user

personRoleGUID - unique identifier of the person role

effectiveTime - time for appointments, null for full appointment history

startFrom - index of the list to start from (0 for start)

pageSize - maximum number of elements to return

Returns:

list of appointees

Throws:

org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - one of the guids is null or not known

org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - problem accessing property server

org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - security access problem

updateAppointment

public void updateAppointment(String userId,
 String externalSourceGUID,
 String externalSourceName,
 String appointmentGUID,
 boolean isMergeUpdate,
 org.odpi.openmetadata.accessservices.communityprofile.properties.AppointmentProperties properties)
                       throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException,
org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException,
org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException

Update the properties for the appointment of a person to a role.

Specified by:

updateAppointment in interface org.odpi.openmetadata.accessservices.communityprofile.api.OrganizationManagementInterface

Parameters:

userId - calling user

externalSourceGUID - guid of the software server capability entity that represented the external source - null for local

externalSourceName - name of the software server capability entity that represented the external source

appointmentGUID - unique identifier of the appointment relationship

isMergeUpdate - are unspecified properties unchanged (true) or replaced with null?

properties - properties to change

Throws:

org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - one of the guids is null or not known

org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - problem accessing property server

org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - security access problem

unlinkPersonRoleFromProfile

public void unlinkPersonRoleFromProfile(String userId,
 String externalSourceGUID,
 String externalSourceName,
 String appointmentGUID)
                                 throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException,
org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException,
org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException

Remove the link between a person role and a person profile.

Specified by:

unlinkPersonRoleFromProfile in interface org.odpi.openmetadata.accessservices.communityprofile.api.OrganizationManagementInterface

Parameters:

userId - calling user

externalSourceGUID - guid of the software server capability entity that represented the external source - null for local

externalSourceName - name of the software server capability entity that represented the external source

appointmentGUID - unique identifier of the appointment relationship

Throws:

org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - one of the guids is null or not known

org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - problem accessing property server

org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - security access problem

linkTeamPlayer

public void linkTeamPlayer(String userId,
 String externalSourceGUID,
 String externalSourceName,
 String teamRoleGUID,
 String teamProfileGUID,
 String position,
 boolean leadershipPosition)
                    throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException,
org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException,
org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException

Link a team leader person role or team member person role to a team profile.

Specified by:

linkTeamPlayer in interface org.odpi.openmetadata.accessservices.communityprofile.api.OrganizationManagementInterface

Parameters:

userId - calling user

externalSourceGUID - guid of the software server capability entity that represented the external source - null for local

externalSourceName - name of the software server capability entity that represented the external source

teamRoleGUID - unique identifier of the person role

teamProfileGUID - unique identifier of the team profile

position - position name of the role in the team

leadershipPosition - is this a leadership position

Throws:

org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - one of the guids is null or not known; the person role is not a team member or team leader

org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - problem accessing property server

org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - security access problem

unlinkTeamPlayer

public void unlinkTeamPlayer(String userId,
 String externalSourceGUID,
 String externalSourceName,
 String teamRoleGUID,
 String teamProfileGUID,
 boolean leadershipPosition)
                      throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException,
org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException,
org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException

Remove the link between a person role and a team profile.

Specified by:

unlinkTeamPlayer in interface org.odpi.openmetadata.accessservices.communityprofile.api.OrganizationManagementInterface

Parameters:

userId - calling user

externalSourceGUID - guid of the software server capability entity that represented the external source - null for local

externalSourceName - name of the software server capability entity that represented the external source

teamRoleGUID - unique identifier of the person role

teamProfileGUID - unique identifier of the team profile

leadershipPosition - is this a leadership position

Throws:

org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - one of the guids is null or not known; the person role is not a team member or team leader

org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - problem accessing property server

org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - security access problem

getPersonRoleByGUID

public org.odpi.openmetadata.accessservices.communityprofile.metadataelements.PersonRoleElement getPersonRoleByGUID(String userId,
 String personRoleGUID)
                                                                                                             throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException,
org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException,
org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException

Return information about a specific person role.

Specified by:

getPersonRoleByGUID in interface org.odpi.openmetadata.accessservices.communityprofile.api.OrganizationManagementInterface

Parameters:

userId - calling user

personRoleGUID - unique identifier for the person role

Returns:

properties of the person role

Throws:

org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - personRoleGUID or userId is null

org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - problem accessing property server

org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - security access problem

getPersonRolesByName

public List<org.odpi.openmetadata.accessservices.communityprofile.metadataelements.PersonRoleElement> getPersonRolesByName(String userId,
 String name,
 int startFrom,
 int pageSize)
                                                                                                                    throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException,
org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException,
org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException

Return information about a named person role.

Specified by:

getPersonRolesByName in interface org.odpi.openmetadata.accessservices.communityprofile.api.OrganizationManagementInterface

Parameters:

userId - calling user

name - unique name for the actor profile

startFrom - index of the list to start from (0 for start)

pageSize - maximum number of elements to return.

Returns:

list of matching actor profiles (hopefully only one)

Throws:

org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - name or userId is null

org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - problem accessing property server

org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - security access problem

getLeadershipRolesForTeam

public List<org.odpi.openmetadata.accessservices.communityprofile.metadataelements.PersonRoleElement> getLeadershipRolesForTeam(String userId,
 String teamGUID,
 int startFrom,
 int pageSize)
                                                                                                                         throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException,
org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException,
org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException

Return information about the leadership person roles linked to a team.

Specified by:

getLeadershipRolesForTeam in interface org.odpi.openmetadata.accessservices.communityprofile.api.OrganizationManagementInterface

Parameters:

userId - calling user

teamGUID - unique identifier for the Team actor profile

startFrom - index of the list to start from (0 for start)

pageSize - maximum number of elements to return.

Returns:

list of matching actor profiles (hopefully only one)

Throws:

org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - name or userId is null

org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - problem accessing property server

org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - security access problem

getMembershipRolesForTeam

public List<org.odpi.openmetadata.accessservices.communityprofile.metadataelements.PersonRoleElement> getMembershipRolesForTeam(String userId,
 String teamGUID,
 int startFrom,
 int pageSize)
                                                                                                                         throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException,
org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException,
org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException

Return information about the membership person roles linked to a team.

Specified by:

getMembershipRolesForTeam in interface org.odpi.openmetadata.accessservices.communityprofile.api.OrganizationManagementInterface

Parameters:

userId - calling user

teamGUID - unique identifier for the Team actor profile

startFrom - index of the list to start from (0 for start)

pageSize - maximum number of elements to return.

Returns:

list of matching actor profiles (hopefully only one)

Throws:

org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - name or userId is null

org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - problem accessing property server

org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - security access problem

findPersonRoles

public List<org.odpi.openmetadata.accessservices.communityprofile.metadataelements.PersonRoleElement> findPersonRoles(String userId,
 String searchString,
 int startFrom,
 int pageSize)
                                                                                                               throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException,
org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException,
org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException

Retrieve the list of matching roles for the search string.

Specified by:

findPersonRoles in interface org.odpi.openmetadata.accessservices.communityprofile.api.OrganizationManagementInterface

Parameters:

userId - the name of the calling user.

searchString - RegEx string to search for

startFrom - index of the list to start from (0 for start)

pageSize - maximum number of elements to return.

Returns:

list of matching actor profiles

Throws:

org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - guid invalid or the external references are not correctly specified, or are null.

org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - the server is not available.

org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - the calling user is not authorized to issue the call.