First-cut Activity Service (SLNG-20)

git-svn-id: https://svn.alfresco.com/repos/alfresco-enterprise/alfresco/HEAD/root@9128 c4b6b30b-aa2e-2d43-bbcb-ca4b014f7261
2025-07-24 17:32:48 +00:00 · 2008-05-15 16:34:11 +00:00
parent 9e67621ace
commit 067013afad
58 changed files with 5420 additions and 2 deletions
--- a/source/java/org/alfresco/service/cmr/activities/ActivityService.java
+++ b/source/java/org/alfresco/service/cmr/activities/ActivityService.java
@@ -0,0 +1,153 @@
+/*
+ * Copyright (C) 2005-2008 Alfresco Software Limited.
+ *
+ * This program is free software; you can redistribute it and/or
+ * modify it under the terms of the GNU General Public License
+ * as published by the Free Software Foundation; either version 2
+ * of the License, or (at your option) any later version.
+
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+
+ * You should have received a copy of the GNU General Public License
+ * along with this program; if not, write to the Free Software
+ * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
+
+ * As a special exception to the terms and conditions of version 2.0 of 
+ * the GPL, you may redistribute this Program in connection with Free/Libre 
+ * and Open Source Software ("FLOSS") applications as described in Alfresco's 
+ * FLOSS exception.  You should have recieved a copy of the text describing 
+ * the FLOSS exception, and it is also available here: 
+ * http://www.alfresco.com/legal/licensing"
+ */
+package org.alfresco.service.cmr.activities;
+
+import java.util.List;
+import java.util.Map;
+
+import org.alfresco.service.cmr.repository.NodeRef;
+import org.alfresco.service.namespace.QName;
+
+public interface ActivityService
+{    
+    
+    /*
+     * Post Activity
+     */
+    
+    /**
+     * Post a custom activity type
+     *
+     * @param activityType - required
+     * @param siteId - optional, if null will be stored as empty string
+     * @param appTool - optional, if null will be stored as empty string
+     * @param jsonActivityData - required
+     */
+    public void postActivity(String activityType, String siteId, String appTool, String jsonActivityData);
+    
+    /**
+     * Post a pre-defined activity type - certain activity data will be looked-up asynchronously, including:
+     *
+     *   name (of nodeRef)
+     *   displayPath
+     *   typeQName
+     *   firstName (of posting user)
+     *   lastName  (of posting user)
+     * 
+     * @param activityType - required
+     * @param siteId - optional, if null will be stored as empty string
+     * @param appTool - optional, if null will be stored as empty string
+     * @param nodeRef - required - do not use for deleted (or about to be deleted) nodeRef
+     */
+    public void postActivity(String activityType, String siteId, String appTool, NodeRef nodeRef);
+    
+    /**
+     * Post a pre-defined activity type - eg. for checked-out nodeRef or renamed nodeRef
+     * 
+     * @param activityType - required
+     * @param siteId - optional, if null will be stored as empty string
+     * @param appTool - optional, if null will be stored as empty string
+     * @param nodeRef - required - do not use deleted (or about to be deleted) nodeRef
+     * @param beforeName - optional - name of node (eg. prior to name change)
+     */
+    public void postActivity(String activityType, String siteId, String appTool, NodeRef nodeRef, String beforeName);
+    
+    /**
+     * Post a pre-defined activity type - eg. for deleted nodeRef
+     *
+     * @param activityType - required
+     * @param siteId - optional, if null will be stored as empty string
+     * @param appTool - optional, if null will be stored as empty string
+     * @param nodeRef - required - can be a deleted (or about to be deleted) nodeRef
+     * @param name - optional - name of name
+     * @param typeQName - optional - type of node
+     * @param parentNodeRef - required - used to lookup path/displayPath
+     */
+    public void postActivity(String activityType, String siteId, String appTool,  NodeRef nodeRef, String name, QName typeQName, NodeRef parentNodeRef);
+
+    
+    /*
+     * Retrieve Feed Entries
+     */
+    
+    /**
+     * Retrieve user feed
+     *
+     * @param userId - required
+     * @param format - required
+     * @param siteId - optional, if set then will filter by given siteId else return all sites
+     */
+    public List<Map<String, Object>> getUserFeedEntries(String userId, String format, String siteId);
+    
+    /**
+     * Retrieve site feed
+     *
+     * @param activityType - required
+     * @param format - required
+     */
+    public List<Map<String, Object>> getSiteFeedEntries(String siteId, String format);
+    
+    
+    /*
+     * Manage User Feed Controls
+     */
+    
+    /**
+     * For current user, set feed control (opt-out) for a site or an appTool or a site/appTool
+     *
+     * @param feedControl - required
+     */
+    public void setFeedControl(FeedControl feedControl);
+    
+    /**
+     * For given user, get feed controls
+     *
+     * @param userId - required (must match
+     * @return list of user feed controls
+     */
+    public List<FeedControl> getFeedControls(String userId);
+    
+    /**
+     * For current user, get feed controls
+     *
+     * @return list of user feed controls
+     */
+    public List<FeedControl> getFeedControls();
+    
+    /**
+     * For current user, unset feed control
+     *
+     * @param feedControl - required
+     */
+    public void unsetFeedControl(FeedControl feedControl);
+    
+    /**
+     * For current user, does the feed control exist ?
+     *
+     * @param feedControl - required
+     * @return true, if user feed control exists
+     */
+    public boolean existsFeedControl(FeedControl feedControl);
+}