inteligr8/alfresco-community-repo
1
0
Fork 0
mirror of https://github.com/Alfresco/alfresco-community-repo.git synced 2025-10-15 15:02:20 +00:00
Code Issues Packages Projects Releases Wiki Activity

Merged HEAD-BUG-FIX (5.1/Cloud) to HEAD (5.1/Cloud)

Browse Source 
107541: Merged 5.0.N (5.0.3) to HEAD-BUG-FIX (5.1/Cloud) (PARTIAL MERGE)
      107413: Merged DEV to 5.0.N (5.0.3)
         106858 : MNT-13545: JavaDoc : Inconsistencies between the Java doc and the actual code
            - Cleaning of Javadoc,
   107565: MNT-13545 Fix compilation after merge of Javadoc


git-svn-id: https://svn.alfresco.com/repos/alfresco-enterprise/alfresco/HEAD/root@107633 c4b6b30b-aa2e-2d43-bbcb-ca4b014f7261
This commit is contained in:
Tatyana Valkevych
2015-07-02 16:13:03 +00:00
parent 4c30e52dc3
commit 7dd2291753
784 changed files with 5454 additions and 5487 deletions
Download Patch File Download Diff File Expand all files Collapse all files

82
source/java/org/alfresco/service/cmr/security/PersonService.java
View File

