Package gov.nist.secauto.oscal.lib.model
Class Activity
- java.lang.Object
-
- gov.nist.secauto.oscal.lib.model.Activity
-
@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", metaschema=OscalAssessmentCommonMetaschema.class) @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.")}) @AssemblyConstraints(isUnique=@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."), hasCardinality=@HasCardinality(level=ERROR,target="prop[has-oscal-namespace(\'http://csrc.nist.gov/ns/oscal\') and @name=\'method\']",minOccurs=1)) public class Activity extends ObjectIdentifies 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
Nested Classes Modifier and Type Class Description static classActivity.StepIdentifies an individual step in a series of steps related to an activity, such as an assessment test or examination procedure.
-
Constructor Summary
Constructors Constructor Description Activity()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description booleanaddLink(Link item)Add a newLinkitem to the underlying collection.booleanaddProp(Property item)Add a newPropertyitem to the underlying collection.booleanaddResponsibleRole(ResponsibleRole item)Add a newResponsibleRoleitem to the underlying collection.booleanaddStep(Activity.Step item)Add a newActivity.Stepitem to the underlying collection.gov.nist.secauto.metaschema.model.common.datatype.markup.MarkupMultilinegetDescription()List<Link>getLinks()List<Property>getProps()ReviewedControlsgetRelatedControls()gov.nist.secauto.metaschema.model.common.datatype.markup.MarkupMultilinegetRemarks()List<ResponsibleRole>getResponsibleRoles()List<Activity.Step>getSteps()gov.nist.secauto.metaschema.model.common.datatype.markup.MarkupLinegetTitle()UUIDgetUuid()booleanremoveLink(Link item)Remove the first matchingLinkitem from the underlying collection.booleanremoveProp(Property item)Remove the first matchingPropertyitem from the underlying collection.booleanremoveResponsibleRole(ResponsibleRole item)Remove the first matchingResponsibleRoleitem from the underlying collection.booleanremoveStep(Activity.Step item)Remove the first matchingActivity.Stepitem from the underlying collection.voidsetDescription(gov.nist.secauto.metaschema.model.common.datatype.markup.MarkupMultiline value)voidsetLinks(List<Link> value)voidsetProps(List<Property> value)voidsetRelatedControls(ReviewedControls value)voidsetRemarks(gov.nist.secauto.metaschema.model.common.datatype.markup.MarkupMultiline value)voidsetResponsibleRoles(List<ResponsibleRole> value)voidsetSteps(List<Activity.Step> value)voidsetTitle(gov.nist.secauto.metaschema.model.common.datatype.markup.MarkupLine value)voidsetUuid(UUID value)StringtoString()
-
-
-
Constructor Detail
-
Activity
public Activity()
-
-
Method Detail
-
getTitle
public gov.nist.secauto.metaschema.model.common.datatype.markup.MarkupLine getTitle()
-
setTitle
public void setTitle(gov.nist.secauto.metaschema.model.common.datatype.markup.MarkupLine value)
-
getDescription
public gov.nist.secauto.metaschema.model.common.datatype.markup.MarkupMultiline getDescription()
-
setDescription
public void setDescription(gov.nist.secauto.metaschema.model.common.datatype.markup.MarkupMultiline value)
-
addProp
public boolean addProp(Property item)
Add a newPropertyitem to the underlying collection.- Parameters:
item- the item to add- Returns:
true
-
removeProp
public boolean removeProp(Property item)
Remove the first matchingPropertyitem from the underlying collection.- Parameters:
item- the item to remove- Returns:
trueif the item was removed orfalseotherwise
-
addLink
public boolean addLink(Link item)
Add a newLinkitem to the underlying collection.- Parameters:
item- the item to add- Returns:
true
-
removeLink
public boolean removeLink(Link item)
Remove the first matchingLinkitem from the underlying collection.- Parameters:
item- the item to remove- Returns:
trueif the item was removed orfalseotherwise
-
getSteps
public List<Activity.Step> getSteps()
-
setSteps
public void setSteps(List<Activity.Step> value)
-
addStep
public boolean addStep(Activity.Step item)
Add a newActivity.Stepitem to the underlying collection.- Parameters:
item- the item to add- Returns:
true
-
removeStep
public boolean removeStep(Activity.Step item)
Remove the first matchingActivity.Stepitem from the underlying collection.- Parameters:
item- the item to remove- Returns:
trueif the item was removed orfalseotherwise
-
getRelatedControls
public ReviewedControls getRelatedControls()
-
setRelatedControls
public void setRelatedControls(ReviewedControls value)
-
getResponsibleRoles
public List<ResponsibleRole> getResponsibleRoles()
-
setResponsibleRoles
public void setResponsibleRoles(List<ResponsibleRole> value)
-
addResponsibleRole
public boolean addResponsibleRole(ResponsibleRole item)
Add a newResponsibleRoleitem to the underlying collection.- Parameters:
item- the item to add- Returns:
true
-
removeResponsibleRole
public boolean removeResponsibleRole(ResponsibleRole item)
Remove the first matchingResponsibleRoleitem from the underlying collection.- Parameters:
item- the item to remove- Returns:
trueif the item was removed orfalseotherwise
-
getRemarks
public gov.nist.secauto.metaschema.model.common.datatype.markup.MarkupMultiline getRemarks()
-
setRemarks
public void setRemarks(gov.nist.secauto.metaschema.model.common.datatype.markup.MarkupMultiline value)
-
-