Package dev.metaschema.oscal.lib.model

Class ProfileImport

java.lang.Object

dev.metaschema.oscal.lib.model.ProfileImport

All Implemented Interfaces:

dev.metaschema.core.model.IBoundObject

@MetaschemaAssembly(formalName="Import Resource",
                    description="Designates a referenced source catalog or profile that provides a source of control information for use in creating a new overlay or baseline.",
                    name="import",
                    moduleClass=OscalProfileModule.class,
                    remarks="The contents of the `import` element indicate which controls from the source will be included. Controls from the source catalog or profile may be either selected, using the `include-all` or `include-controls` directives, or de-selected (using an `exclude-controls` directive).",
                    valueConstraints=@ValueConstraints(lets=@Let(name="resolved-profile-import",target=".[@href] ! resolve-profile(doc(resolve-uri(Q{http://csrc.nist.gov/ns/oscal/1.0}resolve-reference(@href))))/catalog"),expect=@Expect(id="oscal-profile-import-include-exclude-control-id-in-imported-catalog",formalName="In-Scope Control Identifier",description="Each referenced control identifier must match a control in the catalog resolved by the surrounding profile import.",level=ERROR,target="(include-controls|exclude-controls)/with-id",test="let $id := . return exists($resolved-profile-import//control[@id = $id])",message="Control identifier \'{ . }\' was not found in the imported catalog.")))
public class ProfileImport
extends Object
implements dev.metaschema.core.model.IBoundObject

Designates a referenced source catalog or profile that provides a source of control information for use in creating a new overlay or baseline.

Constructor Summary

Constructors

Constructor	Description
ProfileImport()	Constructs a new dev.metaschema.oscal.lib.model.ProfileImport instance with no metadata.
ProfileImport(dev.metaschema.core.model.IMetaschemaData data)	Constructs a new dev.metaschema.oscal.lib.model.ProfileImport 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".
URI	getHref()	Get the "Catalog or Profile Reference".
IncludeAll	getIncludeAll()	Get the "Include All".
List<ControlCommonSelectControlById>	getIncludeControls()	Get the "Select Control".
dev.metaschema.core.model.IMetaschemaData	getMetaschemaData()
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	setHref(URI value)	Set the "Catalog or Profile Reference".
void	setIncludeAll(IncludeAll value)	Set the "Include All".
void	setIncludeControls(List<ControlCommonSelectControlById> value)	Set the "Select Control".
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Details

ProfileImport

public ProfileImport()

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

ProfileImport

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

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

getHref

@NonNull
public URI getHref()

Get the "Catalog or Profile Reference".

A resolvable URL reference to the base catalog or profile that this profile is tailoring.

Returns:

the href value

setHref

public void setHref(@NonNull
 URI value)

Set the "Catalog or Profile Reference".

A resolvable URL reference to the base catalog or profile that this profile is tailoring.

Parameters:

value - the href value to set

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