Package dev.metaschema.oscal.lib.model

Class Action

java.lang.Object
dev.metaschema.oscal.lib.model.Action
All Implemented Interfaces:
dev.metaschema.core.model.IBoundObject
@MetaschemaAssembly(formalName="Action", description="An action applied by a role within a given party to the content.", name="action", moduleClass=OscalMetadataModule.class, valueConstraints=@ValueConstraints(allowedValues={@AllowedValues(id="oscal-metadata-action-system-values",level=ERROR,target="./system/@value",allowOthers=true,values=@AllowedValue(value="http://csrc.nist.gov/ns/oscal",description="This value identifies action types defined in the NIST OSCAL namespace.")),@AllowedValues(id="oscal-metadata-action-type-values",level=ERROR,target="./type[has-oscal-namespace(\'http://csrc.nist.gov/ns/oscal\')]/@value",values={@AllowedValue(value="approval",description="An approval of a document instance\'s content."),@AllowedValue(value="request-changes",description="A request from the responsible party or parties to change the content.")})},indexHasKey={@IndexHasKey(id="oscal-metadata-action-name-index-metadata-role-id",level=ERROR,target="responsible-party",indexName="index-metadata-role-id",keyFields=@KeyField(target="@role-id")),@IndexHasKey(id="oscal-metadata-action-name-index-metadata-party-uuid",level=ERROR,target="responsible-party",indexName="index-metadata-party-uuid",keyFields=@KeyField(target="party-uuid"))})) public class Action extends Object implements dev.metaschema.core.model.IBoundObject
An action applied by a role within a given party to the content.

  • Constructor Details

    • Action

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

    • Action

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

    • getUuid

      @NonNull public UUID getUuid()
      Get the "Action Universally Unique Identifier".

      A unique identifier that can be used to reference this defined action elsewhere in an OSCAL document. A UUID should be consistently used for a given location across revisions of the document.

      Returns:
      the uuid value

    • setUuid

      public void setUuid(@NonNull UUID value)
      Set the "Action Universally Unique Identifier".

      A unique identifier that can be used to reference this defined action elsewhere in an OSCAL document. A UUID should be consistently used for a given location across revisions of the document.

      Parameters:
      value - the uuid value to set

    • getDate

      @Nullable public ZonedDateTime getDate()
      Get the "Action Occurrence Date".

      The date and time when the action occurred.

      Returns:
      the date value, or null if not set

    • setDate

      public void setDate(@Nullable ZonedDateTime value)
      Set the "Action Occurrence Date".

      The date and time when the action occurred.

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

    • getType

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

      The type of action documented by the assembly, such as an approval.

      Returns:
      the type value

    • setType

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

      The type of action documented by the assembly, such as an approval.

      Parameters:
      value - the type value to set

    • getSystem

      @NonNull public URI getSystem()
      Get the "Action Type System".

      Specifies the action type system used.

      Returns:
      the system value

    • setSystem

      public void setSystem(@NonNull URI value)
      Set the "Action Type System".

      Specifies the action type system used.

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

    • getResponsibleParties

      @NonNull public List<ResponsibleParty> getResponsibleParties()
      Get the "Responsible Party".

      A reference to a set of persons and/or organizations that have responsibility for performing the referenced role in the context of the containing object.

      Returns:
      the responsible-party value

    • setResponsibleParties

      public void setResponsibleParties(@NonNull List<ResponsibleParty> value)
      Set the "Responsible Party".

      A reference to a set of persons and/or organizations that have responsibility for performing the referenced role in the context of the containing object.

      Parameters:
      value - the responsible-party value to set

    • addResponsibleParty

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

    • removeResponsibleParty

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