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

Interface OrganizationManagementInterface

All Known Implementing Classes:

OrganizationManagement

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
ActorProfileGraphElement	getActorProfileByUserId(String userId, String actorProfileUserId)	Return information about a specific actor profile.
ActorRoleElement	getPersonRoleByGUID(String userId, String personRoleGUID)	Return information about a specific person role.

Method Details

getActorProfileByUserId

ActorProfileGraphElement 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

getPersonRoleByGUID

ActorRoleElement 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