Package dev.metaschema.oscal.lib.model

Class AssessmentPlan.LocalDefinitions

java.lang.Object
dev.metaschema.oscal.lib.model.AssessmentPlan.LocalDefinitions
All Implemented Interfaces:
dev.metaschema.core.model.IBoundObject
Enclosing class:
AssessmentPlan
@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=OscalApModule.class, modelConstraints=@IsUnique(id="oscal-unique-ap-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-ap-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 AssessmentPlan.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.AssessmentPlan.LocalDefinitions instance with no metadata.

    • LocalDefinitions

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

    • getObjectivesAndMethods

      @NonNull public List<LocalObjective> getObjectivesAndMethods()
      Get the "Assessment-Specific Control Objective".

      A local definition of a control objective for this assessment. Uses catalog syntax for control objective and assessment actions.

      Returns:
      the objectives-and-methods value

    • setObjectivesAndMethods

      public void setObjectivesAndMethods(@NonNull List<LocalObjective> value)
      Set the "Assessment-Specific Control Objective".

      A local definition of a control objective for this assessment. Uses catalog syntax for control objective and assessment actions.

      Parameters:
      value - the objectives-and-methods value to set

    • addObjectivesAndMethods

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

    • removeObjectivesAndMethods

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

    • getActivities

      @NonNull public List<Activity> getActivities()
      Get the "Activity".

      Identifies an assessment or related process that can be performed. In the assessment plan, this is an intended activity which may be associated with an assessment task. In the assessment results, this an activity that was actually performed as part of an assessment.

      Returns:
      the activity value

    • setActivities

      public void setActivities(@NonNull List<Activity> value)
      Set the "Activity".

      Identifies an assessment or related process that can be performed. In the assessment plan, this is an intended activity which may be associated with an assessment task. In the assessment results, this an activity that was actually performed as part of an assessment.

      Parameters:
      value - the activity value to set

    • addActivity

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

    • removeActivity

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