Package dev.metaschema.oscal.lib.model

Class DocumentId

java.lang.Object

dev.metaschema.oscal.lib.model.DocumentId

All Implemented Interfaces:

dev.metaschema.core.model.IBoundObject

@MetaschemaField(formalName="Document Identifier",
                 description="A document identifier qualified by an identifier `scheme`.",
                 name="document-id",
                 moduleClass=OscalMetadataModule.class)
public class DocumentId
extends Object
implements dev.metaschema.core.model.IBoundObject

A document identifier qualified by an identifier scheme.

Constructor Summary

Constructors

Constructor	Description
DocumentId()	Constructs a new dev.metaschema.oscal.lib.model.DocumentId instance with no metadata.
DocumentId(dev.metaschema.core.model.IMetaschemaData data)	Constructs a new dev.metaschema.oscal.lib.model.DocumentId instance with the specified metadata.

Method Summary

Modifier and Type	Method	Description
String	getIdentifier()	Get the field value.
dev.metaschema.core.model.IMetaschemaData	getMetaschemaData()
URI	getScheme()	Get the "Document Identification Scheme".
void	setIdentifier(String value)	Set the field value.
void	setScheme(URI value)	Set the "Document Identification Scheme".
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Details

DocumentId

public DocumentId()

Constructs a new dev.metaschema.oscal.lib.model.DocumentId instance with no metadata.

DocumentId

public DocumentId(dev.metaschema.core.model.IMetaschemaData data)

Constructs a new dev.metaschema.oscal.lib.model.DocumentId instance with the specified metadata.

Parameters:

data - the metaschema data, or null if none

Method Details

getMetaschemaData

public dev.metaschema.core.model.IMetaschemaData getMetaschemaData()

Specified by:

getMetaschemaData in interface dev.metaschema.core.model.IBoundObject

getScheme

@Nullable
public URI getScheme()

Get the "Document Identification Scheme".

Qualifies the kind of document identifier using a URI. If the scheme is not provided the value of the element will be interpreted as a string of characters.

Returns:

the scheme value, or null if not set

setScheme

public void setScheme(@Nullable
 URI value)

Set the "Document Identification Scheme".

Qualifies the kind of document identifier using a URI. If the scheme is not provided the value of the element will be interpreted as a string of characters.

Parameters:

value - the scheme value to set, or null to clear

getIdentifier

@Nullable
public String getIdentifier()

Get the field value.

Returns:

the value

setIdentifier

public void setIdentifier(@Nullable
 String value)

Set the field value.

Parameters:

value - the value to set

toString

public String toString()

Overrides:

toString in class Object