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
Nested ClassesModifier and TypeClassDescriptionstatic classIdentifies an individual step in a series of steps related to an activity, such as an assessment test or examination procedure. -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionbooleanAdd a newLinkitem to the underlying collection.booleanAdd a newPropertyitem to the underlying collection.booleanAdd a newResponsibleRoleitem to the underlying collection.booleanaddStep(Activity.Step item) Add a newActivity.Stepitem to the underlying collection.gov.nist.secauto.metaschema.core.datatype.markup.MarkupMultilinegetLinks()gov.nist.secauto.metaschema.core.model.IMetaschemaDatagetProps()gov.nist.secauto.metaschema.core.datatype.markup.MarkupMultilinegetSteps()gov.nist.secauto.metaschema.core.datatype.markup.MarkupLinegetTitle()getUuid()booleanremoveLink(Link item) Remove the first matchingLinkitem from the underlying collection.booleanremoveProp(Property item) Remove the first matchingPropertyitem from the underlying collection.booleanRemove 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.core.datatype.markup.MarkupMultiline value) voidvoidvoidvoidsetRemarks(gov.nist.secauto.metaschema.core.datatype.markup.MarkupMultiline value) voidsetResponsibleRoles(List<ResponsibleRole> value) voidsetSteps(List<Activity.Step> value) voidsetTitle(gov.nist.secauto.metaschema.core.datatype.markup.MarkupLine value) voidtoString()
-
Constructor Details
-
Activity
public Activity() -
Activity
-
-
Method Details
-
getMetaschemaData
- Specified by:
getMetaschemaDatain interfacegov.nist.secauto.metaschema.core.model.IBoundObject
-
getUuid
-
setUuid
-
getTitle
-
setTitle
-
getDescription
-
setDescription
-
getProps
-
setProps
-
addProp
Add a newPropertyitem to the underlying collection.- Parameters:
item- the item to add- Returns:
true
-
removeProp
Remove the first matchingPropertyitem from the underlying collection.- Parameters:
item- the item to remove- Returns:
trueif the item was removed orfalseotherwise
-
getLinks
-
setLinks
-
addLink
Add a newLinkitem to the underlying collection.- Parameters:
item- the item to add- Returns:
true
-
removeLink
Remove the first matchingLinkitem from the underlying collection.- Parameters:
item- the item to remove- Returns:
trueif the item was removed orfalseotherwise
-
getSteps
-
setSteps
-
addStep
Add a newActivity.Stepitem to the underlying collection.- Parameters:
item- the item to add- Returns:
true
-
removeStep
Remove the first matchingActivity.Stepitem from the underlying collection.- Parameters:
item- the item to remove- Returns:
trueif the item was removed orfalseotherwise
-
getRelatedControls
-
setRelatedControls
-
getResponsibleRoles
-
setResponsibleRoles
-
addResponsibleRole
Add a newResponsibleRoleitem to the underlying collection.- Parameters:
item- the item to add- Returns:
true
-
removeResponsibleRole
Remove the first matchingResponsibleRoleitem from the underlying collection.- Parameters:
item- the item to remove- Returns:
trueif the item was removed orfalseotherwise
-
getRemarks
-
setRemarks
-
toString
-