@@ -86,7 +86,7 @@ public interface PersonService
* Retrieve the person NodeRef for a {@code username}, optionally creating
* the home folder if it does not exist and optionally creating the person
* if they don't exist AND the PersonService is configured to allow the
* creation of missing persons {@see #setCreateMissingPeople(boolean)}.
* creation of missing persons {@link #setCreateMissingPeople(boolean)}.
*
* If not allowed to create missing persons and the person does not exist
* a {@code NoSuchPersonException} exception will be thrown.
@@ -105,13 +105,13 @@ public interface PersonService
@Auditable(parameters = {"userName", "autoCreate"})
public NodeRef getPerson(final String userName, final boolean autoCreateHomeFolderAndMissingPersonIfAllowed);
/**
* Retrieve the person info for an existing {@code person NodeRef}
*
* @param personRef NodeRef
* @return PersonInfo (username, firstname, lastname)
* @throws NoSuchPersonException if the person doesn't exist
*/
/**
* Retrieve the person info for an existing {@code person NodeRef}
*
* @param personRef NodeRef
* @return PersonInfo (username, firstname, lastname)
* @throws NoSuchPersonException if the person doesn't exist
*/
@Auditable(parameters = {"personRef"})
public PersonInfo getPerson(NodeRef personRef) throws NoSuchPersonException;
@@ -194,8 +194,8 @@ public interface PersonService
* Create a new person with the given properties. The userName is one of the
* properties. Users with duplicate userNames are not allowed.
*
* @param properties
* @return
* @param properties Map<QName, Serializable>
* @return NodeRef
*/
@Auditable(parameters = {"properties"})
public NodeRef createPerson(Map<QName, Serializable> properties);
@@ -232,7 +232,7 @@ public interface PersonService
/**
* Delete the person identified by the given user name.
*
* @param userName
* @param userName String
*/
@Auditable(parameters = {"userName"})
public void deletePerson(String userName);
@@ -240,7 +240,7 @@ public interface PersonService
/**
* Delete the person identified by the given ref.
*
* @param personRef
* @param personRef NodeRef
*/
@Auditable(parameters = {"personRef"})
public void deletePerson(NodeRef personRef);
@@ -249,8 +249,8 @@ public interface PersonService
* Delete the person identified by the given ref, and optionally delete
* the associated authentication, if one.
*
* @param personRef
* @param deleteAuthentication
* @param personRef NodeRef
* @param deleteAuthentication boolean
*/
@Auditable(parameters = {"personRef", "deleteAuthentication"})
public void deletePerson(NodeRef personRef, boolean deleteAuthentication);
@@ -318,42 +318,42 @@ public interface PersonService
* @param filterProps list of filter properties (these are OR'ed)
* @param sortProps sort property, eg. cm:username ascending
* @param pagingRequest skip, max + optional query execution id
* @return
* @return PagingResults<PersonInfo>
*
* @author janv
* <br/><br/>author janv
* @since 4.1.2
*/
@Auditable(parameters = {"pattern", "filterProps", "sortProps", "pagingRequest"})
public PagingResults<PersonInfo> getPeople(String pattern, List<QName> filterProps, List<Pair<QName, Boolean>> sortProps, PagingRequest pagingRequest);
/**
* Get paged list of people optionally filtered and/or sorted
*
* @param stringPropFilters list of filter properties (with "startsWith" values), eg. cm:username "al" might match "alex", "alice", ...
* @param filterIgnoreCase true to ignore case when filtering, false to be case-sensitive when filtering
* @param sortProps sort property, eg. cm:username ascending
* @param pagingRequest skip, max + optional query execution id
/**
* Get paged list of people optionally filtered and/or sorted
*
* @param stringPropFilters list of filter properties (with "startsWith" values), eg. cm:username "al" might match "alex", "alice", ...
* @param filterIgnoreCase true to ignore case when filtering, false to be case-sensitive when filtering
* @param sortProps sort property, eg. cm:username ascending
* @param pagingRequest skip, max + optional query execution id
*
* @author janv
* <br/><br/>author janv
* @since 4.0
* @deprecated see getPeople(String pattern, List<QName> filterProps, List<Pair<QName, Boolean>> sortProps, PagingRequest pagingRequest)
*/
@Auditable(parameters = {"stringPropFilters", "filterIgnoreCase", "sortProps", "pagingRequest"})
public PagingResults<PersonInfo> getPeople(List<Pair<QName,String>> stringPropFilters, boolean filterIgnoreCase, List<Pair<QName, Boolean>> sortProps, PagingRequest pagingRequest);
/**
* Get paged list of people optionally filtered and/or sorted
*
* @param pattern
* @param filterStringProps list of filter properties (with "startsWith" values), eg. cm:username "al" might match "alex", "alice", ...
* @param inclusiveAspects if set, filter out any people that don't have one of these aspects
* @param exclusiveAspects if set, filter out any people that do have one of these aspects
* @param includeAdministraotrs true to include administrators in the results.
* @param sortProps sort property, eg. cm:username ascending
* @param pagingRequest skip, max + optional query execution id
*
* @author Alex Miller
/**
* Get paged list of people optionally filtered and/or sorted
*
* @param pattern String
* @param filterStringProps list of filter properties (with "startsWith" values), eg. cm:username "al" might match "alex", "alice", ...
* @param inclusiveAspects if set, filter out any people that don't have one of these aspects
* @param exclusiveAspects if set, filter out any people that do have one of these aspects
* @param includeAdministraotrs true to include administrators in the results.
* @param sortProps sort property, eg. cm:username ascending
* @param pagingRequest skip, max + optional query execution id
*
* @code Alex Miller
* @since 4.0
*/
@Auditable(parameters = {"stringPropFilters", "filterIgnoreCase", "inclusiveAspect", "exclusiveAspects", "sortProps", "pagingRequest"})
@@ -376,7 +376,7 @@ public interface PersonService
/**
* Return the container that stores people.
*
* @return
* @return NodeRef
*/
@Auditable
public NodeRef getPeopleContainer();
@@ -384,7 +384,7 @@ public interface PersonService
/**
* Are user names case sensitive?
*
* @return
* @return boolean
*/
@Auditable
public boolean getUserNamesAreCaseSensitive();
@@ -395,8 +395,8 @@ public interface PersonService
* If case insentive it will return the common object.
* If the user does not exist it will return null;
*
* @param caseSensitiveUserName
* @return
* @param caseSensitiveUserName String
* @return String
*/
@NotAuditable
public String getUserIdentifier(String caseSensitiveUserName);
@@ -404,7 +404,7 @@ public interface PersonService
/**
* Counts the number of persons registered with the system.
*
* @return
* @return int
*/
@NotAuditable
public int countPeople();