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

Class Metadata.Party

java.lang.Object

gov.nist.secauto.oscal.lib.model.Metadata.Party

All Implemented Interfaces:

gov.nist.secauto.metaschema.core.model.IBoundObject

Enclosing class:

Metadata

@MetaschemaAssembly(formalName="Party",
                    description="An organization or person, which may be associated with roles or other concepts within the current or linked OSCAL document.",
                    name="party",
                    moduleClass=OscalMetadataModule.class,
                    remarks="A party can be optionally associated with either an address or a location. While providing a meaningful location for a party is desired, there are some cases where it might not be possible to provide an exact location or even any location.",
                    valueConstraints=@ValueConstraints(allowedValues=@AllowedValues(level=ERROR,target="prop[has-oscal-namespace(\'http://csrc.nist.gov/ns/oscal\')]/@name",values={@AllowedValue(value="mail-stop",description="A mail stop associated with the party."),@AllowedValue(value="office",description="The name or number of the party\'s office."),@AllowedValue(value="job-title",description="The formal job title of a person.")})))
public static class Metadata.Party
extends Object
implements gov.nist.secauto.metaschema.core.model.IBoundObject

An organization or person, which may be associated with roles or other concepts within the current or linked OSCAL document.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	Metadata.Party.ExternalId	An identifier for a person or organization using a designated scheme. e.g. an Open Researcher and Contributor ID (ORCID).

Constructor Summary

Constructors

Constructor	Description
Party()
Party(gov.nist.secauto.metaschema.core.model.IMetaschemaData data)

Method Summary

