Package org.dspace.orcid.service.impl

Class OrcidHistoryServiceImpl

java.lang.Object

org.dspace.orcid.service.impl.OrcidHistoryServiceImpl

All Implemented Interfaces:

OrcidHistoryService

public class OrcidHistoryServiceImpl
extends Object
implements OrcidHistoryService

Implementation of OrcidHistoryService.

Author:

Mykhaylo Boychuk (mykhaylo.boychuk at 4science.it), Luca Giamminonni (luca.giamminonni at 4science.it)

Constructor Summary

Constructors

Constructor	Description
OrcidHistoryServiceImpl()

Method Summary

Modifier and Type	Method	Description
OrcidHistory	create(Context context, Item profileItem, Item entity)	Create a new OrcidHistory records related to the given profileItem and entity items.
void	delete(Context context, OrcidHistory orcidHistory)	Delete an OrcidHistory
OrcidHistory	find(Context context, int id)	Get an OrcidHistory from the database.
List<OrcidHistory>	findAll(Context context)	Find all the ORCID history records.
List<OrcidHistory>	findByEntity(Context context, Item entity)	Find the OrcidHistory records related to the given entity item.
List<OrcidHistory>	findByProfileItemOrEntity(Context context, Item profileItem)	Get the OrcidHistory records where the given item is the profile item OR the entity
Optional<String>	findLastPutCode(Context context, Item profileItem, Item entity)	Find the last put code related to the given profileItem and entity item.
Map<Item,String>	findLastPutCodes(Context context, Item entity)	Find all the last put code related to the entity item each associated with the profileItem to which it refers.
List<OrcidHistory>	findSuccessfullyRecordsByEntityAndType(Context context, Item entity, String recordType)	Find all the successfully Orcid history records with the given record type related to the given entity.
OrcidClient	getOrcidClient()
void	setOrcidClient(OrcidClient orcidClient)
OrcidHistory	synchronizeWithOrcid(Context context, OrcidQueue orcidQueue, boolean forceAddition)	Synchronize the entity related to the given orcidQueue record with ORCID.
void	update(Context context, OrcidHistory orcidHistory)	Update the OrcidHistory

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

OrcidHistoryServiceImpl

public OrcidHistoryServiceImpl()

Method Detail

find

public OrcidHistory find(Context context,
                         int id)
                  throws SQLException

Description copied from interface: OrcidHistoryService

Get an OrcidHistory from the database.

Specified by:

find in interface OrcidHistoryService

Parameters:

context - DSpace context object

id - ID of the OrcidHistory

Returns:

the OrcidHistory format, or null if the ID is invalid.

Throws:

SQLException - if database error

findAll

public List<OrcidHistory> findAll(Context context)
                           throws SQLException

Description copied from interface: OrcidHistoryService

Find all the ORCID history records.

Specified by:

findAll in interface OrcidHistoryService

Parameters:

context - DSpace context object

Returns:

the ORCID history records

Throws:

SQLException - if an SQL error occurs

findByProfileItemOrEntity

public List<OrcidHistory> findByProfileItemOrEntity(Context context,
                                                    Item profileItem)
                                             throws SQLException

Description copied from interface: OrcidHistoryService

Get the OrcidHistory records where the given item is the profile item OR the entity

Specified by:

findByProfileItemOrEntity in interface OrcidHistoryService

Parameters:

context - DSpace context object

profileItem - the item to search for

Returns:

the found OrcidHistory entities

Throws:

SQLException - if database error

create

public OrcidHistory create(Context context,
                           Item profileItem,
                           Item entity)
                    throws SQLException

Description copied from interface: OrcidHistoryService

Create a new OrcidHistory records related to the given profileItem and entity items.

Specified by:

create in interface OrcidHistoryService

Parameters:

context - DSpace context object

profileItem - the profileItem item

entity - the entity item

Returns:

the created orcid history record

Throws:

SQLException - if database error

delete

public void delete(Context context,
                   OrcidHistory orcidHistory)
            throws SQLException

Description copied from interface: OrcidHistoryService

Delete an OrcidHistory

Specified by:

delete in interface OrcidHistoryService

Parameters:

context - context

orcidHistory - the OrcidHistory entity to delete

Throws:

SQLException - if database error

update

public void update(Context context,
                   OrcidHistory orcidHistory)
            throws SQLException

Description copied from interface: OrcidHistoryService

Update the OrcidHistory

Specified by:

update in interface OrcidHistoryService

Parameters:

context - context

orcidHistory - the OrcidHistory entity to update

Throws:

SQLException - if database error

findLastPutCode

public Optional<String> findLastPutCode(Context context,
                                        Item profileItem,
                                        Item entity)
                                 throws SQLException

Description copied from interface: OrcidHistoryService

Find the last put code related to the given profileItem and entity item.

Specified by:

findLastPutCode in interface OrcidHistoryService

Parameters:

context - DSpace context object

profileItem - the profileItem item

entity - the entity item

Returns:

the found put code, if any

Throws:

SQLException - if database error

findLastPutCodes

public Map<Item,String> findLastPutCodes(Context context,
                                               Item entity)
                                        throws SQLException

Description copied from interface: OrcidHistoryService

Find all the last put code related to the entity item each associated with the profileItem to which it refers.

Specified by:

findLastPutCodes in interface OrcidHistoryService

Parameters:

context - DSpace context object

entity - the entity item

Returns:

a map that relates the profileItems with the identified putCode

Throws:

SQLException - if database error

findByEntity

public List<OrcidHistory> findByEntity(Context context,
                                       Item entity)
                                throws SQLException

Description copied from interface: OrcidHistoryService

Find the OrcidHistory records related to the given entity item.

Specified by:

findByEntity in interface OrcidHistoryService

Parameters:

context - DSpace context object

entity - the entity item

Returns:

the found put codes

Throws:

SQLException - if database error

findSuccessfullyRecordsByEntityAndType

public List<OrcidHistory> findSuccessfullyRecordsByEntityAndType(Context context,
                                                                 Item entity,
                                                                 String recordType)
                                                          throws SQLException

Description copied from interface: OrcidHistoryService

Find all the successfully Orcid history records with the given record type related to the given entity. An history record is considered successful if the status is between 200 and 300.

Specified by:

findSuccessfullyRecordsByEntityAndType in interface OrcidHistoryService

Parameters:

context - DSpace context object

entity - the entity item

recordType - the record type

Returns:

the found orcid history records

Throws:

SQLException - if database error

synchronizeWithOrcid

public OrcidHistory synchronizeWithOrcid(Context context,
                                         OrcidQueue orcidQueue,
                                         boolean forceAddition)
                                  throws SQLException

Description copied from interface: OrcidHistoryService

Synchronize the entity related to the given orcidQueue record with ORCID.

Specified by:

synchronizeWithOrcid in interface OrcidHistoryService

Parameters:

context - DSpace context object

orcidQueue - the orcid queue record that has the references of the data to be synchronized

forceAddition - to force the insert on the ORCID registry

Returns:

the created orcid history record with the synchronization result

Throws:

SQLException - if database error

getOrcidClient

public OrcidClient getOrcidClient()

setOrcidClient

public void setOrcidClient(OrcidClient orcidClient)