Package gov.nist.secauto.oscal.lib.model

Class Action

java.lang.Object

gov.nist.secauto.oscal.lib.model.Action

@MetaschemaAssembly(formalName="Action",
                    description="An action applied by a role within a given party to the content.",
                    name="action",
                    metaschema=OscalMetadataMetaschema.class)
@ValueConstraints(allowedValues={@AllowedValues(level=ERROR,target="./system/@value",allowOthers=true,values=@AllowedValue(value="http://csrc.nist.gov/ns/oscal",description="This value identifies action types defined in the NIST OSCAL namespace.")),@AllowedValues(level=ERROR,target="./type[has-oscal-namespace(\'http://csrc.nist.gov/ns/oscal\')]/@value",values={@AllowedValue(value="approval",description="An approval of a document instance\'s content."),@AllowedValue(value="request-changes",description="A request from the responisble party or parties to change the content.")})},indexHasKey={@IndexHasKey(level=ERROR,target="responsible-party",indexName="index-metadata-role-id",keyFields=@KeyField(target="@role-id")),@IndexHasKey(level=ERROR,target="responsible-party",indexName="index-metadata-party-uuid",keyFields=@KeyField(target="party-uuid"))})
public class Action
extends Object

An action applied by a role within a given party to the content.

Constructor Summary

Constructors

Constructor	Description
Action()

Method Summary

Modifier and Type	Method	Description
boolean	addLink(Link item)	Add a new Link item to the underlying collection.
boolean	addProp(Property item)	Add a new Property item to the underlying collection.
boolean	addResponsibleParty(ResponsibleParty item)	Add a new ResponsibleParty item to the underlying collection.
ZonedDateTime	getDate()
List<Link>	getLinks()
List<Property>	getProps()
gov.nist.secauto.metaschema.model.common.datatype.markup.MarkupMultiline	getRemarks()
List<ResponsibleParty>	getResponsibleParties()
URI	getSystem()
String	getType()
UUID	getUuid()
boolean	removeLink(Link item)	Remove the first matching Link item from the underlying collection.
boolean	removeProp(Property item)	Remove the first matching Property item from the underlying collection.
boolean	removeResponsibleParty(ResponsibleParty item)	Remove the first matching ResponsibleParty item from the underlying collection.
void	setDate(ZonedDateTime value)
void	setLinks(List<Link> value)
void	setProps(List<Property> value)
void	setRemarks(gov.nist.secauto.metaschema.model.common.datatype.markup.MarkupMultiline value)
void	setResponsibleParties(List<ResponsibleParty> value)
void	setSystem(URI value)
void	setType(String value)
void	setUuid(UUID value)
String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

Action

public Action()

Method Detail

getUuid

public UUID getUuid()

setUuid

public void setUuid(UUID value)

getDate

public ZonedDateTime getDate()

setDate

public void setDate(ZonedDateTime value)

getType

public String getType()

setType

public void setType(String value)

getSystem

public URI getSystem()

setSystem

public void setSystem(URI value)

getProps

public List<Property> getProps()

setProps

public void setProps(List<Property> value)

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

public List<Link> getLinks()

setLinks

public void setLinks(List<Link> value)

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

getResponsibleParties

public List<ResponsibleParty> getResponsibleParties()

setResponsibleParties

public void setResponsibleParties(List<ResponsibleParty> value)

addResponsibleParty

public boolean addResponsibleParty(ResponsibleParty item)

Add a new ResponsibleParty item to the underlying collection.

Parameters:

item - the item to add

Returns:

true

removeResponsibleParty

public boolean removeResponsibleParty(ResponsibleParty item)

Remove the first matching ResponsibleParty item from the underlying collection.

Parameters:

item - the item to remove

Returns:

true if the item was removed or false otherwise

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)

toString

public String toString()

Overrides:

toString in class Object