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 actionSponsorGUID, String assignToActorGUID, List<org.odpi.openmetadata.frameworks.openmetadata.properties.actions.NewToDoActionTargetProperties> newActionTargetProperties, org.odpi.openmetadata.frameworks.openmetadata.properties.actions.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<org.odpi.openmetadata.frameworks.openmetadata.metadataelements.ToDoElement>	findToDos(String userId, String searchString, org.odpi.openmetadata.frameworks.openmetadata.enums.ToDoStatus toDoStatus, int startFrom, int pageSize)	Retrieve the "To Dos" that match the search string.
List<org.odpi.openmetadata.frameworks.openmetadata.metadataelements.ToDoElement>	getActionsForActionTarget(String userId, String elementGUID, org.odpi.openmetadata.frameworks.openmetadata.enums.ToDoStatus toDoStatus, int startFrom, int pageSize)	Retrieve the "To Dos" that are chained off of an action target element.
List<org.odpi.openmetadata.frameworks.openmetadata.metadataelements.ToDoElement>	getActionsForSponsor(String userId, String elementGUID, org.odpi.openmetadata.frameworks.openmetadata.enums.ToDoStatus toDoStatus, int startFrom, int pageSize)	Retrieve the "To Dos" that are chained off of a sponsor's element.
List<org.odpi.openmetadata.frameworks.openmetadata.metadataelements.ToDoElement>	getAssignedActions(String userId, String actorGUID, org.odpi.openmetadata.frameworks.openmetadata.enums.ToDoStatus toDoStatus, int startFrom, int pageSize)	Retrieve the "To Dos" for a particular actor.
org.odpi.openmetadata.frameworks.openmetadata.metadataelements.ToDoElement	getToDo(String userId, String toDoGUID)	Retrieve a "To Do" by unique identifier.
List<org.odpi.openmetadata.frameworks.openmetadata.metadataelements.ToDoElement>	getToDosByType(String userId, String toDoType, org.odpi.openmetadata.frameworks.openmetadata.enums.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, org.odpi.openmetadata.frameworks.openmetadata.properties.actions.ToDoActionTargetProperties actionTargetProperties)	Update the properties associated with an Action Target.
void	updateToDo(String userId, String toDoGUID, boolean isMergeUpdate, org.odpi.openmetadata.frameworks.openmetadata.properties.actions.ToDoProperties toDoProperties)	Update the properties associated with a "To Do".

Method Details

createToDo

String createToDo(String userId,
 String originatorGUID,
 String actionSponsorGUID,
 String assignToActorGUID,
 List<org.odpi.openmetadata.frameworks.openmetadata.properties.actions.NewToDoActionTargetProperties> newActionTargetProperties,
 org.odpi.openmetadata.frameworks.openmetadata.properties.actions.ToDoProperties properties)
           throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException,
org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException,
org.odpi.openmetadata.frameworks.connectors.ffdc.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 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:

org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - a parameter is invalid

org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - the server is not available

org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - the calling user is not authorized to issue the call

updateToDo

void updateToDo(String userId,
 String toDoGUID,
 boolean isMergeUpdate,
 org.odpi.openmetadata.frameworks.openmetadata.properties.actions.ToDoProperties toDoProperties)
         throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException,
org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException,
org.odpi.openmetadata.frameworks.connectors.ffdc.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:

org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - a parameter is invalid

org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - the server is not available

org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - the calling user is not authorized to issue the call

updateActionTargetProperties

void updateActionTargetProperties(String userId,
 String actionTargetGUID,
 boolean isMergeUpdate,
 org.odpi.openmetadata.frameworks.openmetadata.properties.actions.ToDoActionTargetProperties actionTargetProperties)
                           throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException,
org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException,
org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException

Update the properties associated with an Action Target.

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:

org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - a parameter is invalid

org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - the server is not available

org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - the calling user is not authorized to issue the call

reassignToDo

void reassignToDo(String userId,
 String toDoGUID,
 String actorGUID)
           throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException,
org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException,
org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException

Assign a "To Do" to a new actor.

Parameters:

userId - calling user

toDoGUID - unique identifier of the to do

actorGUID - actor to assign the action to

Throws:

org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - a parameter is invalid

org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - the server is not available

org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - the calling user is not authorized to issue the call

deleteToDo

void deleteToDo(String userId,
 String toDoGUID)
         throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException,
org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException,
org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException

Delete an existing to do.

Parameters:

userId - calling user

toDoGUID - unique identifier of the to do

Throws:

org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - a parameter is invalid

org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - the server is not available

org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - the calling user is not authorized to issue the call

getToDo

org.odpi.openmetadata.frameworks.openmetadata.metadataelements.ToDoElement getToDo(String userId,
 String toDoGUID)
                                                                            throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException,
org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException,
org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException

Retrieve a "To Do" by unique identifier.

Parameters:

userId - calling user

toDoGUID - unique identifier of the to do

Returns:

to do bean

Throws:

org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - a parameter is invalid

org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - the server is not available

org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - the calling user is not authorized to issue the call

getActionsForActionTarget

List<org.odpi.openmetadata.frameworks.openmetadata.metadataelements.ToDoElement> getActionsForActionTarget(String userId,
 String elementGUID,
 org.odpi.openmetadata.frameworks.openmetadata.enums.ToDoStatus toDoStatus,
 int startFrom,
 int pageSize)
                                                                                                    throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException,
org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException,
org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException

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

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:

org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - a parameter is invalid

org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - the server is not available

org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - the calling user is not authorized to issue the call

getActionsForSponsor

List<org.odpi.openmetadata.frameworks.openmetadata.metadataelements.ToDoElement> getActionsForSponsor(String userId,
 String elementGUID,
 org.odpi.openmetadata.frameworks.openmetadata.enums.ToDoStatus toDoStatus,
 int startFrom,
 int pageSize)
                                                                                               throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException,
org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException,
org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException

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

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:

org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - a parameter is invalid

org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - the server is not available

org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - the calling user is not authorized to issue the call

getAssignedActions

List<org.odpi.openmetadata.frameworks.openmetadata.metadataelements.ToDoElement> getAssignedActions(String userId,
 String actorGUID,
 org.odpi.openmetadata.frameworks.openmetadata.enums.ToDoStatus toDoStatus,
 int startFrom,
 int pageSize)
                                                                                             throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException,
org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException,
org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException

Retrieve the "To Dos" for a particular actor.

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:

org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - a parameter is invalid

org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - the server is not available

org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - the calling user is not authorized to issue the call

findToDos

List<org.odpi.openmetadata.frameworks.openmetadata.metadataelements.ToDoElement> findToDos(String userId,
 String searchString,
 org.odpi.openmetadata.frameworks.openmetadata.enums.ToDoStatus toDoStatus,
 int startFrom,
 int pageSize)
                                                                                    throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException,
org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException,
org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException

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

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:

org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - a parameter is invalid

org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - the server is not available

org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - the calling user is not authorized to issue the call

getToDosByType

List<org.odpi.openmetadata.frameworks.openmetadata.metadataelements.ToDoElement> getToDosByType(String userId,
 String toDoType,
 org.odpi.openmetadata.frameworks.openmetadata.enums.ToDoStatus toDoStatus,
 int startFrom,
 int pageSize)
                                                                                         throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException,
org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException,
org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException

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

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:

org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - a parameter is invalid

org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - the server is not available

org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - the calling user is not authorized to issue the call