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 and Description
java.math.BigInteger	addWork(org.um.dsi.gavea.orcid.model.work.Work work) Adds a new work to the ORCID profile.
void	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).
org.um.dsi.gavea.orcid.model.work.Work	getWork(java.math.BigInteger putcode) Retrieves a complete work from the ORCID profile (as opposed to only its summary).
int	threads() The number of worker threads that will be used to communicate with the ORCID API.
void	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

getWork

org.um.dsi.gavea.orcid.model.work.Work getWork(java.math.BigInteger putcode)
                                        throws org.um.dsi.gavea.orcid.client.exception.OrcidClientException

Retrieves a complete work from the ORCID profile (as opposed to only its summary).

Parameters:

putcode - the put-code of the work

Returns:

the complete work

Throws:

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

addWork

java.math.BigInteger addWork(org.um.dsi.gavea.orcid.model.work.Work work)
                      throws org.um.dsi.gavea.orcid.client.exception.OrcidClientException

Adds a new work to the ORCID profile.

Parameters:

work - the work to be added to the ORCID profile

Returns:

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

Throws:

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

deleteWork

void deleteWork(java.math.BigInteger putcode)
         throws org.um.dsi.gavea.orcid.client.exception.OrcidClientException

Deletes a work from the ORCID profile.

Parameters:

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

Throws:

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

updateWork

void updateWork(java.math.BigInteger putcode,
                org.um.dsi.gavea.orcid.model.work.Work work)
         throws org.um.dsi.gavea.orcid.client.exception.OrcidClientException

Updates a work in the ORCID profile.

Parameters:

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

work - the new state of the work

Throws:

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

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

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