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

Class ToDoActionManagement

java.lang.Object

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

org.odpi.openmetadata.accessservices.communityprofile.client.ToDoActionManagement

All Implemented Interfaces:

RelatedElementsManagementInterface, ToDoManagementInterface

public class ToDoActionManagement
extends CommunityProfileBaseClient
implements ToDoManagementInterface

Field Summary

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

baseURLTemplatePrefix, openMetadataStoreClient, propertyHelper

Constructor Summary

Constructors

Constructor	Description
ToDoActionManagement(String serverName, String serverPlatformURLRoot, int maxPageSize)	Create a new client with no authentication embedded in the HTTP request.
ToDoActionManagement(String serverName, String serverPlatformURLRoot, String userId, String password, int maxPageSize)	Create a new client that passes userId and password in each HTTP request.
ToDoActionManagement(String serverName, String serverPlatformURLRoot, String userId, String password, AuditLog auditLog, int maxPageSize)	Create a new client that passes userId and password in each HTTP request.
ToDoActionManagement(String serverName, String serverPlatformURLRoot, AuditLog auditLog, int maxPageSize)	Create a new client with no authentication embedded in the HTTP request.

Method Summary

Modifier and Type	Method	Description
String	createToDo(String userId, String originatorGUID, String actionSponsorGUID, String assignToActorGUID, List<NewToDoActionTargetProperties> newActionTargetProperties, ToDoProperties properties)	Create a new to do action and link it to the supplied role and targets (if applicable).
void	deleteToDo(String userId, String toDoGUID)	Delete an existing to do.
List<ToDoElement>	findToDos(String userId, String searchString, ToDoStatus toDoStatus, int startFrom, int pageSize)	Retrieve the "To Dos" that match the search string.
List<ToDoElement>	getActionsForActionTarget(String userId, String elementGUID, ToDoStatus toDoStatus, int startFrom, int pageSize)	Retrieve the "To Dos" that are chained off of an action target element.
List<ToDoElement>	getActionsForSponsor(String userId, String elementGUID, ToDoStatus toDoStatus, int startFrom, int pageSize)	Retrieve the "To Dos" that are chained off of a sponsor's element.
List<ToDoElement>	getAssignedActions(String userId, String actorGUID, ToDoStatus toDoStatus, int startFrom, int pageSize)	Retrieve the "To Dos" for a particular actor.
ToDoElement	getToDo(String userId, String toDoGUID)	Retrieve a "To Do" by unique identifier.
List<ToDoElement>	getToDosByType(String userId, String toDoType, ToDoStatus toDoStatus, int startFrom, int pageSize)	Retrieve the "To Dos" that match the type name and status.
void	reassignToDo(String userId, String toDoGUID, String actorGUID)	Assign a "To Do" to a new actor.
void	updateActionTargetProperties(String userId, String actionTargetGUID, boolean isMergeUpdate, ToDoActionTargetProperties actionTargetProperties)	Update the properties associated with an Action Target.
void	updateToDo(String userId, String toDoGUID, boolean isMergeUpdate, ToDoProperties properties)	Update the properties associated with a "To Do".

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

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

Constructor Details

ToDoActionManagement

public ToDoActionManagement(String serverName,
 String serverPlatformURLRoot,
 AuditLog auditLog,
 int maxPageSize)
                     throws 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:

InvalidParameterException - there is a problem creating the client-side components to issue any REST API calls.

ToDoActionManagement

public ToDoActionManagement(String serverName,
 String serverPlatformURLRoot,
 int maxPageSize)
                     throws 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:

InvalidParameterException - there is a problem creating the client-side components to issue any REST API calls.

ToDoActionManagement

public ToDoActionManagement(String serverName,
 String serverPlatformURLRoot,
 String userId,
 String password,
 int maxPageSize)
                     throws 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:

InvalidParameterException - there is a problem creating the client-side components to issue any REST API calls.

ToDoActionManagement

public ToDoActionManagement(String serverName,
 String serverPlatformURLRoot,
 String userId,
 String password,
 AuditLog auditLog,
 int maxPageSize)
                     throws 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:

InvalidParameterException - there is a problem creating the client-side components to issue any REST API calls.

Method Details

createToDo

public String createToDo(String userId,
 String originatorGUID,
 String actionSponsorGUID,
 String assignToActorGUID,
 List<NewToDoActionTargetProperties> newActionTargetProperties,
 ToDoProperties properties)
                  throws InvalidParameterException,
PropertyServerException,
UserNotAuthorizedException

Create a new to do action and link it to the supplied role and targets (if applicable).

Specified by:

createToDo in interface ToDoManagementInterface

Parameters:

userId - calling user

originatorGUID - optional originator element (such as a person or Governance Service)

actionSponsorGUID - optional element that maintains the "To Do" on their list

assignToActorGUID - optional actor to assign the action to

newActionTargetProperties - optional list of elements that the action is to target

properties - properties of the to do action

Returns:

unique identifier of the to do

Throws:

InvalidParameterException - a parameter is invalid

PropertyServerException - the server is not available

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

updateToDo

public void updateToDo(String userId,
 String toDoGUID,
 boolean isMergeUpdate,
 ToDoProperties properties)
                throws InvalidParameterException,
PropertyServerException,
UserNotAuthorizedException

Update the properties associated with a "To Do".

Specified by:

updateToDo in interface ToDoManagementInterface

Parameters:

userId - calling user

toDoGUID - unique identifier of the to do

isMergeUpdate - should the properties overlay the existing stored properties or replace them

properties - properties to change

Throws:

InvalidParameterException - a parameter is invalid

PropertyServerException - the server is not available

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