Modifier and Type	Method	Description
boolean	addAddress(Address item)	Add a new Address item to the underlying collection.
boolean	addEmailAddress(String item)	Add a new String item to the underlying collection.
boolean	addExternalId(Metadata.Party.ExternalId item)	Add a new Metadata.Party.ExternalId item to the underlying collection.
boolean	addLink(Link item)	Add a new Link item to the underlying collection.
boolean	addLocationUuid(UUID item)	Add a new UUID item to the underlying collection.
boolean	addMemberOfOrganization(UUID item)	Add a new UUID item to the underlying collection.
boolean	addProp(Property item)	Add a new Property item to the underlying collection.
boolean	addTelephoneNumber(TelephoneNumber item)	Add a new TelephoneNumber item to the underlying collection.
List<Address>	getAddresses()
List<String>	getEmailAddresses()
List<Metadata.Party.ExternalId>	getExternalIds()
List<Link>	getLinks()
List<UUID>	getLocationUuids()
List<UUID>	getMemberOfOrganizations()
gov.nist.secauto.metaschema.core.model.IMetaschemaData	getMetaschemaData()
String	getName()
List<Property>	getProps()
gov.nist.secauto.metaschema.core.datatype.markup.MarkupMultiline	getRemarks()
String	getShortName()
List<TelephoneNumber>	getTelephoneNumbers()
String	getType()
UUID	getUuid()
boolean	removeAddress(Address item)	Remove the first matching Address item from the underlying collection.
boolean	removeEmailAddress(String item)	Remove the first matching String item from the underlying collection.
boolean	removeExternalId(Metadata.Party.ExternalId item)	Remove the first matching Metadata.Party.ExternalId item from the underlying collection.
boolean	removeLink(Link item)	Remove the first matching Link item from the underlying collection.
boolean	removeLocationUuid(UUID item)	Remove the first matching UUID item from the underlying collection.
boolean	removeMemberOfOrganization(UUID item)	Remove the first matching UUID item from the underlying collection.
boolean	removeProp(Property item)	Remove the first matching Property item from the underlying collection.
boolean	removeTelephoneNumber(TelephoneNumber item)	Remove the first matching TelephoneNumber item from the underlying collection.
void	setAddresses(List<Address> value)
void	setEmailAddresses(List<String> value)
void	setExternalIds(List<Metadata.Party.ExternalId> value)
void	setLinks(List<Link> value)
void	setLocationUuids(List<UUID> value)
void	setMemberOfOrganizations(List<UUID> value)
void	setName(String value)
void	setProps(List<Property> value)
void	setRemarks(gov.nist.secauto.metaschema.core.datatype.markup.MarkupMultiline value)
void	setShortName(String value)
void	setTelephoneNumbers(List<TelephoneNumber> 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 Details

Party

public Party()

Party

public Party(gov.nist.secauto.metaschema.core.model.IMetaschemaData data)

Method Details

getMetaschemaData

public gov.nist.secauto.metaschema.core.model.IMetaschemaData getMetaschemaData()

Specified by:

getMetaschemaData in interface gov.nist.secauto.metaschema.core.model.IBoundObject

getUuid

public UUID getUuid()

setUuid

public void setUuid(UUID value)

getType

public String getType()

setType

public void setType(String value)

getName

public String getName()

setName

public void setName(String value)

getShortName

public String getShortName()

setShortName

public void setShortName(String value)

getExternalIds

public List<Metadata.Party.ExternalId> getExternalIds()

setExternalIds

public void setExternalIds(List<Metadata.Party.ExternalId> value)

addExternalId

public boolean addExternalId(Metadata.Party.ExternalId item)

Add a new Metadata.Party.ExternalId item to the underlying collection.

Parameters:

item - the item to add

Returns:

true

removeExternalId

public boolean removeExternalId(Metadata.Party.ExternalId item)

Remove the first matching Metadata.Party.ExternalId item from the underlying collection.

Parameters:

item - the item to remove

Returns:

true if the item was removed or false otherwise

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

getEmailAddresses

public List<String> getEmailAddresses()

setEmailAddresses

public void setEmailAddresses(List<String> value)

addEmailAddress

public boolean addEmailAddress(String item)

Add a new String item to the underlying collection.

Parameters:

item - the item to add

Returns:

true

removeEmailAddress

public boolean removeEmailAddress(String item)

Remove the first matching String item from the underlying collection.

Parameters:

item - the item to remove

Returns:

true if the item was removed or false otherwise

getTelephoneNumbers

public List<TelephoneNumber> getTelephoneNumbers()

setTelephoneNumbers

public void setTelephoneNumbers(List<TelephoneNumber> value)

addTelephoneNumber

public boolean addTelephoneNumber(TelephoneNumber item)

Add a new TelephoneNumber item to the underlying collection.

Parameters:

item - the item to add

Returns:

true

removeTelephoneNumber

public boolean removeTelephoneNumber(TelephoneNumber item)

Remove the first matching TelephoneNumber item from the underlying collection.

Parameters:

item - the item to remove

Returns:

true if the item was removed or false otherwise

getAddresses

public List<Address> getAddresses()

setAddresses

public void setAddresses(List<Address> value)

addAddress

public boolean addAddress(Address item)

Add a new Address item to the underlying collection.

Parameters:

item - the item to add

Returns:

true

removeAddress

public boolean removeAddress(Address item)

Remove the first matching Address item from the underlying collection.

Parameters:

item - the item to remove

Returns:

true if the item was removed or false otherwise

getLocationUuids

public List<UUID> getLocationUuids()

setLocationUuids

public void setLocationUuids(List<UUID> value)

addLocationUuid

public boolean addLocationUuid(UUID item)

Add a new UUID item to the underlying collection.

Parameters:

item - the item to add

Returns:

true

removeLocationUuid

public boolean removeLocationUuid(UUID item)

Remove the first matching UUID item from the underlying collection.

Parameters:

item - the item to remove

Returns:

true if the item was removed or false otherwise

getMemberOfOrganizations

public List<UUID> getMemberOfOrganizations()

setMemberOfOrganizations

public void setMemberOfOrganizations(List<UUID> value)

addMemberOfOrganization

public boolean addMemberOfOrganization(UUID item)

Add a new UUID item to the underlying collection.

Parameters:

item - the item to add

Returns:

true

removeMemberOfOrganization

public boolean removeMemberOfOrganization(UUID item)

Remove the first matching UUID 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.core.datatype.markup.MarkupMultiline getRemarks()

setRemarks

public void setRemarks(gov.nist.secauto.metaschema.core.datatype.markup.MarkupMultiline value)

toString

public String toString()

Overrides:

toString in class Object