Package gov.nist.secauto.oscal.lib.model
Class Activity
java.lang.Object
gov.nist.secauto.oscal.lib.model.Activity
- All Implemented Interfaces:
gov.nist.secauto.metaschema.core.model.IBoundObject
@MetaschemaAssembly(formalName="Activity",
description="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.",
name="activity",
moduleClass=OscalAssessmentCommonModule.class,
valueConstraints=@AllowedValues(level=ERROR,target="prop[has-oscal-namespace(\'http://csrc.nist.gov/ns/oscal\')]/@name",values=@AllowedValue(value="method",description="The assessment method to use. This typically appears on parts with the name \"assessment\".")) @AllowedValues(level=ERROR,target="prop[has-oscal-namespace(\'http://csrc.nist.gov/ns/oscal\') and @name=\'method\']/@value",values={@AllowedValue(value="INTERVIEW",description="The process of holding discussions with individuals or groups of individuals within an organization to once again, facilitate assessor understanding, achieve clarification, or obtain evidence."),@AllowedValue(value="EXAMINE",description="The process of reviewing, inspecting, observing, studying, or analyzing one or more assessment objects (i.e., specifications, mechanisms, or activities)."),@AllowedValue(value="TEST",description="The process of exercising one or more assessment objects (i.e., activities or mechanisms) under specified conditions to compare actual with expected behavior.")}),
modelConstraints=@AssemblyConstraints(unique=@IsUnique(id="unique-activity-responsible-role",level=ERROR,target="responsible-role",keyFields=@KeyField(target="@role-id"),remarks="Since `responsible-role` associates multiple `party-uuid` entries with a single `role-id`, each role-id must be referenced only once."),cardinality=@HasCardinality(level=ERROR,target="prop[has-oscal-namespace(\'http://csrc.nist.gov/ns/oscal\') and @name=\'method\']",minOccurs=1)))
public class Activity
extends Object
implements gov.nist.secauto.metaschema.core.model.IBoundObject
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.
-
Nested Class Summary
Modifier and TypeClassDescriptionstatic class
Identifies an individual step in a series of steps related to an activity, such as an assessment test or examination procedure. -
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionboolean
Add a newLink
item to the underlying collection.boolean
Add a newProperty
item to the underlying collection.boolean
Add a newResponsibleRole
item to the underlying collection.boolean
addStep
(Activity.Step item) Add a newActivity.Step
item to the underlying collection.gov.nist.secauto.metaschema.core.datatype.markup.MarkupMultiline
getLinks()
gov.nist.secauto.metaschema.core.model.IMetaschemaData
getProps()
gov.nist.secauto.metaschema.core.datatype.markup.MarkupMultiline
getSteps()
gov.nist.secauto.metaschema.core.datatype.markup.MarkupLine
getTitle()
getUuid()
boolean
removeLink
(Link item) Remove the first matchingLink
item from the underlying collection.boolean
removeProp
(Property item) Remove the first matchingProperty
item from the underlying collection.boolean
Remove the first matchingResponsibleRole
item from the underlying collection.boolean
removeStep
(Activity.Step item) Remove the first matchingActivity.Step
item from the underlying collection.void
setDescription
(gov.nist.secauto.metaschema.core.datatype.markup.MarkupMultiline value) void
void
void
void
setRemarks
(gov.nist.secauto.metaschema.core.datatype.markup.MarkupMultiline value) void
setResponsibleRoles
(List<ResponsibleRole> value) void
setSteps
(List<Activity.Step> value) void
setTitle
(gov.nist.secauto.metaschema.core.datatype.markup.MarkupLine value) void
toString()
-
Constructor Details
-
Activity
public Activity() -
Activity
-
-
Method Details
-
getMetaschemaData
- Specified by:
getMetaschemaData
in interfacegov.nist.secauto.metaschema.core.model.IBoundObject
-
getUuid
-
setUuid
-
getTitle
-
setTitle
-
getDescription
-
setDescription
-
getProps
-
setProps
-
addProp
Add a newProperty
item to the underlying collection.- Parameters:
item
- the item to add- Returns:
true
-
removeProp
Remove the first matchingProperty
item from the underlying collection.- Parameters:
item
- the item to remove- Returns:
true
if the item was removed orfalse
otherwise
-
getLinks
-
setLinks
-
addLink
Add a newLink
item to the underlying collection.- Parameters:
item
- the item to add- Returns:
true
-
removeLink
Remove the first matchingLink
item from the underlying collection.- Parameters:
item
- the item to remove- Returns:
true
if the item was removed orfalse
otherwise
-
getSteps
-
setSteps
-
addStep
Add a newActivity.Step
item to the underlying collection.- Parameters:
item
- the item to add- Returns:
true
-
removeStep
Remove the first matchingActivity.Step
item from the underlying collection.- Parameters:
item
- the item to remove- Returns:
true
if the item was removed orfalse
otherwise
-
getRelatedControls
-
setRelatedControls
-
getResponsibleRoles
-
setResponsibleRoles
-
addResponsibleRole
Add a newResponsibleRole
item to the underlying collection.- Parameters:
item
- the item to add- Returns:
true
-
removeResponsibleRole
Remove the first matchingResponsibleRole
item from the underlying collection.- Parameters:
item
- the item to remove- Returns:
true
if the item was removed orfalse
otherwise
-
getRemarks
-
setRemarks
-
toString
-