Package org.dspace.app.rest.model

Class IdentifierRest

java.lang.Object

org.dspace.app.rest.model.RestAddressableModel

org.dspace.app.rest.model.BaseObjectRest<String>

org.dspace.app.rest.model.IdentifierRest

All Implemented Interfaces:

Serializable, RestModel

public class IdentifierRest
extends BaseObjectRest<String>
implements RestModel

Implementation of IdentifierRest REST resource, representing some DSpace identifier for use with the REST API

Author:

Kim Shepherd

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
static String	NAME
static String	PLURAL_NAME

Fields inherited from class org.dspace.app.rest.model.BaseObjectRest

id

Fields inherited from interface org.dspace.app.rest.model.RestModel

AUTHENTICATION, AUTHORIZATION, CONFIGURATION, CORE, DISCOVER, EPERSON, INTEGRATION, ROOT, STATISTICS, SUBMISSION, SYSTEM, TOOLS, VERSIONING, WORKFLOW

Constructor Summary

Constructors

Constructor	Description
IdentifierRest()
IdentifierRest(String value, String identifierType, String identifierStatus)	Constructor that takes a value, type and status for an identifier

Method Summary

Modifier and Type	Method	Description
String	getCategory()
Class	getController()
String	getId()
String	getIdentifierStatus()	Get status of identifier, if relevant
String	getIdentifierType()	Get type of identifier eg 'doi' or 'handle'
String	getType()	Return name for getType() - this is the section name and not the type of identifier, see: identifierType string
String	getTypePlural()
String	getValue()	Get the identifier value eg full DOI URL
void	setIdentifierStatus(String identifierStatus)	Set status of identifier, if relevant
void	setIdentifierType(String identifierType)	Set type of identifier
void	setValue(String value)	Set the identifier value

Methods inherited from class org.dspace.app.rest.model.BaseObjectRest

getErrors, setErrors, setId

Methods inherited from class org.dspace.app.rest.model.RestAddressableModel

getEmbedLevel, getProjection, getUniqueType, setEmbedLevel, setProjection

Methods inherited from class java.lang.Object

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

Field Detail

NAME

public static final String NAME

See Also:

Constant Field Values

PLURAL_NAME

public static final String PLURAL_NAME

See Also:

Constant Field Values

Constructor Detail

IdentifierRest

public IdentifierRest()

IdentifierRest

public IdentifierRest(String value,
                      String identifierType,
                      String identifierStatus)

Constructor that takes a value, type and status for an identifier

Parameters:

value - the identifier value eg. https://doi.org/123/234

identifierType - identifier type eg. doi

identifierStatus - identifier status eg. TO_BE_REGISTERED

Method Detail

getType

public String getType()

Return name for getType() - this is the section name and not the type of identifier, see: identifierType string

Specified by:

getType in interface RestModel

Returns:

getTypePlural

public String getTypePlural()

Specified by:

getTypePlural in interface RestModel

getValue

public String getValue()

Get the identifier value eg full DOI URL

Returns:

identifier value eg. https://doi.org/123/234

setValue

public void setValue(String value)

Set the identifier value

Parameters:

value - identifier value, eg. https://doi.org/123/234

getIdentifierType

public String getIdentifierType()

Get type of identifier eg 'doi' or 'handle'

Returns:

type string

setIdentifierType

public void setIdentifierType(String identifierType)

Set type of identifier

Parameters:

identifierType - type string eg 'doi'

getIdentifierStatus

public String getIdentifierStatus()

Get status of identifier, if relevant

Returns:

identifierStatus eg. null or TO_BE_REGISTERED

setIdentifierStatus

public void setIdentifierStatus(String identifierStatus)

Set status of identifier, if relevant

Parameters:

identifierStatus - eg. null or TO_BE_REGISTERED

getCategory

public String getCategory()

Specified by:

getCategory in class RestAddressableModel

getId

public String getId()

Overrides:

getId in class BaseObjectRest<String>

getController

public Class getController()

Specified by:

getController in class RestAddressableModel