Class Metadata.Role

java.lang.Object
gov.nist.secauto.oscal.lib.model.Metadata.Role
All Implemented Interfaces:
gov.nist.secauto.metaschema.core.model.IBoundObject
Enclosing class:
Metadata

@MetaschemaAssembly(formalName="Role", description="Defines a function, which might be assigned to a party in a specific situation.", name="role", moduleClass=OscalMetadataModule.class, remarks="Permissible values to be determined closer to the application (e.g. by a receiving authority).\n\nOSCAL has defined a set of standardized roles for consistent use in OSCAL documents. This allows tools consuming OSCAL content to infer specific semantics when these roles are used. These roles are documented in the specific contexts of their use (e.g., responsible-party, responsible-role). When using such a role, it is necessary to define these roles in this list, which will then allow such a role to be referenced.") public static class Metadata.Role extends Object implements gov.nist.secauto.metaschema.core.model.IBoundObject
Defines a function, which might be assigned to a party in a specific situation.
  • Constructor Details

    • Role

      public Role()
    • Role

      public Role(gov.nist.secauto.metaschema.core.model.IMetaschemaData data)
  • Method Details

    • getMetaschemaData

      public gov.nist.secauto.metaschema.core.model.IMetaschemaData getMetaschemaData()
      Specified by:
      getMetaschemaData in interface gov.nist.secauto.metaschema.core.model.IBoundObject
    • getId

      public String getId()
    • setId

      public void setId(String value)
    • getTitle

      public gov.nist.secauto.metaschema.core.datatype.markup.MarkupLine getTitle()
    • setTitle

      public void setTitle(gov.nist.secauto.metaschema.core.datatype.markup.MarkupLine value)
    • getShortName

      public String getShortName()
    • setShortName

      public void setShortName(String value)
    • getDescription

      public gov.nist.secauto.metaschema.core.datatype.markup.MarkupMultiline getDescription()
    • setDescription

      public void setDescription(gov.nist.secauto.metaschema.core.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
    • getRemarks

      public gov.nist.secauto.metaschema.core.datatype.markup.MarkupMultiline getRemarks()
    • setRemarks

      public void setRemarks(gov.nist.secauto.metaschema.core.datatype.markup.MarkupMultiline value)
    • toString

      public String toString()
      Overrides:
      toString in class Object