Package dev.metaschema.oscal.lib.model

Class Task

java.lang.Object
dev.metaschema.oscal.lib.model.Task
All Implemented Interfaces:
dev.metaschema.core.model.IBoundObject
@MetaschemaAssembly(formalName="Task", description="Represents a scheduled event or milestone, which may be associated with a series of assessment actions.", name="task", moduleClass=OscalAssessmentCommonModule.class) public class Task extends Object implements dev.metaschema.core.model.IBoundObject
Represents a scheduled event or milestone, which may be associated with a series of assessment actions.

  • Constructor Details

    • Task

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

    • Task

      public Task(dev.metaschema.core.model.IMetaschemaData data)
      Constructs a new dev.metaschema.oscal.lib.model.Task 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 "Task Universally Unique Identifier".

      A machine-oriented, globally unique identifier with cross-instance scope that can be used to reference this task elsewhere in this or other OSCAL instances. The locally defined UUID of the task can be used to reference the data item locally or globally (e.g., in an imported OSCAL instance). This UUID should be assigned per-subject, which means it should be consistently used to identify the same subject across revisions of the document.

      Returns:
      the uuid value

    • setUuid

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

      A machine-oriented, globally unique identifier with cross-instance scope that can be used to reference this task elsewhere in this or other OSCAL instances. The locally defined UUID of the task can be used to reference the data item locally or globally (e.g., in an imported OSCAL instance). This UUID should be assigned per-subject, which means it should be consistently used to identify the same subject across revisions of the document.

      Parameters:
      value - the uuid value to set

    • getType

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

      The type of task.

      Returns:
      the type value

    • setType

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

      The type of task.

      Parameters:
      value - the type value to set

    • getTitle

      @NonNull public dev.metaschema.core.datatype.markup.MarkupLine getTitle()
      Get the "Task Title".

      The title for this task.

      Returns:
      the title value

    • setTitle

      public void setTitle(@NonNull dev.metaschema.core.datatype.markup.MarkupLine value)
      Set the "Task Title".

      The title for this task.

      Parameters:
      value - the title value to set

    • getDescription

      @Nullable public dev.metaschema.core.datatype.markup.MarkupMultiline getDescription()
      Get the "Task Description".

      A human-readable description of this task.

      Returns:
      the description value, or null if not set

    • setDescription

      public void setDescription(@Nullable dev.metaschema.core.datatype.markup.MarkupMultiline value)
      Set the "Task Description".

      A human-readable description of this task.

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

    • 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

    • getTiming

      @Nullable public Task.Timing getTiming()
      Get the "Event Timing".

      The timing under which the task is intended to occur.

      Returns:
      the timing value, or null if not set

    • setTiming

      public void setTiming(@Nullable Task.Timing value)
      Set the "Event Timing".

      The timing under which the task is intended to occur.

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

    • getDependencies

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

      Used to indicate that a task is dependent on another task.

      Returns:
      the dependency value

    • setDependencies

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

      Used to indicate that a task is dependent on another task.

      Parameters:
      value - the dependency value to set

    • addDependency

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

    • removeDependency

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

    • 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 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 task value to set

    • addTask

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

    • removeTask

      public boolean removeTask(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

    • getAssociatedActivities

      @NonNull public List<Task.AssociatedActivity> getAssociatedActivities()
      Get the "Associated Activity".

      Identifies an individual activity to be performed as part of a task.

      Returns:
      the associated-activity value

    • setAssociatedActivities

      public void setAssociatedActivities(@NonNull List<Task.AssociatedActivity> value)
      Set the "Associated Activity".

      Identifies an individual activity to be performed as part of a task.

      Parameters:
      value - the associated-activity value to set

    • addAssociatedActivity

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

    • removeAssociatedActivity

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

    • getSubjects

      @NonNull public List<AssessmentSubject> getSubjects()
      Get the "Subject of Assessment".

      Identifies system elements being assessed, such as components, inventory items, and locations. In the assessment plan, this identifies a planned assessment subject. In the assessment results this is an actual assessment subject, and reflects any changes from the plan. exactly what will be the focus of this assessment. Any subjects not identified in this way are out-of-scope.

      Returns:
      the subject value

    • setSubjects

      public void setSubjects(@NonNull List<AssessmentSubject> value)
      Set the "Subject of Assessment".

      Identifies system elements being assessed, such as components, inventory items, and locations. In the assessment plan, this identifies a planned assessment subject. In the assessment results this is an actual assessment subject, and reflects any changes from the plan. exactly what will be the focus of this assessment. Any subjects not identified in this way are out-of-scope.

      Parameters:
      value - the subject value to set

    • addSubject

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

    • removeSubject

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

    • getResponsibleRoles

      @NonNull public List<ResponsibleRole> getResponsibleRoles()
      Get the "Responsible Role".

      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.

      Returns:
      the responsible-role value

    • setResponsibleRoles

      public void setResponsibleRoles(@NonNull List<ResponsibleRole> value)
      Set the "Responsible Role".

      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.

      Parameters:
      value - the responsible-role value to set

    • addResponsibleRole

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

    • removeResponsibleRole

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