Skip to content
This repository

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Browse code

LPS-26306 Update javadoc

  • Loading branch information...
commit 0abf123cae2bf9dce329acc336ca1213391dc92b 1 parent 11f7b07
Raymond Augé authored April 05, 2012
28  portal-impl/src/META-INF/javadocs.xml
@@ -30199,6 +30199,9 @@ Never call the update methods of this service directly, always go through the re
30199 30199
 				<type>long</type>
30200 30200
 				<comment><![CDATA[the primary key of the role]]></comment>
30201 30201
 			</param>
  30202
+			<return>
  30203
+				<comment><![CDATA[]]></comment>
  30204
+			</return>
30202 30205
 			<throws>
30203 30206
 				<name>PortalException</name>
30204 30207
 				<type>com.liferay.portal.kernel.exception.PortalException</type>
@@ -30218,6 +30221,9 @@ Never call the update methods of this service directly, always go through the re
30218 30221
 				<type>com.liferay.portal.model.Role</type>
30219 30222
 				<comment><![CDATA[the role]]></comment>
30220 30223
 			</param>
  30224
+			<return>
  30225
+				<comment><![CDATA[]]></comment>
  30226
+			</return>
30221 30227
 			<throws>
30222 30228
 				<name>PortalException</name>
30223 30229
 				<type>com.liferay.portal.kernel.exception.PortalException</type>
