[CST-5307] Added missing javadocs, removed showClaimItem feature

This commit is contained in:
Luca Giamminonni
2022-05-05 17:46:30 +02:00
parent 804930fbe2
commit d51dcca87c
6 changed files with 40 additions and 29 deletions

View File

@@ -28,6 +28,5 @@ export enum FeatureID {
CanCreateVersion = 'canCreateVersion', CanCreateVersion = 'canCreateVersion',
CanViewUsageStatistics = 'canViewUsageStatistics', CanViewUsageStatistics = 'canViewUsageStatistics',
CanSendFeedback = 'canSendFeedback', CanSendFeedback = 'canSendFeedback',
ShowClaimItem = 'showClaimItem',
CanClaimItem = 'canClaimItem', CanClaimItem = 'canClaimItem',
} }

View File

@@ -40,7 +40,7 @@ export class PersonComponent extends ItemComponent implements OnInit {
ngOnInit(): void { ngOnInit(): void {
super.ngOnInit(); super.ngOnInit();
this.authorizationService.isAuthorized(FeatureID.ShowClaimItem, this.object._links.self.href).pipe( this.authorizationService.isAuthorized(FeatureID.CanClaimItem, this.object._links.self.href).pipe(
take(1) take(1)
).subscribe((isAuthorized: boolean) => { ).subscribe((isAuthorized: boolean) => {
this.claimable$.next(isAuthorized); this.claimable$.next(isAuthorized);
@@ -48,21 +48,10 @@ export class PersonComponent extends ItemComponent implements OnInit {
} }
/**
* Create a new researcher profile claiming the current item.
*/
claim() { claim() {
this.authorizationService.isAuthorized(FeatureID.CanClaimItem, this.object._links.self.href).pipe(
take(1)
).subscribe((isAuthorized: boolean) => {
if (!isAuthorized) {
this.notificationsService.warning(this.translate.get('researcherprofile.claim.not-authorized'));
} else {
this.createFromExternalSource();
}
});
}
createFromExternalSource() {
this.researcherProfileService.createFromExternalSource(this.object._links.self.href).pipe( this.researcherProfileService.createFromExternalSource(this.object._links.self.href).pipe(
getFirstSucceededRemoteData(), getFirstSucceededRemoteData(),
mergeMap((rd: RemoteData<ResearcherProfile>) => { mergeMap((rd: RemoteData<ResearcherProfile>) => {
@@ -81,10 +70,16 @@ export class PersonComponent extends ItemComponent implements OnInit {
}); });
} }
/**
* Returns true if the item is claimable, false otherwise.
*/
isClaimable(): Observable<boolean> { isClaimable(): Observable<boolean> {
return this.claimable$; return this.claimable$;
} }
/**
* Returns the metadata values to be used for the page title.
*/
getTitleMetadataValues(): MetadataValue[]{ getTitleMetadataValues(): MetadataValue[]{
const metadataValues = []; const metadataValues = [];
const familyName = this.object?.firstMetadata('person.familyName'); const familyName = this.object?.firstMetadata('person.familyName');

View File

@@ -1,6 +1,6 @@
import { Injectable } from '@angular/core'; import { Injectable } from '@angular/core';
import { Observable, of } from 'rxjs'; import { Observable, of } from 'rxjs';
import { mergeMap, switchMap, take } from 'rxjs/operators'; import { mergeMap, take } from 'rxjs/operators';
import { ConfigurationDataService } from '../../core/data/configuration-data.service'; import { ConfigurationDataService } from '../../core/data/configuration-data.service';
import { PaginatedList } from '../../core/data/paginated-list.model'; import { PaginatedList } from '../../core/data/paginated-list.model';
import { RemoteData } from '../../core/data/remote-data'; import { RemoteData } from '../../core/data/remote-data';
@@ -12,6 +12,9 @@ import { PaginatedSearchOptions } from '../../shared/search/models/paginated-sea
import { SearchResult } from '../../shared/search/models/search-result.model'; import { SearchResult } from '../../shared/search/models/search-result.model';
import { getFirstSucceededRemoteData } from './../../core/shared/operators'; import { getFirstSucceededRemoteData } from './../../core/shared/operators';
/**
* Service that handle profiles claim.
*/
@Injectable() @Injectable()
export class ProfileClaimService { export class ProfileClaimService {
@@ -19,6 +22,11 @@ export class ProfileClaimService {
private configurationService: ConfigurationDataService) { private configurationService: ConfigurationDataService) {
} }
/**
* Returns true if it is possible to suggest profiles to be claimed to the given eperson.
*
* @param eperson the eperson
*/
canClaimProfiles(eperson: EPerson): Observable<boolean> { canClaimProfiles(eperson: EPerson): Observable<boolean> {
const query = this.personQueryData(eperson); const query = this.personQueryData(eperson);
@@ -33,6 +41,10 @@ export class ProfileClaimService {
} }
/**
* Returns profiles that could be associated with the given user.
* @param eperson the user
*/
search(eperson: EPerson): Observable<RemoteData<PaginatedList<SearchResult<DSpaceObject>>>> { search(eperson: EPerson): Observable<RemoteData<PaginatedList<SearchResult<DSpaceObject>>>> {
const query = this.personQueryData(eperson); const query = this.personQueryData(eperson);
if (!hasValue(query) || query.length === 0) { if (!hasValue(query) || query.length === 0) {
@@ -41,6 +53,10 @@ export class ProfileClaimService {
return this.lookup(query); return this.lookup(query);
} }
/**
* Search object by the given query.
* @param query the query for the search
*/
private lookup(query: string): Observable<RemoteData<PaginatedList<SearchResult<DSpaceObject>>>> { private lookup(query: string): Observable<RemoteData<PaginatedList<SearchResult<DSpaceObject>>>> {
if (!hasValue(query)) { if (!hasValue(query)) {
return of(null); return of(null);
@@ -55,16 +71,7 @@ export class ProfileClaimService {
} }
private personQueryData(eperson: EPerson): string { private personQueryData(eperson: EPerson): string {
const querySections = []; return 'dc.title:' + eperson.name;
this.queryParam(querySections, 'dc.title', eperson.name);
this.queryParam(querySections, 'crisrp.name', eperson.name);
return querySections.join(' OR ');
} }
private queryParam(query: string[], metadata: string, value: string) {
if (!hasValue(value)) {return;}
query.push(metadata + ':' + value);
}
} }

View File

@@ -152,6 +152,9 @@ export class ProfilePageResearcherFormComponent implements OnInit {
return this.processingCreate$.asObservable(); return this.processingCreate$.asObservable();
} }
/**
* Create a new profile related to the current user from scratch.
*/
createProfileFromScratch() { createProfileFromScratch() {
this.processingCreate$.next(true); this.processingCreate$.next(true);
this.researcherProfileService.create().pipe( this.researcherProfileService.create().pipe(
@@ -167,6 +170,9 @@ export class ProfilePageResearcherFormComponent implements OnInit {
}); });
} }
/**
* Initializes the researcherProfile and researcherProfileItemId attributes using the profile of the current user.
*/
private initResearchProfile(): void { private initResearchProfile(): void {
this.researcherProfileService.findById(this.user.id).pipe( this.researcherProfileService.findById(this.user.id).pipe(
take(1), take(1),

View File

@@ -172,6 +172,9 @@ export class ProfilePageComponent implements OnInit {
this.updateProfile(); this.updateProfile();
} }
/**
* Returns true if the researcher profile feature is enabled, false otherwise.
*/
isResearcherProfileEnabled(){ isResearcherProfileEnabled(){
return this.isResearcherProfileEnabled$; return this.isResearcherProfileEnabled$;
} }

View File

@@ -14,8 +14,9 @@ import { ViewMode } from '../../../../core/shared/view-mode.model';
import { ProfileClaimService } from '../../../../profile-page/profile-claim/profile-claim.service'; import { ProfileClaimService } from '../../../../profile-page/profile-claim/profile-claim.service';
import { CollectionElementLinkType } from '../../../object-collection/collection-element-link.type'; import { CollectionElementLinkType } from '../../../object-collection/collection-element-link.type';
/**
* Component
*/
@Component({ @Component({
selector: 'ds-claim-item-selector', selector: 'ds-claim-item-selector',
templateUrl: './claim-item-selector.component.html' templateUrl: './claim-item-selector.component.html'