Package dev.metaschema.oscal.lib.model

Class ResponsibleRole

java.lang.Object
dev.metaschema.oscal.lib.model.ResponsibleRole
All Implemented Interfaces:
dev.metaschema.core.model.IBoundObject
@MetaschemaAssembly(formalName="Responsible Role", description="A reference to a role with responsibility for performing a function relative to the containing object, optionally associated with a set of persons and/or organizations that perform that role.", name="responsible-role", moduleClass=OscalMetadataModule.class, remarks="A `responsible-role` allows zero or more `party-uuid` references, each of which creates a relationship arc between the referenced `role-id` and the referenced party. This differs in semantics from `responsible-party`, which requires that at least one `party-uuid` is referenced.\n\nThe scope of use of this object determines if the responsibility has been performed or will be performed in the future. The containing object will describe the intent.") public class ResponsibleRole extends Object implements dev.metaschema.core.model.IBoundObject
A reference to a role with responsibility for performing a function relative to the containing object, optionally associated with a set of persons and/or organizations that perform that role.

  • Constructor Details

    • ResponsibleRole

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

    • ResponsibleRole

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

    • getRoleId

      @NonNull public String getRoleId()
      Get the "Responsible Role ID".

      A human-oriented identifier reference to a role performed.

      Returns:
      the role-id value

    • setRoleId

      public void setRoleId(@NonNull String value)
      Set the "Responsible Role ID".

      A human-oriented identifier reference to a role performed.

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

    • getPartyUuids

      @NonNull public List<UUID> getPartyUuids()
      Get the "Party Universally Unique Identifier Reference".

      Specifies zero or more parties responsible for performing the associated role.

      Returns:
      the party-uuid value

    • setPartyUuids

      public void setPartyUuids(@NonNull List<UUID> value)
      Set the "Party Universally Unique Identifier Reference".

      Specifies zero or more parties responsible for performing the associated role.

      Parameters:
      value - the party-uuid value to set

    • addPartyUuid

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

    • removePartyUuid

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