Changeset 1475

Timestamp:

07/27/11 13:55:35 (13 years ago)

Author:

twagoo

Message:

ComponentUsageService? actually checks results of service call and includes them in event.
Editor shows names of items that use the component in the confirmation dialog.

Fixes #134

Location:

ComponentRegistry/trunk

Files:

• ComponentBrowserGui/src/main/flex/clarin/cmdi/componentregistry/editor/EditorAS.as (modified) (2 diffs)
• ComponentBrowserGui/src/main/flex/clarin/cmdi/componentregistry/services/ComponentUsageCheckEvent.as (modified) (2 diffs)
• ComponentBrowserGui/src/main/flex/clarin/cmdi/componentregistry/services/ComponentUsageService.as (modified) (3 diffs)
• ComponentRegistry/src/main/java/clarin/cmdi/componentregistry/rest/ComponentRegistryRestService.java (modified) (1 diff)

ComponentRegistry/trunk/ComponentBrowserGui/src/main/flex/clarin/cmdi/componentregistry/editor/EditorAS.as

@@ -105 +105 @@
                 // Private components that are in updated require usage check call. If in use, the user can choose whether or not to save the changes .
                 if(inUserSpace && uploadAction == UploadService.UPDATE && !item.isProfile){
-                        checkUsage(item);
+                        checkUsage(item, inUserSpace);
                 }else{
                         doUpload(uploadAction,item);
@@ -117 +117 @@
  * Calls usage check for the specified component. If in use, asks user whether to proceed; if positive, initiates update.
  */
-private function checkUsage(item:ItemDescription, uploadAction:int = UploadService.UPDATE):void{
-        var componentUsageService:ComponentUsageService = new ComponentUsageService(item);
+private function checkUsage(item:ItemDescription, inUserSpace:Boolean = true, uploadAction:int = UploadService.UPDATE):void{
+        var componentUsageService:ComponentUsageService = new ComponentUsageService(item,inUserSpace);
         componentUsageService.addEventListener(ComponentUsageCheckEvent.COMPONENT_IN_USE, 
                 function (event:ComponentUsageCheckEvent):void{
                         if(event.isComponentInUse){
-                                Alert.show("Component is used by other components and/or profiles. Changes in this component will affect these. Do you want to proceed?","Component is used", Alert.YES|Alert.NO,null,
+                                var messageBody:String = "The component you are about to save is used by the following component(s) and/or profile(s):\n\n";
+                                for each(var name:String in event.itemUsingComponent){
+                                        messageBody += " - " + name + "\n";
+                                }
+                                messageBody += "\nChanges in this component will affect the above. Do you want to proceed?";
+                                Alert.show(messageBody,"Component is used", Alert.YES|Alert.NO,null,
                                         function (eventObj:CloseEvent):void{
                                                 if(eventObj.detail == Alert.YES){

ComponentRegistry/trunk/ComponentBrowserGui/src/main/flex/clarin/cmdi/componentregistry/services/ComponentUsageCheckEvent.as

@@ -3 +3 @@
         import flash.events.Event;
         
+        import mx.collections.ArrayCollection;
+        
         public class ComponentUsageCheckEvent extends Event
         {       
                 public static const COMPONENT_IN_USE:String = "componentInUse";
+                private var _itemsUsingComponent:ArrayCollection;
                 
-                public function ComponentUsageCheckEvent(type:String, componentInUse:Boolean,bubbles:Boolean = false, cancelable:Boolean = false)
+                public function ComponentUsageCheckEvent(type:String, itemsUsingComponent:ArrayCollection, bubbles:Boolean = false, cancelable:Boolean = false)
                 {
                         super(type, bubbles, cancelable);
-                        this._isComponentInUse = componentInUse;
+                        _itemsUsingComponent = itemsUsingComponent;
                 }
                 
@@ -16 +19 @@
                 
                 public function get isComponentInUse():Boolean{
-                        return _isComponentInUse;
+                        return _itemsUsingComponent != null && _itemsUsingComponent.length > 0;
+                }
+                
+                /**
+                 * Names of components that use the specified item
+                 */
+                public function get itemUsingComponent():ArrayCollection{
+                        return _itemsUsingComponent;
                 }
         }

ComponentRegistry/trunk/ComponentBrowserGui/src/main/flex/clarin/cmdi/componentregistry/services/ComponentUsageService.as

@@ -8 +8 @@
         import flash.events.EventDispatcher;
         
+        import mx.collections.ArrayCollection;
         import mx.controls.Alert;
         import mx.messaging.messages.HTTPRequestMessage;
@@ -15 +16 @@
         import mx.rpc.events.ResultEvent;
         import mx.rpc.http.HTTPService;
-        
         import mx.utils.StringUtil;
         
+        /**
+         * Service that calls registry/components/usage/{id} for the specified component, which is used to check
+         * whether the component is used by any other components or profiles in the same registry. 
+         */
         [Event(name="componentInUse", type="clarin.cmdi.componentregistry.services.ComponentUsageCheckEvent")]
         public class ComponentUsageService extends EventDispatcher
         {
                 private var service:HTTPService;
-                private var serviceUrl:String;
                 
-                public function ComponentUsageService(itemDescription:ItemDescription)
+                public function ComponentUsageService(itemDescription:ItemDescription, userSpace:Boolean)
                 {
                         var url:URI = new URI(Config.instance.componentUsageUrl + itemDescription.id);
+                        if (userSpace) {
+                                url.setQueryValue(Config.PARAM_USERSPACE, "true");
+                        }
 
                         service = new HTTPService();
@@ -41 +47 @@
                 
                 private function result(resultEvent:ResultEvent):void {
+                        // Result contains list of items that use the specified component
                         var resultXml:XML = resultEvent.result as XML;
-                        dispatchEvent(new ComponentUsageCheckEvent(ComponentUsageCheckEvent.COMPONENT_IN_USE, true));
+                        
+                        // Collect item names so the view can show them to the user
+                        var resultItems:ArrayCollection = new ArrayCollection();
+                        for each (var description:XML in resultXml.children()) {
+                                resultItems.addItem(description.name.toString());
+                        }
+                        
+                        var event:ComponentUsageCheckEvent = new ComponentUsageCheckEvent(ComponentUsageCheckEvent.COMPONENT_IN_USE, resultItems);                                      
+                        dispatchEvent(event);
                 }
                 

ComponentRegistry/trunk/ComponentRegistry/src/main/java/clarin/cmdi/componentregistry/rest/ComponentRegistryRestService.java

@@ -205 +205 @@
     @Path("/components/usage/{componentId}")
     @Produces({MediaType.TEXT_XML, MediaType.APPLICATION_XML, MediaType.APPLICATION_JSON})
-    public List<AbstractDescription> getComponentUsage(@PathParam("componentId") String componentId, @QueryParam(USERSPACE_PARAM) @DefaultValue("false") boolean userspace) throws ComponentRegistryException {
+    public List<AbstractDescription> getComponentUsage(@PathParam("componentId") String componentId, @QueryParam(USERSPACE_PARAM) @DefaultValue("true") boolean userspace) throws ComponentRegistryException {
         try {
             final long start = System.currentTimeMillis();