Fixed MNT-14690: DictionaryService.getModel() has incorrect javadoc

- Added note that null is not returned and add @exception - Some other minor javadoc clean up

Fixed MNT-14690: DictionaryService.getModel() has incorrect javadoc
- Added note that null is not returned and add @exception - Some other minor javadoc clean up
Derek Hulley
1 parent 3c1c46dda8
Showing 1 changed file with 3 additions and 6 deletions Show diff stats
src/main/java/org/alfresco/service/cmr/dictionary/DictionaryService.java
@@ -41,7 +41,7 @@ import com.sun.tools.xjc.outline.Aspect;
  * This interface represents the Repository Data Dictionary.  The
  * dictionary provides access to content meta-data such as Type
  * and Aspect descriptions.
- *
+ * <p>
  * Content meta-data is organised into models where each model is
  * given a qualified name.  This means that it is safe to develop
  * independent models and bring them together into the same
@@ -62,7 +62,8 @@ public interface DictionaryService extends MessageLookup
  
     /**
      * @param model the model name to retrieve
-     * @return the specified model (or null, if it doesn't exist)
+     * @return the specified model (never null)
+     * @throws DictionaryException if the model could not be found
      */
     @NotAuditable
     public ModelDefinition getModel(QName model);
@@ -315,13 +316,9 @@ public interface DictionaryService extends MessageLookup
      */
     Collection<ConstraintDefinition> getConstraints(QName model, boolean referenceableDefsOnly);
  
-
     /**
      * @param uri the namespace uri for search for
      * @return the named model definition
      */
     ModelDefinition getModelByNamespaceUri(String uri);
-
-    // TODO: Behaviour definitions
-    
 }
...	...	@@ -41,7 +41,7 @@ import com.sun.tools.xjc.outline.Aspect;
41	41	* This interface represents the Repository Data Dictionary. The
42	42	* dictionary provides access to content meta-data such as Type
43	43	* and Aspect descriptions.
44		- *
	44	+ * <p>
45	45	* Content meta-data is organised into models where each model is
46	46	* given a qualified name. This means that it is safe to develop
47	47	* independent models and bring them together into the same
...	...	@@ -62,7 +62,8 @@ public interface DictionaryService extends MessageLookup
62	62
63	63	/**
64	64	* @param model the model name to retrieve
65		- * @return the specified model (or null, if it doesn't exist)
	65	+ * @return the specified model (never null)
	66	+ * @throws DictionaryException if the model could not be found
66	67	*/
67	68	@NotAuditable
68	69	public ModelDefinition getModel(QName model);
...	...	@@ -315,13 +316,9 @@ public interface DictionaryService extends MessageLookup
315	316	*/
316	317	Collection<ConstraintDefinition> getConstraints(QName model, boolean referenceableDefsOnly);
317	318
318		-
319	319	/**
320	320	* @param uri the namespace uri for search for
321	321	* @return the named model definition
322	322	*/
323	323	ModelDefinition getModelByNamespaceUri(String uri);
324		-
325		- // TODO: Behaviour definitions
326		-
327	324	}
...	...