Package org.odpi.openmetadata.accessservices.communityprofile.server

Class OrganizationRESTServices

java.lang.Object

org.odpi.openmetadata.accessservices.communityprofile.server.OrganizationRESTServices

public class OrganizationRESTServices
extends Object

The OrganizationRESTServices provides the server-side implementation of the Community Profile Open Metadata Assess Service (OMAS) capability for organization management. This interface provides support for creating all types of actor profiles and associated user roles in order to describe the structure of an organization.

Constructor Summary

Constructors

Constructor	Description
OrganizationRESTServices()	Default constructor

Method Summary

Modifier and Type	Method	Description
ActorProfileGraphResponse	getActorProfileByUserId(String serverName, String userId, String actorProfileUserId)	Return information about a specific actor profile.
ActorRoleResponse	getPersonRoleByGUID(String serverName, String userId, String personRoleGUID)	Return information about a specific person role.

Methods inherited from class java.lang.Object

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

Constructor Details

OrganizationRESTServices

public OrganizationRESTServices()

Default constructor

Method Details

getActorProfileByUserId

public ActorProfileGraphResponse getActorProfileByUserId(String serverName,
 String userId,
 String actorProfileUserId)

Return information about a specific actor profile.

Parameters:

serverName - called server

userId - calling user

actorProfileUserId - unique identifier for the actor profile

Returns:

properties of the actor profile InvalidParameterException actorProfileUserId or userId is null PropertyServerException problem accessing property server UserNotAuthorizedException security access problem

getPersonRoleByGUID

public ActorRoleResponse getPersonRoleByGUID(String serverName,
 String userId,
 String personRoleGUID)

Return information about a specific person role.

Parameters:

serverName - called server

userId - calling user

personRoleGUID - unique identifier for the person role

Returns:

properties of the person role InvalidParameterException personRoleGUID or userId is null PropertyServerException problem accessing property server UserNotAuthorizedException security access problem