updateActionTargetProperties

public void updateActionTargetProperties(String userId,
 String actionTargetGUID,
 boolean isMergeUpdate,
 ToDoActionTargetProperties actionTargetProperties)
                                  throws InvalidParameterException,
PropertyServerException,
UserNotAuthorizedException

Update the properties associated with an Action Target.

Specified by:

updateActionTargetProperties in interface ToDoManagementInterface

Parameters:

userId - calling user

actionTargetGUID - unique identifier of the action target relationship

isMergeUpdate - should the actionTargetProperties overlay the existing stored properties or replace them

actionTargetProperties - properties to change

Throws:

InvalidParameterException - a parameter is invalid

PropertyServerException - the server is not available

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

reassignToDo

public void reassignToDo(String userId,
 String toDoGUID,
 String actorGUID)
                  throws InvalidParameterException,
PropertyServerException,
UserNotAuthorizedException

Assign a "To Do" to a new actor.

Specified by:

reassignToDo in interface ToDoManagementInterface

Parameters:

userId - calling user

toDoGUID - unique identifier of the to do

actorGUID - actor to assign the action to

Throws:

InvalidParameterException - a parameter is invalid

PropertyServerException - the server is not available

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

deleteToDo

public void deleteToDo(String userId,
 String toDoGUID)
                throws InvalidParameterException,
PropertyServerException,
UserNotAuthorizedException

Delete an existing to do.

Specified by:

deleteToDo in interface ToDoManagementInterface

Parameters:

userId - calling user

toDoGUID - unique identifier of the to do

Throws:

InvalidParameterException - a parameter is invalid

PropertyServerException - the server is not available

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

getToDo

public ToDoElement getToDo(String userId,
 String toDoGUID)
                    throws InvalidParameterException,
PropertyServerException,
UserNotAuthorizedException

Retrieve a "To Do" by unique identifier.

Specified by:

getToDo in interface ToDoManagementInterface

Parameters:

userId - calling user

toDoGUID - unique identifier of the to do

Returns:

to do bean

Throws:

InvalidParameterException - a parameter is invalid

PropertyServerException - the server is not available

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

getActionsForActionTarget

public List<ToDoElement> getActionsForActionTarget(String userId,
 String elementGUID,
 ToDoStatus toDoStatus,
 int startFrom,
 int pageSize)
                                            throws InvalidParameterException,
PropertyServerException,
UserNotAuthorizedException

Retrieve the "To Dos" that are chained off of an action target element.

Specified by:

getActionsForActionTarget in interface ToDoManagementInterface

Parameters:

userId - calling user

elementGUID - unique identifier of the element to start with

toDoStatus - optional "To Do" status

startFrom - initial position of the results to return

pageSize - maximum number of results to return

Returns:

list of to do beans

Throws:

InvalidParameterException - a parameter is invalid

PropertyServerException - the server is not available

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

getActionsForSponsor

public List<ToDoElement> getActionsForSponsor(String userId,
 String elementGUID,
 ToDoStatus toDoStatus,
 int startFrom,
 int pageSize)
                                       throws InvalidParameterException,
PropertyServerException,
UserNotAuthorizedException

Retrieve the "To Dos" that are chained off of a sponsor's element.

Specified by:

getActionsForSponsor in interface ToDoManagementInterface

Parameters:

userId - calling user

elementGUID - unique identifier of the element to start with

toDoStatus - optional "To Do" status

startFrom - initial position of the results to return

pageSize - maximum number of results to return

Returns:

list of to do beans

Throws:

InvalidParameterException - a parameter is invalid

PropertyServerException - the server is not available

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

getAssignedActions

public List<ToDoElement> getAssignedActions(String userId,
 String actorGUID,
 ToDoStatus toDoStatus,
 int startFrom,
 int pageSize)
                                     throws InvalidParameterException,
PropertyServerException,
UserNotAuthorizedException

Retrieve the "To Dos" for a particular actor.

Specified by:

getAssignedActions in interface ToDoManagementInterface

Parameters:

userId - calling user

actorGUID - unique identifier of the role

toDoStatus - optional "To Do" status

startFrom - initial position of the results to return

pageSize - maximum number of results to return

Returns:

list of to do beans

Throws:

InvalidParameterException - a parameter is invalid

PropertyServerException - the server is not available

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

findToDos

public List<ToDoElement> findToDos(String userId,
 String searchString,
 ToDoStatus toDoStatus,
 int startFrom,
 int pageSize)
                            throws InvalidParameterException,
PropertyServerException,
UserNotAuthorizedException

Retrieve the "To Dos" that match the search string.

Specified by:

findToDos in interface ToDoManagementInterface

Parameters:

userId - calling user

searchString - string to search for (may include RegExs)

toDoStatus - optional "To Do" status

startFrom - initial position of the results to return

pageSize - maximum number of results to return

Returns:

list of to do beans

Throws:

InvalidParameterException - a parameter is invalid

PropertyServerException - the server is not available

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

getToDosByType

public List<ToDoElement> getToDosByType(String userId,
 String toDoType,
 ToDoStatus toDoStatus,
 int startFrom,
 int pageSize)
                                 throws InvalidParameterException,
PropertyServerException,
UserNotAuthorizedException

Retrieve the "To Dos" that match the type name and status.

Specified by:

getToDosByType in interface ToDoManagementInterface

Parameters:

userId - calling user

toDoType - type to search for

toDoStatus - optional "To Do" status

startFrom - initial position of the results to return

pageSize - maximum number of results to return

Returns:

list of to do beans

Throws:

InvalidParameterException - a parameter is invalid

PropertyServerException - the server is not available

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