org.argeo.activities

Interface ActivitiesService

All Superinterfaces:

AppService

All Known Implementing Classes:

ActivitiesServiceImpl

public interface ActivitiesService
extends AppService

Manage activity and tasks concepts in a Connect repository. Implementing applications should extend and/or override the canonical implementation in order to provide business specific behaviours. The correct instance of this interface is usually acquired through the peopleService.

Method Summary

Modifier and Type	Method and Description
Node	configureActivity(Node activity, java.lang.String type, java.lang.String title, java.lang.String desc, java.util.List<Node> relatedTo) Simply configures a simple activity using default manager (the current logged in user) and default date (now)
Node	configureActivity(Node activity, java.lang.String reporterId, java.lang.String type, java.lang.String title, java.lang.String desc, java.util.List<Node> relatedTo, java.util.Calendar date) Creates a new simple activity using the default path We use a distinct manager and activity date rather than JCR_CREATED and JCR_CREATED_BY fields because we cannot force these fields and this is problematic for instance when importing old activities
Node	configureTask(Node task, java.lang.String taskNodeType, java.lang.String title, java.lang.String description, java.lang.String assignedTo) Creates a new draft task with the minimum information
Node	configureTask(Node task, java.lang.String taskNodeType, java.lang.String reporterId, java.lang.String title, java.lang.String description, java.lang.String assignedTo, java.util.List<Node> relatedTo, java.util.Calendar creationDate, java.util.Calendar dueDate, java.util.Calendar wakeUpDate) Creates a new draft task with the given information.
java.lang.String	getActivityLabel(Node activity) Returns the default activity English Label if defined.
java.util.Calendar	getActivityRelevantDate(Node activityNode) Retrieves a date to display depending on the node type.
java.lang.String	getAssignedToDisplayName(Node taskNode) Gets the display name of the assigned to group for this task
NodeIterator	getMyTasks(Session session, boolean onlyOpenTasks) Retrieves tasks assigned to one of the group that contain the username retrieved from the current session
NodeIterator	getTasksForUser(Session session, java.lang.String username, boolean onlyOpenTasks) Retrieves tasks assigned to one of the group that contain this username
boolean	isTaskDone(Node taskNode) Determines whether a task has been done.
boolean	isTaskSleeping(Node taskNode) Determines whether is sleeping.
void	setTaskDefaultStatus(Node taskNode, java.lang.String taskNodeType)
boolean	updateStatus(java.lang.String templateId, Node taskNode, java.lang.String newStatus, java.util.List<java.lang.String> modifiedPaths) Updates the status of this task to the new passed status.

Methods inherited from interface org.argeo.connect.AppService

createDraftEntity, getAppBaseName, getBaseRelPath, getDefaultRelPath, getDefaultRelPath, getDisplayName, getDraftParent, getEntityByUid, getLabel, getMainNodeType, isKnownType, isKnownType, publishEntity, publishEntity, saveEntity

Method Detail

configureActivity

Node configureActivity(Node activity,
                       java.lang.String type,
                       java.lang.String title,
                       java.lang.String desc,
                       java.util.List<Node> relatedTo)
                throws RepositoryException

Simply configures a simple activity using default manager (the current logged in user) and default date (now)

Throws:

RepositoryException

configureActivity

Node configureActivity(Node activity,
                       java.lang.String reporterId,
                       java.lang.String type,
                       java.lang.String title,
                       java.lang.String desc,
                       java.util.List<Node> relatedTo,
                       java.util.Calendar date)
                throws RepositoryException

Creates a new simple activity using the default path We use a distinct manager and activity date rather than JCR_CREATED and JCR_CREATED_BY fields because we cannot force these fields and this is problematic for instance when importing old activities

Throws:

RepositoryException

getActivityLabel

java.lang.String getActivityLabel(Node activity)

Returns the default activity English Label if defined. It relies on the mixin of this node. If an activity Node is having more than one "activity type" mixin, the main type as returned by the AppService.getMainNodeType(Node) methods will be used.

getActivityRelevantDate

java.util.Calendar getActivityRelevantDate(Node activityNode)

Retrieves a date to display depending on the node type.

Parameters:

activityNode - an activity or a task

Returns:

configureTask

Node configureTask(Node task,
                   java.lang.String taskNodeType,
                   java.lang.String title,
                   java.lang.String description,
                   java.lang.String assignedTo)
            throws RepositoryException

Creates a new draft task with the minimum information

Parameters:

taskNodeType -

Throws:

RepositoryException

configureTask

Node configureTask(Node task,
                   java.lang.String taskNodeType,
                   java.lang.String reporterId,
                   java.lang.String title,
                   java.lang.String description,
                   java.lang.String assignedTo,
                   java.util.List<Node> relatedTo,
                   java.util.Calendar creationDate,
                   java.util.Calendar dueDate,
                   java.util.Calendar wakeUpDate)
            throws RepositoryException

Creates a new draft task with the given information.

Parameters:

session -

taskNodeType -

reporterId -

title -

description -

assignedTo -

relatedTo -

creationDate -

dueDate -

wakeUpDate -

Returns:

Throws:

RepositoryException

setTaskDefaultStatus

void setTaskDefaultStatus(Node taskNode,
                          java.lang.String taskNodeType)
                   throws RepositoryException

Throws:

RepositoryException

getMyTasks

NodeIterator getMyTasks(Session session,
                        boolean onlyOpenTasks)

Retrieves tasks assigned to one of the group that contain the username retrieved from the current session

getTasksForUser

NodeIterator getTasksForUser(Session session,
                             java.lang.String username,
                             boolean onlyOpenTasks)

Retrieves tasks assigned to one of the group that contain this username

getAssignedToDisplayName

java.lang.String getAssignedToDisplayName(Node taskNode)

Gets the display name of the assigned to group for this task

updateStatus

boolean updateStatus(java.lang.String templateId,
                     Node taskNode,
                     java.lang.String newStatus,
                     java.util.List<java.lang.String> modifiedPaths)
              throws RepositoryException

Updates the status of this task to the new passed status. It is also in charge of updating other task properties, typically after determining if the closed status of the task has changed. It also enable to keep a cache of modified node if the update triggered modification or update on other nodes. It will return true if anything has changed but *DOES NOT SAVE* the session

Throws:

RepositoryException

isTaskDone

boolean isTaskDone(Node taskNode)

Determines whether a task has been done. Application should override or extends this to provide specific behaviour

isTaskSleeping

boolean isTaskSleeping(Node taskNode)

Determines whether is sleeping. Application should override or extends this to provide specific behaviour