Package org.dspace.orcid.service

Interface OrcidTokenService

All Known Implementing Classes:

OrcidTokenServiceImpl

public interface OrcidTokenService

Service that handle OrcidToken entities.

Author:

Luca Giamminonni (luca.giamminonni at 4science.it)

Method Summary

Modifier and Type	Method	Description
OrcidToken	create(Context context, EPerson ePerson, String accessToken)	Creates a new OrcidToken entity for the given ePerson and accessToken.
OrcidToken	create(Context context, EPerson ePerson, Item profileItem, String accessToken)	Creates a new OrcidToken entity for the given ePerson and accessToken.
void	delete(Context context, OrcidToken orcidToken)	Delete the given ORCID token entity.
void	deleteAll(Context context)	Delete all the ORCID token entities.
void	deleteByEPerson(Context context, EPerson ePerson)	Deletes the ORCID token entity related to the given EPerson.
void	deleteByProfileItem(Context context, Item profileItem)	Deletes the ORCID token entity related to the given profile item.
OrcidToken	findByEPerson(Context context, EPerson ePerson)	Find an OrcidToken by ePerson.
OrcidToken	findByProfileItem(Context context, Item profileItem)	Find an OrcidToken by profileItem.

Method Detail

create

OrcidToken create(Context context,
                  EPerson ePerson,
                  String accessToken)

Creates a new OrcidToken entity for the given ePerson and accessToken.

Parameters:

context - the DSpace context

ePerson - the EPerson

accessToken - the access token

Returns:

the created entity instance

create

OrcidToken create(Context context,
                  EPerson ePerson,
                  Item profileItem,
                  String accessToken)

Creates a new OrcidToken entity for the given ePerson and accessToken.

Parameters:

context - the DSpace context

ePerson - the EPerson

profileItem - the profile item

accessToken - the access token

Returns:

the created entity instance

findByEPerson

OrcidToken findByEPerson(Context context,
                         EPerson ePerson)

Find an OrcidToken by ePerson.

Parameters:

context - the DSpace context

ePerson - the ePerson to search for

Returns:

the Orcid token, if any

findByProfileItem

OrcidToken findByProfileItem(Context context,
                             Item profileItem)

Find an OrcidToken by profileItem.

Parameters:

context - the DSpace context

profileItem - the profile item to search for

Returns:

the Orcid token, if any

delete

void delete(Context context,
            OrcidToken orcidToken)

Delete the given ORCID token entity.

Parameters:

context - the DSpace context

orcidToken - the ORCID token entity to delete

deleteAll

void deleteAll(Context context)

Delete all the ORCID token entities.

Parameters:

context - the DSpace context

deleteByEPerson

void deleteByEPerson(Context context,
                     EPerson ePerson)

Deletes the ORCID token entity related to the given EPerson.

Parameters:

context - the DSpace context

ePerson - the ePerson for the deletion

deleteByProfileItem

void deleteByProfileItem(Context context,
                         Item profileItem)

Deletes the ORCID token entity related to the given profile item.

Parameters:

context - the DSpace context

profileItem - the item for the deletion