Package dev.metaschema.oscal.lib.model

Class InsertControls

java.lang.Object

dev.metaschema.oscal.lib.model.InsertControls

All Implemented Interfaces:

dev.metaschema.core.model.IBoundObject

@MetaschemaAssembly(formalName="Insert Controls",
                    description="Specifies which controls to use in the containing context.",
                    name="insert-controls",
                    moduleClass=OscalProfileModule.class,
                    remarks="To be schema-valid, this element must contain either (but not both) a single `include-all` directive, or a sequence of `include-controls` directives.\n\nIf this directive is not provided, then no controls are to be inserted; i.e., all controls are included explicitly.")
public class InsertControls
extends Object
implements dev.metaschema.core.model.IBoundObject

Specifies which controls to use in the containing context.

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
boolean	addExcludeControls(ControlCommonSelectControlById item)	Add a new ControlCommonSelectControlById item to the underlying collection.
boolean	addIncludeControls(ControlCommonSelectControlById item)	Add a new ControlCommonSelectControlById item to the underlying collection.
List<ControlCommonSelectControlById>	getExcludeControls()	Get the "Select Control".
IncludeAll	getIncludeAll()	Get the "Include All".
List<ControlCommonSelectControlById>	getIncludeControls()	Get the "Select Control".
dev.metaschema.core.model.IMetaschemaData	getMetaschemaData()
String	getOrder()	Get the "Order".
boolean	removeExcludeControls(ControlCommonSelectControlById item)	Remove the first matching ControlCommonSelectControlById item from the underlying collection.
boolean	removeIncludeControls(ControlCommonSelectControlById item)	Remove the first matching ControlCommonSelectControlById item from the underlying collection.
void	setExcludeControls(List<ControlCommonSelectControlById> value)	Set the "Select Control".
void	setIncludeAll(IncludeAll value)	Set the "Include All".
void	setIncludeControls(List<ControlCommonSelectControlById> value)	Set the "Select Control".
void	setOrder(String value)	Set the "Order".
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Details

InsertControls

public InsertControls()

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

InsertControls

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

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

getOrder

@Nullable
public String getOrder()

Get the "Order".

A designation of how a selection of controls in a profile is to be ordered.

Returns:

the order value, or null if not set

setOrder

public void setOrder(@Nullable
 String value)

Set the "Order".

A designation of how a selection of controls in a profile is to be ordered.

Parameters:

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

getIncludeAll

@Nullable
public IncludeAll getIncludeAll()

Get the "Include All".

Include all controls from the imported catalog or profile resources.

Returns:

the include-all value, or null if not set

setIncludeAll

public void setIncludeAll(@Nullable
 IncludeAll value)

Set the "Include All".

Include all controls from the imported catalog or profile resources.

Parameters:

value - the include-all value to set, or null to clear

getIncludeControls

@NonNull
public List<ControlCommonSelectControlById> getIncludeControls()

Get the "Select Control".

Select a control or controls from an imported control set.

Returns:

the include-controls value

setIncludeControls

public void setIncludeControls(@NonNull
 List<ControlCommonSelectControlById> value)

Set the "Select Control".

Select a control or controls from an imported control set.

Parameters:

value - the include-controls value to set

addIncludeControls

public boolean addIncludeControls(ControlCommonSelectControlById item)

Add a new ControlCommonSelectControlById item to the underlying collection.

Parameters:

item - the item to add

Returns:

true

removeIncludeControls

public boolean removeIncludeControls(ControlCommonSelectControlById item)

Remove the first matching ControlCommonSelectControlById item from the underlying collection.

Parameters:

item - the item to remove

Returns:

true if the item was removed or false otherwise

getExcludeControls

@NonNull
public List<ControlCommonSelectControlById> getExcludeControls()

Get the "Select Control".

Select a control or controls from an imported control set.

Returns:

the exclude-controls value

setExcludeControls

public void setExcludeControls(@NonNull
 List<ControlCommonSelectControlById> value)

Set the "Select Control".

Select a control or controls from an imported control set.

Parameters:

value - the exclude-controls value to set

addExcludeControls

public boolean addExcludeControls(ControlCommonSelectControlById item)

Add a new ControlCommonSelectControlById item to the underlying collection.

Parameters:

item - the item to add

Returns:

true

removeExcludeControls

public boolean removeExcludeControls(ControlCommonSelectControlById item)

Remove the first matching ControlCommonSelectControlById item from the underlying collection.

Parameters:

item - the item to remove

Returns:

true if the item was removed or false otherwise

toString

public String toString()

Overrides:

toString in class Object