Package org.odpi.openmetadata.accessservices.communityprofile.api

Interface OrganizationManagementInterface

public interface OrganizationManagementInterface

OrganizationManagementInterface defines the client interface for setting up the profiles, roles and relationships for an organization.

Method Summary

Modifier and Type	Method	Description
String	addContactMethod(String userId, String externalSourceGUID, String externalSourceName, String actorProfileGUID, ContactMethodProperties properties)	Add a new contact method to the profile.
String	createActorProfile(String userId, String externalSourceGUID, String externalSourceName, ActorProfileProperties properties, ContributionRecord contributionRecord)	Create a definition of a actor profile.
String	createPersonRole(String userId, String externalSourceGUID, String externalSourceName, PersonRoleProperties properties)	Create a definition of a person role.
void	deleteActorProfile(String userId, String actorProfileGUID, String externalSourceGUID, String externalSourceName)	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<ActorProfileElement>	findActorProfile(String userId, String searchString, int startFrom, int pageSize)	Retrieve the list of matching profiles for the search string.
List<PersonRoleElement>	findPersonRole(String userId, String searchString, int startFrom, int pageSize)	Retrieve the list of matching roles for the search string.
ActorProfileElement	getActorProfileByGUID(String userId, String actorProfileGUID)	Return information about a specific actor profile.
List<ActorProfileElement>	getActorProfileByName(String userId, String name, int startFrom, int pageSize)	Return information about a named actor profile.
ActorProfileElement	getActorProfileByUserId(String userId, String actorProfileUserId)	Return information about a specific actor profile.
List<PersonRoleAppointee>	getAppointees(String userId, String personRoleGUID, Date effectiveTime, int startFrom, int pageSize)	Return the list of people appointed to a particular role.
PersonRoleElement	getPersonRoleByGUID(String userId, String personRoleGUID)	Return information about a specific person role.
List<PersonRoleElement>	getPersonRoleByName(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, 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, ActorProfileProperties properties, ContributionRecord contributionRecord)	Update the definition of an actor profile.
void	updateAppointment(String userId, String externalSourceGUID, String externalSourceName, String appointmentGUID, boolean isMergeUpdate, 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, PersonRoleProperties properties)	Update the definition of a person role.

Method Detail

createActorProfile

String createActorProfile(String userId,
                          String externalSourceGUID,
                          String externalSourceName,
                          ActorProfileProperties properties,
                          ContributionRecord contributionRecord)
                   throws InvalidParameterException,
                          UserNotAuthorizedException,
                          PropertyServerException

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

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:

InvalidParameterException - qualifiedName or userId is null; qualifiedName is not unique

PropertyServerException - problem accessing property server

UserNotAuthorizedException - security access problem

updateActorProfile

void updateActorProfile(String userId,
                        String externalSourceGUID,
                        String externalSourceName,
                        String actorProfileGUID,
                        boolean isMergeUpdate,
                        ActorProfileProperties properties,
                        ContributionRecord contributionRecord)
                 throws InvalidParameterException,
                        UserNotAuthorizedException,
                        PropertyServerException

Update the definition of an actor profile.

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

Throws:

InvalidParameterException - guid, qualifiedName or userId is null; qualifiedName is not unique; guid is not known

PropertyServerException - problem accessing property server

UserNotAuthorizedException - security access problem

deleteActorProfile

void deleteActorProfile(String userId,
                        String actorProfileGUID,
                        String externalSourceGUID,
                        String externalSourceName)
                 throws InvalidParameterException,
                        UserNotAuthorizedException,
                        PropertyServerException

Remove the definition of an actor profile.

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:

InvalidParameterException - guid or userId is null; guid is not known

PropertyServerException - problem accessing property server

UserNotAuthorizedException - security access problem

addContactMethod

String addContactMethod(String userId,
                        String externalSourceGUID,
                        String externalSourceName,
                        String actorProfileGUID,
                        ContactMethodProperties properties)
                 throws InvalidParameterException,
                        PropertyServerException,
                        UserNotAuthorizedException

Add a new contact method to the profile.

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:

InvalidParameterException - the userId is null or invalid. Another property is invalid.

PropertyServerException - there is a problem retrieving information from the property server(s).

UserNotAuthorizedException - the requesting user is not authorized to issue this request.

deleteContactMethod

void deleteContactMethod(String userId,
                         String externalSourceGUID,
                         String externalSourceName,
                         String contactMethodGUID)
                  throws InvalidParameterException,
                         PropertyServerException,
                         UserNotAuthorizedException

