Package dev.metaschema.oscal.lib.model

Class ControlPart

java.lang.Object
dev.metaschema.oscal.lib.model.control.AbstractPart
dev.metaschema.oscal.lib.model.ControlPart
All Implemented Interfaces:
dev.metaschema.core.model.IBoundObject, IPart
@MetaschemaAssembly(formalName="Part", description="An annotated, markup-based textual element of a control\'s or catalog group\'s definition, or a child of another part.", name="part", moduleClass=OscalControlCommonModule.class, remarks="A `part` provides for logical partitioning of prose, and can be thought of as a grouping structure (e.g., section). A `part` can have child parts allowing for arbitrary nesting of prose content (e.g., statement hierarchy). A `part` can contain `prop` objects that allow for enriching prose text with structured name/value information.\n\nA `part` can be assigned an optional `id`, which allows references to this part from within a catalog, or within an instance of another OSCAL model that has a need to reference the part. Examples of where part referencing is used in OSCAL include:\n\n- Referencing a part by id to tailor (make modifications to) a control statement in a profile.\n- Referencing a control statement represented by a part in a system security plan implemented-requirement where a statement-level response is desired.\n\nUse of `part` and `prop` provides for a wide degree of extensibility within the OSCAL catalog model. The optional `ns` provides a means to qualify a part\'s `name`, allowing for organization-specific vocabularies to be defined with clear semantics. Any organization that extends OSCAL in this way should consistently assign a `ns` value that represents the organization, making a given namespace qualified `name` unique to that organization. This allows the combination of `ns` and `name` to always be unique and unambiguous, even when mixed with extensions from other organizations. Each organization is responsible for governance of their own extensions, and is strongly encouraged to publish their extensions as standards to their user community. If no `ns` is provided, the name is expected to be in the \"OSCAL\" namespace.\n\nTo ensure a `ns` is unique to an organization and naming conflicts are avoided, a URI containing a DNS or other globally defined organization name should be used. For example, if FedRAMP and DoD both extend OSCAL, FedRAMP will use the `ns` `http://fedramp.gov/ns/oscal`, while DoD might use the `ns` `https://defense.gov` for any organization specific `name`.\n\nTools that process OSCAL content are not required to interpret unrecognized OSCAL extensions; however, OSCAL compliant tools should not modify or remove unrecognized extensions, unless there is a compelling reason to do so, such as data sensitivity.", valueConstraints=@ValueConstraints(allowedValues=@AllowedValues(id="oscal-part-prop-name",level=ERROR,target="prop[has-oscal-namespace(\'http://csrc.nist.gov/ns/oscal\')]/@name",values={@AllowedValue(value="label",description="A human-readable label for the parent context, which may be rendered in place of the actual identifier for some use cases."),@AllowedValue(value="sort-id",description="An alternative identifier, whose value is easily sortable among other such values in the document."),@AllowedValue(value="alt-identifier",description="An alternate or aliased identifier for the parent context.")}))) public class ControlPart extends AbstractPart implements dev.metaschema.core.model.IBoundObject
An annotated, markup-based textual element of a control's or catalog group's definition, or a child of another part.

  • Constructor Details

    • ControlPart

      public ControlPart()
      Constructs a new dev.metaschema.oscal.lib.model.ControlPart instance with no metadata.

    • ControlPart

      public ControlPart(dev.metaschema.core.model.IMetaschemaData data)
      Constructs a new dev.metaschema.oscal.lib.model.ControlPart 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

      @Nullable public String getId()
      Get the "Part Identifier".

      A unique identifier for the part.

      Returns:
      the id value, or null if not set

    • setId

      public void setId(@Nullable String value)
      Set the "Part Identifier".

      A unique identifier for the part.

      Parameters:
      value - the id value to set, or null to clear

    • getName

      @NonNull public String getName()
      Get the "Part Name".

      A textual label that uniquely identifies the part's semantic type, which exists in a value space qualified by the ns.

      Returns:
      the name value

    • setName

      public void setName(@NonNull String value)
      Set the "Part Name".

      A textual label that uniquely identifies the part's semantic type, which exists in a value space qualified by the ns.

      Parameters:
      value - the name value to set

    • getNs

      @Nullable public URI getNs()
      Get the "Part Namespace".

      An optional namespace qualifying the part's name. This allows different organizations to associate distinct semantics with the same name.

      Returns:
      the ns value, or null if not set

    • setNs

      public void setNs(@Nullable URI value)
      Set the "Part Namespace".

      An optional namespace qualifying the part's name. This allows different organizations to associate distinct semantics with the same name.

      Parameters:
      value - the ns value to set, or null to clear

    • getClazz

      @Nullable public String getClazz()
      Get the "Part Class".

      An optional textual providing a sub-type or characterization of the part's name, or a category to which the part belongs.

      Returns:
      the class value, or null if not set

    • setClazz

      public void setClazz(@Nullable String value)
      Set the "Part Class".

      An optional textual providing a sub-type or characterization of the part's name, or a category to which the part belongs.

      Parameters:
      value - the class value to set, or null to clear

    • getTitle

      @Nullable public dev.metaschema.core.datatype.markup.MarkupLine getTitle()
      Get the "Part Title".

      An optional name given to the part, which may be used by a tool for display and navigation.

      Returns:
      the title value, or null if not set

    • setTitle

      public void setTitle(@Nullable dev.metaschema.core.datatype.markup.MarkupLine value)
      Set the "Part Title".

      An optional name given to the part, which may be used by a tool for display and navigation.

      Parameters:
      value - the title 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

    • getProse

      @Nullable public dev.metaschema.core.datatype.markup.MarkupMultiline getProse()
      Get the "Part Text".

      Permits multiple paragraphs, lists, tables etc.

      Specified by:
      getProse in interface IPart
      Returns:
      the prose value, or null if not set

    • setProse

      public void setProse(@Nullable dev.metaschema.core.datatype.markup.MarkupMultiline value)
      Set the "Part Text".

      Permits multiple paragraphs, lists, tables etc.

      Parameters:
      value - the prose value to set, or null to clear

    • getParts

      @NonNull public List<ControlPart> getParts()
      Get the "Part".

      An annotated, markup-based textual element of a control's or catalog group's definition, or a child of another part.

      Specified by:
      getParts in interface IPart
      Returns:
      the part value

    • setParts

      public void setParts(@NonNull List<ControlPart> value)
      Set the "Part".

      An annotated, markup-based textual element of a control's or catalog group's definition, or a child of another part.

      Parameters:
      value - the part value to set

    • addPart

      public boolean addPart(ControlPart item)
      Add a new ControlPart item to the underlying collection.
      Parameters:
      item - the item to add
      Returns:
      true

    • removePart

      public boolean removePart(ControlPart item)
      Remove the first matching ControlPart 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

    • toString

      public String toString()
      Overrides:
      toString in class Object