diff --git a/.travis.yml b/.travis.yml index b59830c0c5..2172514ab1 100644 --- a/.travis.yml +++ b/.travis.yml @@ -1,6 +1,6 @@ language: java jdk: - - oraclejdk8 + - openjdk11 sudo: false install: true -script: travis_wait 30 mvn -B clean verify -Dcommunity -Dorg.slf4j.simpleLogger.log.org.apache.maven.cli.transfer.Slf4jMavenTransferListener=warn +script: travis_wait 35 mvn -B clean verify -Dcommunity -Dorg.slf4j.simpleLogger.log.org.apache.maven.cli.transfer.Slf4jMavenTransferListener=warn diff --git a/pom.xml b/pom.xml index 3ff2e1b1f0..795cd885f5 100644 --- a/pom.xml +++ b/pom.xml @@ -31,7 +31,7 @@ - 3.2.5 + 3.3.9 @@ -131,7 +131,7 @@ maven-dependency-plugin - 2.10 + 3.1.1 @@ -157,11 +157,13 @@ maven-javadoc-plugin - 2.10.3 + ${maven.javadoc.version} com.docflex.javadoc.Doclet ${project.build.directory}/docflex-javadoc-${docflex.version}/lib/docflex-javadoc.jar - + none + + -license ${settings.localRepository}/com/docflex/docflex-alfresco-license/1.0/docflex-alfresco-license-1.0.license -template ${project.build.directory}/docflex-javadoc-${docflex.version}/templates/JavadocPro/FramedDoc.tpl -nodialog @@ -169,7 +171,8 @@ -p:filter.byAnns.include.classes=org.alfresco.api.AlfrescoPublicApi -p:docTitle "${project.name} ${project.version} Public API" -p:windowTitle "${project.name} ${project.version} Public API" - + + @@ -471,19 +474,22 @@ /share + 3.1.0 + true + 2.6 false 1.8 1.8 1.9.1 - 3.2 - 1.4 - 2.7 + 3.8.0 + 3.0.0-M2 + 3.1.0 8080 2.9.8 0.25.0 1.10.19 - 42.2.1 + 42.2.5 5432 5.1.40 3306 @@ -512,6 +518,8 @@ imageNameNotSet latest quay.io + + 2.3.0 @@ -552,6 +560,27 @@ 4.12 test + + + javax.xml.bind + jaxb-api + ${javax-jaxb.version} + provided + + + + com.sun.xml.bind + jaxb-impl + ${javax-jaxb.version} + provided + + + + org.apache.bcel + bcel + 6.2.99 + provided + @@ -559,7 +588,6 @@ maven-enforcer-plugin - 1.4 enforce-java @@ -569,7 +597,7 @@ - 1.8 + [1.8.0,) @@ -619,7 +647,6 @@ maven-surefire-plugin - 2.18 **/*UnitTest.java @@ -640,25 +667,25 @@ maven-javadoc-plugin - 2.10.4 + ${maven.javadoc.version} + + none + attach-javadocs + + none + jar - - -Xdoclint:none - - - -Xdoclint:none - maven-clean-plugin - 2.6.1 + 3.1.0 default-clean @@ -697,7 +724,7 @@ maven-site-plugin - 3.3 + 3.7.1 default-site @@ -773,7 +800,12 @@ maven-surefire-plugin - 2.18 + 2.22.1 + + + --illegal-access=permit + + maven-install-plugin @@ -781,11 +813,11 @@ maven-jar-plugin - 2.5 + 3.1.0 maven-assembly-plugin - 2.2-beta-5 + 3.1.0 org.alfresco.maven.plugin @@ -871,7 +903,12 @@ maven-failsafe-plugin - 2.19 + 2.22.1 + + + --illegal-access=permit + + maven-antrun-plugin @@ -901,14 +938,15 @@ maven-javadoc-plugin - -Xdoclint:none + none + 8 org.codehaus.mojo license-maven-plugin - 1.8 + 1.16 ${license.verbose} @@ -1000,7 +1038,7 @@ maven-war-plugin - 2.5 + ${maven.war.plugin.version} org.alfresco.maven.plugin @@ -1019,11 +1057,11 @@ maven-clean-plugin - 2.6.1 + 3.1.0 maven-dependency-plugin - 2.9 + 3.1.1 maven-archetype-plugin diff --git a/rm-automation/rm-automation-community-rest-api/pom.xml b/rm-automation/rm-automation-community-rest-api/pom.xml index d45d244d80..a3f5b92ecb 100644 --- a/rm-automation/rm-automation-community-rest-api/pom.xml +++ b/rm-automation/rm-automation-community-rest-api/pom.xml @@ -13,9 +13,10 @@ 1.8 + false alfresco-rm-community-share alfresco-rm-community-repo - 5.2.0-10 + 6.0.0.3 2.0.0 @@ -59,7 +60,7 @@ org.projectlombok lombok - 1.16.10 + 1.18.6 provided @@ -73,5 +74,10 @@ alfresco-testng 1.1 + + org.apache.commons + commons-collections4 + 4.1 + diff --git a/rm-automation/rm-automation-community-rest-api/src/main/java/org/alfresco/rest/core/v0/APIUtils.java b/rm-automation/rm-automation-community-rest-api/src/main/java/org/alfresco/rest/core/v0/APIUtils.java index fb6e3d9802..3d3f362a41 100644 --- a/rm-automation/rm-automation-community-rest-api/src/main/java/org/alfresco/rest/core/v0/APIUtils.java +++ b/rm-automation/rm-automation-community-rest-api/src/main/java/org/alfresco/rest/core/v0/APIUtils.java @@ -27,6 +27,8 @@ package org.alfresco.rest.core.v0; import java.io.IOException; +import java.time.format.DateTimeFormatter; +import java.time.format.DateTimeFormatterBuilder; import org.apache.commons.io.IOUtils; import org.apache.http.HttpResponse; @@ -44,6 +46,10 @@ public class APIUtils { /** Logger for this class. */ private static final Logger LOGGER = LoggerFactory.getLogger(APIUtils.class); + /** The ISO instant formatter that formats or parses an instant in UTC, such as '2011-12-03T10:15:305Z' + * similar with {@link DateTimeFormatter#ISO_INSTANT}, but with only 3 nanoseconds*/ + public static final DateTimeFormatter ISO_INSTANT_FORMATTER = + new DateTimeFormatterBuilder().appendInstant(3).toFormatter(); /** Private constructor for helper class. */ private APIUtils() diff --git a/rm-automation/rm-automation-community-rest-api/src/main/java/org/alfresco/rest/v0/RMRolesAndActionsAPI.java b/rm-automation/rm-automation-community-rest-api/src/main/java/org/alfresco/rest/v0/RMRolesAndActionsAPI.java index 8209a19a45..2cc343a50a 100644 --- a/rm-automation/rm-automation-community-rest-api/src/main/java/org/alfresco/rest/v0/RMRolesAndActionsAPI.java +++ b/rm-automation/rm-automation-community-rest-api/src/main/java/org/alfresco/rest/v0/RMRolesAndActionsAPI.java @@ -27,6 +27,7 @@ package org.alfresco.rest.v0; import static org.alfresco.dataprep.AlfrescoHttpClient.MIME_TYPE_JSON; +import static org.alfresco.rest.core.v0.APIUtils.ISO_INSTANT_FORMATTER; import static org.apache.http.HttpStatus.SC_OK; import static org.testng.AssertJUnit.assertEquals; import static org.testng.AssertJUnit.assertNotNull; @@ -37,7 +38,6 @@ import java.io.IOException; import java.text.MessageFormat; import java.time.Instant; import java.time.ZonedDateTime; -import java.time.format.DateTimeFormatter; import java.util.Arrays; import java.util.Map; import java.util.Set; @@ -337,7 +337,7 @@ public class RMRolesAndActionsAPI extends BaseAPI requestParams.put("nodeRef", recNodeRef); if (date != null) { - String thisMoment = date.format(DateTimeFormatter.ISO_INSTANT); + String thisMoment = date.format(ISO_INSTANT_FORMATTER); requestParams.put("params", new JSONObject() .put("asOfDate", new JSONObject() .put("iso8601", thisMoment) @@ -364,7 +364,7 @@ public class RMRolesAndActionsAPI extends BaseAPI requestParams.put("name", RM_ACTIONS.COMPLETE_EVENT.getAction()); requestParams.put("nodeRef", recNodeRef); date = (date != null) ? date : Instant.now(); - String formattedDate = DateTimeFormatter.ISO_INSTANT.format(date); + String formattedDate = ISO_INSTANT_FORMATTER.format(date); requestParams.put("params", new JSONObject() .put("eventName", event.getEventName()) .put("eventCompletedBy", user) diff --git a/rm-automation/rm-automation-community-rest-api/src/main/resources/config.properties b/rm-automation/rm-automation-community-rest-api/src/main/resources/config.properties index 8b94951ea5..f66389d1f5 100644 --- a/rm-automation/rm-automation-community-rest-api/src/main/resources/config.properties +++ b/rm-automation/rm-automation-community-rest-api/src/main/resources/config.properties @@ -1,2 +1,3 @@ alfresco.server=localhost +alfresco.port=8080 rest.rmPath=alfresco/api/-default-/public/gs/versions/1 \ No newline at end of file diff --git a/rm-community/rm-community-repo/pom.xml b/rm-community/rm-community-repo/pom.xml index 76bbb7602f..c9bacd8959 100644 --- a/rm-community/rm-community-repo/pom.xml +++ b/rm-community/rm-community-repo/pom.xml @@ -33,6 +33,8 @@ 6.0.b alfresco/alfresco-governance-repository-community + false + @@ -265,6 +267,7 @@ true true true + diff --git a/rm-community/rm-community-repo/source/compatibility/org/alfresco/module/org_alfresco_module_rm/audit/RecordsManagementAuditServiceDeprecated.java b/rm-community/rm-community-repo/source/compatibility/org/alfresco/module/org_alfresco_module_rm/audit/RecordsManagementAuditServiceDeprecated.java index dfbc255329..bf77147568 100644 --- a/rm-community/rm-community-repo/source/compatibility/org/alfresco/module/org_alfresco_module_rm/audit/RecordsManagementAuditServiceDeprecated.java +++ b/rm-community/rm-community-repo/source/compatibility/org/alfresco/module/org_alfresco_module_rm/audit/RecordsManagementAuditServiceDeprecated.java @@ -46,31 +46,31 @@ import org.alfresco.service.cmr.repository.NodeRef; public interface RecordsManagementAuditServiceDeprecated { /** - * @deprecated as of 2.1, see {@link #stop(NodeRef)} + * @deprecated as of 2.1, see {@link RecordsManagementAuditService#stopAuditLog(NodeRef)} */ @Deprecated void stop(); /** - * @deprecated as of 2.1, see {@link #clear(NodeRef)} + * @deprecated as of 2.1, see {@link RecordsManagementAuditService#clearAuditLog(NodeRef)} */ @Deprecated void clear(); /** - * @deprecated as of 2.1, see {@link #isEnabled(NodeRef)} + * @deprecated as of 2.1, see {@link RecordsManagementAuditService#isAuditLogEnabled(NodeRef)} */ @Deprecated boolean isEnabled(); /** - * @deprecated as of 2.1, see {@link #getDateLastStarted(NodeRef)} + * @deprecated as of 2.1, see {@link RecordsManagementAuditService#getDateAuditLogLastStarted(NodeRef)} */ @Deprecated Date getDateLastStarted(); /** - * @deprecated as of 2.1, see {@link #getDateLastStopped(NodeRef)} + * @deprecated as of 2.1, see {@link RecordsManagementAuditService#getDateLastStopped()} */ Date getDateLastStopped(); diff --git a/rm-community/rm-community-repo/source/compatibility/org/alfresco/module/org_alfresco_module_rm/caveat/RMCaveatConfigComponentImpl.java b/rm-community/rm-community-repo/source/compatibility/org/alfresco/module/org_alfresco_module_rm/caveat/RMCaveatConfigComponentImpl.java index ea6a566863..536a619db8 100644 --- a/rm-community/rm-community-repo/source/compatibility/org/alfresco/module/org_alfresco_module_rm/caveat/RMCaveatConfigComponentImpl.java +++ b/rm-community/rm-community-repo/source/compatibility/org/alfresco/module/org_alfresco_module_rm/caveat/RMCaveatConfigComponentImpl.java @@ -281,7 +281,6 @@ public class RMCaveatConfigComponentImpl implements ContentServicePolicies.OnCon * Validate the caveat config and optionally update the cache. * * @param nodeRef The nodeRef of the config - * @param updateCache Set to true to update the cache */ @SuppressWarnings("unchecked") protected void validateAndReset(NodeRef nodeRef) @@ -988,7 +987,6 @@ public class RMCaveatConfigComponentImpl implements ContentServicePolicies.OnCon * * @param listName the name of the RMConstraintList * @param authorityName - * @param values */ public void removeRMConstraintListAuthority(String listName, String authorityName) { diff --git a/rm-community/rm-community-repo/source/compatibility/org/alfresco/module/org_alfresco_module_rm/caveat/RMCaveatConfigService.java b/rm-community/rm-community-repo/source/compatibility/org/alfresco/module/org_alfresco_module_rm/caveat/RMCaveatConfigService.java index aa04bd6b5c..aa9533fda7 100644 --- a/rm-community/rm-community-repo/source/compatibility/org/alfresco/module/org_alfresco_module_rm/caveat/RMCaveatConfigService.java +++ b/rm-community/rm-community-repo/source/compatibility/org/alfresco/module/org_alfresco_module_rm/caveat/RMCaveatConfigService.java @@ -95,7 +95,7 @@ public interface RMCaveatConfigService /** * update RM constraint Title * @param listName the name of the RMConstraintList - can not be changed - * @param allowedValues + * @param newTitle the new value for the title constraint */ RMConstraintInfo updateRMConstraintTitle(String listName, String newTitle); @@ -112,7 +112,7 @@ public interface RMCaveatConfigService * * @param listName the name of the RMConstraintList * @param authorityName - * @param values + * @param value * @throws AlfrescoRuntimeException if either the list or the authority do not already exist. */ void addRMConstraintListValue(String listName, String authorityName, String value); @@ -134,7 +134,6 @@ public interface RMCaveatConfigService * * @param listName the name of the RMConstraintList * @param authorityName - * @param values */ void removeRMConstraintListAuthority(String listName, String authorityName); @@ -154,8 +153,7 @@ public interface RMCaveatConfigService * Remove an authority from a list * * @param listName the name of the RMConstraintList - * @param authorityName - * @param value + * @param valueName */ void removeRMConstraintListValue(String listName, String valueName); } diff --git a/rm-community/rm-community-repo/source/compatibility/org/alfresco/module/org_alfresco_module_rm/caveat/RMCaveatConfigServiceImpl.java b/rm-community/rm-community-repo/source/compatibility/org/alfresco/module/org_alfresco_module_rm/caveat/RMCaveatConfigServiceImpl.java index b2b8ced94b..a42e3cf013 100644 --- a/rm-community/rm-community-repo/source/compatibility/org/alfresco/module/org_alfresco_module_rm/caveat/RMCaveatConfigServiceImpl.java +++ b/rm-community/rm-community-repo/source/compatibility/org/alfresco/module/org_alfresco_module_rm/caveat/RMCaveatConfigServiceImpl.java @@ -201,7 +201,7 @@ public class RMCaveatConfigServiceImpl implements RMCaveatConfigService * * @param listName the name of the RMConstraintList * @param authorityName - * @param values + * @param value * @throws AlfrescoRuntimeException if either the list or the authority do not already exist. */ public void addRMConstraintListValue(String listName, String authorityName, String value) @@ -251,7 +251,6 @@ public class RMCaveatConfigServiceImpl implements RMCaveatConfigService * * @param listName the name of the RMConstraintList * @param authorityName - * @param values */ public void removeRMConstraintListAuthority(String listName, String authorityName) { diff --git a/rm-community/rm-community-repo/source/compatibility/org/alfresco/module/org_alfresco_module_rm/caveat/RMListOfValuesConstraint.java b/rm-community/rm-community-repo/source/compatibility/org/alfresco/module/org_alfresco_module_rm/caveat/RMListOfValuesConstraint.java index f86bd43418..e0de5e8dff 100644 --- a/rm-community/rm-community-repo/source/compatibility/org/alfresco/module/org_alfresco_module_rm/caveat/RMListOfValuesConstraint.java +++ b/rm-community/rm-community-repo/source/compatibility/org/alfresco/module/org_alfresco_module_rm/caveat/RMListOfValuesConstraint.java @@ -172,7 +172,7 @@ public class RMListOfValuesConstraint extends ListOfValuesConstraint /** * Set the values that are allowed by the constraint. * - * @param values a list of allowed values + * @param allowedValues a list of allowed values */ @SuppressWarnings({ "unchecked", "rawtypes" }) @Override diff --git a/rm-community/rm-community-repo/source/compatibility/org/alfresco/module/org_alfresco_module_rm/caveat/ScriptConstraint.java b/rm-community/rm-community-repo/source/compatibility/org/alfresco/module/org_alfresco_module_rm/caveat/ScriptConstraint.java index d31c2ddde1..b44e49fa47 100644 --- a/rm-community/rm-community-repo/source/compatibility/org/alfresco/module/org_alfresco_module_rm/caveat/ScriptConstraint.java +++ b/rm-community/rm-community-repo/source/compatibility/org/alfresco/module/org_alfresco_module_rm/caveat/ScriptConstraint.java @@ -134,8 +134,7 @@ public class ScriptConstraint implements Serializable /** * Update a value - * @param values - * @param authorities + * @param bodge */ public void updateValues(JSONArray bodge) throws Exception { @@ -156,7 +155,7 @@ public class ScriptConstraint implements Serializable /** * Update a value - * @param values + * @param value * @param authorities */ public void updateValues(String value, String[] authorities) diff --git a/rm-community/rm-community-repo/source/compatibility/org/alfresco/module/org_alfresco_module_rm/security/DeprecatedExtendedSecurityService.java b/rm-community/rm-community-repo/source/compatibility/org/alfresco/module/org_alfresco_module_rm/security/DeprecatedExtendedSecurityService.java index b7405dd079..ca4cae065f 100644 --- a/rm-community/rm-community-repo/source/compatibility/org/alfresco/module/org_alfresco_module_rm/security/DeprecatedExtendedSecurityService.java +++ b/rm-community/rm-community-repo/source/compatibility/org/alfresco/module/org_alfresco_module_rm/security/DeprecatedExtendedSecurityService.java @@ -42,7 +42,7 @@ public interface DeprecatedExtendedSecurityService * Gets the set of authorities that are extended readers for the given node. * * @param nodeRef node reference - * @return {@link Set}<{@link String}> set of extended readers + * @return {@link Set}<{@link String}> set of extended readers * * @deprecated as of 2.5, use {@link ExtendedSecurityService#getReaders(NodeRef)} */ @@ -52,7 +52,7 @@ public interface DeprecatedExtendedSecurityService * Get the set of authorities that are extended writers for the given node. * * @param nodeRef node reference - * @return {@link Set}<{@link String}> set of extended writers + * @return {@link Set}<{@link String}> set of extended writers * * @deprecated as of 2.5, use {@link ExtendedSecurityService#getWriters(NodeRef)} */ diff --git a/rm-community/rm-community-repo/source/compatibility/org/alfresco/module/org_alfresco_module_rm/security/FilePlanAuthenticationService.java b/rm-community/rm-community-repo/source/compatibility/org/alfresco/module/org_alfresco_module_rm/security/FilePlanAuthenticationService.java index 54ceba5c71..a7432cbfbe 100644 --- a/rm-community/rm-community-repo/source/compatibility/org/alfresco/module/org_alfresco_module_rm/security/FilePlanAuthenticationService.java +++ b/rm-community/rm-community-repo/source/compatibility/org/alfresco/module/org_alfresco_module_rm/security/FilePlanAuthenticationService.java @@ -53,7 +53,10 @@ public interface FilePlanAuthenticationService * @param runAsWork work to execute as the rm admin user * @return R result of work execution * - * @deprecated as of 2.2, use {@link AuthenticationUtil#runAs(RunAsWork, AuthenticationUtil#getAdminUserName())} + * @deprecated as of 2.2, use + * + * + * {@link AuthenticationUtil#runAs(RunAsWork, String)} */ R runAsRmAdmin(RunAsWork runAsWork); } diff --git a/rm-community/rm-community-repo/source/compatibility/org/alfresco/module/org_alfresco_module_rm/security/FilePlanAuthenticationServiceImpl.java b/rm-community/rm-community-repo/source/compatibility/org/alfresco/module/org_alfresco_module_rm/security/FilePlanAuthenticationServiceImpl.java index 298f1132f1..62e56fdd60 100644 --- a/rm-community/rm-community-repo/source/compatibility/org/alfresco/module/org_alfresco_module_rm/security/FilePlanAuthenticationServiceImpl.java +++ b/rm-community/rm-community-repo/source/compatibility/org/alfresco/module/org_alfresco_module_rm/security/FilePlanAuthenticationServiceImpl.java @@ -42,7 +42,7 @@ public class FilePlanAuthenticationServiceImpl implements FilePlanAuthentication public static final String DEFAULT_RM_ADMIN_USER = "rmadmin"; /** - * @see org.alfresco.module.org_alfresco_module_rm.security.FilePlanAuthenticationService#getRMAdminUserName() + * @see FilePlanAuthenticationService#getRmAdminUserName() () */ @Override @Deprecated @@ -52,7 +52,7 @@ public class FilePlanAuthenticationServiceImpl implements FilePlanAuthentication } /** - * @see org.alfresco.module.org_alfresco_module_rm.security.FilePlanAuthenticationService#runAsRMAdmin(org.alfresco.repo.security.authentication.AuthenticationUtil.RunAsWork) + * @see FilePlanAuthenticationService#runAsRmAdmin(RunAsWork) */ @Override @Deprecated diff --git a/rm-community/rm-community-repo/source/compatibility/org/alfresco/module/org_alfresco_module_rm/security/RecordsManagementSecurityService.java b/rm-community/rm-community-repo/source/compatibility/org/alfresco/module/org_alfresco_module_rm/security/RecordsManagementSecurityService.java index 65ff0fb011..ac76a889bc 100644 --- a/rm-community/rm-community-repo/source/compatibility/org/alfresco/module/org_alfresco_module_rm/security/RecordsManagementSecurityService.java +++ b/rm-community/rm-community-repo/source/compatibility/org/alfresco/module/org_alfresco_module_rm/security/RecordsManagementSecurityService.java @@ -70,7 +70,7 @@ public interface RecordsManagementSecurityService * Get all the available roles for the given records management root node * * @param rmRootNode root node - * @return {@link Set}<{@link Role}> all roles for a given root node + * @return {@link Set}<{@link Role}> all roles for a given root node * * @deprecated As of release 2.1, replaced by {@link FilePlanRoleService#getRoles(NodeRef)} */ @@ -201,14 +201,14 @@ public interface RecordsManagementSecurityService void deletePermission(NodeRef nodeRef, String authority, String permission); /** - * @return {@link Set}<{@link QName}> protected aspect names + * @return {@link Set}<{@link QName}> protected aspect names * @deprecated As of release 2.1, replaced by {@link ModelSecurityService#getProtectedAspects} */ @Deprecated Set getProtectedAspects(); /** - * @return {@link Set}<{@link QName}> protected properties + * @return {@link Set}<{@link QName}> protected properties * @deprecated As of release 2.1, replaced by {@link ModelSecurityService#getProtectedProperties} */ Set getProtectedProperties(); diff --git a/rm-community/rm-community-repo/source/java/org/alfresco/module/org_alfresco_module_rm/action/RMActionExecuterAbstractBase.java b/rm-community/rm-community-repo/source/java/org/alfresco/module/org_alfresco_module_rm/action/RMActionExecuterAbstractBase.java index e6d3ae0657..135501c1d0 100644 --- a/rm-community/rm-community-repo/source/java/org/alfresco/module/org_alfresco_module_rm/action/RMActionExecuterAbstractBase.java +++ b/rm-community/rm-community-repo/source/java/org/alfresco/module/org_alfresco_module_rm/action/RMActionExecuterAbstractBase.java @@ -683,7 +683,7 @@ public abstract class RMActionExecuterAbstractBase extends PropertySubActionExe * * @return padded string or the original if already at >= len characters * - * @deprecated As of 2.1, replaced by {@link org.apache.commons.lang.StringUtils.leftPad} + * @deprecated As of 2.1, replaced by {@link org.apache.commons.lang.StringUtils#leftPad(String, int)} */ @Deprecated protected String padString(String s, int len) diff --git a/rm-community/rm-community-repo/source/java/org/alfresco/module/org_alfresco_module_rm/admin/RecordsManagementAdminService.java b/rm-community/rm-community-repo/source/java/org/alfresco/module/org_alfresco_module_rm/admin/RecordsManagementAdminService.java index 6a1ae91c01..aacb554459 100644 --- a/rm-community/rm-community-repo/source/java/org/alfresco/module/org_alfresco_module_rm/admin/RecordsManagementAdminService.java +++ b/rm-community/rm-community-repo/source/java/org/alfresco/module/org_alfresco_module_rm/admin/RecordsManagementAdminService.java @@ -42,7 +42,7 @@ import org.alfresco.service.cmr.repository.ChildAssociationRef; import org.alfresco.service.cmr.repository.NodeRef; import org.alfresco.service.cmr.repository.NodeService; import org.alfresco.service.namespace.QName; -import org.alfresco.service.namespace.RegexQNamePattern; +import org.alfresco.service.namespace.QNamePattern; /** * Records management custom model service interface. Implementations of this class are responsible @@ -58,7 +58,7 @@ public interface RecordsManagementAdminService /** * Get a list of all registered customisable types and aspects. * - * @return Set of <{@link QName}>s of customisable types and aspects + * @return Set of <{@link QName}>s of customisable types and aspects */ Set getCustomisable(); @@ -67,7 +67,7 @@ public interface RecordsManagementAdminService * node reference. * * @param nodeRef node reference - * @return Set of <{@link QName}>s of customisable types and aspects, empty if none + * @return Set of <{@link QName}>s of customisable types and aspects, empty if none */ Set getCustomisable(NodeRef nodeRef); @@ -110,22 +110,23 @@ public interface RecordsManagementAdminService * Therefore custom properties created in the current transaction will not appear * in the result of this method. * + *

* @param customisableType - * @return - * @see CustomisableRmElement + * @return Map of <{@link QName}, {@link PropertyDefinition}>s of custom properties definitions */ Map getCustomPropertyDefinitions(QName customisableType); /** * This method returns the custom properties that have been defined for all of * the specified customisable RM elements. + *

* Note: the custom property definitions are retrieved from the dictionaryService * which is notified of any newly created definitions on transaction commit. * Therefore custom properties created in the current transaction will not appear * in the result of this method. + *

* - * @return - * @see CustomisableRmElement + * @return Map of <{@link QName}, {@link PropertyDefinition}>s of custom properties definitions */ Map getCustomPropertyDefinitions(); @@ -138,7 +139,7 @@ public interface RecordsManagementAdminService * within URLs and in QNames. Therefore it must contain URL/QName-valid characters * only. It must also be unique. * If a null value is passed, an id will be generated. - * @param aspectName - mandatory. The aspect within which the property is to be defined. + * @param typeName - mandatory. The aspect within which the property is to be defined. * This must be one of the CustomisableRmElements. * @param label - mandatory * @param dataType - mandatory @@ -146,7 +147,6 @@ public interface RecordsManagementAdminService * @param description - optional * * @return the propId, whether supplied as a parameter or generated. - * @see CustomisableRmElement#getCorrespondingAspect() */ QName addCustomPropertyDefinition(QName propId, QName typeName, String label, QName dataType, String title, String description) throws CustomMetadataException; @@ -157,7 +157,7 @@ public interface RecordsManagementAdminService * within URLs and in QNames. Therefore it must contain URL/QName-valid characters * only. It must also be unique. * If a null value is passed, an id will be generated. - * @param aspectName - mandatory. The aspect within which the property is to be defined. + * @param typeName - mandatory. The aspect within which the property is to be defined. * This must be one of the CustomisableRmElements. * @param label - mandatory * @param dataType - mandatory @@ -170,7 +170,6 @@ public interface RecordsManagementAdminService * @param lovConstraintQName - optional custom constraint * * @return the propId, whether supplied as a parameter or generated. - * @see CustomisableRmElement#getCorrespondingAspect() */ // TODO propId string (not QName) ? @@ -248,7 +247,9 @@ public interface RecordsManagementAdminService * * @param node the node from which the associations start. * @return a List of associations. - * @deprecated as of RM 2.3, please use {@link NodeService#getTargetAssocs(NodeRef, RegexQNamePattern.MATCH_ALL)} instead. + * @deprecated as of RM 2.3, please + * use{@link NodeService#getTargetAssocs(NodeRef, QNamePattern)} with QNamePattern RegexQNamePattern.MATCH_ALL + * instead */ List getCustomReferencesFrom(NodeRef node); @@ -267,7 +268,8 @@ public interface RecordsManagementAdminService * * @param node the node to which the associations point. * @return a List of associations. - * @deprecated as of RM 2.3, please use {@link NodeService#getSourceAssocs(NodeRef, RegexQNamePattern.MATCH_ALL)} instead. + * @deprecated as of RM 2.3, please use + * {@link NodeService#getSourceAssocs(NodeRef, QNamePattern)} with QNamePattern RegexQNamePattern.MATCH_ALL instead. */ List getCustomReferencesTo(NodeRef node); diff --git a/rm-community/rm-community-repo/source/java/org/alfresco/module/org_alfresco_module_rm/admin/RecordsManagementAdminServiceImpl.java b/rm-community/rm-community-repo/source/java/org/alfresco/module/org_alfresco_module_rm/admin/RecordsManagementAdminServiceImpl.java index bf18587423..a696f7d85b 100644 --- a/rm-community/rm-community-repo/source/java/org/alfresco/module/org_alfresco_module_rm/admin/RecordsManagementAdminServiceImpl.java +++ b/rm-community/rm-community-repo/source/java/org/alfresco/module/org_alfresco_module_rm/admin/RecordsManagementAdminServiceImpl.java @@ -32,7 +32,6 @@ import static org.springframework.extensions.surf.util.ParameterCheck.mandatoryS import java.text.MessageFormat; import java.util.ArrayList; import java.util.Collection; -import java.util.Collections; import java.util.HashMap; import java.util.HashSet; import java.util.List; @@ -61,7 +60,6 @@ import org.alfresco.repo.policy.annotation.BehaviourBean; import org.alfresco.repo.policy.annotation.BehaviourKind; import org.alfresco.repo.security.authentication.AuthenticationUtil; import org.alfresco.repo.security.authentication.AuthenticationUtil.RunAsWork; -import org.alfresco.repo.security.authority.RMAuthority; import org.alfresco.repo.transaction.RetryingTransactionHelper.RetryingTransactionCallback; import org.alfresco.service.cmr.dictionary.AspectDefinition; import org.alfresco.service.cmr.dictionary.AssociationDefinition; @@ -73,7 +71,6 @@ import org.alfresco.service.cmr.dictionary.TypeDefinition; import org.alfresco.service.cmr.repository.AssociationRef; import org.alfresco.service.cmr.repository.ChildAssociationRef; import org.alfresco.service.cmr.repository.NodeRef; -import org.alfresco.service.cmr.security.AuthorityType; import org.alfresco.service.namespace.QName; import org.alfresco.service.namespace.RegexQNamePattern; import org.alfresco.service.transaction.TransactionService; @@ -652,7 +649,7 @@ public class RecordsManagementAdminServiceImpl extends RecordsManagementAdminBas } /** - * @see org.alfresco.module.org_alfresco_module_rm.RecordsManagementAdminService#getCustomPropertyDefinitions(org.alfresco.module.org_alfresco_module_rm.CustomisableRmElement) + * @see org.alfresco.module.org_alfresco_module_rm.RecordsManagementAdminService#getCustomPropertyDefinitions(QName) */ public Map getCustomPropertyDefinitions(QName customisableType) { diff --git a/rm-community/rm-community-repo/source/java/org/alfresco/module/org_alfresco_module_rm/audit/RecordsManagementAuditServiceImpl.java b/rm-community/rm-community-repo/source/java/org/alfresco/module/org_alfresco_module_rm/audit/RecordsManagementAuditServiceImpl.java index 8af59833ee..8e816549d8 100644 --- a/rm-community/rm-community-repo/source/java/org/alfresco/module/org_alfresco_module_rm/audit/RecordsManagementAuditServiceImpl.java +++ b/rm-community/rm-community-repo/source/java/org/alfresco/module/org_alfresco_module_rm/audit/RecordsManagementAuditServiceImpl.java @@ -1696,8 +1696,6 @@ public class RecordsManagementAuditServiceImpl extends AbstractLifecycleBean * Returns the display label for a property QName * * @param property The property to get label for - * @param ddService DictionaryService instance - * @param namespaceService NamespaceService instance * @return The label */ private String getPropertyLabel(QName property) @@ -1830,7 +1828,8 @@ public class RecordsManagementAuditServiceImpl extends AbstractLifecycleBean } /** - * {@inheritDoc} + * use {@link #startAuditLog(NodeRef)} instead + * */ @Deprecated public void start() diff --git a/rm-community/rm-community-repo/source/java/org/alfresco/module/org_alfresco_module_rm/capability/CapabilityService.java b/rm-community/rm-community-repo/source/java/org/alfresco/module/org_alfresco_module_rm/capability/CapabilityService.java index aa25dac7f3..b8dd1b16fb 100644 --- a/rm-community/rm-community-repo/source/java/org/alfresco/module/org_alfresco_module_rm/capability/CapabilityService.java +++ b/rm-community/rm-community-repo/source/java/org/alfresco/module/org_alfresco_module_rm/capability/CapabilityService.java @@ -62,7 +62,7 @@ public interface CapabilityService /** * Get a list of all the assignable capabilities. * - * @return {@link Set}<{@link Capability}> set of all the assignable capabilities + * @return {@link Set}<{@link Capability}> set of all the assignable capabilities */ Set getCapabilities(); @@ -70,7 +70,7 @@ public interface CapabilityService * Get a list of all the capabilities, optionally including those that are non-assignable. * * @param includePrivate indicates that the private, or non-assignable capabilities are included in the result - * @return {@link Set}<{@link Capability}> set of capabilities + * @return {@link Set}<{@link Capability}> set of capabilities */ Set getCapabilities(boolean includePrivate); @@ -110,7 +110,7 @@ public interface CapabilityService /** * Gets the list of all the capability groups (in index order) * - * @return {@link List}<{@link Group}> List of all the capability groups (in index order) + * @return {@link List}<{@link Group}> List of all the capability groups (in index order) */ List getGroups(); @@ -118,7 +118,7 @@ public interface CapabilityService * Gets a list of capabilities for the given group id * * @param groupId The id of a group for which the list of capabilities should be retrieved - * @return {@link List}<{@link Capability}> List of capabilities for the given group + * @return {@link List}<{@link Capability}> List of capabilities for the given group */ List getCapabilitiesByGroupId(String groupId); @@ -126,7 +126,7 @@ public interface CapabilityService * Get a list of capabilities for the given group * * @param group The group for which the list of capabilities should be retrieved - * @return {@link List}<{@link Capability}> List of capabilities for the given group + * @return {@link List}<{@link Capability}> List of capabilities for the given group */ List getCapabilitiesByGroup(Group group); diff --git a/rm-community/rm-community-repo/source/java/org/alfresco/module/org_alfresco_module_rm/capability/CompositeCapability.java b/rm-community/rm-community-repo/source/java/org/alfresco/module/org_alfresco_module_rm/capability/CompositeCapability.java index f74944660f..dbc9991368 100644 --- a/rm-community/rm-community-repo/source/java/org/alfresco/module/org_alfresco_module_rm/capability/CompositeCapability.java +++ b/rm-community/rm-community-repo/source/java/org/alfresco/module/org_alfresco_module_rm/capability/CompositeCapability.java @@ -40,7 +40,7 @@ public interface CompositeCapability extends Capability /** * Get set of child capabilities. * - * @return {@link Set}<{@link Capability}> set of child capabilities. + * @return {@link Set}<{@link Capability} > set of child capabilities. */ Set getCapabilities(); } diff --git a/rm-community/rm-community-repo/source/java/org/alfresco/module/org_alfresco_module_rm/capability/RMActionProxyFactoryBean.java b/rm-community/rm-community-repo/source/java/org/alfresco/module/org_alfresco_module_rm/capability/RMActionProxyFactoryBean.java index adbd7b929d..6c2dbeb946 100644 --- a/rm-community/rm-community-repo/source/java/org/alfresco/module/org_alfresco_module_rm/capability/RMActionProxyFactoryBean.java +++ b/rm-community/rm-community-repo/source/java/org/alfresco/module/org_alfresco_module_rm/capability/RMActionProxyFactoryBean.java @@ -60,7 +60,7 @@ public class RMActionProxyFactoryBean extends ProxyFactoryBean /** * Set action service * - * @param actionService + * @param runtimeActionService */ public void setRuntimeActionService(RuntimeActionService runtimeActionService) { diff --git a/rm-community/rm-community-repo/source/java/org/alfresco/module/org_alfresco_module_rm/capability/RMPermissionModel.java b/rm-community/rm-community-repo/source/java/org/alfresco/module/org_alfresco_module_rm/capability/RMPermissionModel.java index f4b3aac725..fd51d82fbf 100644 --- a/rm-community/rm-community-repo/source/java/org/alfresco/module/org_alfresco_module_rm/capability/RMPermissionModel.java +++ b/rm-community/rm-community-repo/source/java/org/alfresco/module/org_alfresco_module_rm/capability/RMPermissionModel.java @@ -45,27 +45,27 @@ public interface RMPermissionModel // Roles /** - * @deprecated as of 2.1.0.3, please use {@link FilePlanRoleService.ROLE_USER} instead + * @deprecated as of 2.1.0.3, please use {@link FilePlanRoleService#ROLE_USER} instead */ @Deprecated String ROLE_NAME_USER = FilePlanRoleService.ROLE_USER; /** - * @deprecated as of 2.1.0.3, please use {@link FilePlanRoleService.ROLE_POWER_USER} instead + * @deprecated as of 2.1.0.3, please use {@link FilePlanRoleService#ROLE_POWER_USER} instead */ @Deprecated String ROLE_NAME_POWER_USER = FilePlanRoleService.ROLE_POWER_USER; /** - * @deprecated as of 2.1.0.3, please use {@link FilePlanRoleService.ROLE_SECURITY_OFFICER} instead + * @deprecated as of 2.1.0.3, please use {@link FilePlanRoleService#ROLE_SECURITY_OFFICER} instead */ @Deprecated String ROLE_NAME_SECURITY_OFFICER = FilePlanRoleService.ROLE_SECURITY_OFFICER; /** - * @deprecated as of 2.1.0.3, please use {@link FilePlanRoleService.ROLE_RECORDS_MANAGER} instead + * @deprecated as of 2.1.0.3, please use {@link FilePlanRoleService#ROLE_RECORDS_MANAGER} instead */ @Deprecated String ROLE_NAME_RECORDS_MANAGER = FilePlanRoleService.ROLE_RECORDS_MANAGER; /** - * @deprecated as of 2.1.0.3, please use {@link FilePlanRoleService.ROLE_ADMIN} instead + * @deprecated as of 2.1.0.3, please use {@link FilePlanRoleService#ROLE_ADMIN} instead */ @Deprecated String ROLE_NAME_ADMINISTRATOR = FilePlanRoleService.ROLE_ADMIN; diff --git a/rm-community/rm-community-repo/source/java/org/alfresco/module/org_alfresco_module_rm/capability/declarative/DeclarativeCapability.java b/rm-community/rm-community-repo/source/java/org/alfresco/module/org_alfresco_module_rm/capability/declarative/DeclarativeCapability.java index cb792debf6..86c8d5c83b 100644 --- a/rm-community/rm-community-repo/source/java/org/alfresco/module/org_alfresco_module_rm/capability/declarative/DeclarativeCapability.java +++ b/rm-community/rm-community-repo/source/java/org/alfresco/module/org_alfresco_module_rm/capability/declarative/DeclarativeCapability.java @@ -92,7 +92,7 @@ public class DeclarativeCapability extends AbstractCapability } /** - * @return {@link Map} conditions and expected values + * @return {@link Map} <String, Boolean > conditions and expected values */ public Map getConditions() { @@ -108,7 +108,7 @@ public class DeclarativeCapability extends AbstractCapability } /** - * @return {@link List}<@link String> list of expected file plan component kinds + * @return {@link List} <@link String > list of expected file plan component kinds */ public List getKinds() { diff --git a/rm-community/rm-community-repo/source/java/org/alfresco/module/org_alfresco_module_rm/capability/declarative/DeclarativeCompositeCapability.java b/rm-community/rm-community-repo/source/java/org/alfresco/module/org_alfresco_module_rm/capability/declarative/DeclarativeCompositeCapability.java index 06429342cd..9859f5f685 100644 --- a/rm-community/rm-community-repo/source/java/org/alfresco/module/org_alfresco_module_rm/capability/declarative/DeclarativeCompositeCapability.java +++ b/rm-community/rm-community-repo/source/java/org/alfresco/module/org_alfresco_module_rm/capability/declarative/DeclarativeCompositeCapability.java @@ -47,7 +47,7 @@ public class DeclarativeCompositeCapability extends DeclarativeCapability private Set capabilities; /** - * @param capabilites set of capabilities + * @param capabilities set of capabilities */ public void setCapabilities(Set capabilities) { diff --git a/rm-community/rm-community-repo/source/java/org/alfresco/module/org_alfresco_module_rm/content/EagerContentStoreCleaner.java b/rm-community/rm-community-repo/source/java/org/alfresco/module/org_alfresco_module_rm/content/EagerContentStoreCleaner.java index cc370c601b..530acc40a4 100644 --- a/rm-community/rm-community-repo/source/java/org/alfresco/module/org_alfresco_module_rm/content/EagerContentStoreCleaner.java +++ b/rm-community/rm-community-repo/source/java/org/alfresco/module/org_alfresco_module_rm/content/EagerContentStoreCleaner.java @@ -60,7 +60,7 @@ public class EagerContentStoreCleaner extends org.alfresco.repo.content.cleanup. private ContentCleanser contentCleanser; /** - * @param transactionResourceHelper transactional resource helper + * @param transactionalResourceHelper transactional resource helper */ public void setTransactionalResourceHelper(TransactionalResourceHelper transactionalResourceHelper) { diff --git a/rm-community/rm-community-repo/source/java/org/alfresco/module/org_alfresco_module_rm/dataset/DataSetService.java b/rm-community/rm-community-repo/source/java/org/alfresco/module/org_alfresco_module_rm/dataset/DataSetService.java index 9aa965565a..377ce52ff7 100644 --- a/rm-community/rm-community-repo/source/java/org/alfresco/module/org_alfresco_module_rm/dataset/DataSetService.java +++ b/rm-community/rm-community-repo/source/java/org/alfresco/module/org_alfresco_module_rm/dataset/DataSetService.java @@ -44,7 +44,7 @@ public interface DataSetService /** * Gets the details of all available data sets. * - * @return Map details of all available data sets + * @return the Map<String, DataSet> with details of all available data sets */ Map getDataSets(); @@ -55,7 +55,7 @@ public interface DataSetService * @param filePlan the file plan for which the details should be retrieved * @param excludeLoaded if true only data sets will be retrieved which has * not been loaded - * @return Map details of the available data sets for a + * @return Map<String, DataSet> with details of the available data sets for a * specified file plan depending on the parameter "excludeLoaded". * The result could also be an empty map */ @@ -66,7 +66,7 @@ public interface DataSetService * * @param filePlan the file plan for which the loaded data sets should be * retrieved - * @return Map details of all loaded data sets or an empty + * @return Map<String, DataSet> details of all loaded data sets or an empty * map if there has not been any data sets loaded for the specified * file plan */ diff --git a/rm-community/rm-community-repo/source/java/org/alfresco/module/org_alfresco_module_rm/dataset/DataSetServiceImpl.java b/rm-community/rm-community-repo/source/java/org/alfresco/module/org_alfresco_module_rm/dataset/DataSetServiceImpl.java index d12e072d5e..c51581cbd6 100644 --- a/rm-community/rm-community-repo/source/java/org/alfresco/module/org_alfresco_module_rm/dataset/DataSetServiceImpl.java +++ b/rm-community/rm-community-repo/source/java/org/alfresco/module/org_alfresco_module_rm/dataset/DataSetServiceImpl.java @@ -257,8 +257,8 @@ public class DataSetServiceImpl implements DataSetService, RecordsManagementMode } /** - * @see org.alfresco.module.org_alfresco_module_rm.dataset.DataSetService#loadDataSet(java.lang.String, - * org.alfresco.service.cmr.repository.NodeRef) + * @see org.alfresco.module.org_alfresco_module_rm.dataset.DataSetService#loadDataSet( + *org.alfresco.service.cmr.repository.NodeRef, java.lang.String) */ @Override public void loadDataSet(NodeRef filePlan, String dataSetId) diff --git a/rm-community/rm-community-repo/source/java/org/alfresco/module/org_alfresco_module_rm/disposition/DispositionActionDefinitionImpl.java b/rm-community/rm-community-repo/source/java/org/alfresco/module/org_alfresco_module_rm/disposition/DispositionActionDefinitionImpl.java index 02000d0d44..4963de8248 100644 --- a/rm-community/rm-community-repo/source/java/org/alfresco/module/org_alfresco_module_rm/disposition/DispositionActionDefinitionImpl.java +++ b/rm-community/rm-community-repo/source/java/org/alfresco/module/org_alfresco_module_rm/disposition/DispositionActionDefinitionImpl.java @@ -78,7 +78,9 @@ public class DispositionActionDefinitionImpl implements DispositionActionDefinit /** * Constructor * - * @param services service registry + * @param recordsManagementEventService records management event service + * @param recordsManagementActionService records management action service + * @param nodeService node service * @param nodeRef disposition action node reference * @param index index of disposition action */ diff --git a/rm-community/rm-community-repo/source/java/org/alfresco/module/org_alfresco_module_rm/disposition/DispositionActionImpl.java b/rm-community/rm-community-repo/source/java/org/alfresco/module/org_alfresco_module_rm/disposition/DispositionActionImpl.java index 31f0f88d4d..8329406e2b 100644 --- a/rm-community/rm-community-repo/source/java/org/alfresco/module/org_alfresco_module_rm/disposition/DispositionActionImpl.java +++ b/rm-community/rm-community-repo/source/java/org/alfresco/module/org_alfresco_module_rm/disposition/DispositionActionImpl.java @@ -187,7 +187,7 @@ public class DispositionActionImpl implements DispositionAction, } /** - * @see org.alfresco.module.org_alfresco_module_rm.DispositionAction#getStartedAt() + * @see org.alfresco.module.org_alfresco_module_rm.disposition.DispositionAction#getStartedAt() */ public Date getStartedAt() { @@ -195,7 +195,7 @@ public class DispositionActionImpl implements DispositionAction, } /** - * @see org.alfresco.module.org_alfresco_module_rm.DispositionAction#getStartedBy() + * @see org.alfresco.module.org_alfresco_module_rm.disposition.DispositionAction#getStartedBy() */ public String getStartedBy() { diff --git a/rm-community/rm-community-repo/source/java/org/alfresco/module/org_alfresco_module_rm/disposition/DispositionSchedule.java b/rm-community/rm-community-repo/source/java/org/alfresco/module/org_alfresco_module_rm/disposition/DispositionSchedule.java index 510be0625e..e9ddf24785 100644 --- a/rm-community/rm-community-repo/source/java/org/alfresco/module/org_alfresco_module_rm/disposition/DispositionSchedule.java +++ b/rm-community/rm-community-repo/source/java/org/alfresco/module/org_alfresco_module_rm/disposition/DispositionSchedule.java @@ -70,7 +70,7 @@ public interface DispositionSchedule /** * Gets all the disposition action definitions for the schedule * - * @return List<{@link DispositionActionDefinition}> disposition action definitions + * @return List<{@link DispositionActionDefinition}> disposition action definitions */ List getDispositionActionDefinitions(); diff --git a/rm-community/rm-community-repo/source/java/org/alfresco/module/org_alfresco_module_rm/disposition/DispositionService.java b/rm-community/rm-community-repo/source/java/org/alfresco/module/org_alfresco_module_rm/disposition/DispositionService.java index cec70cc8e0..ef7a27b86a 100644 --- a/rm-community/rm-community-repo/source/java/org/alfresco/module/org_alfresco_module_rm/disposition/DispositionService.java +++ b/rm-community/rm-community-repo/source/java/org/alfresco/module/org_alfresco_module_rm/disposition/DispositionService.java @@ -108,7 +108,7 @@ public interface DispositionService * the disposition schedule. * * @param dispositionSchedule disposition schedule - * @return {@link List}<{@link NodeRef}> list of disposable items + * @return {@link List} <{@link NodeRef}> list of disposable items */ List getDisposableItems(DispositionSchedule dispositionSchedule); diff --git a/rm-community/rm-community-repo/source/java/org/alfresco/module/org_alfresco_module_rm/email/CustomEmailMappingService.java b/rm-community/rm-community-repo/source/java/org/alfresco/module/org_alfresco_module_rm/email/CustomEmailMappingService.java index 4dd2fbc14f..68f20376a9 100644 --- a/rm-community/rm-community-repo/source/java/org/alfresco/module/org_alfresco_module_rm/email/CustomEmailMappingService.java +++ b/rm-community/rm-community-repo/source/java/org/alfresco/module/org_alfresco_module_rm/email/CustomEmailMappingService.java @@ -38,7 +38,7 @@ public interface CustomEmailMappingService /** * Get the list of custom mappings * - * @return {@link Set}<{@link CustomMapping}> + * @return {@link Set}<{@link CustomMapping}> */ Set getCustomMappings(); diff --git a/rm-community/rm-community-repo/source/java/org/alfresco/module/org_alfresco_module_rm/email/CustomEmailMappingServiceImpl.java b/rm-community/rm-community-repo/source/java/org/alfresco/module/org_alfresco_module_rm/email/CustomEmailMappingServiceImpl.java index 3b9be9366a..214229395a 100644 --- a/rm-community/rm-community-repo/source/java/org/alfresco/module/org_alfresco_module_rm/email/CustomEmailMappingServiceImpl.java +++ b/rm-community/rm-community-repo/source/java/org/alfresco/module/org_alfresco_module_rm/email/CustomEmailMappingServiceImpl.java @@ -277,7 +277,7 @@ public class CustomEmailMappingServiceImpl extends AbstractLifecycleBean impleme } /** - * @see org.alfresco.module.org_alfresco_module_rm.email.EmailMappingKeyService#registerEMailMappingKey(java.lang.String) + * @see org.alfresco.module.org_alfresco_module_rm.email.CustomEmailMappingService#registerEMailMappingKey(java.lang.String) */ @Override public void registerEMailMappingKey(String emailMappingKey) diff --git a/rm-community/rm-community-repo/source/java/org/alfresco/module/org_alfresco_module_rm/email/CustomisableEmailMappingKeyBootstrap.java b/rm-community/rm-community-repo/source/java/org/alfresco/module/org_alfresco_module_rm/email/CustomisableEmailMappingKeyBootstrap.java index 1272017ff2..1e1d26cafb 100644 --- a/rm-community/rm-community-repo/source/java/org/alfresco/module/org_alfresco_module_rm/email/CustomisableEmailMappingKeyBootstrap.java +++ b/rm-community/rm-community-repo/source/java/org/alfresco/module/org_alfresco_module_rm/email/CustomisableEmailMappingKeyBootstrap.java @@ -44,7 +44,7 @@ public class CustomisableEmailMappingKeyBootstrap private CustomEmailMappingService customEmailMappingService; /** - * @param customizable list of mappings to register as customisable + * @param customisable list of mappings to register as customisable */ public void setCustomisable(List customisable) { diff --git a/rm-community/rm-community-repo/source/java/org/alfresco/module/org_alfresco_module_rm/event/RecordsManagementEventService.java b/rm-community/rm-community-repo/source/java/org/alfresco/module/org_alfresco_module_rm/event/RecordsManagementEventService.java index 55f320abd7..7e99b10162 100644 --- a/rm-community/rm-community-repo/source/java/org/alfresco/module/org_alfresco_module_rm/event/RecordsManagementEventService.java +++ b/rm-community/rm-community-repo/source/java/org/alfresco/module/org_alfresco_module_rm/event/RecordsManagementEventService.java @@ -56,7 +56,7 @@ public interface RecordsManagementEventService /** * Get the records management event type * - * @param eventType name + * @param eventTypeName name * @return RecordsManagementEventType event type */ RecordsManagementEventType getEventType(String eventTypeName); diff --git a/rm-community/rm-community-repo/source/java/org/alfresco/module/org_alfresco_module_rm/event/RecordsManagementEventServiceImpl.java b/rm-community/rm-community-repo/source/java/org/alfresco/module/org_alfresco_module_rm/event/RecordsManagementEventServiceImpl.java index e6fc8ace75..c161c04036 100644 --- a/rm-community/rm-community-repo/source/java/org/alfresco/module/org_alfresco_module_rm/event/RecordsManagementEventServiceImpl.java +++ b/rm-community/rm-community-repo/source/java/org/alfresco/module/org_alfresco_module_rm/event/RecordsManagementEventServiceImpl.java @@ -134,7 +134,10 @@ public class RecordsManagementEventServiceImpl implements RecordsManagementEvent } /** - * @see org.alfresco.module.org_alfresco_module_rm.event.RecordsManagementEventService#existsEventDisplayLabel(java.lang.String) + * Indicates whether a particular event display label exists. Returns true if it does, false otherwise. + * + * @param eventDisplayLabel event display label + * @return boolean true if event exists, false otherwise */ public boolean existsEventDisplayLabel(String eventDisplayLabel) { diff --git a/rm-community/rm-community-repo/source/java/org/alfresco/module/org_alfresco_module_rm/fileplan/FilePlanService.java b/rm-community/rm-community-repo/source/java/org/alfresco/module/org_alfresco_module_rm/fileplan/FilePlanService.java index bffa52dddd..cf12e30450 100644 --- a/rm-community/rm-community-repo/source/java/org/alfresco/module/org_alfresco_module_rm/fileplan/FilePlanService.java +++ b/rm-community/rm-community-repo/source/java/org/alfresco/module/org_alfresco_module_rm/fileplan/FilePlanService.java @@ -143,7 +143,7 @@ public interface FilePlanService * Creates, and returns, a unfiled container for a given file plan. * * @param filePlan file plan - * @return {@link Node} unfiled container + * @return {@link NodeRef} unfiled container */ NodeRef createUnfiledContainer(NodeRef filePlan); @@ -260,7 +260,7 @@ public interface FilePlanService * @param recordCategory record category node reference * @param deep if true then return all children including sub-categories and their children in turn, if false then just * return the immediate children - * @return {@link List}<{@link NodeRef>} list of contained node references + * @return {@link List}<{@link NodeRef}> list of contained node references */ List getAllContained(NodeRef recordCategory, boolean deep); @@ -268,7 +268,7 @@ public interface FilePlanService * Only return the immediate children. * * @param recordCategory record category node reference - * @return {@link List}<{@link NodeRef>} list of contained node references + * @return {@link List}<{@link NodeRef}> list of contained node references */ List getAllContained(NodeRef recordCategory); @@ -278,7 +278,7 @@ public interface FilePlanService * @param recordCategory record category node reference * @param deep if true then return all children including sub-categories and their children in turn, if false then just * return the immediate children - * @return {@link List}<{@link NodeRef>} list of container node references + * @return {@link List}<{@link NodeRef}> list of container node references */ List getContainedRecordCategories(NodeRef recordCategory, boolean deep); @@ -286,7 +286,7 @@ public interface FilePlanService * Only return immediate children. * * @param recordCategory container node reference - * @return {@link List}<{@link NodeRef>} list of container node references + * @return {@link List}<{@link NodeRef}> list of container node references */ List getContainedRecordCategories(NodeRef recordCategory); @@ -296,7 +296,7 @@ public interface FilePlanService * @param container container node reference * @param deep if true then return all children including sub-containers and their children in turn, if false then just * return the immediate children - * @return {@link List}<{@link NodeRef>} list of record folder node references + * @return {@link List}<{@link NodeRef}> list of record folder node references */ List getContainedRecordFolders(NodeRef container, boolean deep); @@ -304,7 +304,7 @@ public interface FilePlanService * Only return immediate children. * * @param container container node reference - * @return {@link List}<{@link NodeRef>} list of record folder node references + * @return {@link List}<{@link NodeRef}> list of record folder node references */ List getContainedRecordFolders(NodeRef container); diff --git a/rm-community/rm-community-repo/source/java/org/alfresco/module/org_alfresco_module_rm/forms/RecordsManagementTypeFormFilter.java b/rm-community/rm-community-repo/source/java/org/alfresco/module/org_alfresco_module_rm/forms/RecordsManagementTypeFormFilter.java index 46389d3f4d..0dc515728e 100644 --- a/rm-community/rm-community-repo/source/java/org/alfresco/module/org_alfresco_module_rm/forms/RecordsManagementTypeFormFilter.java +++ b/rm-community/rm-community-repo/source/java/org/alfresco/module/org_alfresco_module_rm/forms/RecordsManagementTypeFormFilter.java @@ -143,7 +143,7 @@ public class RecordsManagementTypeFormFilter extends RecordsManagementFormFilter * Adds a property definition for each of the custom properties for the * given RM type to the given form. * - * @param rmTypeCustomAspect Enum representing the RM type to add custom + * @param customisableType Enum representing the RM type to add custom * properties for * @param form The form to add the properties to */ diff --git a/rm-community/rm-community-repo/source/java/org/alfresco/module/org_alfresco_module_rm/freeze/FreezeService.java b/rm-community/rm-community-repo/source/java/org/alfresco/module/org_alfresco_module_rm/freeze/FreezeService.java index 9ae6b85775..fc15aa1ab5 100644 --- a/rm-community/rm-community-repo/source/java/org/alfresco/module/org_alfresco_module_rm/freeze/FreezeService.java +++ b/rm-community/rm-community-repo/source/java/org/alfresco/module/org_alfresco_module_rm/freeze/FreezeService.java @@ -28,6 +28,7 @@ package org.alfresco.module.org_alfresco_module_rm.freeze; import java.util.Date; +import java.util.List; import java.util.Set; import org.alfresco.api.AlfrescoPublicApi; @@ -102,13 +103,14 @@ public interface FreezeService void freeze(NodeRef hold, NodeRef nodeRef); /** - * @deprecated as of 2.2, use {@link HoldService#createHold(NodeRef, String, String, String)} and {@link HoldService#addToHold(NodeRef, List)} instead. + * @deprecated as of 2.2, use {@link HoldService#createHold(NodeRef, String, String, String)} and + * {@link HoldService#addToHold(NodeRef, List)} instead. */ @Deprecated NodeRef freeze(String reason, Set nodeRefs); /** - * @deprecated as of 2.2, use {@link HoldService#addToHold(NodeRef, List)} instead. + * @deprecated as of 2.2, use {@link HoldService#addToHold(NodeRef, List)} instead. */ @Deprecated void freeze(NodeRef hold, Set nodeRefs); @@ -148,4 +150,4 @@ public interface FreezeService */ @Deprecated Set getHolds(NodeRef filePlan); -} +} \ No newline at end of file diff --git a/rm-community/rm-community-repo/source/java/org/alfresco/module/org_alfresco_module_rm/freeze/FreezeServiceImpl.java b/rm-community/rm-community-repo/source/java/org/alfresco/module/org_alfresco_module_rm/freeze/FreezeServiceImpl.java index 08e61bd993..65724d81bb 100644 --- a/rm-community/rm-community-repo/source/java/org/alfresco/module/org_alfresco_module_rm/freeze/FreezeServiceImpl.java +++ b/rm-community/rm-community-repo/source/java/org/alfresco/module/org_alfresco_module_rm/freeze/FreezeServiceImpl.java @@ -22,6 +22,7 @@ * - * You should have received a copy of the GNU Lesser General Public License * along with Alfresco. If not, see . + * #L% */ @@ -252,7 +253,7 @@ public class FreezeServiceImpl extends ServiceBaseImpl } /** - * @see org.alfresco.module.org_alfresco_module_rm.freeze.FreezeService#getHold(org.alfresco.service.cmr.repository.NodeRef) + * @see org.alfresco.module.org_alfresco_module_rm.hold.HoldService#getHolds(NodeRef) */ @Override public Set getHolds(NodeRef filePlan) diff --git a/rm-community/rm-community-repo/source/java/org/alfresco/module/org_alfresco_module_rm/identifier/IdentifierGeneratorBase.java b/rm-community/rm-community-repo/source/java/org/alfresco/module/org_alfresco_module_rm/identifier/IdentifierGeneratorBase.java index b40e77d47e..d99d3bdf0c 100644 --- a/rm-community/rm-community-repo/source/java/org/alfresco/module/org_alfresco_module_rm/identifier/IdentifierGeneratorBase.java +++ b/rm-community/rm-community-repo/source/java/org/alfresco/module/org_alfresco_module_rm/identifier/IdentifierGeneratorBase.java @@ -96,7 +96,7 @@ public abstract class IdentifierGeneratorBase implements IdentifierGenerator * * @param s String to pad with leading zero '0' characters * @param len Length to pad to - * @return padded string or the original if already at >=len characters + * @return padded string or the original if already at >=len characters */ protected String padString(String s, int len) { diff --git a/rm-community/rm-community-repo/source/java/org/alfresco/module/org_alfresco_module_rm/job/DispositionLifecycleJobExecuter.java b/rm-community/rm-community-repo/source/java/org/alfresco/module/org_alfresco_module_rm/job/DispositionLifecycleJobExecuter.java index cfe7237333..5416c936a9 100644 --- a/rm-community/rm-community-repo/source/java/org/alfresco/module/org_alfresco_module_rm/job/DispositionLifecycleJobExecuter.java +++ b/rm-community/rm-community-repo/source/java/org/alfresco/module/org_alfresco_module_rm/job/DispositionLifecycleJobExecuter.java @@ -50,7 +50,7 @@ import org.apache.commons.logging.LogFactory; /** * The Disposition Lifecycle Job Finds all disposition action nodes which are for disposition actions specified Where - * asOf > now OR dispositionEventsEligible = true; Runs the cut off or retain action for eligible records. + * asOf > now OR dispositionEventsEligible = true; Runs the cut off or retain action for eligible records. * * @author mrogers * @author Roy Wetherall diff --git a/rm-community/rm-community-repo/source/java/org/alfresco/module/org_alfresco_module_rm/model/CustomisableTypesBootstrap.java b/rm-community/rm-community-repo/source/java/org/alfresco/module/org_alfresco_module_rm/model/CustomisableTypesBootstrap.java index 17fdc83935..1cd6fe39f9 100644 --- a/rm-community/rm-community-repo/source/java/org/alfresco/module/org_alfresco_module_rm/model/CustomisableTypesBootstrap.java +++ b/rm-community/rm-community-repo/source/java/org/alfresco/module/org_alfresco_module_rm/model/CustomisableTypesBootstrap.java @@ -68,7 +68,7 @@ public class CustomisableTypesBootstrap } /** - * @param customizable list of types and aspects to register as customisable + * @param customisable list of types and aspects to register as customisable */ public void setCustomisable(List customisable) { diff --git a/rm-community/rm-community-repo/source/java/org/alfresco/module/org_alfresco_module_rm/model/rma/aspect/FilePlanComponentAspect.java b/rm-community/rm-community-repo/source/java/org/alfresco/module/org_alfresco_module_rm/model/rma/aspect/FilePlanComponentAspect.java index 697a53d725..6364cea652 100644 --- a/rm-community/rm-community-repo/source/java/org/alfresco/module/org_alfresco_module_rm/model/rma/aspect/FilePlanComponentAspect.java +++ b/rm-community/rm-community-repo/source/java/org/alfresco/module/org_alfresco_module_rm/model/rma/aspect/FilePlanComponentAspect.java @@ -83,6 +83,9 @@ public class FilePlanComponentAspect extends BaseBehaviourBean /** file plan service */ private FilePlanService filePlanService; + /** rendition service */ + private RenditionService renditionService; + /** * @param scriptService set script service */ @@ -107,6 +110,14 @@ public class FilePlanComponentAspect extends BaseBehaviourBean this.filePlanService = filePlanService; } + /** + * @param service rendition service + */ + public void setRenditionService(RenditionService service) + { + this.renditionService = service; + } + /** * @see org.alfresco.repo.node.NodeServicePolicies.OnUpdatePropertiesPolicy#onUpdateProperties(org.alfresco.service.cmr.repository.NodeRef, java.util.Map, java.util.Map) */ @@ -142,7 +153,7 @@ public class FilePlanComponentAspect extends BaseBehaviourBean * @param oldProps the old properties and their values. * @param newProps the new properties and their values. * - * @see #lookupScripts(Map, Map) + * @see #lookupScripts(Map, Map) */ private void lookupAndExecuteScripts(NodeRef nodeWithChangedProperties, Map oldProps, @@ -168,7 +179,7 @@ public class FilePlanComponentAspect extends BaseBehaviourBean * @param newProps the new properties and their values. * @return A list of nodeRefs corresponding to the Script resources. * - * @see #determineChangedProps(Map, Map) + * @see org.alfresco.util.PropertyMap#getChangedProperties(Map, Map) */ private List lookupScripts(Map oldProps, Map newProps) { @@ -276,7 +287,7 @@ public class FilePlanComponentAspect extends BaseBehaviourBean * Copy behaviour call back * * @param classRef class reference - * @param copyDetail details of the information being copied + * @param copyDetails details of the information being copied * @return CopyBehaviourCallback */ @Behaviour diff --git a/rm-community/rm-community-repo/source/java/org/alfresco/module/org_alfresco_module_rm/model/rma/type/RecordsManagementContainerType.java b/rm-community/rm-community-repo/source/java/org/alfresco/module/org_alfresco_module_rm/model/rma/type/RecordsManagementContainerType.java index 37be591979..36635049c1 100644 --- a/rm-community/rm-community-repo/source/java/org/alfresco/module/org_alfresco_module_rm/model/rma/type/RecordsManagementContainerType.java +++ b/rm-community/rm-community-repo/source/java/org/alfresco/module/org_alfresco_module_rm/model/rma/type/RecordsManagementContainerType.java @@ -27,11 +27,7 @@ package org.alfresco.module.org_alfresco_module_rm.model.rma.type; -import static org.alfresco.module.org_alfresco_module_rm.record.RecordUtils.appendIdentifierToName; -import static org.alfresco.module.org_alfresco_module_rm.record.RecordUtils.generateRecordIdentifier; - import org.alfresco.model.ContentModel; -import org.alfresco.module.org_alfresco_module_rm.disposition.DispositionService; import org.alfresco.module.org_alfresco_module_rm.identifier.IdentifierService; import org.alfresco.module.org_alfresco_module_rm.model.BaseBehaviourBean; import org.alfresco.module.org_alfresco_module_rm.model.RecordsManagementModel; @@ -121,7 +117,8 @@ public class RecordsManagementContainerType extends BaseBehaviourBean } /** - * @see org.alfresco.module.org_alfresco_module_rm.model.BaseTypeBehaviour#onCreateChildAssociation(org.alfresco.service.cmr.repository.ChildAssociationRef, boolean) + * @see org.alfresco.repo.node.NodeServicePolicies.OnCreateChildAssociationPolicy#onCreateChildAssociation + * (ChildAssociationRef, boolean) */ @Behaviour ( @@ -159,7 +156,8 @@ public class RecordsManagementContainerType extends BaseBehaviourBean } /** - * @see org.alfresco.module.org_alfresco_module_rm.model.BaseTypeBehaviour#onCreateChildAssociation(org.alfresco.service.cmr.repository.ChildAssociationRef, boolean) + * @see org.alfresco.repo.node.NodeServicePolicies.OnCreateChildAssociationPolicy#onCreateChildAssociation(ChildAssociationRef, boolean) + * */ @Behaviour ( diff --git a/rm-community/rm-community-repo/source/java/org/alfresco/module/org_alfresco_module_rm/model/rma/type/RmSiteType.java b/rm-community/rm-community-repo/source/java/org/alfresco/module/org_alfresco_module_rm/model/rma/type/RmSiteType.java index d559b6e8d5..fe2063d735 100644 --- a/rm-community/rm-community-repo/source/java/org/alfresco/module/org_alfresco_module_rm/model/rma/type/RmSiteType.java +++ b/rm-community/rm-community-repo/source/java/org/alfresco/module/org_alfresco_module_rm/model/rma/type/RmSiteType.java @@ -59,12 +59,10 @@ import org.alfresco.service.namespace.QName; import org.alfresco.util.ParameterCheck; import org.alfresco.util.PropertyMap; -import com.google.common.collect.Sets; - /** * Behaviour associated with the RM Site type * - * @author Roy Wetherall + * @author Roy Wetherall, Silviu Dinuta * @since 2.2 */ @BehaviourBean @@ -318,8 +316,6 @@ public class RmSiteType extends BaseBehaviourBean * * * Other than this nothing can be created under rm site nodeRef - * - * @author Silviu Dinuta * @since 2.6 */ @Override diff --git a/rm-community/rm-community-repo/source/java/org/alfresco/module/org_alfresco_module_rm/model/security/ModelSecurityService.java b/rm-community/rm-community-repo/source/java/org/alfresco/module/org_alfresco_module_rm/model/security/ModelSecurityService.java index a8495bca10..3ad804b421 100644 --- a/rm-community/rm-community-repo/source/java/org/alfresco/module/org_alfresco_module_rm/model/security/ModelSecurityService.java +++ b/rm-community/rm-community-repo/source/java/org/alfresco/module/org_alfresco_module_rm/model/security/ModelSecurityService.java @@ -76,7 +76,7 @@ public interface ModelSecurityService /** * Indicates whether a property is protected or not. * - * @param name name of property + * @param property name of property * @return boolean true if property is protected, false otherwise */ boolean isProtectedProperty(QName property); @@ -84,7 +84,7 @@ public interface ModelSecurityService /** * Get the protected properties * - * @return {@link Set}<{@link QName}> all the protected properties + * @return {@link Set}<{@link QName} > all the protected properties */ Set getProtectedProperties(); @@ -121,7 +121,7 @@ public interface ModelSecurityService /** * Get the protected aspects. * - * @return {@link Set}<{@link QName}> all the protected aspects + * @return {@link Set}<{@link QName}> all the protected aspects */ Set getProtectedAspects(); diff --git a/rm-community/rm-community-repo/source/java/org/alfresco/module/org_alfresco_module_rm/permission/RecordsManagementPermissionPostProcessor.java b/rm-community/rm-community-repo/source/java/org/alfresco/module/org_alfresco_module_rm/permission/RecordsManagementPermissionPostProcessor.java index 06a0182cd1..c03c7a3b42 100644 --- a/rm-community/rm-community-repo/source/java/org/alfresco/module/org_alfresco_module_rm/permission/RecordsManagementPermissionPostProcessor.java +++ b/rm-community/rm-community-repo/source/java/org/alfresco/module/org_alfresco_module_rm/permission/RecordsManagementPermissionPostProcessor.java @@ -60,7 +60,7 @@ public class RecordsManagementPermissionPostProcessor extends PermissionPostProc public void setPermissionModel(PermissionModel permissionModel) {this.permissionModel=permissionModel;} /** - * @see org.alfresco.repo.security.permissions.processor.PermissionPostProcessor#process(org.alfresco.service.cmr.security.AccessStatus, org.alfresco.service.cmr.repository.NodeRef, java.lang.String) + * @see org.alfresco.repo.security.permissions.processor.PermissionPostProcessor#process(AccessStatus, NodeRef, String, List, List) */ @Override public AccessStatus process(AccessStatus accessStatus, NodeRef nodeRef, String perm, diff --git a/rm-community/rm-community-repo/source/java/org/alfresco/module/org_alfresco_module_rm/record/RecordService.java b/rm-community/rm-community-repo/source/java/org/alfresco/module/org_alfresco_module_rm/record/RecordService.java index fd1209762d..abc18b4ff8 100644 --- a/rm-community/rm-community-repo/source/java/org/alfresco/module/org_alfresco_module_rm/record/RecordService.java +++ b/rm-community/rm-community-repo/source/java/org/alfresco/module/org_alfresco_module_rm/record/RecordService.java @@ -86,7 +86,7 @@ public interface RecordService /** * Gets a list of all the record meta-data aspects * - * @return {@link Set}<{@link QName}> list of record meta-data aspects + * @return {@link Set}<{@link QName}> list of record meta-data aspects * * @deprecated since 2.2, file plan component required to provide context */ @@ -124,7 +124,7 @@ public interface RecordService * recommended. * * @param nodeRef node reference to file plan component providing context - * @return {@link Set}<{@link QName}> list of record meta-data aspects + * @return {@link Set}<{@link QName} > list of record meta-data aspects * * @since 2.2 */ @@ -137,7 +137,7 @@ public interface RecordService * file plan type (rma:filePlan) are returned. * * @param filePlanType file plan type - * @return{@link Set}<{@link QName}> list of record meta-data aspects + * @return {@link Set} <{@link QName} > list of record meta-data aspects * * @since 2.2 */ @@ -242,7 +242,7 @@ public interface RecordService * Gets a list of all the records within a record folder * * @param recordFolder record folder - * @return List list of records in the record folder + * @return List<NodeRef> list of records in the record folder */ List getRecords(NodeRef recordFolder); diff --git a/rm-community/rm-community-repo/source/java/org/alfresco/module/org_alfresco_module_rm/record/RecordServiceImpl.java b/rm-community/rm-community-repo/source/java/org/alfresco/module/org_alfresco_module_rm/record/RecordServiceImpl.java index fc0c2615d2..882290659d 100644 --- a/rm-community/rm-community-repo/source/java/org/alfresco/module/org_alfresco_module_rm/record/RecordServiceImpl.java +++ b/rm-community/rm-community-repo/source/java/org/alfresco/module/org_alfresco_module_rm/record/RecordServiceImpl.java @@ -701,7 +701,7 @@ public class RecordServiceImpl extends BaseBehaviourBean /** * Get map containing record metadata aspects. * - * @return {@link Map}<{@link QName}, {@link Set}<{@link QName}>> map containing record metadata aspects + * @return {@link Map}<{@link QName}, {@link Set}<{@link QName} >> map containing record metadata aspects * * @since 2.2 */ @@ -812,7 +812,7 @@ public class RecordServiceImpl extends BaseBehaviourBean } /** - * @see org.alfresco.module.org_alfresco_module_rm.record.RecordService#getRecordMetaDataAspects(org.alfresco.service.cmr.repository.NodeRef) + * @see org.alfresco.module.org_alfresco_module_rm.record.RecordService#getRecordMetadataAspects(NodeRef) */ @Override public Set getRecordMetadataAspects(NodeRef nodeRef) @@ -1202,7 +1202,7 @@ public class RecordServiceImpl extends BaseBehaviourBean } /** - * @see org.alfresco.module.org_alfresco_module_rm.record.RecordService#createNewRecord(org.alfresco.service.cmr.repository.NodeRef, java.lang.String, org.alfresco.service.namespace.QName, java.util.Map, org.alfresco.service.cmr.repository.ContentReader) + * @see org.alfresco.module.org_alfresco_module_rm.record.RecordService#createRecordFromContent(org.alfresco.service.cmr.repository.NodeRef, java.lang.String, org.alfresco.service.namespace.QName, java.util.Map, org.alfresco.service.cmr.repository.ContentReader) */ @Override public NodeRef createRecordFromContent(NodeRef parent, String name, QName type, Map properties, ContentReader reader) @@ -1322,7 +1322,7 @@ public class RecordServiceImpl extends BaseBehaviourBean } /** - * @see org.alfresco.module.org_alfresco_module_rm.disposableitem.RecordService#isFiled(org.alfresco.service.cmr.repository.NodeRef) + * @see org.alfresco.module.org_alfresco_module_rm.record.RecordService#isFiled(org.alfresco.service.cmr.repository.NodeRef) */ @Override public boolean isFiled(final NodeRef nodeRef) diff --git a/rm-community/rm-community-repo/source/java/org/alfresco/module/org_alfresco_module_rm/relationship/RelationshipServiceImpl.java b/rm-community/rm-community-repo/source/java/org/alfresco/module/org_alfresco_module_rm/relationship/RelationshipServiceImpl.java index 3c863b3202..315d8a01d9 100644 --- a/rm-community/rm-community-repo/source/java/org/alfresco/module/org_alfresco_module_rm/relationship/RelationshipServiceImpl.java +++ b/rm-community/rm-community-repo/source/java/org/alfresco/module/org_alfresco_module_rm/relationship/RelationshipServiceImpl.java @@ -263,7 +263,7 @@ public class RelationshipServiceImpl extends RecordsManagementAdminBase implemen } /** - * @see org.alfresco.module.org_alfresco_module_rm.relationship.RelationshipService#updateReleationshipDefinition(java.lang.String) + * @see org.alfresco.module.org_alfresco_module_rm.relationship.RelationshipService#updateRelationshipDefinition(java.lang.String, RelationshipDisplayName) */ @Override public RelationshipDefinition updateRelationshipDefinition(String uniqueName, RelationshipDisplayName displayName) diff --git a/rm-community/rm-community-repo/source/java/org/alfresco/module/org_alfresco_module_rm/report/Report.java b/rm-community/rm-community-repo/source/java/org/alfresco/module/org_alfresco_module_rm/report/Report.java index ca13e874cd..b748d8af74 100644 --- a/rm-community/rm-community-repo/source/java/org/alfresco/module/org_alfresco_module_rm/report/Report.java +++ b/rm-community/rm-community-repo/source/java/org/alfresco/module/org_alfresco_module_rm/report/Report.java @@ -54,7 +54,7 @@ public interface Report String getReportName(); /** - * @return {@link Map}<{@link QName},{@link Serializable}> report properties + * @return {@link Map}<{@link QName},{@link Serializable}> report properties */ Map getReportProperties(); diff --git a/rm-community/rm-community-repo/source/java/org/alfresco/module/org_alfresco_module_rm/report/ReportService.java b/rm-community/rm-community-repo/source/java/org/alfresco/module/org_alfresco_module_rm/report/ReportService.java index 750b0a1235..66bdaff2f0 100644 --- a/rm-community/rm-community-repo/source/java/org/alfresco/module/org_alfresco_module_rm/report/ReportService.java +++ b/rm-community/rm-community-repo/source/java/org/alfresco/module/org_alfresco_module_rm/report/ReportService.java @@ -52,7 +52,7 @@ public interface ReportService /** * Get a list of the available report types. * - * @return {@link Set}<{@link QName}> list of the available report types + * @return {@link Set}<{@link QName}> list of the available report types */ Set getReportTypes(); diff --git a/rm-community/rm-community-repo/source/java/org/alfresco/module/org_alfresco_module_rm/report/ReportServiceImpl.java b/rm-community/rm-community-repo/source/java/org/alfresco/module/org_alfresco_module_rm/report/ReportServiceImpl.java index ac96ed6743..cf8fec6c8f 100644 --- a/rm-community/rm-community-repo/source/java/org/alfresco/module/org_alfresco_module_rm/report/ReportServiceImpl.java +++ b/rm-community/rm-community-repo/source/java/org/alfresco/module/org_alfresco_module_rm/report/ReportServiceImpl.java @@ -117,7 +117,7 @@ public class ReportServiceImpl extends ServiceBaseImpl } /** - * @see org.alfresco.module.org_alfresco_module_rm.report.ReportService#fileReport(org.alfresco.module.org_alfresco_module_rm.report.Report) + * @see org.alfresco.module.org_alfresco_module_rm.report.ReportService#fileReport(NodeRef, org.alfresco.module.org_alfresco_module_rm.report.Report) */ @Override public NodeRef fileReport(NodeRef nodeRef, Report report) diff --git a/rm-community/rm-community-repo/source/java/org/alfresco/module/org_alfresco_module_rm/report/generator/BaseReportGenerator.java b/rm-community/rm-community-repo/source/java/org/alfresco/module/org_alfresco_module_rm/report/generator/BaseReportGenerator.java index 7264d32f91..5dd9ec9fde 100644 --- a/rm-community/rm-community-repo/source/java/org/alfresco/module/org_alfresco_module_rm/report/generator/BaseReportGenerator.java +++ b/rm-community/rm-community-repo/source/java/org/alfresco/module/org_alfresco_module_rm/report/generator/BaseReportGenerator.java @@ -102,7 +102,7 @@ public abstract class BaseReportGenerator implements ReportGenerator } /** - * @see org.alfresco.module.org_alfresco_module_rm.report.ReportGenerator#generateReport(org.alfresco.service.cmr.repository.NodeRef, java.lang.String, java.util.Map) + * @see org.alfresco.module.org_alfresco_module_rm.report.ReportGenerator#generateReport(org.alfresco.service.cmr.repository.NodeRef, java.lang.String) */ @Override public Report generateReport(NodeRef reportedUponNodeRef, String mimetype) diff --git a/rm-community/rm-community-repo/source/java/org/alfresco/module/org_alfresco_module_rm/report/generator/DeclarativeReportGenerator.java b/rm-community/rm-community-repo/source/java/org/alfresco/module/org_alfresco_module_rm/report/generator/DeclarativeReportGenerator.java index da106c0529..ed8799b00d 100644 --- a/rm-community/rm-community-repo/source/java/org/alfresco/module/org_alfresco_module_rm/report/generator/DeclarativeReportGenerator.java +++ b/rm-community/rm-community-repo/source/java/org/alfresco/module/org_alfresco_module_rm/report/generator/DeclarativeReportGenerator.java @@ -175,7 +175,7 @@ public class DeclarativeReportGenerator extends BaseReportGenerator } /** - * @see org.alfresco.module.org_alfresco_module_rm.report.generator.BaseReportGenerator#generateReportName(org.alfresco.service.cmr.repository.NodeRef) + * @see org.alfresco.module.org_alfresco_module_rm.report.generator.BaseReportGenerator#generateReportName(org.alfresco.service.cmr.repository.NodeRef, String) */ @Override protected String generateReportName(NodeRef reportedUponNodeRef, String mimetype) diff --git a/rm-community/rm-community-repo/source/java/org/alfresco/module/org_alfresco_module_rm/report/generator/transfer/TransferReportGenerator.java b/rm-community/rm-community-repo/source/java/org/alfresco/module/org_alfresco_module_rm/report/generator/transfer/TransferReportGenerator.java index 228219b390..26eaf123e8 100644 --- a/rm-community/rm-community-repo/source/java/org/alfresco/module/org_alfresco_module_rm/report/generator/transfer/TransferReportGenerator.java +++ b/rm-community/rm-community-repo/source/java/org/alfresco/module/org_alfresco_module_rm/report/generator/transfer/TransferReportGenerator.java @@ -66,7 +66,7 @@ public class TransferReportGenerator extends DeclarativeReportGenerator } /** - * @see org.alfresco.module.org_alfresco_module_rm.report.generator.DeclarativeReportGeneratorUnitTest#generateReportTemplateContext(org.alfresco.service.cmr.repository.NodeRef) + * @see org.alfresco.module.org_alfresco_module_rm.report.generator.DeclarativeReportGenerator#generateReportTemplateContext(org.alfresco.service.cmr.repository.NodeRef) */ @Override protected Map generateReportTemplateContext(NodeRef reportedUponNodeRef) diff --git a/rm-community/rm-community-repo/source/java/org/alfresco/module/org_alfresco_module_rm/role/FilePlanRoleService.java b/rm-community/rm-community-repo/source/java/org/alfresco/module/org_alfresco_module_rm/role/FilePlanRoleService.java index f13c73c3c5..905f3e8b00 100644 --- a/rm-community/rm-community-repo/source/java/org/alfresco/module/org_alfresco_module_rm/role/FilePlanRoleService.java +++ b/rm-community/rm-community-repo/source/java/org/alfresco/module/org_alfresco_module_rm/role/FilePlanRoleService.java @@ -183,7 +183,7 @@ public interface FilePlanRoleService * * @param filePlan file plan * @param role role - * @return {@link Set}<{@link String}> set of users + * @return {@link Set}<{@link String}> set of users */ Set getUsersAssignedToRole(NodeRef filePlan, String role); @@ -192,7 +192,7 @@ public interface FilePlanRoleService * * @param filePlan file plan * @param role role - * @return {@link Set}<{@link String}> set of groups + * @return {@link Set}<{@link String}> set of groups */ Set getGroupsAssignedToRole(NodeRef filePlan, String role); @@ -201,7 +201,7 @@ public interface FilePlanRoleService * * @param filePlan file plan * @param role role - * @return {@link Set}<{@link String}> set of groups and users + * @return {@link Set}<{@link String}> set of groups and users */ Set getAllAssignedToRole(NodeRef filePlan, String role); diff --git a/rm-community/rm-community-repo/source/java/org/alfresco/module/org_alfresco_module_rm/role/FilePlanRoleServiceImpl.java b/rm-community/rm-community-repo/source/java/org/alfresco/module/org_alfresco_module_rm/role/FilePlanRoleServiceImpl.java index 77c28ecf0c..63b914953e 100644 --- a/rm-community/rm-community-repo/source/java/org/alfresco/module/org_alfresco_module_rm/role/FilePlanRoleServiceImpl.java +++ b/rm-community/rm-community-repo/source/java/org/alfresco/module/org_alfresco_module_rm/role/FilePlanRoleServiceImpl.java @@ -27,11 +27,8 @@ package org.alfresco.module.org_alfresco_module_rm.role; -import java.io.BufferedReader; import java.io.IOException; import java.io.InputStream; -import java.io.InputStreamReader; -import java.nio.charset.Charset; import java.util.ArrayList; import java.util.Arrays; import java.util.HashSet; @@ -161,7 +158,7 @@ public class FilePlanRoleServiceImpl implements FilePlanRoleService, } /** - * @see org.alfresco.module.org_alfresco_module_rm.role.FilePlanRoleService#initialiseFilePlan(org.alfresco.service.cmr.repository.NodeRef) + * @see org.alfresco.module.org_alfresco_module_rm.role.FilePlanRoleService#setupFilePlanRoles(NodeRef) */ @Override public void setupFilePlanRoles(final NodeRef filePlan) @@ -394,7 +391,7 @@ public class FilePlanRoleServiceImpl implements FilePlanRoleService, } /** - * @see org.alfresco.module.org_alfresco_module_rm.security.RecordsManagementSecurityService#getRoles() + * @see org.alfresco.module.org_alfresco_module_rm.role.FilePlanRoleService#getRoles(NodeRef) */ public Set getRoles(final NodeRef rmRootNode) { @@ -519,7 +516,7 @@ public class FilePlanRoleServiceImpl implements FilePlanRoleService, } /** - * @see org.alfresco.module.org_alfresco_module_rm.security.RecordsManagementSecurityService#getRole(org.alfresco.service.cmr.repository.NodeRef, java.lang.String) + * @see org.alfresco.module.org_alfresco_module_rm.role.FilePlanRoleService#getRole(org.alfresco.service.cmr.repository.NodeRef, java.lang.String) */ public Role getRole(final NodeRef rmRootNode, final String role) { @@ -571,7 +568,7 @@ public class FilePlanRoleServiceImpl implements FilePlanRoleService, } /** - * @see org.alfresco.module.org_alfresco_module_rm.security.RecordsManagementSecurityService#existsRole(java.lang.String) + * @see org.alfresco.module.org_alfresco_module_rm.role.FilePlanRoleService#existsRole(NodeRef, java.lang.String) */ public boolean existsRole(final NodeRef rmRootNode, final String role) { @@ -589,7 +586,7 @@ public class FilePlanRoleServiceImpl implements FilePlanRoleService, } /** - * @see org.alfresco.module.org_alfresco_module_rm.security.RecordsManagementSecurityService#hasRMAdminRole(org.alfresco.service.cmr.repository.NodeRef, java.lang.String) + * @see org.alfresco.module.org_alfresco_module_rm.role.FilePlanRoleService#hasRMAdminRole(org.alfresco.service.cmr.repository.NodeRef, java.lang.String) * * TODO .. change this to check a property of the role its self */ @@ -708,7 +705,7 @@ public class FilePlanRoleServiceImpl implements FilePlanRoleService, } /** - * @see org.alfresco.module.org_alfresco_module_rm.security.RecordsManagementSecurityService#deleteRole(java.lang.String) + * @see org.alfresco.module.org_alfresco_module_rm.security.RecordsManagementSecurityService#deleteRole(NodeRef,String) */ public void deleteRole(final NodeRef rmRootNode, final String role) { diff --git a/rm-community/rm-community-repo/source/java/org/alfresco/module/org_alfresco_module_rm/script/AbstractRmWebScript.java b/rm-community/rm-community-repo/source/java/org/alfresco/module/org_alfresco_module_rm/script/AbstractRmWebScript.java index 91201fcc53..7dd0ea4dd0 100644 --- a/rm-community/rm-community-repo/source/java/org/alfresco/module/org_alfresco_module_rm/script/AbstractRmWebScript.java +++ b/rm-community/rm-community-repo/source/java/org/alfresco/module/org_alfresco_module_rm/script/AbstractRmWebScript.java @@ -29,9 +29,8 @@ package org.alfresco.module.org_alfresco_module_rm.script; import static org.alfresco.util.WebScriptUtils.getTemplateVars; -import java.util.Map; - import javax.servlet.http.HttpServletResponse; +import java.util.Map; import org.alfresco.module.org_alfresco_module_rm.disposition.DispositionService; import org.alfresco.service.cmr.repository.NodeRef; @@ -47,6 +46,7 @@ import org.springframework.extensions.webscripts.WebScriptRequest; * * @author Neil McErlean * @author Tuna Aksoy + * @author Gavin Cornwell */ public abstract class AbstractRmWebScript extends DeclarativeWebScript { @@ -133,7 +133,6 @@ public abstract class AbstractRmWebScript extends DeclarativeWebScript * @param req The webscript request * @return The NodeRef passed in the request * - * @author Gavin Cornwell */ protected NodeRef parseRequestForNodeRef(WebScriptRequest req) { diff --git a/rm-community/rm-community-repo/source/java/org/alfresco/module/org_alfresco_module_rm/script/AuditLogStatusGet.java b/rm-community/rm-community-repo/source/java/org/alfresco/module/org_alfresco_module_rm/script/AuditLogStatusGet.java index 6608169d23..78b0da1824 100644 --- a/rm-community/rm-community-repo/source/java/org/alfresco/module/org_alfresco_module_rm/script/AuditLogStatusGet.java +++ b/rm-community/rm-community-repo/source/java/org/alfresco/module/org_alfresco_module_rm/script/AuditLogStatusGet.java @@ -55,7 +55,7 @@ public class AuditLogStatusGet extends DeclarativeWebScript /** * Sets the RecordsManagementAuditService instance * - * @param auditService The RecordsManagementAuditService instance + * @param rmAuditService The RecordsManagementAuditService instance */ public void setRecordsManagementAuditService(RecordsManagementAuditService rmAuditService) { diff --git a/rm-community/rm-community-repo/source/java/org/alfresco/module/org_alfresco_module_rm/script/BaseAuditAdminWebScript.java b/rm-community/rm-community-repo/source/java/org/alfresco/module/org_alfresco_module_rm/script/BaseAuditAdminWebScript.java index 4e544a7ee5..261ca51d9b 100644 --- a/rm-community/rm-community-repo/source/java/org/alfresco/module/org_alfresco_module_rm/script/BaseAuditAdminWebScript.java +++ b/rm-community/rm-community-repo/source/java/org/alfresco/module/org_alfresco_module_rm/script/BaseAuditAdminWebScript.java @@ -53,7 +53,7 @@ public class BaseAuditAdminWebScript extends DeclarativeWebScript /** * Sets the RecordsManagementAuditService instance * - * @param auditService The RecordsManagementAuditService instance + * @param rmAuditService The RecordsManagementAuditService instance */ public void setRecordsManagementAuditService(RecordsManagementAuditService rmAuditService) { diff --git a/rm-community/rm-community-repo/source/java/org/alfresco/module/org_alfresco_module_rm/script/BaseAuditRetrievalWebScript.java b/rm-community/rm-community-repo/source/java/org/alfresco/module/org_alfresco_module_rm/script/BaseAuditRetrievalWebScript.java index 19b53db6d5..a2beab806e 100644 --- a/rm-community/rm-community-repo/source/java/org/alfresco/module/org_alfresco_module_rm/script/BaseAuditRetrievalWebScript.java +++ b/rm-community/rm-community-repo/source/java/org/alfresco/module/org_alfresco_module_rm/script/BaseAuditRetrievalWebScript.java @@ -73,7 +73,7 @@ public class BaseAuditRetrievalWebScript extends StreamContent /** * Sets the RecordsManagementAuditService instance * - * @param auditService The RecordsManagementAuditService instance + * @param rmAuditService The RecordsManagementAuditService instance */ public void setRecordsManagementAuditService(RecordsManagementAuditService rmAuditService) { diff --git a/rm-community/rm-community-repo/source/java/org/alfresco/module/org_alfresco_module_rm/script/BaseTransferWebScript.java b/rm-community/rm-community-repo/source/java/org/alfresco/module/org_alfresco_module_rm/script/BaseTransferWebScript.java index 79c6d1fcff..f7f2f60bd5 100644 --- a/rm-community/rm-community-repo/source/java/org/alfresco/module/org_alfresco_module_rm/script/BaseTransferWebScript.java +++ b/rm-community/rm-community-repo/source/java/org/alfresco/module/org_alfresco_module_rm/script/BaseTransferWebScript.java @@ -27,14 +27,13 @@ package org.alfresco.module.org_alfresco_module_rm.script; +import javax.servlet.http.HttpServletResponse; import java.io.File; import java.io.IOException; import java.util.HashMap; import java.util.List; import java.util.Map; -import javax.servlet.http.HttpServletResponse; - import org.alfresco.model.ContentModel; import org.alfresco.module.org_alfresco_module_rm.fileplan.FilePlanService; import org.alfresco.module.org_alfresco_module_rm.model.RecordsManagementModel; @@ -69,7 +68,9 @@ public abstract class BaseTransferWebScript extends StreamACP } /** - * @see org.alfresco.web.scripts.WebScript#execute(org.alfresco.web.scripts.WebScriptRequest, org.alfresco.web.scripts.WebScriptResponse) + * @see org.springframework.extensions.webscripts.DeclarativeWebScript#executeImpl(org.springframework.extensions.webscripts.WebScriptRequest, + * org.springframework.extensions.webscripts.Status, + * org.springframework.extensions.webscripts.Cache) */ public void execute(WebScriptRequest req, WebScriptResponse res) throws IOException { diff --git a/rm-community/rm-community-repo/source/java/org/alfresco/module/org_alfresco_module_rm/script/EmailMapDelete.java b/rm-community/rm-community-repo/source/java/org/alfresco/module/org_alfresco_module_rm/script/EmailMapDelete.java index a76076a55d..c70166c3ff 100644 --- a/rm-community/rm-community-repo/source/java/org/alfresco/module/org_alfresco_module_rm/script/EmailMapDelete.java +++ b/rm-community/rm-community-repo/source/java/org/alfresco/module/org_alfresco_module_rm/script/EmailMapDelete.java @@ -59,7 +59,9 @@ public class EmailMapDelete extends DeclarativeWebScript } /** - * @see org.alfresco.web.scripts.DeclarativeWebScript#executeImpl(org.alfresco.web.scripts.WebScriptRequest, org.alfresco.web.scripts.Status, org.alfresco.web.scripts.Cache) + * @see org.springframework.extensions.webscripts.DeclarativeWebScript#executeImpl(org.springframework.extensions.webscripts.WebScriptRequest, + * org.springframework.extensions.webscripts.Status, + * org.springframework.extensions.webscripts.Cache) */ @Override protected Map executeImpl(WebScriptRequest req, Status status, Cache cache) diff --git a/rm-community/rm-community-repo/source/java/org/alfresco/module/org_alfresco_module_rm/script/EmailMapGet.java b/rm-community/rm-community-repo/source/java/org/alfresco/module/org_alfresco_module_rm/script/EmailMapGet.java index 33f47996f0..6b9765d0bb 100644 --- a/rm-community/rm-community-repo/source/java/org/alfresco/module/org_alfresco_module_rm/script/EmailMapGet.java +++ b/rm-community/rm-community-repo/source/java/org/alfresco/module/org_alfresco_module_rm/script/EmailMapGet.java @@ -56,7 +56,9 @@ public class EmailMapGet extends DeclarativeWebScript } /** - * @see org.alfresco.web.scripts.DeclarativeWebScript#executeImpl(org.alfresco.web.scripts.WebScriptRequest, org.alfresco.web.scripts.Status, org.alfresco.web.scripts.Cache) + * @see org.springframework.extensions.webscripts.DeclarativeWebScript#executeImpl(org.springframework.extensions.webscripts.WebScriptRequest, + * org.springframework.extensions.webscripts.Status, + * org.springframework.extensions.webscripts.Cache) */ @Override protected Map executeImpl(WebScriptRequest req, Status status, Cache cache) diff --git a/rm-community/rm-community-repo/source/java/org/alfresco/module/org_alfresco_module_rm/script/EmailMapPost.java b/rm-community/rm-community-repo/source/java/org/alfresco/module/org_alfresco_module_rm/script/EmailMapPost.java index f6f30454da..7b49399f8b 100644 --- a/rm-community/rm-community-repo/source/java/org/alfresco/module/org_alfresco_module_rm/script/EmailMapPost.java +++ b/rm-community/rm-community-repo/source/java/org/alfresco/module/org_alfresco_module_rm/script/EmailMapPost.java @@ -62,7 +62,9 @@ public class EmailMapPost extends DeclarativeWebScript } /** - * @see org.alfresco.web.scripts.DeclarativeWebScript#executeImpl(org.alfresco.web.scripts.WebScriptRequest, org.alfresco.web.scripts.Status, org.alfresco.web.scripts.Cache) + * @see org.springframework.extensions.webscripts.DeclarativeWebScript#executeImpl(org.springframework.extensions.webscripts.WebScriptRequest, + * org.springframework.extensions.webscripts.Status, + * org.springframework.extensions.webscripts.Cache) */ @Override protected Map executeImpl(WebScriptRequest req, Status status, Cache cache) diff --git a/rm-community/rm-community-repo/source/java/org/alfresco/module/org_alfresco_module_rm/script/ExportPost.java b/rm-community/rm-community-repo/source/java/org/alfresco/module/org_alfresco_module_rm/script/ExportPost.java index 404fe1e55e..7778627c0d 100644 --- a/rm-community/rm-community-repo/source/java/org/alfresco/module/org_alfresco_module_rm/script/ExportPost.java +++ b/rm-community/rm-community-repo/source/java/org/alfresco/module/org_alfresco_module_rm/script/ExportPost.java @@ -78,7 +78,9 @@ public class ExportPost extends StreamACP } /** - * @see org.alfresco.web.scripts.WebScript#execute(org.alfresco.web.scripts.WebScriptRequest, org.alfresco.web.scripts.WebScriptResponse) + * @see org.springframework.extensions.webscripts.DeclarativeWebScript#executeImpl(org.springframework.extensions.webscripts.WebScriptRequest, + * org.springframework.extensions.webscripts.Status, + * org.springframework.extensions.webscripts.Cache) */ @SuppressWarnings("deprecation") @Override diff --git a/rm-community/rm-community-repo/source/java/org/alfresco/module/org_alfresco_module_rm/script/admin/RmEventDelete.java b/rm-community/rm-community-repo/source/java/org/alfresco/module/org_alfresco_module_rm/script/admin/RmEventDelete.java index c3f42c488b..13132629bf 100644 --- a/rm-community/rm-community-repo/source/java/org/alfresco/module/org_alfresco_module_rm/script/admin/RmEventDelete.java +++ b/rm-community/rm-community-repo/source/java/org/alfresco/module/org_alfresco_module_rm/script/admin/RmEventDelete.java @@ -58,7 +58,9 @@ public class RmEventDelete extends DeclarativeWebScript } /** - * @see org.alfresco.web.scripts.DeclarativeWebScript#executeImpl(org.alfresco.web.scripts.WebScriptRequest, org.alfresco.web.scripts.Status, org.alfresco.web.scripts.Cache) + * @see org.springframework.extensions.webscripts.DeclarativeWebScript#executeImpl(org.springframework.extensions.webscripts.WebScriptRequest, + * org.springframework.extensions.webscripts.Status, + * org.springframework.extensions.webscripts.Cache) */ @Override public Map executeImpl(WebScriptRequest req, Status status, Cache cache) diff --git a/rm-community/rm-community-repo/source/java/org/alfresco/module/org_alfresco_module_rm/script/slingshot/RMSavedSearchesPost.java b/rm-community/rm-community-repo/source/java/org/alfresco/module/org_alfresco_module_rm/script/slingshot/RMSavedSearchesPost.java index 836eb39f4e..1a0f9e0429 100644 --- a/rm-community/rm-community-repo/source/java/org/alfresco/module/org_alfresco_module_rm/script/slingshot/RMSavedSearchesPost.java +++ b/rm-community/rm-community-repo/source/java/org/alfresco/module/org_alfresco_module_rm/script/slingshot/RMSavedSearchesPost.java @@ -86,7 +86,9 @@ public class RMSavedSearchesPost extends DeclarativeWebScript } /** - * @see org.alfresco.web.scripts.DeclarativeWebScript#executeImpl(org.alfresco.web.scripts.WebScriptRequest, org.alfresco.web.scripts.Status, org.alfresco.web.scripts.Cache) + * @see org.springframework.extensions.webscripts.DeclarativeWebScript#executeImpl(org.springframework.extensions.webscripts.WebScriptRequest, + * org.springframework.extensions.webscripts.Status, + * org.springframework.extensions.webscripts.Cache) */ @Override protected Map executeImpl(WebScriptRequest req, Status status, Cache cache) diff --git a/rm-community/rm-community-repo/source/java/org/alfresco/module/org_alfresco_module_rm/script/slingshot/RMSearchPropertiesGet.java b/rm-community/rm-community-repo/source/java/org/alfresco/module/org_alfresco_module_rm/script/slingshot/RMSearchPropertiesGet.java index 8e7e9e05ca..0765e8852b 100644 --- a/rm-community/rm-community-repo/source/java/org/alfresco/module/org_alfresco_module_rm/script/slingshot/RMSearchPropertiesGet.java +++ b/rm-community/rm-community-repo/source/java/org/alfresco/module/org_alfresco_module_rm/script/slingshot/RMSearchPropertiesGet.java @@ -102,7 +102,9 @@ public class RMSearchPropertiesGet extends DeclarativeWebScript } /** - * @see org.alfresco.web.scripts.DeclarativeWebScript#executeImpl(org.alfresco.web.scripts.WebScriptRequest, org.alfresco.web.scripts.Status, org.alfresco.web.scripts.Cache) + * @see org.springframework.extensions.webscripts.DeclarativeWebScript#executeImpl(org.springframework.extensions.webscripts.WebScriptRequest, + * org.springframework.extensions.webscripts.Status, + * org.springframework.extensions.webscripts.Cache) */ @Override protected Map executeImpl(WebScriptRequest req, Status status, Cache cache) diff --git a/rm-community/rm-community-repo/source/java/org/alfresco/module/org_alfresco_module_rm/script/slingshot/RecordedVersionConfigGet.java b/rm-community/rm-community-repo/source/java/org/alfresco/module/org_alfresco_module_rm/script/slingshot/RecordedVersionConfigGet.java index d32c382ed5..212c2d29da 100644 --- a/rm-community/rm-community-repo/source/java/org/alfresco/module/org_alfresco_module_rm/script/slingshot/RecordedVersionConfigGet.java +++ b/rm-community/rm-community-repo/source/java/org/alfresco/module/org_alfresco_module_rm/script/slingshot/RecordedVersionConfigGet.java @@ -70,7 +70,9 @@ public class RecordedVersionConfigGet extends AbstractRmWebScript } /** - * @see org.alfresco.web.scripts.DeclarativeWebScript#executeImpl(org.alfresco.web.scripts.WebScriptRequest, org.alfresco.web.scripts.Status, org.alfresco.web.scripts.Cache) + * @see org.springframework.extensions.webscripts.DeclarativeWebScript#executeImpl(org.springframework.extensions.webscripts.WebScriptRequest, + * org.springframework.extensions.webscripts.Status, + * org.springframework.extensions.webscripts.Cache) */ @Override protected Map executeImpl(WebScriptRequest req, Status status, Cache cache) diff --git a/rm-community/rm-community-repo/source/java/org/alfresco/module/org_alfresco_module_rm/script/slingshot/RecordedVersionConfigPost.java b/rm-community/rm-community-repo/source/java/org/alfresco/module/org_alfresco_module_rm/script/slingshot/RecordedVersionConfigPost.java index 8d1fbc5f8b..0bfab96fef 100644 --- a/rm-community/rm-community-repo/source/java/org/alfresco/module/org_alfresco_module_rm/script/slingshot/RecordedVersionConfigPost.java +++ b/rm-community/rm-community-repo/source/java/org/alfresco/module/org_alfresco_module_rm/script/slingshot/RecordedVersionConfigPost.java @@ -76,7 +76,9 @@ public class RecordedVersionConfigPost extends AbstractRmWebScript } /** - * @see org.alfresco.web.scripts.DeclarativeWebScript#executeImpl(org.alfresco.web.scripts.WebScriptRequest, org.alfresco.web.scripts.Status, org.alfresco.web.scripts.Cache) + * @see org.springframework.extensions.webscripts.DeclarativeWebScript#executeImpl(org.springframework.extensions.webscripts.WebScriptRequest, + * org.springframework.extensions.webscripts.Status, + * org.springframework.extensions.webscripts.Cache) */ @Override protected Map executeImpl(WebScriptRequest req, Status status, Cache cache) @@ -90,7 +92,7 @@ public class RecordedVersionConfigPost extends AbstractRmWebScript /** * Gets the recordable version policy from the request * - * @param The webscript request + * @param req The webscript request * @return The recordable version policy */ private String getRecordableVersionPolicy(WebScriptRequest req) diff --git a/rm-community/rm-community-repo/source/java/org/alfresco/module/org_alfresco_module_rm/search/RecordsManagementSearchService.java b/rm-community/rm-community-repo/source/java/org/alfresco/module/org_alfresco_module_rm/search/RecordsManagementSearchService.java index ee8419ded2..acb1a5e1c0 100644 --- a/rm-community/rm-community-repo/source/java/org/alfresco/module/org_alfresco_module_rm/search/RecordsManagementSearchService.java +++ b/rm-community/rm-community-repo/source/java/org/alfresco/module/org_alfresco_module_rm/search/RecordsManagementSearchService.java @@ -45,14 +45,14 @@ public interface RecordsManagementSearchService * @param siteId the id of the rm site to query * @param query search query string * @param searchParameters search parameters - * @return {@link List}<{@link Pair}<{@link NodeRef}, {@link NodeRef}> search results as pairs for parent and child nodes + * @return {@link List}<{@link Pair} <{@link NodeRef}, {@link NodeRef}>> search results as pairs for parent and child nodes */ List> search(String siteId, String query, RecordsManagementSearchParameters searchParameters); /** * Get all the searches saved on the given records management site. * @param siteId site id - * @return {@link List<{@link SavedSearchDetails}>} list of saved search details + * @return {@link List}<{@link SavedSearchDetails}> list of saved search details */ List getSavedSearches(String siteId); diff --git a/rm-community/rm-community-repo/source/java/org/alfresco/module/org_alfresco_module_rm/search/RecordsManagementSearchServiceImpl.java b/rm-community/rm-community-repo/source/java/org/alfresco/module/org_alfresco_module_rm/search/RecordsManagementSearchServiceImpl.java index 02666fbd38..90aa48eb3b 100644 --- a/rm-community/rm-community-repo/source/java/org/alfresco/module/org_alfresco_module_rm/search/RecordsManagementSearchServiceImpl.java +++ b/rm-community/rm-community-repo/source/java/org/alfresco/module/org_alfresco_module_rm/search/RecordsManagementSearchServiceImpl.java @@ -466,7 +466,7 @@ public class RecordsManagementSearchServiceImpl implements RecordsManagementSear } /** - * @see org.alfresco.module.org_alfresco_module_rm.search.RecordsManagementSearchService#saveSearch(java.lang.String, java.lang.String, java.lang.String, java.lang.String, boolean) + * @see org.alfresco.module.org_alfresco_module_rm.search.RecordsManagementSearchService#saveSearch(String, String, String, String, RecordsManagementSearchParameters, boolean) */ @Override public SavedSearchDetails saveSearch(String siteId, String name, String description, String query, RecordsManagementSearchParameters searchParameters, boolean isPublic) diff --git a/rm-community/rm-community-repo/source/java/org/alfresco/module/org_alfresco_module_rm/search/ReportDetails.java b/rm-community/rm-community-repo/source/java/org/alfresco/module/org_alfresco_module_rm/search/ReportDetails.java index f07bb3f6aa..f75b93a4c0 100644 --- a/rm-community/rm-community-repo/source/java/org/alfresco/module/org_alfresco_module_rm/search/ReportDetails.java +++ b/rm-community/rm-community-repo/source/java/org/alfresco/module/org_alfresco_module_rm/search/ReportDetails.java @@ -97,7 +97,7 @@ public class ReportDetails } /** - * @param query query string + * @param search query string */ public void setSearch(String search) { diff --git a/rm-community/rm-community-repo/source/java/org/alfresco/module/org_alfresco_module_rm/search/SavedSearchDetails.java b/rm-community/rm-community-repo/source/java/org/alfresco/module/org_alfresco_module_rm/search/SavedSearchDetails.java index 41d7a9561b..04f1c2a3a9 100644 --- a/rm-community/rm-community-repo/source/java/org/alfresco/module/org_alfresco_module_rm/search/SavedSearchDetails.java +++ b/rm-community/rm-community-repo/source/java/org/alfresco/module/org_alfresco_module_rm/search/SavedSearchDetails.java @@ -74,7 +74,7 @@ import org.springframework.extensions.surf.util.I18NUtil; * searchparams contains the filters, sort, etc information about the query * query is there for backward compatibility * note: - * "params": "terms=keywords:xyz&undeclared=true", + * "params": "terms=keywords:xyz&undeclared=true", * "sort": "cm:name/asc" * "query": "the complete search query string", * ... are sometimes found in the place of searchparams and are migrated to the new format when re-saved diff --git a/rm-community/rm-community-repo/source/java/org/alfresco/module/org_alfresco_module_rm/security/ExtendedSecurityService.java b/rm-community/rm-community-repo/source/java/org/alfresco/module/org_alfresco_module_rm/security/ExtendedSecurityService.java index 5fe283da60..572303c1da 100644 --- a/rm-community/rm-community-repo/source/java/org/alfresco/module/org_alfresco_module_rm/security/ExtendedSecurityService.java +++ b/rm-community/rm-community-repo/source/java/org/alfresco/module/org_alfresco_module_rm/security/ExtendedSecurityService.java @@ -57,7 +57,7 @@ public interface ExtendedSecurityService extends DeprecatedExtendedSecurityServi * Gets the set of authorities that are extended readers for the given node. * * @param nodeRef node reference - * @return {@link Set}<{@link String}> set of extended readers + * @return {@link Set}<{@link String}> set of extended readers */ Set getReaders(NodeRef nodeRef); @@ -65,7 +65,7 @@ public interface ExtendedSecurityService extends DeprecatedExtendedSecurityServi * Get the set of authorities that are extended writers for the given node. * * @param nodeRef node reference - * @return {@link Set}<{@link String}> set of extended writers + * @return {@link Set}<{@link String}> set of extended writers */ Set getWriters(NodeRef nodeRef); diff --git a/rm-community/rm-community-repo/source/java/org/alfresco/module/org_alfresco_module_rm/security/ExtendedSecurityServiceImpl.java b/rm-community/rm-community-repo/source/java/org/alfresco/module/org_alfresco_module_rm/security/ExtendedSecurityServiceImpl.java index 5920b071e7..7af2408b09 100644 --- a/rm-community/rm-community-repo/source/java/org/alfresco/module/org_alfresco_module_rm/security/ExtendedSecurityServiceImpl.java +++ b/rm-community/rm-community-repo/source/java/org/alfresco/module/org_alfresco_module_rm/security/ExtendedSecurityServiceImpl.java @@ -184,7 +184,7 @@ public class ExtendedSecurityServiceImpl extends ServiceBaseImpl } /** - * @see org.alfresco.module.org_alfresco_module_rm.security.RecordsManagementSecurityService#getReaders(org.alfresco.service.cmr.repository.NodeRef) + * @see org.alfresco.module.org_alfresco_module_rm.security.ExtendedSecurityService#getReaders(org.alfresco.service.cmr.repository.NodeRef) */ @SuppressWarnings("unchecked") @Override diff --git a/rm-community/rm-community-repo/source/java/org/alfresco/module/org_alfresco_module_rm/security/FilePlanPermissionService.java b/rm-community/rm-community-repo/source/java/org/alfresco/module/org_alfresco_module_rm/security/FilePlanPermissionService.java index 010c76db62..8e798f30d4 100644 --- a/rm-community/rm-community-repo/source/java/org/alfresco/module/org_alfresco_module_rm/security/FilePlanPermissionService.java +++ b/rm-community/rm-community-repo/source/java/org/alfresco/module/org_alfresco_module_rm/security/FilePlanPermissionService.java @@ -42,7 +42,7 @@ public interface FilePlanPermissionService /** * Setup permissions for a record category * - * @param nodeRef record category node reference + * @param recordCategory record category node reference */ void setupRecordCategoryPermissions(NodeRef recordCategory); diff --git a/rm-community/rm-community-repo/source/java/org/alfresco/module/org_alfresco_module_rm/security/FilePlanPermissionServiceImpl.java b/rm-community/rm-community-repo/source/java/org/alfresco/module/org_alfresco_module_rm/security/FilePlanPermissionServiceImpl.java index 5a51c73585..fd28505b70 100644 --- a/rm-community/rm-community-repo/source/java/org/alfresco/module/org_alfresco_module_rm/security/FilePlanPermissionServiceImpl.java +++ b/rm-community/rm-community-repo/source/java/org/alfresco/module/org_alfresco_module_rm/security/FilePlanPermissionServiceImpl.java @@ -28,8 +28,7 @@ package org.alfresco.module.org_alfresco_module_rm.security; import static java.util.Collections.singletonMap; -import static org.alfresco.module.org_alfresco_module_rm.security.ExtendedReaderDynamicAuthority.EXTENDED_READER; -import static org.alfresco.module.org_alfresco_module_rm.security.ExtendedWriterDynamicAuthority.EXTENDED_WRITER; + import static org.alfresco.repo.policy.Behaviour.NotificationFrequency.TRANSACTION_COMMIT; import static org.alfresco.repo.policy.annotation.BehaviourKind.CLASS; import static org.alfresco.repo.security.authentication.AuthenticationUtil.getSystemUserName; @@ -589,7 +588,7 @@ public class FilePlanPermissionServiceImpl extends ServiceBaseImpl } /** - * @see org.alfresco.module.org_alfresco_module_rm.security.RecordsManagementSecurityService#setPermission(org.alfresco.service.cmr.repository.NodeRef, java.lang.String, java.lang.String, boolean) + * @see org.alfresco.module.org_alfresco_module_rm.security.FilePlanPermissionService#setPermission(NodeRef, String, String) */ @Override public void setPermission(final NodeRef nodeRef, final String authority, final String permission) diff --git a/rm-community/rm-community-repo/source/java/org/alfresco/module/org_alfresco_module_rm/util/AuthenticationUtil.java b/rm-community/rm-community-repo/source/java/org/alfresco/module/org_alfresco_module_rm/util/AuthenticationUtil.java index 4723c1b52d..4d1ba62780 100644 --- a/rm-community/rm-community-repo/source/java/org/alfresco/module/org_alfresco_module_rm/util/AuthenticationUtil.java +++ b/rm-community/rm-community-repo/source/java/org/alfresco/module/org_alfresco_module_rm/util/AuthenticationUtil.java @@ -45,7 +45,7 @@ public class AuthenticationUtil *

* Useful when testing using mocks. * - * @see org.alfresco.repo.security.authentication.AuthenticationUtil#runAsSystem(RunAsWork, String) + * @see org.alfresco.repo.security.authentication.AuthenticationUtil#runAsSystem(RunAsWork) */ public R runAsSystem(RunAsWork runAsWork) { diff --git a/rm-community/rm-community-repo/source/java/org/alfresco/module/org_alfresco_module_rm/version/RecordableVersionNodeServiceImpl.java b/rm-community/rm-community-repo/source/java/org/alfresco/module/org_alfresco_module_rm/version/RecordableVersionNodeServiceImpl.java index f1f53750b4..79695c3428 100644 --- a/rm-community/rm-community-repo/source/java/org/alfresco/module/org_alfresco_module_rm/version/RecordableVersionNodeServiceImpl.java +++ b/rm-community/rm-community-repo/source/java/org/alfresco/module/org_alfresco_module_rm/version/RecordableVersionNodeServiceImpl.java @@ -101,7 +101,7 @@ public class RecordableVersionNodeServiceImpl extends Node2ServiceImpl * Process properties map before returning as frozen state. * * @param properties properties map - * @return {@link Map}<{@link QName}, {@link Serializable}> processed property map + * @return {@link Map}<{@link QName}, {@link Serializable}> processed property map */ protected Map processProperties(NodeRef version, Map properties) { @@ -229,7 +229,7 @@ public class RecordableVersionNodeServiceImpl extends Node2ServiceImpl * Process frozen aspects. * * @param aspects aspect set - * @return {@link Set}<{@link QName}> processed aspect set + * @return {@link Set}<{@link QName}> processed aspect set */ protected Set processAspects(Set aspects) { diff --git a/rm-community/rm-community-repo/source/java/org/alfresco/module/org_alfresco_module_rm/version/RecordableVersionService.java b/rm-community/rm-community-repo/source/java/org/alfresco/module/org_alfresco_module_rm/version/RecordableVersionService.java index 643d009458..c7d80b5abe 100644 --- a/rm-community/rm-community-repo/source/java/org/alfresco/module/org_alfresco_module_rm/version/RecordableVersionService.java +++ b/rm-community/rm-community-repo/source/java/org/alfresco/module/org_alfresco_module_rm/version/RecordableVersionService.java @@ -69,7 +69,7 @@ public interface RecordableVersionService /** * Gets the version that relates to the version record * - * @param versionRecord version record node reference + * @param record version record node reference * @return Version version or null if not found */ Version getRecordedVersion(NodeRef record); @@ -89,7 +89,7 @@ public interface RecordableVersionService *

* Does not create a record if the node is not versionable or the latest version is already recorded. * - * @param nodeRef parent node reference + * @param filePlan parent node reference * @param nodeRef node reference * @param autoVersion true, create new record version from latest version, false creates a record from the latest frozen version * @return NodeRef node reference to the created record. diff --git a/rm-community/rm-community-repo/source/java/org/alfresco/module/org_alfresco_module_rm/version/RecordableVersionServiceImpl.java b/rm-community/rm-community-repo/source/java/org/alfresco/module/org_alfresco_module_rm/version/RecordableVersionServiceImpl.java index 2380e3309a..1fceed588f 100644 --- a/rm-community/rm-community-repo/source/java/org/alfresco/module/org_alfresco_module_rm/version/RecordableVersionServiceImpl.java +++ b/rm-community/rm-community-repo/source/java/org/alfresco/module/org_alfresco_module_rm/version/RecordableVersionServiceImpl.java @@ -620,7 +620,7 @@ public class RecordableVersionServiceImpl extends Version2ServiceImpl } /** - * @see org.alfresco.module.org_alfresco_module_rm.version.RecordableVersionService#isLatestVersionRecorded(org.alfresco.service.cmr.repository.NodeRef) + * @see org.alfresco.module.org_alfresco_module_rm.version.RecordableVersionService#isCurrentVersionRecorded(NodeRef) */ @Override public boolean isCurrentVersionRecorded(NodeRef nodeRef) @@ -672,7 +672,7 @@ public class RecordableVersionServiceImpl extends Version2ServiceImpl /** * Create Version Store Ref * - * @param store ref + * @param storeRef store ref * @return store ref for version store */ public StoreRef convertStoreRef(StoreRef storeRef) @@ -693,7 +693,7 @@ public class RecordableVersionServiceImpl extends Version2ServiceImpl } /** - * @see org.alfresco.module.org_alfresco_module_rm.version.RecordableVersionService#createRecordFromLatestVersion(org.alfresco.service.cmr.repository.NodeRef, org.alfresco.service.cmr.repository.NodeRef, autoVersion) + * @see org.alfresco.module.org_alfresco_module_rm.version.RecordableVersionService#createRecordFromLatestVersion(NodeRef, NodeRef, boolean autoVersion) */ @Override public NodeRef createRecordFromLatestVersion(final NodeRef filePlan, final NodeRef nodeRef, final boolean isEnableAutoVersionOnRecordCreation) diff --git a/rm-community/rm-community-repo/source/java/org/alfresco/repo/action/parameter/NodeParameterSuggesterBootstrap.java b/rm-community/rm-community-repo/source/java/org/alfresco/repo/action/parameter/NodeParameterSuggesterBootstrap.java index b1deb19f16..762f12bce9 100644 --- a/rm-community/rm-community-repo/source/java/org/alfresco/repo/action/parameter/NodeParameterSuggesterBootstrap.java +++ b/rm-community/rm-community-repo/source/java/org/alfresco/repo/action/parameter/NodeParameterSuggesterBootstrap.java @@ -52,7 +52,7 @@ public class NodeParameterSuggesterBootstrap private NodeParameterProcessor nodeParameterProcessor; /** - * @param recordMetadataAspects map of record metadata aspects against file plan types + * @param nodeParameterProcessorAspectsNames map of record metadata aspects against file plan types */ public void setNodeParameterProcessorAspects(String nodeParameterProcessorAspectsNames) { diff --git a/rm-community/rm-community-repo/source/java/org/alfresco/repo/action/parameter/ParameterProcessorComponent.java b/rm-community/rm-community-repo/source/java/org/alfresco/repo/action/parameter/ParameterProcessorComponent.java index dd5d89d3fd..6f8c6d6619 100644 --- a/rm-community/rm-community-repo/source/java/org/alfresco/repo/action/parameter/ParameterProcessorComponent.java +++ b/rm-community/rm-community-repo/source/java/org/alfresco/repo/action/parameter/ParameterProcessorComponent.java @@ -137,7 +137,7 @@ public class ParameterProcessorComponent implements ParameterSubstitutionSuggest /** * Return a list of substitution suggestions for the passed string fragment. * - * @param subtitutionFragment Text fragment to search on. + * @param substitutionFragment Text fragment to search on. * @return A list of substitutions that match the substitution fragment. */ public List getSubstitutionSuggestions(final String substitutionFragment) diff --git a/rm-community/rm-community-repo/source/java/org/alfresco/repo/security/permissions/impl/ExtendedPermissionService.java b/rm-community/rm-community-repo/source/java/org/alfresco/repo/security/permissions/impl/ExtendedPermissionService.java index 6fab4e94a2..83fb1501a9 100644 --- a/rm-community/rm-community-repo/source/java/org/alfresco/repo/security/permissions/impl/ExtendedPermissionService.java +++ b/rm-community/rm-community-repo/source/java/org/alfresco/repo/security/permissions/impl/ExtendedPermissionService.java @@ -45,7 +45,7 @@ public interface ExtendedPermissionService extends PermissionService * Get a set of all the authorities that have write access. * * @param aclId acl id - * @return {@link Set}<{@link String}> set of authorities with write access + * @return {@link Set}<{@link String}> set of authorities with write access */ Set getWriters(Long aclId); @@ -55,7 +55,7 @@ public interface ExtendedPermissionService extends PermissionService * The writers list includes the owner for the node. * * @param nodeRef node reference - * @return Pair, Set> first is a set containing all the authorities that have read permission on the + * @return Pair<Set<String>, Set<String>> first is a set containing all the authorities that have read permission on the * document and second is a set containing all the authorities that have write * permission on the document, including the owner. * diff --git a/rm-community/rm-community-repo/source/java/org/alfresco/repo/security/permissions/processor/PermissionPreProcessor.java b/rm-community/rm-community-repo/source/java/org/alfresco/repo/security/permissions/processor/PermissionPreProcessor.java index 689c00748b..ff42e9f192 100644 --- a/rm-community/rm-community-repo/source/java/org/alfresco/repo/security/permissions/processor/PermissionPreProcessor.java +++ b/rm-community/rm-community-repo/source/java/org/alfresco/repo/security/permissions/processor/PermissionPreProcessor.java @@ -41,8 +41,7 @@ public interface PermissionPreProcessor { /** * Process permission. - * - * @param accessStatus current access status + * * @param nodeRef node reference * @param perm permission * @return {@link AccessStatus} diff --git a/rm-community/rm-community-repo/source/java/org/alfresco/repo/security/permissions/processor/PermissionProcessorRegistry.java b/rm-community/rm-community-repo/source/java/org/alfresco/repo/security/permissions/processor/PermissionProcessorRegistry.java index 766ac302ce..96794d1daf 100644 --- a/rm-community/rm-community-repo/source/java/org/alfresco/repo/security/permissions/processor/PermissionProcessorRegistry.java +++ b/rm-community/rm-community-repo/source/java/org/alfresco/repo/security/permissions/processor/PermissionProcessorRegistry.java @@ -67,7 +67,7 @@ public class PermissionProcessorRegistry /** * Get a list of the registered permission pre-processors. * - * @return {@link List}<{@link PermissionPreProcessor}> list of permission pre-processors + * @return {@link List}<{@link PermissionPreProcessor}> list of permission pre-processors */ public List getPermissionPreProcessors() { @@ -77,7 +77,7 @@ public class PermissionProcessorRegistry /** * Get a list of the registered permission post-processors. * - * @return <{@link List}>{@link PermissionPreProcessor} list of permission post-processors + * @return <{@link List}>{@link PermissionPreProcessor} list of permission post-processors */ public List getPermissionPostProcessors() { diff --git a/rm-community/rm-community-repo/source/java/org/alfresco/repo/security/permissions/processor/impl/PermissionProcessorBaseImpl.java b/rm-community/rm-community-repo/source/java/org/alfresco/repo/security/permissions/processor/impl/PermissionProcessorBaseImpl.java index 6e1d6e6330..5eede3afe2 100644 --- a/rm-community/rm-community-repo/source/java/org/alfresco/repo/security/permissions/processor/impl/PermissionProcessorBaseImpl.java +++ b/rm-community/rm-community-repo/source/java/org/alfresco/repo/security/permissions/processor/impl/PermissionProcessorBaseImpl.java @@ -41,7 +41,7 @@ import org.alfresco.repo.security.permissions.processor.PermissionProcessorRegis private PermissionProcessorRegistry permissionProcessorRegistry; /** - * @param PermissionProcessorRegistry permission processor registry + * @param permissionProcessorRegistry permission processor registry */ public void setPermissionProcessorRegistry(PermissionProcessorRegistry permissionProcessorRegistry) { diff --git a/rm-community/rm-community-repo/source/java/org/alfresco/repo/web/scripts/dictionary/RmPropertiesGet.java b/rm-community/rm-community-repo/source/java/org/alfresco/repo/web/scripts/dictionary/RmPropertiesGet.java index d95cd506e6..ccec29a168 100644 --- a/rm-community/rm-community-repo/source/java/org/alfresco/repo/web/scripts/dictionary/RmPropertiesGet.java +++ b/rm-community/rm-community-repo/source/java/org/alfresco/repo/web/scripts/dictionary/RmPropertiesGet.java @@ -44,7 +44,7 @@ import org.springframework.extensions.webscripts.WebScriptException; import org.springframework.extensions.webscripts.WebScriptRequest; /** - * Webscript to get the Propertydefinitions for a given classname eg. =>cm_person + * Webscript to get the Propertydefinitions for a given classname eg. =>cm_person * * This class makes it possible to get only RM related property definitions * @see PropertiesGet for the original implementation diff --git a/rm-community/rm-community-repo/source/java/org/alfresco/repo/web/scripts/substitutionsuggestions/RmSubstitutionSuggestionsGet.java b/rm-community/rm-community-repo/source/java/org/alfresco/repo/web/scripts/substitutionsuggestions/RmSubstitutionSuggestionsGet.java index a4e9f1798e..c435076953 100644 --- a/rm-community/rm-community-repo/source/java/org/alfresco/repo/web/scripts/substitutionsuggestions/RmSubstitutionSuggestionsGet.java +++ b/rm-community/rm-community-repo/source/java/org/alfresco/repo/web/scripts/substitutionsuggestions/RmSubstitutionSuggestionsGet.java @@ -91,9 +91,9 @@ public class RmSubstitutionSuggestionsGet extends DeclarativeWebScript } /** - * Set the parameter processor component bean + * Set the node service * - * @param parameterProcessorComponent + * @param nodeService */ public void setNodeService(NodeService nodeService) { @@ -109,7 +109,7 @@ public class RmSubstitutionSuggestionsGet extends DeclarativeWebScript } /** - * @param filePlanService file plan service + * @param capabilityService file plan service */ public void setCapabilityService(CapabilityService capabilityService) { @@ -119,7 +119,7 @@ public class RmSubstitutionSuggestionsGet extends DeclarativeWebScript /** * Set the minimum fragment size to process for suggestion processing * - * @param maximumNumberSuggestions + * @param substitutionMinimumFragmentSize */ public void setSubstitutionMinimumFragmentSize(int substitutionMinimumFragmentSize) { @@ -129,7 +129,7 @@ public class RmSubstitutionSuggestionsGet extends DeclarativeWebScript /** * Set the maxmimum number of suggestions returned from the global property * - * @param maximumNumberSuggestions + * @param pathSubstitutionMaximumNumberSuggestions */ public void setPathSubstitutionMaximumNumberSuggestions(int pathSubstitutionMaximumNumberSuggestions) { diff --git a/rm-community/rm-community-repo/source/java/org/alfresco/rm/rest/api/impl/ApiNodesModelFactory.java b/rm-community/rm-community-repo/source/java/org/alfresco/rm/rest/api/impl/ApiNodesModelFactory.java index fbd2b911a3..60bab513dd 100644 --- a/rm-community/rm-community-repo/source/java/org/alfresco/rm/rest/api/impl/ApiNodesModelFactory.java +++ b/rm-community/rm-community-repo/source/java/org/alfresco/rm/rest/api/impl/ApiNodesModelFactory.java @@ -641,8 +641,7 @@ public class ApiNodesModelFactory * Creates an object of type FilePlan * * @param info info of the file plan - * @param propertyFilter - * @param includeParam + * @param parameters * @param mapUserInfo * @param isMinimalInfo * @return FilePlan object @@ -659,8 +658,7 @@ public class ApiNodesModelFactory * Creates an object of type RecordCategory * * @param info info of the record category - * @param propertyFilter - * @param includeParam + * @param parameters * @param mapUserInfo * @param isMinimalInfo * @return RecordCategory object @@ -685,8 +683,7 @@ public class ApiNodesModelFactory * Creates an object of type RecordCategory * * @param info - * @param propertyFilter - * @param includeParam + * @param parameters * @param mapUserInfo * @param isMinimalInfo * @return RecordCategory object @@ -710,8 +707,7 @@ public class ApiNodesModelFactory * Creates an object of type UnfiledContainer * * @param info - * @param propertyFilter - * @param includeParam + * @param parameters * @param mapUserInfo * @param isMinimalInfo * @return UnfiledContainer object @@ -729,8 +725,7 @@ public class ApiNodesModelFactory * Creates an object of type TransferContainer * * @param info - * @param propertyFilter - * @param includeParam + * @param parameters * @param mapUserInfo * @param isMinimalInfo * @return UnfiledContainer object @@ -747,8 +742,7 @@ public class ApiNodesModelFactory * Creates an object of type Transfer * * @param info - * @param propertyFilter - * @param includeParam + * @param parameters * @param mapUserInfo * @param isMinimalInfo * @return UnfiledContainer object @@ -765,8 +759,7 @@ public class ApiNodesModelFactory * Creates an object of type TransferChild * * @param info - * @param propertyFilter - * @param includeParam + * @param parameters * @param mapUserInfo * @param isMinimalInfo * @return UnfiledContainer object diff --git a/rm-community/rm-community-repo/source/java/org/alfresco/rm/rest/api/impl/FilePlanComponentsApiUtils.java b/rm-community/rm-community-repo/source/java/org/alfresco/rm/rest/api/impl/FilePlanComponentsApiUtils.java index 78b0e5a5b2..472d079ef8 100644 --- a/rm-community/rm-community-repo/source/java/org/alfresco/rm/rest/api/impl/FilePlanComponentsApiUtils.java +++ b/rm-community/rm-community-repo/source/java/org/alfresco/rm/rest/api/impl/FilePlanComponentsApiUtils.java @@ -39,7 +39,6 @@ import java.io.Serializable; import java.nio.charset.Charset; import java.util.ArrayList; import java.util.Arrays; -import java.util.Collections; import java.util.HashMap; import java.util.List; import java.util.Map; @@ -65,8 +64,6 @@ import org.alfresco.repo.tenant.TenantUtil; import org.alfresco.rest.antlr.WhereClauseParser; import org.alfresco.rest.api.Activities; import org.alfresco.rest.api.Nodes; -import org.alfresco.rest.api.model.PathInfo; -import org.alfresco.rest.api.model.PathInfo.ElementInfo; import org.alfresco.rest.framework.core.exceptions.ConstraintViolatedException; import org.alfresco.rest.framework.core.exceptions.EntityNotFoundException; import org.alfresco.rest.framework.core.exceptions.InsufficientStorageException; @@ -90,7 +87,6 @@ import org.alfresco.service.cmr.dictionary.DictionaryService; import org.alfresco.service.cmr.lock.NodeLockedException; import org.alfresco.service.cmr.model.FileFolderService; import org.alfresco.service.cmr.model.FileInfo; -import org.alfresco.service.cmr.repository.ChildAssociationRef; import org.alfresco.service.cmr.repository.ContentIOException; import org.alfresco.service.cmr.repository.ContentService; import org.alfresco.service.cmr.repository.ContentWriter; @@ -98,10 +94,7 @@ import org.alfresco.service.cmr.repository.DuplicateChildNodeNameException; import org.alfresco.service.cmr.repository.MimetypeService; import org.alfresco.service.cmr.repository.NodeRef; import org.alfresco.service.cmr.repository.NodeService; -import org.alfresco.service.cmr.repository.Path; -import org.alfresco.service.cmr.repository.Path.Element; import org.alfresco.service.cmr.repository.StoreRef; -import org.alfresco.service.cmr.security.AccessStatus; import org.alfresco.service.cmr.security.PermissionService; import org.alfresco.service.cmr.usage.ContentQuotaException; import org.alfresco.service.namespace.QName; @@ -781,7 +774,7 @@ public class FilePlanComponentsApiUtils * Returns a List of filter properties specified by request parameters. * @param parameters The {@link Parameters} object to get the parameters passed into the request * including: - * - filter, sort & paging params (where, orderBy, skipCount, maxItems) + * - filter, sort & paging params (where, orderBy, skipCount, maxItems) * @return The list of {@link FilterProp}. Can be null. */ public List getListChildrenFilterProps(Parameters parameters, Set listFolderChildrenEqualsQueryProperties) @@ -912,8 +905,9 @@ public class FilePlanComponentsApiUtils /** * Helper method that generates allowable operation for the provided node * @param nodeRef the node to get the allowable operations for - * @param type the type of the provided nodeRef - * @return a sublist of [{@link Nodes.OP_DELETE}, {@link Nodes.OP_CREATE}, {@link Nodes.OP_UPDATE}] representing the allowable operations for the provided node + * @param typeQName the type of the provided nodeRef + * @return a sublist of [{@link Nodes#OP_DELETE}, {@link Nodes#OP_CREATE}, {@link Nodes#OP_UPDATE}] representing + * the allowable operations for the provided node */ protected List getAllowableOperations(NodeRef nodeRef, QName typeQName) { diff --git a/rm-community/rm-community-repo/test/java/org/alfresco/module/org_alfresco_module_rm/test/integration/destroy/DestroyContentTest.java b/rm-community/rm-community-repo/test/java/org/alfresco/module/org_alfresco_module_rm/test/integration/destroy/DestroyContentTest.java index 489c8335c3..bea15c57b2 100644 --- a/rm-community/rm-community-repo/test/java/org/alfresco/module/org_alfresco_module_rm/test/integration/destroy/DestroyContentTest.java +++ b/rm-community/rm-community-repo/test/java/org/alfresco/module/org_alfresco_module_rm/test/integration/destroy/DestroyContentTest.java @@ -111,7 +111,7 @@ public class DestroyContentTest extends BaseRMTestCase Map props = new HashMap(1); props.put(ContentModel.PROP_TITLE, GUID.generate()); - InputStream is = System.class.getResourceAsStream("/alfresco/test/content/Image.jpg"); + InputStream is = DestroyContentTest.class.getResourceAsStream("/alfresco/test/content/Image.jpg"); subRecord = utils.createRecord(destroyableFolder, GUID.generate(), props, MimetypeMap.MIMETYPE_IMAGE_JPEG, is); diff --git a/rm-community/rm-community-rest-api-explorer/pom.xml b/rm-community/rm-community-rest-api-explorer/pom.xml index ff7981e582..be4b38bdfd 100644 --- a/rm-community/rm-community-rest-api-explorer/pom.xml +++ b/rm-community/rm-community-rest-api-explorer/pom.xml @@ -13,6 +13,7 @@ 1.8 1.8 + false UTF-8 UTF-8