Remove an obsolete contact method from the profile.

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:

InvalidParameterException - the userId is null or invalid. Another property is invalid.

PropertyServerException - there is a problem retrieving information from the property server(s).

UserNotAuthorizedException - the requesting user is not authorized to issue this request.

linkTeamsInHierarchy

void linkTeamsInHierarchy(String userId,
                          String externalSourceGUID,
                          String externalSourceName,
                          String superTeamProfileGUID,
                          String subTeamProfileGUID,
                          boolean delegationEscalationAuthority,
                          Date effectiveFrom,
                          Date effectiveTo)
                   throws InvalidParameterException,
                          UserNotAuthorizedException,
                          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.

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:

InvalidParameterException - one of the guids is null or not known

PropertyServerException - problem accessing property server

UserNotAuthorizedException - security access problem

unlinkTeamsInHierarchy

void unlinkTeamsInHierarchy(String userId,
                            String externalSourceGUID,
                            String externalSourceName,
                            String superTeamProfileGUID,
                            String subTeamProfileGUID)
                     throws InvalidParameterException,
                            UserNotAuthorizedException,
                            PropertyServerException

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

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:

InvalidParameterException - one of the guids is null or not known

PropertyServerException - problem accessing property server

UserNotAuthorizedException - security access problem

getActorProfileByGUID

ActorProfileElement getActorProfileByGUID(String userId,
                                          String actorProfileGUID)
                                   throws InvalidParameterException,
                                          UserNotAuthorizedException,
                                          PropertyServerException

Return information about a specific actor profile.

Parameters:

userId - calling user

actorProfileGUID - unique identifier for the actor profile

Returns:

properties of the actor profile

Throws:

InvalidParameterException - actorProfileGUID or userId is null

PropertyServerException - problem accessing property server

UserNotAuthorizedException - security access problem

getActorProfileByUserId

ActorProfileElement getActorProfileByUserId(String userId,
                                            String actorProfileUserId)
                                     throws InvalidParameterException,
                                            UserNotAuthorizedException,
                                            PropertyServerException

Return information about a specific actor profile.

Parameters:

userId - calling user

actorProfileUserId - unique identifier for the actor profile

Returns:

properties of the actor profile

Throws:

InvalidParameterException - actorProfileUserId or userId is null

PropertyServerException - problem accessing property server

UserNotAuthorizedException - security access problem

getActorProfileByName

List<ActorProfileElement> getActorProfileByName(String userId,
                                                String name,
                                                int startFrom,
                                                int pageSize)
                                         throws InvalidParameterException,
                                                UserNotAuthorizedException,
                                                PropertyServerException

Return information about a named actor profile.

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:

InvalidParameterException - name or userId is null

PropertyServerException - problem accessing property server

UserNotAuthorizedException - security access problem

findActorProfile

List<ActorProfileElement> findActorProfile(String userId,
                                           String searchString,
                                           int startFrom,
                                           int pageSize)
                                    throws InvalidParameterException,
                                           PropertyServerException,
                                           UserNotAuthorizedException

Retrieve the list of matching profiles for the search string.

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:

InvalidParameterException - guid invalid or the external references are not correctly specified, or are null.

PropertyServerException - the server is not available.

UserNotAuthorizedException - the calling user is not authorized to issue the call.

createPersonRole

String createPersonRole(String userId,
                        String externalSourceGUID,
                        String externalSourceName,
                        PersonRoleProperties properties)
                 throws InvalidParameterException,
                        UserNotAuthorizedException,
                        PropertyServerException

Create a definition of a person role.

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:

InvalidParameterException - qualifiedName or userId is null; qualifiedName is not unique

PropertyServerException - problem accessing property server

UserNotAuthorizedException - security access problem

updatePersonRole

void updatePersonRole(String userId,
                      String externalSourceGUID,
                      String externalSourceName,
                      String personRoleGUID,
                      boolean isMergeUpdate,
                      PersonRoleProperties properties)
               throws InvalidParameterException,
                      UserNotAuthorizedException,
                      PropertyServerException

Update the definition of a person role.

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:

InvalidParameterException - guid, qualifiedName or userId is null; qualifiedName is not unique; guid is not known

PropertyServerException - problem accessing property server

UserNotAuthorizedException - security access problem

deletePersonRole

void deletePersonRole(String userId,
                      String externalSourceGUID,
                      String externalSourceName,
                      String personRoleGUID)
               throws InvalidParameterException,
                      UserNotAuthorizedException,
                      PropertyServerException

Remove the definition of a person role.

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:

