Package pt.ptcris

Interface ORCIDClient

All Known Implementing Classes:

ORCIDClientImpl

public interface ORCIDClient

Interface that encapsulates the communication with the ORCID client for a specified user profile. Currently focuses on managing works.

Method Summary

Modifier and Type	Method	Description
PTCRISyncResult<org.um.dsi.gavea.orcid.model.funding.Funding>	addFunding(org.um.dsi.gavea.orcid.model.funding.Funding funding)	Adds a new funding entry to the ORCID profile and returns the assigned put-code.
PTCRISyncResult<org.um.dsi.gavea.orcid.model.work.Work>	addWork(org.um.dsi.gavea.orcid.model.work.Work work)	Adds a new work to the ORCID profile and returns the assigned put-code.
java.util.List<PTCRISyncResult<org.um.dsi.gavea.orcid.model.work.Work>>	addWorks(java.util.List<org.um.dsi.gavea.orcid.model.work.Work> works)	Adds a list of new works to the ORCID profile.
PTCRISyncResult<org.um.dsi.gavea.orcid.model.funding.Funding>	deleteFunding(java.math.BigInteger putcode)	Deletes a funding entry from the ORCID profile.
PTCRISyncResult<org.um.dsi.gavea.orcid.model.work.Work>	deleteWork(java.math.BigInteger putcode)	Deletes a work from the ORCID profile.
org.um.dsi.gavea.orcid.model.activities.ActivitiesSummary	getActivitiesSummary()	Retrieves every activity summary from the ORCID profile.
java.lang.String	getClientId()	Returns the Member API client id that will commit the changes (i.e., the works' source).
PTCRISyncResult<org.um.dsi.gavea.orcid.model.funding.Funding>	getFunding(org.um.dsi.gavea.orcid.model.funding.FundingSummary summary)	Retrieves a complete funding entry from the ORCID profile (as opposed to only its summary).
org.um.dsi.gavea.orcid.model.activities.Fundings	getFundingsSummary()	Retrieves every funding summary from the ORCID profile.
java.lang.String	getUserId()	Returns the user ORCID to whose profiles the changes will be commited.
PTCRISyncResult<org.um.dsi.gavea.orcid.model.work.Work>	getWork(org.um.dsi.gavea.orcid.model.work.WorkSummary summary)	Retrieves a complete work from the ORCID profile (as opposed to only its summary).
java.util.Map<java.math.BigInteger,PTCRISyncResult<org.um.dsi.gavea.orcid.model.work.Work>>	getWorks(java.util.List<org.um.dsi.gavea.orcid.model.work.WorkSummary> summaries)	Retrieves a list of complete work from the ORCID profile (as opposed to only their summaries).
org.um.dsi.gavea.orcid.model.activities.Works	getWorksSummary()	Retrieves every work summary from the ORCID profile.
int	threads()	The number of worker threads that will be used to communicate with the ORCID API.
PTCRISyncResult<org.um.dsi.gavea.orcid.model.funding.Funding>	updateFunding(java.math.BigInteger putcode, org.um.dsi.gavea.orcid.model.funding.Funding funding)	Updates a funding entry in the ORCID profile.
PTCRISyncResult<org.um.dsi.gavea.orcid.model.work.Work>	updateWork(java.math.BigInteger putcode, org.um.dsi.gavea.orcid.model.work.Work work)	Updates a work in the ORCID profile.

Method Detail

getClientId

java.lang.String getClientId()

Returns the Member API client id that will commit the changes (i.e., the works' source).

Returns:

the client id

getUserId

java.lang.String getUserId()

Returns the user ORCID to whose profiles the changes will be commited.

Returns:

the user ORCID

getActivitiesSummary

org.um.dsi.gavea.orcid.model.activities.ActivitiesSummary getActivitiesSummary()
                                                                        throws org.um.dsi.gavea.orcid.client.exception.OrcidClientException

Retrieves every activity summary from the ORCID profile.

Returns:

the activities summary of the ORCID profile

Throws:

org.um.dsi.gavea.orcid.client.exception.OrcidClientException - if the communication with ORCID fails

getWorksSummary

org.um.dsi.gavea.orcid.model.activities.Works getWorksSummary()
                                                       throws org.um.dsi.gavea.orcid.client.exception.OrcidClientException

Retrieves every work summary from the ORCID profile.

Returns:

the work summaries of the ORCID profile

Throws:

org.um.dsi.gavea.orcid.client.exception.OrcidClientException - if the communication with ORCID fails

getFundingsSummary

org.um.dsi.gavea.orcid.model.activities.Fundings getFundingsSummary()
                                                             throws org.um.dsi.gavea.orcid.client.exception.OrcidClientException

Retrieves every funding summary from the ORCID profile.

Returns:

the funding summaries of the ORCID profile

Throws:

org.um.dsi.gavea.orcid.client.exception.OrcidClientException - if the communication with ORCID fails

getWork

PTCRISyncResult<org.um.dsi.gavea.orcid.model.work.Work> getWork(org.um.dsi.gavea.orcid.model.work.WorkSummary summary)

Retrieves a complete work from the ORCID profile (as opposed to only its summary). Exceptions are embedded in the PTCRISyncResult.

Parameters:

summary - the summary of the work to be retrieved

Returns:

the complete work

getFunding

PTCRISyncResult<org.um.dsi.gavea.orcid.model.funding.Funding> getFunding(org.um.dsi.gavea.orcid.model.funding.FundingSummary summary)

Retrieves a complete funding entry from the ORCID profile (as opposed to only its summary). Exceptions are embedded in the PTCRISyncResult.

Parameters:

summary - the summary of the funding entry to be retrieved

Returns:

the complete funding entry

getWorks

java.util.Map<java.math.BigInteger,PTCRISyncResult<org.um.dsi.gavea.orcid.model.work.Work>> getWorks(java.util.List<org.um.dsi.gavea.orcid.model.work.WorkSummary> summaries)

Retrieves a list of complete work from the ORCID profile (as opposed to only their summaries). Exceptions are embedded in the PTCRISyncResult. This should generate a single API call internally.

Parameters:

summaries - the summaries of the works to be retrieved

Returns:

the complete works

addWork

PTCRISyncResult<org.um.dsi.gavea.orcid.model.work.Work> addWork(org.um.dsi.gavea.orcid.model.work.Work work)

Adds a new work to the ORCID profile and returns the assigned put-code. Exceptions are embedded in the PTCRISyncResult.

Parameters:

work - the work to be added to the ORCID profile

Returns:

the put-code assigned by ORCID to the newly created work

addFunding

PTCRISyncResult<org.um.dsi.gavea.orcid.model.funding.Funding> addFunding(org.um.dsi.gavea.orcid.model.funding.Funding funding)

Adds a new funding entry to the ORCID profile and returns the assigned put-code. Exceptions are embedded in the PTCRISyncResult.

Parameters:

funding - the funding entry to be added to the ORCID profile

Returns:

the put-code assigned by ORCID to the newly created funding entry

addWorks

java.util.List<PTCRISyncResult<org.um.dsi.gavea.orcid.model.work.Work>> addWorks(java.util.List<org.um.dsi.gavea.orcid.model.work.Work> works)

Adds a list of new works to the ORCID profile. Exceptions are embedded in the PTCRISyncResult. This should generate a single API call internally.

Parameters:

works - the works to be added to the ORCID profile

Returns:

the put-codes assigned by ORCID to each of the newly created works

deleteWork

PTCRISyncResult<org.um.dsi.gavea.orcid.model.work.Work> deleteWork(java.math.BigInteger putcode)

Deletes a work from the ORCID profile. Exceptions are embedded in the PTCRISyncResult.

Parameters:

putcode - the put-code of the work to be deleted

Returns:

the outcome of the delete request

deleteFunding

PTCRISyncResult<org.um.dsi.gavea.orcid.model.funding.Funding> deleteFunding(java.math.BigInteger putcode)

Deletes a funding entry from the ORCID profile. Exceptions are embedded in the PTCRISyncResult.

Parameters:

putcode - the put-code of the funding entry to be deleted

Returns:

the outcome of the delete request

updateWork

PTCRISyncResult<org.um.dsi.gavea.orcid.model.work.Work> updateWork(java.math.BigInteger putcode,
                                                                   org.um.dsi.gavea.orcid.model.work.Work work)

Updates a work in the ORCID profile. Exceptions are embedded in the PTCRISyncResult.

Parameters:

putcode - the put-code of the work to be updated

work - the new state of the work

Returns:

the outcome of the update request

updateFunding

PTCRISyncResult<org.um.dsi.gavea.orcid.model.funding.Funding> updateFunding(java.math.BigInteger putcode,
                                                                            org.um.dsi.gavea.orcid.model.funding.Funding funding)

Updates a funding entry in the ORCID profile. Exceptions are embedded in the PTCRISyncResult.

Parameters:

putcode - the put-code of the funding entry to be updated

funding - the new state of the funding entry

Returns:

the outcome of the update request

threads

int threads()

The number of worker threads that will be used to communicate with the ORCID API.

Returns:

the number of ORCID worker threads