Package org.ivoa.dm.registry.standard

Class EndorsedVersion

java.lang.Object

org.ivoa.dm.registry.standard.EndorsedVersion

All Implemented Interfaces:

org.ivoa.vodml.jpa.JPAManipulations

@Embeddable
@VoDml(id="StandardsRegExt:EndorsedVersion",
       role=dataType)
public class EndorsedVersion
extends Object
implements org.ivoa.vodml.jpa.JPAManipulations

. dataType: EndorsedVersion

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	EndorsedVersion.EndorsedVersionBuilder	A builder class for EndorsedVersion, mainly for use in the functional builder pattern.

Field Summary

Fields

Modifier and Type	Field	Description
protected EndorsedVersion_status	status	the IVOA status level of this version of the standard.
protected EndorsedVersion_use	use	A designation of preference for the version compared to other versions in use.
protected String	value	.

Constructor Summary

Constructors

Constructor	Description
EndorsedVersion()	Creates a new EndorsedVersion
EndorsedVersion(String value, EndorsedVersion_status status, EndorsedVersion_use use)	full parameter constructor.
EndorsedVersion(EndorsedVersion other)	Copy Constructor.

Method Summary

Modifier and Type	Method	Description
static EndorsedVersion	createEndorsedVersion(Consumer<EndorsedVersion.EndorsedVersionBuilder> f)	create a EndorsedVersion in functional builder style.
void	forceLoad()
EndorsedVersion_status	getStatus()	Returns status Attribute.
EndorsedVersion_use	getUse()	Returns use Attribute.
String	getValue()	Returns value Attribute.
void	setStatus(EndorsedVersion_status pStatus)	Set status Attribute.
void	setUse(EndorsedVersion_use pUse)	Set use Attribute.
void	setValue(String pValue)	Set value Attribute.
void	updateUsing(EndorsedVersion other)	Update this object with the content of the given object.
EndorsedVersion	withStatus(EndorsedVersion_status pStatus)	fluent setter for status Attribute.
EndorsedVersion	withUse(EndorsedVersion_use pUse)	fluent setter for use Attribute.
EndorsedVersion	withValue(String pValue)	fluent setter for value Attribute.

Methods inherited from class java.lang.Object

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

Field Details

value

@VoDml(id="StandardsRegExt:EndorsedVersion.value",
       role=attribute,
       type="ivoa:string",
       typeRole=primitiveType)
protected String value

. : Attribute value : multiplicity 1

status

@VoDml(id="StandardsRegExt:EndorsedVersion.status",
       role=attribute,
       type="StandardsRegExt:EndorsedVersion_status",
       typeRole=enumeration)
protected EndorsedVersion_status status

the IVOA status level of this version of the standard. For values of 'rec', 'pr', 'wd', and 'note', the record's referenceURL element should point to the official specification document in the IVOA Document Repository; if the document does not appear there, these values should not be used. : Attribute status : multiplicity 1

use

@VoDml(id="StandardsRegExt:EndorsedVersion.use",
       role=attribute,
       type="StandardsRegExt:EndorsedVersion_use",
       typeRole=enumeration)
protected EndorsedVersion_use use

A designation of preference for the version compared to other versions in use. : Attribute use : multiplicity 1

Constructor Details

EndorsedVersion

public EndorsedVersion()

Creates a new EndorsedVersion

EndorsedVersion

public EndorsedVersion(String value,
 EndorsedVersion_status status,
 EndorsedVersion_use use)

full parameter constructor.

Parameters:

value - .

status - the IVOA status level of this version of the standard. For values of 'rec', 'pr', 'wd', and 'note', the record's referenceURL element should point to the official specification document in the IVOA Document Repository; if the document does not appear there, these values should not be used.

use - A designation of preference for the version compared to other versions in use.

EndorsedVersion

public EndorsedVersion(EndorsedVersion other)

Copy Constructor. Note that references will remain as is rather than be copied.

Parameters:

other - the object to be copied.

Method Details

updateUsing

public void updateUsing(EndorsedVersion other)

Update this object with the content of the given object. Note that references will remain as is rather than be copied.

Parameters:

other - the object to be copied.

getValue

public String getValue()

Returns value Attribute.

Returns:

value Attribute

setValue

public void setValue(String pValue)

Set value Attribute.

Parameters:

pValue - value to set

withValue

public EndorsedVersion withValue(String pValue)

fluent setter for value Attribute.

Parameters:

pValue - value to set

Returns:

EndorsedVersion

getStatus

public EndorsedVersion_status getStatus()

Returns status Attribute.

Returns:

status Attribute

setStatus

public void setStatus(EndorsedVersion_status pStatus)

Set status Attribute.

Parameters:

pStatus - value to set

withStatus

public EndorsedVersion withStatus(EndorsedVersion_status pStatus)

fluent setter for status Attribute.

Parameters:

pStatus - value to set

Returns:

EndorsedVersion

getUse

public EndorsedVersion_use getUse()

Returns use Attribute.

Returns:

use Attribute

setUse

public void setUse(EndorsedVersion_use pUse)

Set use Attribute.

Parameters:

pUse - value to set

withUse

public EndorsedVersion withUse(EndorsedVersion_use pUse)

fluent setter for use Attribute.

Parameters:

pUse - value to set

Returns:

EndorsedVersion

createEndorsedVersion

public static EndorsedVersion createEndorsedVersion(Consumer<EndorsedVersion.EndorsedVersionBuilder> f)

create a EndorsedVersion in functional builder style.

Parameters:

f - the functional builder.

Returns:

an object initialized from the builder.

forceLoad

public void forceLoad()

Specified by:

forceLoad in interface org.ivoa.vodml.jpa.JPAManipulations