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

Class DataFlow

java.lang.Object

gov.nist.secauto.oscal.lib.model.DataFlow

@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",
                    metaschema=OscalSspMetaschema.class)
@AssemblyConstraints(isUnique=@IsUnique(id="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

A description of the logical flow of information within the system and across its boundaries, optionally supplemented by diagrams that illustrate these flows.

Constructor Summary

Constructors

Constructor	Description
DataFlow()

Method Summary

Modifier and Type	Method	Description
boolean	addDiagram(Diagram item)	Add a new Diagram item to the underlying collection.
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.
gov.nist.secauto.metaschema.model.common.datatype.markup.MarkupMultiline	getDescription()
List<Diagram>	getDiagrams()
List<Link>	getLinks()
List<Property>	getProps()
gov.nist.secauto.metaschema.model.common.datatype.markup.MarkupMultiline	getRemarks()
boolean	removeDiagram(Diagram item)	Remove the first matching Diagram item from the underlying collection.
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.
void	setDescription(gov.nist.secauto.metaschema.model.common.datatype.markup.MarkupMultiline value)
void	setDiagrams(List<Diagram> value)
void	setLinks(List<Link> value)
void	setProps(List<Property> value)
void	setRemarks(gov.nist.secauto.metaschema.model.common.datatype.markup.MarkupMultiline value)
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

DataFlow

public DataFlow()

Method Detail

getDescription

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

setDescription

public void setDescription(gov.nist.secauto.metaschema.model.common.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

getDiagrams

public List<Diagram> getDiagrams()

setDiagrams

public void setDiagrams(List<Diagram> value)

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

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

setRemarks

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

toString

public String toString()

Overrides:

toString in class Object