Package gov.nist.secauto.oscal.lib.model

Class ComponentImplementedRequirement

java.lang.Object

gov.nist.secauto.oscal.lib.model.ComponentImplementedRequirement

All Implemented Interfaces:

gov.nist.secauto.metaschema.core.model.IBoundObject

@MetaschemaAssembly(formalName="Control Implementation",
                    description="Describes how the containing component or capability implements an individual control.",
                    name="implemented-requirement",
                    moduleClass=OscalComponentDefinitionModule.class,
                    remarks="Implemented requirements within a component or capability in a component definition provide a means for component suppliers to suggest possible control implementation details, which may be used by a different party (e.g., component consumers) when authoring a system security plan. Thus, these requirements defined in a component definition are only a suggestion of how to implement, which may be adopted wholesale, changed, or ignored by a person defining an information system implementation.\n\nUse of `set-parameter` in this context, sets the parameter for the referenced control and any associated statements.",
                    modelConstraints=@IsUnique(id="unique-component-definition-implemented-requirement-set-parameter",level=ERROR,target="set-parameter",keyFields=@KeyField(target="@param-id"),remarks="Since multiple `set-parameter` entries can be provided, each parameter must be set only once.") @IsUnique(id="unique-component-definition-implemented-requirement-responsible-role",level=ERROR,target="responsible-role",keyFields=@KeyField(target="@role-id"),remarks="Since `responsible-role` associates multiple `party-uuid` entries with a single `role-id`, each role-id must be referenced only once.") @IsUnique(id="unique-component-definition-implemented-requirement-statement",level=ERROR,target="statement",keyFields=@KeyField(target="@statement-id"),remarks="Since `statement` entries can be referenced using the statement\'s statement-id, each statement must be referenced only once."))
public class ComponentImplementedRequirement
extends Object
implements gov.nist.secauto.metaschema.core.model.IBoundObject

Describes how the containing component or capability implements an individual control.

Constructor Summary

Constructors

Constructor	Description
ComponentImplementedRequirement()
ComponentImplementedRequirement(gov.nist.secauto.metaschema.core.model.IMetaschemaData data)

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.
boolean	addResponsibleRole(ResponsibleRole item)	Add a new ResponsibleRole item to the underlying collection.
boolean	addSetParameter(SetParameter item)	Add a new SetParameter item to the underlying collection.
boolean	addStatement(ComponentStatement item)	Add a new ComponentStatement item to the underlying collection.
String	getControlId()
gov.nist.secauto.metaschema.core.datatype.markup.MarkupMultiline	getDescription()
List<Link>	getLinks()
gov.nist.secauto.metaschema.core.model.IMetaschemaData	getMetaschemaData()
List<Property>	getProps()
gov.nist.secauto.metaschema.core.datatype.markup.MarkupMultiline	getRemarks()
List<ResponsibleRole>	getResponsibleRoles()
List<SetParameter>	getSetParameters()
List<ComponentStatement>	getStatements()
UUID	getUuid()
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.
boolean	removeResponsibleRole(ResponsibleRole item)	Remove the first matching ResponsibleRole item from the underlying collection.
boolean	removeSetParameter(SetParameter item)	Remove the first matching SetParameter item from the underlying collection.
boolean	removeStatement(ComponentStatement item)	Remove the first matching ComponentStatement item from the underlying collection.
void	setControlId(String value)
void	setDescription(gov.nist.secauto.metaschema.core.datatype.markup.MarkupMultiline value)
void	setLinks(List<Link> value)
void	setProps(List<Property> value)
void	setRemarks(gov.nist.secauto.metaschema.core.datatype.markup.MarkupMultiline value)
void	setResponsibleRoles(List<ResponsibleRole> value)
void	setSetParameters(List<SetParameter> value)
void	setStatements(List<ComponentStatement> value)
void	setUuid(UUID value)
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Details

ComponentImplementedRequirement

public ComponentImplementedRequirement()

ComponentImplementedRequirement

public ComponentImplementedRequirement(gov.nist.secauto.metaschema.core.model.IMetaschemaData data)

Method Details

getMetaschemaData

public gov.nist.secauto.metaschema.core.model.IMetaschemaData getMetaschemaData()

Specified by:

getMetaschemaData in interface gov.nist.secauto.metaschema.core.model.IBoundObject

getUuid

public UUID getUuid()

setUuid

public void setUuid(UUID value)

getControlId

public String getControlId()

setControlId

public void setControlId(String value)

getDescription

public gov.nist.secauto.metaschema.core.datatype.markup.MarkupMultiline getDescription()

setDescription

public void setDescription(gov.nist.secauto.metaschema.core.datatype.markup.MarkupMultiline value)

getProps

public List<Property> getProps()

setProps

public void setProps(List<Property> value)

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

public List<Link> getLinks()

setLinks

public void setLinks(List<Link> value)

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

getSetParameters

public List<SetParameter> getSetParameters()

setSetParameters

public void setSetParameters(List<SetParameter> value)

addSetParameter

public boolean addSetParameter(SetParameter item)

Add a new SetParameter item to the underlying collection.

Parameters:

item - the item to add

Returns:

true

removeSetParameter

public boolean removeSetParameter(SetParameter item)

Remove the first matching SetParameter item from the underlying collection.

Parameters:

item - the item to remove

Returns:

true if the item was removed or false otherwise

getResponsibleRoles

public List<ResponsibleRole> getResponsibleRoles()

setResponsibleRoles

public void setResponsibleRoles(List<ResponsibleRole> value)

addResponsibleRole

public boolean addResponsibleRole(ResponsibleRole item)

Add a new ResponsibleRole item to the underlying collection.

Parameters:

item - the item to add

Returns:

true

removeResponsibleRole

public boolean removeResponsibleRole(ResponsibleRole item)

Remove the first matching ResponsibleRole item from the underlying collection.

Parameters:

item - the item to remove

Returns:

true if the item was removed or false otherwise

getStatements

public List<ComponentStatement> getStatements()

setStatements

public void setStatements(List<ComponentStatement> value)

addStatement

public boolean addStatement(ComponentStatement item)

Add a new ComponentStatement item to the underlying collection.

Parameters:

item - the item to add

Returns:

true

removeStatement

public boolean removeStatement(ComponentStatement item)

Remove the first matching ComponentStatement item from the underlying collection.

Parameters:

item - the item to remove

Returns:

true if the item was removed or false otherwise

getRemarks

public gov.nist.secauto.metaschema.core.datatype.markup.MarkupMultiline getRemarks()

setRemarks

public void setRemarks(gov.nist.secauto.metaschema.core.datatype.markup.MarkupMultiline value)

toString

public String toString()

Overrides:

toString in class Object