Interface ToDoManagementInterface
public interface ToDoManagementInterface
-
Method Summary
Modifier and TypeMethodDescriptioncreateToDo
(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.getActionsForElement
(String userId, String elementGUID, int startFrom, int pageSize) Retrieve the to dos that are chained off of an element.getAssignedActions
(String userId, String roleGUID, int startFrom, int pageSize) Retrieve the to dos for a particular person role.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 Details
-
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 useroriginatorGUID
- optional originator element (such as a meeting or project or asset)assignToRoleGUID
- optional role to assign the action totargetElementGUIDs
- optional list of elements that the action is to targetproperties
- properties of the to do action- Returns:
- unique identifier of the to do
- Throws:
InvalidParameterException
- a parameter is invalidPropertyServerException
- the server is not availableUserNotAuthorizedException
- 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 usertoDoGUID
- unique identifier of the to doisMergeUpdate
- should the toDoProperties overlay the existing stored properties or replace themtoDoProperties
- properties to change- Throws:
InvalidParameterException
- a parameter is invalidPropertyServerException
- the server is not availableUserNotAuthorizedException
- 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 usertoDoGUID
- unique identifier of the to do- Throws:
InvalidParameterException
- a parameter is invalidPropertyServerException
- the server is not availableUserNotAuthorizedException
- 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 usertoDoGUID
- unique identifier of the to do- Returns:
- to do bean
- Throws:
InvalidParameterException
- a parameter is invalidPropertyServerException
- the server is not availableUserNotAuthorizedException
- 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 userelementGUID
- unique identifier of the element to start withstartFrom
- initial position of the results to returnpageSize
- maximum number of results to return- Returns:
- list of to do beans
- Throws:
InvalidParameterException
- a parameter is invalidPropertyServerException
- the server is not availableUserNotAuthorizedException
- 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 userroleGUID
- unique identifier of the rolestartFrom
- initial position of the results to returnpageSize
- maximum number of results to return- Returns:
- list of to do beans
- Throws:
InvalidParameterException
- a parameter is invalidPropertyServerException
- the server is not availableUserNotAuthorizedException
- the calling user is not authorized to issue the call
-