@@ -30371,28 +30377,6 @@ If the group is a site, then the default role is {@link com.liferay.portal.model
30371 30377
 		</method>
30372 30378
 		<method>
30373 30379
 			<name>getRole</name>
30374  
-			<comment><![CDATA[Returns the role with the primary key.]]></comment>
30375  
-			<param>
30376  
-				<name>roleId</name>
30377  
-				<type>long</type>
30378  
-				<comment><![CDATA[the primary key of the role]]></comment>
30379  
-			</param>
30380  
-			<return>
30381  
-				<comment><![CDATA[the role with the primary key]]></comment>
30382  
-			</return>
30383  
-			<throws>
30384  
-				<name>PortalException</name>
30385  
-				<type>com.liferay.portal.kernel.exception.PortalException</type>
30386  
-				<comment><![CDATA[if a role with the primary key could not be found]]></comment>
30387  
-			</throws>
30388  
-			<throws>
30389  
-				<name>SystemException</name>
30390  
-				<type>com.liferay.portal.kernel.exception.SystemException</type>
30391  
-				<comment><![CDATA[if a system exception occurred]]></comment>
30392  
-			</throws>
30393  
-		</method>
30394  
-		<method>
30395  
-			<name>getRole</name>
30396 30380
 			<comment><![CDATA[Returns the role with the name in the company.
30397 30381
 
30398 30382
 <p>
17  portal-impl/src/com/liferay/portal/service/impl/RoleLocalServiceImpl.java
@@ -291,6 +291,7 @@ public void checkSystemRoles(long companyId)
291 291
 	 * Deletes the role with the primary key and its associated permissions.
292 292
 	 *
293 293
 	 * @param  roleId the primary key of the role
  294
+	 * @return
294 295
 	 * @throws PortalException if a role with the primary key could not be
295 296
 	 *         found, if the role is a default system role, or if the role's
296 297
 	 *         resource could not be found
@@ -309,6 +310,7 @@ public Role deleteRole(long roleId)
309 310
 	 * Deletes the role and its associated permissions.
310 311
 	 *
311 312
 	 * @param  role the role
  313
+	 * @return
312 314
 	 * @throws PortalException if the role is a default system role or if the
313 315
 	 *         role's resource could not be found
314 316
 	 * @throws SystemException if a system exception occurred
@@ -906,9 +908,8 @@ public Role loadGetRole(long companyId, String name)
906 908
 	 * @param  keywords the keywords (space separated), which may occur in the
907 909
 	 *         role's name or description (optionally <code>null</code>)
908 910
 	 * @param  types the role types (optionally <code>null</code>)
909  
-	 * @param  params the finder parameters. Can specify values for
910  
-	 *         "permissionsResourceId" and "usersRoles" keys. For more
911  
-	 *         information, see {@link
  911
+	 * @param  params the finder parameters. Can specify values for the
  912
+	 *         "usersRoles" key. For more information, see {@link
912 913
 	 *         com.liferay.portal.service.persistence.RoleFinder}
913 914
 	 * @param  start the lower bound of the range of roles to return
914 915
 	 * @param  end the upper bound of the range of roles to return (not
@@ -986,9 +987,8 @@ public Role loadGetRole(long companyId, String name)
986 987
 	 * @param  name the role's name (optionally <code>null</code>)
987 988
 	 * @param  description the role's description (optionally <code>null</code>)
988 989
 	 * @param  types the role types (optionally <code>null</code>)
989  
-	 * @param  params the finder's parameters. Can specify values for
990  
-	 *         "permissionsResourceId" and "usersRoles" keys. For more
991  
-	 *         information, see {@link
  990
+	 * @param  params the finder's parameters. Can specify values for the
  991
+	 *         "usersRoles" key. For more information, see {@link
992 992
 	 *         com.liferay.portal.service.persistence.RoleFinder}
993 993
 	 * @param  start the lower bound of the range of the roles to return
994 994
 	 * @param  end the upper bound of the range of the roles to return (not
@@ -1074,9 +1074,8 @@ public int searchCount(
1074 1074
 	 * @param  name the role's name (optionally <code>null</code>)
1075 1075
 	 * @param  description the role's description (optionally <code>null</code>)
1076 1076
 	 * @param  types the role types (optionally <code>null</code>)
1077  
-	 * @param  params the finder parameters. Can specify values for
1078  
-	 *         "permissionsResourceId" and "usersRoles" keys. For more
1079  
-	 *         information, see {@link
  1077
+	 * @param  params the finder parameters. Can specify values for the
  1078
+	 *         "usersRoles" key. For more information, see {@link
1080 1079
 	 *         com.liferay.portal.service.persistence.RoleFinder}
1081 1080
 	 * @return the number of matching roles
1082 1081
 	 * @throws SystemException if a system exception occurred
15  portal-service/src/com/liferay/portal/service/RoleLocalService.java
@@ -747,9 +747,8 @@ public boolean hasUserRoles(long userId, long companyId,
747 747
 	* @param keywords the keywords (space separated), which may occur in the
748 748
 	role's name or description (optionally <code>null</code>)
749 749
 	* @param types the role types (optionally <code>null</code>)
750  
-	* @param params the finder parameters. Can specify values for
751  
-	"permissionsResourceId" and "usersRoles" keys. For more
752  
-	information, see {@link
  750
+	* @param params the finder parameters. Can specify values for the
  751
+	"usersRoles" key. For more information, see {@link
753 752
 	com.liferay.portal.service.persistence.RoleFinder}
754 753
 	* @param start the lower bound of the range of roles to return
755 754
 	* @param end the upper bound of the range of roles to return (not
@@ -821,9 +820,8 @@ public boolean hasUserRoles(long userId, long companyId,
821 820
 	* @param name the role's name (optionally <code>null</code>)
822 821
 	* @param description the role's description (optionally <code>null</code>)
823 822
 	* @param types the role types (optionally <code>null</code>)
824  
-	* @param params the finder's parameters. Can specify values for
825  
-	"permissionsResourceId" and "usersRoles" keys. For more
826  
-	information, see {@link
  823
+	* @param params the finder's parameters. Can specify values for the
  824
+	"usersRoles" key. For more information, see {@link
827 825
 	com.liferay.portal.service.persistence.RoleFinder}
828 826
 	* @param start the lower bound of the range of the roles to return
829 827
 	* @param end the upper bound of the range of the roles to return (not
@@ -899,9 +897,8 @@ public int searchCount(long companyId, java.lang.String name,
899 897
 	* @param name the role's name (optionally <code>null</code>)
900 898
 	* @param description the role's description (optionally <code>null</code>)
901 899
 	* @param types the role types (optionally <code>null</code>)
902  
-	* @param params the finder parameters. Can specify values for
903  
-	"permissionsResourceId" and "usersRoles" keys. For more
904  
-	information, see {@link
  900
+	* @param params the finder parameters. Can specify values for the
  901
+	"usersRoles" key. For more information, see {@link
905 902
 	com.liferay.portal.service.persistence.RoleFinder}
906 903
 	* @return the number of matching roles
907 904
 	* @throws SystemException if a system exception occurred
15  portal-service/src/com/liferay/portal/service/RoleLocalServiceUtil.java
@@ -815,9 +815,8 @@ public static boolean hasUserRoles(long userId, long companyId,
815 815
 	* @param keywords the keywords (space separated), which may occur in the
816 816
 	role's name or description (optionally <code>null</code>)
817 817
 	* @param types the role types (optionally <code>null</code>)
818  
-	* @param params the finder parameters. Can specify values for
819  
-	"permissionsResourceId" and "usersRoles" keys. For more
820  
-	information, see {@link
  818
+	* @param params the finder parameters. Can specify values for the
  819
+	"usersRoles" key. For more information, see {@link
821 820
 	com.liferay.portal.service.persistence.RoleFinder}
822 821
 	* @param start the lower bound of the range of roles to return
823 822
 	* @param end the upper bound of the range of roles to return (not
@@ -893,9 +892,8 @@ public static boolean hasUserRoles(long userId, long companyId,
893 892
 	* @param name the role's name (optionally <code>null</code>)
894 893
 	* @param description the role's description (optionally <code>null</code>)
895 894
 	* @param types the role types (optionally <code>null</code>)
896  
-	* @param params the finder's parameters. Can specify values for
897  
-	"permissionsResourceId" and "usersRoles" keys. For more
898  
-	information, see {@link
  895
+	* @param params the finder's parameters. Can specify values for the
  896
+	"usersRoles" key. For more information, see {@link
899 897
 	com.liferay.portal.service.persistence.RoleFinder}
900 898
 	* @param start the lower bound of the range of the roles to return
901 899
 	* @param end the upper bound of the range of the roles to return (not
@@ -977,9 +975,8 @@ public static int searchCount(long companyId, java.lang.String name,
977 975
 	* @param name the role's name (optionally <code>null</code>)
978 976
 	* @param description the role's description (optionally <code>null</code>)
979 977
 	* @param types the role types (optionally <code>null</code>)
980  
-	* @param params the finder parameters. Can specify values for
981  
-	"permissionsResourceId" and "usersRoles" keys. For more
982  
-	information, see {@link
  978
+	* @param params the finder parameters. Can specify values for the
  979
+	"usersRoles" key. For more information, see {@link
983 980
 	com.liferay.portal.service.persistence.RoleFinder}
984 981
 	* @return the number of matching roles
985 982
 	* @throws SystemException if a system exception occurred
15  portal-service/src/com/liferay/portal/service/RoleLocalServiceWrapper.java
@@ -804,9 +804,8 @@ public boolean hasUserRoles(long userId, long companyId,
804 804
 	* @param keywords the keywords (space separated), which may occur in the
805 805
 	role's name or description (optionally <code>null</code>)
806 806
 	* @param types the role types (optionally <code>null</code>)
807  
-	* @param params the finder parameters. Can specify values for
808  
-	"permissionsResourceId" and "usersRoles" keys. For more
809  
-	information, see {@link
  807
+	* @param params the finder parameters. Can specify values for the
  808
+	"usersRoles" key. For more information, see {@link
810 809
 	com.liferay.portal.service.persistence.RoleFinder}
811 810
 	* @param start the lower bound of the range of roles to return
812 811
 	* @param end the upper bound of the range of roles to return (not
@@ -882,9 +881,8 @@ public boolean hasUserRoles(long userId, long companyId,
882 881
 	* @param name the role's name (optionally <code>null</code>)
883 882
 	* @param description the role's description (optionally <code>null</code>)
884 883
 	* @param types the role types (optionally <code>null</code>)
885  
-	* @param params the finder's parameters. Can specify values for
886  
-	"permissionsResourceId" and "usersRoles" keys. For more
887  
-	information, see {@link
  884
+	* @param params the finder's parameters. Can specify values for the
  885
+	"usersRoles" key. For more information, see {@link
888 886
 	com.liferay.portal.service.persistence.RoleFinder}
889 887
 	* @param start the lower bound of the range of the roles to return
890 888
 	* @param end the upper bound of the range of the roles to return (not
@@ -965,9 +963,8 @@ public int searchCount(long companyId, java.lang.String name,
965 963
 	* @param name the role's name (optionally <code>null</code>)
966 964
 	* @param description the role's description (optionally <code>null</code>)
967 965
 	* @param types the role types (optionally <code>null</code>)
968  
-	* @param params the finder parameters. Can specify values for
969  
-	"permissionsResourceId" and "usersRoles" keys. For more
970  
-	information, see {@link
  966
+	* @param params the finder parameters. Can specify values for the
  967
+	"usersRoles" key. For more information, see {@link
971 968
 	com.liferay.portal.service.persistence.RoleFinder}
972 969
 	* @return the number of matching roles
973 970
 	* @throws SystemException if a system exception occurred

0 notes on commit 0abf123

Please sign in to comment.
Something went wrong with that request. Please try again.