Package dev.metaschema.oscal.lib.model

Class Result.LocalDefinitions

java.lang.Object
dev.metaschema.oscal.lib.model.Result.LocalDefinitions
All Implemented Interfaces:
dev.metaschema.core.model.IBoundObject
Enclosing class:
Result
@MetaschemaAssembly(formalName="Local Definitions", description="Used to define data objects that are used in the assessment plan, that do not appear in the referenced SSP.", name="local-definitions", moduleClass=OscalArModule.class, modelConstraints=@IsUnique(id="oscal-unique-ar-local-definitions-component",level=ERROR,target="component",keyFields=@KeyField(target="@uuid"),remarks="Since multiple `component` entries can be provided, each component must have a unique `uuid`.") @IsUnique(id="oscal-unique-ar-local-definitions-user",level=ERROR,target="user",keyFields=@KeyField(target="@uuid"),remarks="A given `uuid` must be assigned only once to a user.")) public static class Result.LocalDefinitions extends Object implements dev.metaschema.core.model.IBoundObject
Used to define data objects that are used in the assessment plan, that do not appear in the referenced SSP.

  • Constructor Details

    • LocalDefinitions

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

    • LocalDefinitions

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

    • getComponents

      @NonNull public List<SystemComponent> getComponents()
      Get the "Component".

      A defined component that can be part of an implemented system.

      Returns:
      the component value

    • setComponents

      public void setComponents(@NonNull List<SystemComponent> value)
      Set the "Component".

      A defined component that can be part of an implemented system.

      Parameters:
      value - the component value to set

    • addComponent

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

    • removeComponent

      public boolean removeComponent(SystemComponent item)
      Remove the first matching SystemComponent item from the underlying collection.
      Parameters:
      item - the item to remove
      Returns:
      true if the item was removed or false otherwise

    • getInventoryItems

      @NonNull public List<InventoryItem> getInventoryItems()
      Get the "Inventory Item".

      A single managed inventory item within the system.

      Returns:
      the inventory-item value

    • setInventoryItems

      public void setInventoryItems(@NonNull List<InventoryItem> value)
      Set the "Inventory Item".

      A single managed inventory item within the system.

      Parameters:
      value - the inventory-item value to set

    • addInventoryItem

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

    • removeInventoryItem

      public boolean removeInventoryItem(InventoryItem item)
      Remove the first matching InventoryItem item from the underlying collection.
      Parameters:
      item - the item to remove
      Returns:
      true if the item was removed or false otherwise

    • getUsers

      @NonNull public List<SystemUser> getUsers()
      Get the "System User".

      A type of user that interacts with the system based on an associated role.

      Returns:
      the user value

    • setUsers

      public void setUsers(@NonNull List<SystemUser> value)
      Set the "System User".

      A type of user that interacts with the system based on an associated role.

      Parameters:
      value - the user value to set

    • addUser

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

    • removeUser

      public boolean removeUser(SystemUser item)
      Remove the first matching SystemUser item from the underlying collection.
      Parameters:
      item - the item to remove
      Returns:
      true if the item was removed or false otherwise

    • getAssessmentAssets

      @Nullable public AssessmentAssets getAssessmentAssets()
      Get the "Assessment Assets".

      Identifies the assets used to perform this assessment, such as the assessment team, scanning tools, and assumptions.

      Returns:
      the assessment-assets value, or null if not set

    • setAssessmentAssets

      public void setAssessmentAssets(@Nullable AssessmentAssets value)
      Set the "Assessment Assets".

      Identifies the assets used to perform this assessment, such as the assessment team, scanning tools, and assumptions.

      Parameters:
      value - the assessment-assets value to set, or null to clear

    • getTasks

      @NonNull public List<Task> getTasks()
      Get the "Task".

      Represents a scheduled event or milestone, which may be associated with a series of assessment actions.

      Returns:
      the assessment-task value

    • setTasks

      public void setTasks(@NonNull List<Task> value)
      Set the "Task".

      Represents a scheduled event or milestone, which may be associated with a series of assessment actions.

      Parameters:
      value - the assessment-task value to set

    • addAssessmentTask

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

    • removeAssessmentTask

      public boolean removeAssessmentTask(Task item)
      Remove the first matching Task item from the underlying collection.
      Parameters:
      item - the item to remove
      Returns:
      true if the item was removed or false otherwise

    • toString

      public String toString()
      Overrides:
      toString in class Object