Package dev.metaschema.oscal.lib.model

Class DataFlow

java.lang.Object
dev.metaschema.oscal.lib.model.DataFlow
All Implemented Interfaces:
dev.metaschema.core.model.IBoundObject
@MetaschemaAssembly(formalName="Data Flow", description="A description of the logical flow of information within the system and across its boundaries, optionally supplemented by diagrams that illustrate these flows.", name="data-flow", moduleClass=OscalSspModule.class, modelConstraints=@AssemblyConstraints(unique=@IsUnique(id="oscal-unique-ssp-data-flow-diagram",level=ERROR,target="diagram",keyFields=@KeyField(target="@uuid"),remarks="A given `uuid` must be assigned only once to a diagram."))) public class DataFlow extends Object implements dev.metaschema.core.model.IBoundObject
A description of the logical flow of information within the system and across its boundaries, optionally supplemented by diagrams that illustrate these flows.

  • Constructor Details

    • DataFlow

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

    • DataFlow

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

    • getDescription

      @NonNull public dev.metaschema.core.datatype.markup.MarkupMultiline getDescription()
      Get the "Data Flow Description".

      A summary of the system's data flow.

      Returns:
      the description value

    • setDescription

      public void setDescription(@NonNull dev.metaschema.core.datatype.markup.MarkupMultiline value)
      Set the "Data Flow Description".

      A summary of the system's data flow.

      Parameters:
      value - the description value to set

    • 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

    • getDiagrams

      @NonNull public List<Diagram> getDiagrams()
      Get the "Diagram".

      A graphic that provides a visual representation the system, or some aspect of it.

      Returns:
      the diagram value

    • setDiagrams

      public void setDiagrams(@NonNull List<Diagram> value)
      Set the "Diagram".

      A graphic that provides a visual representation the system, or some aspect of it.

      Parameters:
      value - the diagram value to set

    • addDiagram

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

    • removeDiagram

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