Package dev.metaschema.oscal.lib.model

Class Metadata.Role

java.lang.Object

dev.metaschema.oscal.lib.model.Metadata.Role

All Implemented Interfaces:

dev.metaschema.core.model.IBoundObject

Enclosing class:

Metadata

@MetaschemaAssembly(formalName="Role",
                    description="Defines a function, which might be assigned to a party in a specific situation.",
                    name="role",
                    moduleClass=OscalMetadataModule.class,
                    remarks="Permissible values to be determined closer to the application (e.g. by a receiving authority).\n\nOSCAL has defined a set of standardized roles for consistent use in OSCAL documents. This allows tools consuming OSCAL content to infer specific semantics when these roles are used. These roles are documented in the specific contexts of their use (e.g., responsible-party, responsible-role). When using such a role, it is necessary to define these roles in this list, which will then allow such a role to be referenced.")
public static class Metadata.Role
extends Object
implements dev.metaschema.core.model.IBoundObject

Defines a function, which might be assigned to a party in a specific situation.

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
boolean	addLink(Link item)	Add a new Link item to the underlying collection.
boolean	addProp(Property item)	Add a new Property item to the underlying collection.
dev.metaschema.core.datatype.markup.MarkupMultiline	getDescription()	Get the "Role Description".
String	getId()	Get the "Role Identifier".
List<Link>	getLinks()	Get the "Link".
dev.metaschema.core.model.IMetaschemaData	getMetaschemaData()
List<Property>	getProps()	Get the "Property".
dev.metaschema.core.datatype.markup.MarkupMultiline	getRemarks()	Get the "Remarks".
String	getShortName()	Get the "Role Short Name".
dev.metaschema.core.datatype.markup.MarkupLine	getTitle()	Get the "Role Title".
boolean	removeLink(Link item)	Remove the first matching Link item from the underlying collection.
boolean	removeProp(Property item)	Remove the first matching Property item from the underlying collection.
void	setDescription(dev.metaschema.core.datatype.markup.MarkupMultiline value)	Set the "Role Description".
void	setId(String value)	Set the "Role Identifier".
void	setLinks(List<Link> value)	Set the "Link".
void	setProps(List<Property> value)	Set the "Property".
void	setRemarks(dev.metaschema.core.datatype.markup.MarkupMultiline value)	Set the "Remarks".
void	setShortName(String value)	Set the "Role Short Name".
void	setTitle(dev.metaschema.core.datatype.markup.MarkupLine value)	Set the "Role Title".
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Details

Role

public Role()

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

Role

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

Constructs a new dev.metaschema.oscal.lib.model.Metadata.Role 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

getId

@NonNull
public String getId()

Get the "Role Identifier".

A unique identifier for the role.

Returns:

the id value

setId

public void setId(@NonNull
 String value)

Set the "Role Identifier".

A unique identifier for the role.

Parameters:

value - the id value to set

getTitle

@NonNull
public dev.metaschema.core.datatype.markup.MarkupLine getTitle()

Get the "Role Title".

A name given to the role, which may be used by a tool for display and navigation.

Returns:

the title value

setTitle

public void setTitle(@NonNull
 dev.metaschema.core.datatype.markup.MarkupLine value)

Set the "Role Title".

A name given to the role, which may be used by a tool for display and navigation.

Parameters:

value - the title value to set

getShortName

@Nullable
public String getShortName()

Get the "Role Short Name".

A short common name, abbreviation, or acronym for the role.

Returns:

the short-name value, or null if not set

setShortName

public void setShortName(@Nullable
 String value)

Set the "Role Short Name".

A short common name, abbreviation, or acronym for the role.

Parameters:

value - the short-name value to set, or null to clear

getDescription

@Nullable
public dev.metaschema.core.datatype.markup.MarkupMultiline getDescription()

Get the "Role Description".

A summary of the role's purpose and associated responsibilities.

Returns:

the description value, or null if not set

setDescription

public void setDescription(@Nullable
 dev.metaschema.core.datatype.markup.MarkupMultiline value)

Set the "Role Description".

A summary of the role's purpose and associated responsibilities.

Parameters:

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

getProps

@NonNull
public List<Property> getProps()

Get the "Property".

An attribute, characteristic, or quality of the containing object expressed as a namespace qualified name/value pair.

Returns:

the prop value

setProps

public void setProps(@NonNull
 List<Property> value)

Set the "Property".

An attribute, characteristic, or quality of the containing object expressed as a namespace qualified name/value pair.

Parameters:

value - the prop value to set

addProp

public boolean addProp(Property item)

Add a new Property item to the underlying collection.

Parameters:

item - the item to add

Returns:

true

removeProp

public boolean removeProp(Property item)

Remove the first matching Property item from the underlying collection.

Parameters:

item - the item to remove

Returns:

true if the item was removed or false otherwise

getLinks

@NonNull
public List<Link> getLinks()

Get the "Link".

A reference to a local or remote resource, that has a specific relation to the containing object.

Returns:

the link value

setLinks

public void setLinks(@NonNull
 List<Link> value)

Set the "Link".

A reference to a local or remote resource, that has a specific relation to the containing object.

Parameters:

value - the link value to set

addLink

public boolean addLink(Link item)

Add a new Link item to the underlying collection.

Parameters:

item - the item to add

Returns:

true

removeLink

public boolean removeLink(Link item)

Remove the first matching Link item from the underlying collection.

Parameters:

item - the item to remove

Returns:

true if the item was removed or false otherwise

getRemarks

@Nullable
public dev.metaschema.core.datatype.markup.MarkupMultiline getRemarks()

Get the "Remarks".

Additional commentary about the containing object.

Returns:

the remarks value, or null if not set

setRemarks

public void setRemarks(@Nullable
 dev.metaschema.core.datatype.markup.MarkupMultiline value)

Set the "Remarks".

Additional commentary about the containing object.

Parameters:

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

toString

public String toString()

Overrides:

toString in class Object