Package dev.metaschema.oscal.lib.model

Class MappingResourceReference

java.lang.Object
dev.metaschema.oscal.lib.model.MappingResourceReference
All Implemented Interfaces:
dev.metaschema.core.model.IBoundObject
@MetaschemaAssembly(formalName="Mapped Resource Reference", description="A reference to a resource that is either the source or the target of a mapping.", name="mapping-resource-reference", moduleClass=OscalMappingCommonModule.class) public class MappingResourceReference extends Object implements dev.metaschema.core.model.IBoundObject
A reference to a resource that is either the source or the target of a mapping.

  • Constructor Details

    • MappingResourceReference

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

    • MappingResourceReference

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

    • getNs

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

      An optional namespace qualifying the resource's type.

      Returns:
      the ns value, or null if not set

    • setNs

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

      An optional namespace qualifying the resource's type.

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

    • getType

      @NonNull public String getType()
      Get the "Resource Type".

      The semantic type of the resource.

      Returns:
      the type value

    • setType

      public void setType(@NonNull String value)
      Set the "Resource Type".

      The semantic type of the resource.

      Parameters:
      value - the type value to set

    • 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

    • 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

    • 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