InvalidParameterException - guid or userId is null; guid is not known

PropertyServerException - problem accessing property server

UserNotAuthorizedException - security access problem

linkPersonRoleToProfile

String linkPersonRoleToProfile(String userId,
                               String externalSourceGUID,
                               String externalSourceName,
                               String personRoleGUID,
                               String personProfileGUID,
                               AppointmentProperties properties)
                        throws InvalidParameterException,
                               UserNotAuthorizedException,
                               PropertyServerException

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

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

Returns:

unique identifier of the appointment

Throws:

InvalidParameterException - one of the guids is null or not known

PropertyServerException - problem accessing property server

UserNotAuthorizedException - security access problem

getAppointees

List<PersonRoleAppointee> getAppointees(String userId,
                                        String personRoleGUID,
                                        Date effectiveTime,
                                        int startFrom,
                                        int pageSize)
                                 throws InvalidParameterException,
                                        UserNotAuthorizedException,
                                        PropertyServerException

Return the list of people appointed to a particular role.

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:

InvalidParameterException - one of the guids is null or not known

PropertyServerException - problem accessing property server

UserNotAuthorizedException - security access problem

updateAppointment

void updateAppointment(String userId,
                       String externalSourceGUID,
                       String externalSourceName,
                       String appointmentGUID,
                       boolean isMergeUpdate,
                       AppointmentProperties properties)
                throws InvalidParameterException,
                       UserNotAuthorizedException,
                       PropertyServerException

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

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:

InvalidParameterException - one of the guids is null or not known

PropertyServerException - problem accessing property server

UserNotAuthorizedException - security access problem

unlinkPersonRoleFromProfile

void unlinkPersonRoleFromProfile(String userId,
                                 String externalSourceGUID,
                                 String externalSourceName,
                                 String appointmentGUID)
                          throws InvalidParameterException,
                                 UserNotAuthorizedException,
                                 PropertyServerException

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

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:

InvalidParameterException - one of the guids is null or not known

PropertyServerException - problem accessing property server

UserNotAuthorizedException - security access problem

linkTeamPlayer

void linkTeamPlayer(String userId,
                    String externalSourceGUID,
                    String externalSourceName,
                    String teamRoleGUID,
                    String teamProfileGUID,
                    String position,
                    boolean leadershipPosition)
             throws InvalidParameterException,
                    UserNotAuthorizedException,
                    PropertyServerException

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

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:

InvalidParameterException - one of the guids is null or not known; the person role is not a team member or team leader

PropertyServerException - problem accessing property server

UserNotAuthorizedException - security access problem

unlinkTeamPlayer

void unlinkTeamPlayer(String userId,
                      String externalSourceGUID,
                      String externalSourceName,
                      String teamRoleGUID,
                      String teamProfileGUID,
                      boolean leadershipPosition)
               throws InvalidParameterException,
                      UserNotAuthorizedException,
                      PropertyServerException

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

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:

InvalidParameterException - one of the guids is null or not known; the person role is not a team member or team leader

PropertyServerException - problem accessing property server

UserNotAuthorizedException - security access problem

getPersonRoleByGUID

PersonRoleElement getPersonRoleByGUID(String userId,
                                      String personRoleGUID)
                               throws InvalidParameterException,
                                      UserNotAuthorizedException,
                                      PropertyServerException

Return information about a specific person role.

Parameters:

userId - calling user

personRoleGUID - unique identifier for the person role

Returns:

properties of the person role

Throws:

InvalidParameterException - personRoleGUID or userId is null

PropertyServerException - problem accessing property server

UserNotAuthorizedException - security access problem

getPersonRoleByName

List<PersonRoleElement> getPersonRoleByName(String userId,
                                            String name,
                                            int startFrom,
                                            int pageSize)
                                     throws InvalidParameterException,
                                            UserNotAuthorizedException,
                                            PropertyServerException

Return information about a named person role.

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:

InvalidParameterException - name or userId is null

PropertyServerException - problem accessing property server

UserNotAuthorizedException - security access problem

findPersonRole

List<PersonRoleElement> findPersonRole(String userId,
                                       String searchString,
                                       int startFrom,
                                       int pageSize)
                                throws InvalidParameterException,
                                       PropertyServerException,
                                       UserNotAuthorizedException

Retrieve the list of matching roles for the search string.

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:

InvalidParameterException - guid invalid or the external references are not correctly specified, or are null.

PropertyServerException - the server is not available.

UserNotAuthorizedException - the calling user is not authorized to issue the call.