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

Interface ToDoManagementInterface

public interface ToDoManagementInterface

Method Summary

Modifier and Type	Method	Description
String	createToDo(String userId, String originatorGUID, String assignToRoleGUID, List<String> targetElementGUIDs, 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>	getActionsForElement(String userId, String elementGUID, int startFrom, int pageSize)	Retrieve the to dos that are chained off of an element.
List<ToDoElement>	getAssignedActions(String userId, String roleGUID, int startFrom, int pageSize)	Retrieve the to dos for a particular person role.
ToDoElement	getToDo(String userId, String toDoGUID)	Retrieve a to do by unique identifier.
void	updateToDo(String userId, String toDoGUID, boolean isMergeUpdate, ToDoProperties toDoProperties)	Update the properties associated with a To Do.

Method Detail

createToDo

String createToDo(String userId,
                  String originatorGUID,
                  String assignToRoleGUID,
                  List<String> targetElementGUIDs,
                  ToDoProperties properties)
           throws InvalidParameterException,
                  PropertyServerException,
                  UserNotAuthorizedException

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

Parameters:

userId - calling user

originatorGUID - optional originator element (such as a meeting or project or asset)

assignToRoleGUID - optional role to assign the action to

targetElementGUIDs - 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

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

Update the properties associated with a To Do.

Parameters:

userId - calling user

toDoGUID - unique identifier of the to do

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

toDoProperties - 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

deleteToDo

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

Delete an existing to do.

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

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

Retrieve a to do by unique identifier.

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

getActionsForElement

List<ToDoElement> getActionsForElement(String userId,
                                       String elementGUID,
                                       int startFrom,
                                       int pageSize)
                                throws InvalidParameterException,
                                       PropertyServerException,
                                       UserNotAuthorizedException

Retrieve the to dos that are chained off of an element.

Parameters:

userId - calling user

elementGUID - unique identifier of the element to start with

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

List<ToDoElement> getAssignedActions(String userId,
                                     String roleGUID,
                                     int startFrom,
                                     int pageSize)
                              throws InvalidParameterException,
                                     PropertyServerException,
                                     UserNotAuthorizedException

Retrieve the to dos for a particular person role.

Parameters:

userId - calling user

roleGUID - unique identifier of the role

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