inteligr8/alfresco-community-repo
1
0
Fork 0
mirror of https://github.com/Alfresco/alfresco-community-repo.git synced 2025-07-31 17:39:05 +00:00
Code Issues Packages Projects Releases Wiki Activity

Fixed minor issues reported by sonar (Redundant Modifier)

Browse Source 
git-svn-id: https://svn.alfresco.com/repos/alfresco-enterprise/modules/recordsmanagement/HEAD@63497 c4b6b30b-aa2e-2d43-bbcb-ca4b014f7261
This commit is contained in:
Tuna Aksoy
2014-03-02 16:56:25 +00:00
parent 90c08059e3
commit 172fcf3d77
1 changed files with 143 additions and 143 deletions
Download Patch File Download Diff File Expand all files Collapse all files

144
rm-server/source/java/org/alfresco/module/org_alfresco_module_rm/admin/RecordsManagementAdminService.java
View File

@@ -42,56 +42,56 @@ import org.alfresco.service.namespace.QName;
*/ */
public interface RecordsManagementAdminService public interface RecordsManagementAdminService
{ {
/** /**
* Initialise the custom model * Initialise the custom model
*/ */
public void initialiseCustomModel(); void initialiseCustomModel();
/** /**
* Get a list of all registered customisable types and aspects. * Get a list of all registered customisable types and aspects.
* *
* @return {@link Set}<{@link QName}> QName's of customisable types and aspects * @return {@link Set}<{@link QName}> QName's of customisable types and aspects
*/ */
public Set<QName> getCustomisable(); Set<QName> getCustomisable();
/** /**
* Get a list of all the registered customisable types and aspects present on a given * Get a list of all the registered customisable types and aspects present on a given
* node reference. * node reference.
* *
* @param nodeRef node reference * @param nodeRef node reference
* @return {@link Set}<{@link QName}> QName's of customisable types and aspects, empty if none * @return {@link Set}<{@link QName}> QName's of customisable types and aspects, empty if none
*/ */
public Set<QName> getCustomisable(NodeRef nodeRef); Set<QName> getCustomisable(NodeRef nodeRef);
/** /**
* Indicates whether a type (or aspect) is customisable. * Indicates whether a type (or aspect) is customisable.
* *
* @param type customisable type {@link QName} * @param type customisable type {@link QName}
* @return boolean true if type customisable, false otherwise * @return boolean true if type customisable, false otherwise
*/ */
public boolean isCustomisable(QName type); boolean isCustomisable(QName type);
/** /**
* Makes a type customisable. * Makes a type customisable.
* *
* @param type type {@link QName} to make customisable * @param type type {@link QName} to make customisable
*/ */
public void makeCustomisable(QName type); void makeCustomisable(QName type);
/** /**
* Assuming the custom properties are not in use, makes a type no longer customisable. * Assuming the custom properties are not in use, makes a type no longer customisable.
* *
* @param type type {@link QName} to make customisable * @param type type {@link QName} to make customisable
*/ */
public void unmakeCustomisable(QName type); void unmakeCustomisable(QName type);
/** /**
* Indicates whether the custom property exists. * Indicates whether the custom property exists.
* *
* @param property properties {@link QName} * @param property properties {@link QName}
* @return boolean true if property exists, false otherwise * @return boolean true if property exists, false otherwise
*/ */
public boolean existsCustomProperty(QName property); boolean existsCustomProperty(QName property);
/** /**
* This method returns the custom properties that have been defined for the specified * This method returns the custom properties that have been defined for the specified
@@ -106,7 +106,7 @@ public interface RecordsManagementAdminService
* @return * @return
* @see CustomisableRmElement * @see CustomisableRmElement
*/ */
public Map<QName, PropertyDefinition> getCustomPropertyDefinitions(QName customisableType); Map<QName, PropertyDefinition> getCustomPropertyDefinitions(QName customisableType);
/** /**
* This method returns the custom properties that have been defined for all of * This method returns the custom properties that have been defined for all of
@@ -119,7 +119,7 @@ public interface RecordsManagementAdminService
* @return * @return
* @see CustomisableRmElement * @see CustomisableRmElement
*/ */
public Map<QName, PropertyDefinition> getCustomPropertyDefinitions(); Map<QName, PropertyDefinition> getCustomPropertyDefinitions();
/** /**
* Add custom property definition * Add custom property definition
@@ -140,7 +140,7 @@ public interface RecordsManagementAdminService
* @return the propId, whether supplied as a parameter or generated. * @return the propId, whether supplied as a parameter or generated.
* @see CustomisableRmElement#getCorrespondingAspect() * @see CustomisableRmElement#getCorrespondingAspect()
*/ */
public QName addCustomPropertyDefinition(QName propId, QName typeName, String label, QName dataType, String title, String description) throws CustomMetadataException; QName addCustomPropertyDefinition(QName propId, QName typeName, String label, QName dataType, String title, String description) throws CustomMetadataException;
/** /**
* Add custom property definition with one optional constraint reference * Add custom property definition with one optional constraint reference
@@ -168,7 +168,7 @@ public interface RecordsManagementAdminService
// TODO propId string (not QName) ? // TODO propId string (not QName) ?
// TODO remove title (since it is ignored) (or remove label to title) // TODO remove title (since it is ignored) (or remove label to title)
public QName addCustomPropertyDefinition(QName propId, QName addCustomPropertyDefinition(QName propId,
QName typeName, QName typeName,
String label, String label,
QName dataType, QName dataType,
@@ -187,7 +187,7 @@ public interface RecordsManagementAdminService
* @param newLabel the new value for the label. * @param newLabel the new value for the label.
* @return the propId. * @return the propId.
*/ */
public QName setCustomPropertyDefinitionLabel(QName propQName, String newLabel) throws PropertyAlreadyExistsMetadataException; QName setCustomPropertyDefinitionLabel(QName propQName, String newLabel) throws PropertyAlreadyExistsMetadataException;
/** /**
* Update the name and label of the custom property definition. * Update the name and label of the custom property definition.
@@ -196,7 +196,7 @@ public interface RecordsManagementAdminService
* @return * @return
* @throws CustomMetadataException * @throws CustomMetadataException
*/ */
public QName updateCustomPropertyDefinitionName(QName propQName, String newName) throws CustomMetadataException; QName updateCustomPropertyDefinitionName(QName propQName, String newName) throws CustomMetadataException;
/** /**
* Sets a new list of values constraint on the custom property definition. * Sets a new list of values constraint on the custom property definition.
@@ -205,7 +205,7 @@ public interface RecordsManagementAdminService
* @param newLovConstraint the List-Of-Values constraintRef. * @param newLovConstraint the List-Of-Values constraintRef.
* @return the propId. * @return the propId.
*/ */
public QName setCustomPropertyDefinitionConstraint(QName propQName, QName newLovConstraint); QName setCustomPropertyDefinitionConstraint(QName propQName, QName newLovConstraint);
/** /**
* Removes all list of values constraints from the custom property definition. * Removes all list of values constraints from the custom property definition.
@@ -213,14 +213,14 @@ public interface RecordsManagementAdminService
* @param propQName the qname of the property definition * @param propQName the qname of the property definition
* @return the propId. * @return the propId.
*/ */
public QName removeCustomPropertyDefinitionConstraints(QName propQName); QName removeCustomPropertyDefinitionConstraints(QName propQName);
/** /**
* Remove custom property definition * Remove custom property definition
* *
* @param propQName * @param propQName
*/ */
public void removeCustomPropertyDefinition(QName propQName); void removeCustomPropertyDefinition(QName propQName);
/** /**
* This method returns the custom references that have been defined in the custom * This method returns the custom references that have been defined in the custom
@@ -232,7 +232,7 @@ public interface RecordsManagementAdminService
* *
* @return The Map of custom references (both parent-child and standard). * @return The Map of custom references (both parent-child and standard).
*/ */
public Map<QName, AssociationDefinition> getCustomReferenceDefinitions(); Map<QName, AssociationDefinition> getCustomReferenceDefinitions();
/** /**
* Fetches all associations <i>from</i> the given source. * Fetches all associations <i>from</i> the given source.
@@ -240,7 +240,7 @@ public interface RecordsManagementAdminService
* @param node the node from which the associations start. * @param node the node from which the associations start.
* @return a List of associations. * @return a List of associations.
*/ */
public List<AssociationRef> getCustomReferencesFrom(NodeRef node); List<AssociationRef> getCustomReferencesFrom(NodeRef node);
/** /**
* Fetches all child associations of the given source. i.e. all associations where the * Fetches all child associations of the given source. i.e. all associations where the
@@ -249,7 +249,7 @@ public interface RecordsManagementAdminService
* @param node * @param node
* @return * @return
*/ */
public List<ChildAssociationRef> getCustomChildReferences(NodeRef node); List<ChildAssociationRef> getCustomChildReferences(NodeRef node);
/** /**
* Returns a List of all associations <i>to</i> the given node. * Returns a List of all associations <i>to</i> the given node.
@@ -257,7 +257,7 @@ public interface RecordsManagementAdminService
* @param node the node to which the associations point. * @param node the node to which the associations point.
* @return a List of associations. * @return a List of associations.
*/ */
public List<AssociationRef> getCustomReferencesTo(NodeRef node); List<AssociationRef> getCustomReferencesTo(NodeRef node);
/** /**
* Fetches all child associations where the given node is the child. * Fetches all child associations where the given node is the child.
@@ -265,7 +265,7 @@ public interface RecordsManagementAdminService
* @param node * @param node
* @return * @return
*/ */
public List<ChildAssociationRef> getCustomParentReferences(NodeRef node); List<ChildAssociationRef> getCustomParentReferences(NodeRef node);
/** /**
* This method adds the specified custom reference instance between the specified nodes. * This method adds the specified custom reference instance between the specified nodes.
@@ -278,7 +278,7 @@ public interface RecordsManagementAdminService
* @throws AlfrescoRuntimeException if an instance of the specified reference type * @throws AlfrescoRuntimeException if an instance of the specified reference type
* already exists from fromNode to toNode. * already exists from fromNode to toNode.
*/ */
public void addCustomReference(NodeRef fromNode, NodeRef toNode, QName assocId); void addCustomReference(NodeRef fromNode, NodeRef toNode, QName assocId);
/** /**
* This method removes the specified custom reference instance from the specified node. * This method removes the specified custom reference instance from the specified node.
@@ -287,7 +287,7 @@ public interface RecordsManagementAdminService
* @param toNode * @param toNode
* @param assocId the server-side qname e.g. {http://www.alfresco.org/model/rmcustom/1.0}abcd-12-efgh-4567 * @param assocId the server-side qname e.g. {http://www.alfresco.org/model/rmcustom/1.0}abcd-12-efgh-4567
*/ */
public void removeCustomReference(NodeRef fromNode, NodeRef toNode, QName assocId); void removeCustomReference(NodeRef fromNode, NodeRef toNode, QName assocId);
/** /**
* This method creates a new custom association, using the given label as the title. * This method creates a new custom association, using the given label as the title.
@@ -295,7 +295,7 @@ public interface RecordsManagementAdminService
* @param label the title of the association definition * @param label the title of the association definition
* @return the QName of the newly-created association. * @return the QName of the newly-created association.
*/ */
public QName addCustomAssocDefinition(String label); QName addCustomAssocDefinition(String label);
/** /**
* This method creates a new custom child association, combining the given source and * This method creates a new custom child association, combining the given source and
@@ -305,7 +305,7 @@ public interface RecordsManagementAdminService
* @param target * @param target
* @return the QName of the newly-created association. * @return the QName of the newly-created association.
*/ */
public QName addCustomChildAssocDefinition(String source, String target); QName addCustomChildAssocDefinition(String source, String target);
/** /**
* This method updates the source and target values for the specified child association. * This method updates the source and target values for the specified child association.
@@ -318,7 +318,7 @@ public interface RecordsManagementAdminService
* @see #getCompoundIdFor(String, String) * @see #getCompoundIdFor(String, String)
* @see #splitSourceTargetId(String) * @see #splitSourceTargetId(String)
*/ */
public QName updateCustomChildAssocDefinition(QName refQName, String newSource, String newTarget); QName updateCustomChildAssocDefinition(QName refQName, String newSource, String newTarget);
/** /**
* This method updates the label value for the specified association. * This method updates the label value for the specified association.
@@ -328,7 +328,7 @@ public interface RecordsManagementAdminService
* @param refQName qname of the child association. * @param refQName qname of the child association.
* @param newLabel the new value for the label field. * @param newLabel the new value for the label field.
*/ */
public QName updateCustomAssocDefinition(QName refQName, String newLabel); QName updateCustomAssocDefinition(QName refQName, String newLabel);
/** /**
* This method returns ConstraintDefinition objects defined in the given model * This method returns ConstraintDefinition objects defined in the given model
@@ -338,7 +338,7 @@ public interface RecordsManagementAdminService
* Therefore custom constraints created in the current transaction will not appear * Therefore custom constraints created in the current transaction will not appear
* in the results. * in the results.
*/ */
public List<ConstraintDefinition> getCustomConstraintDefinitions(QName modelQName); List<ConstraintDefinition> getCustomConstraintDefinitions(QName modelQName);
/** /**
* This method adds a Constraint definition to the custom model. * This method adds a Constraint definition to the custom model.
@@ -353,7 +353,7 @@ public interface RecordsManagementAdminService
* @param allowedValues the allowed values list * @param allowedValues the allowed values list
* @param matchLogic AND (all values must match), OR (at least one values must match) * @param matchLogic AND (all values must match), OR (at least one values must match)
*/ */
public void addCustomConstraintDefinition(QName constraintName, String title, boolean caseSensitive, List<String> allowedValues, MatchLogic matchLogic); void addCustomConstraintDefinition(QName constraintName, String title, boolean caseSensitive, List<String> allowedValues, MatchLogic matchLogic);
/** /**
* Remove custom constraint definition - if not referenced (by any properties) * Remove custom constraint definition - if not referenced (by any properties)
@@ -361,7 +361,7 @@ public interface RecordsManagementAdminService
* *
* @param constraintName the name e.g. rmc:foo * @param constraintName the name e.g. rmc:foo
*/ */
public void removeCustomConstraintDefinition(QName constraintName); void removeCustomConstraintDefinition(QName constraintName);
/** /**
* Update custom constraint definition with new list of values (replaces existing list, if any) * Update custom constraint definition with new list of values (replaces existing list, if any)
@@ -369,14 +369,14 @@ public interface RecordsManagementAdminService
* @param constraintName the name e.g. rmc:foo * @param constraintName the name e.g. rmc:foo
* @param newValues * @param newValues
*/ */
public void changeCustomConstraintValues(QName constraintName, List<String> newValues); void changeCustomConstraintValues(QName constraintName, List<String> newValues);
/** /**
* *
* @param constraintName * @param constraintName
* @param title * @param title
*/ */
public void changeCustomConstraintTitle(QName constraintName, String title); void changeCustomConstraintTitle(QName constraintName, String title);
/** /**
* This method iterates over the custom properties, references looking for one whose id * This method iterates over the custom properties, references looking for one whose id
@@ -385,7 +385,7 @@ public interface RecordsManagementAdminService
* @param localName the localName part of the qname of the property or reference definition. * @param localName the localName part of the qname of the property or reference definition.
* @return the QName of the property, association definition which matches, or null. * @return the QName of the property, association definition which matches, or null.
*/ */
public QName getQNameForClientId(String localName); QName getQNameForClientId(String localName);
/** /**
* Given a compound id for source and target strings (as used with parent/child * Given a compound id for source and target strings (as used with parent/child
@@ -395,7 +395,7 @@ public interface RecordsManagementAdminService
* @param sourceTargetId the compound ID. * @param sourceTargetId the compound ID.
* @return a String array, where result[0] == sourceId and result[1] == targetId. * @return a String array, where result[0] == sourceId and result[1] == targetId.
*/ */
public String[] splitSourceTargetId(String sourceTargetId); String[] splitSourceTargetId(String sourceTargetId);
/** /**
* This method retrieves a compound ID (client-side) for the specified * This method retrieves a compound ID (client-side) for the specified
@@ -405,5 +405,5 @@ public interface RecordsManagementAdminService
* @param targetId * @param targetId
* @return * @return
*/ */
public String getCompoundIdFor(String sourceId, String targetId); String getCompoundIdFor(String sourceId, String targetId);
} }