Package gov.nist.secauto.oscal.lib.model
Class Metadata.Location
- java.lang.Object
-
- gov.nist.secauto.oscal.lib.model.Metadata.Location
-
- Enclosing class:
- Metadata
@MetaschemaAssembly(formalName="Location", description="A physical point of presence, which may be associated with people, organizations, or other concepts within the current or linked OSCAL document.", name="location", metaschema=OscalMetadataMetaschema.class, remarks="An address might be sensitive in nature. In such cases a title, mailing address, email-address, and/or phone number may be used instead.") @AllowedValues(level=ERROR,target="prop[has-oscal-namespace(\'http://csrc.nist.gov/ns/oscal\')]/@name",values=@AllowedValue(value="type",description="Characterizes the kind of location.")) @AllowedValues(level=ERROR,target="prop[has-oscal-namespace(\'http://csrc.nist.gov/ns/oscal\') and @name=\'type\']/@value",values=@AllowedValue(value="data-center",description="A location that contains computing assets. A `class` can be used to indicate the sub-type of data-center as *primary* or *alternate*.")) @AllowedValues(level=ERROR,target="prop[has-oscal-namespace(\'http://csrc.nist.gov/ns/oscal\') and @name=\'type\' and @value=\'data-center\']/@class",values={@AllowedValue(value="primary",description="The location is a data-center used for normal operations."),@AllowedValue(value="alternate",description="The location is a data-center used for fail-over or backup operations.")}) @HasCardinality(level=WARNING,target="address",minOccurs=1) @HasCardinality(level=ERROR,target="title|address|email-address|telephone-number",minOccurs=1) public static class Metadata.Location extends Object
A physical point of presence, which may be associated with people, organizations, or other concepts within the current or linked OSCAL document.
-
-
Constructor Summary
Constructors Constructor Description Location()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description boolean
addEmailAddress(String item)
Add a newString
item to the underlying collection.boolean
addLink(Link item)
Add a newLink
item to the underlying collection.boolean
addProp(Property item)
Add a newProperty
item to the underlying collection.boolean
addTelephoneNumber(TelephoneNumber item)
Add a newTelephoneNumber
item to the underlying collection.boolean
addUrl(URI item)
Add a newURI
item to the underlying collection.Address
getAddress()
List<String>
getEmailAddresses()
List<Link>
getLinks()
List<Property>
getProps()
gov.nist.secauto.metaschema.model.common.datatype.markup.MarkupMultiline
getRemarks()
List<TelephoneNumber>
getTelephoneNumbers()
gov.nist.secauto.metaschema.model.common.datatype.markup.MarkupLine
getTitle()
List<URI>
getUrls()
UUID
getUuid()
boolean
removeEmailAddress(String item)
Remove the first matchingString
item from the underlying collection.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
removeTelephoneNumber(TelephoneNumber item)
Remove the first matchingTelephoneNumber
item from the underlying collection.boolean
removeUrl(URI item)
Remove the first matchingURI
item from the underlying collection.void
setAddress(Address value)
void
setEmailAddresses(List<String> value)
void
setLinks(List<Link> value)
void
setProps(List<Property> value)
void
setRemarks(gov.nist.secauto.metaschema.model.common.datatype.markup.MarkupMultiline value)
void
setTelephoneNumbers(List<TelephoneNumber> value)
void
setTitle(gov.nist.secauto.metaschema.model.common.datatype.markup.MarkupLine value)
void
setUrls(List<URI> value)
void
setUuid(UUID value)
String
toString()
-
-
-
Constructor Detail
-
Location
public Location()
-
-
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)
-
getAddress
public Address getAddress()
-
setAddress
public void setAddress(Address value)
-
getEmailAddresses
public List<String> getEmailAddresses()
-
setEmailAddresses
public void setEmailAddresses(List<String> value)
-
addEmailAddress
public boolean addEmailAddress(String item)
Add a newString
item to the underlying collection.- Parameters:
item
- the item to add- Returns:
true
-
removeEmailAddress
public boolean removeEmailAddress(String item)
Remove the first matchingString
item from the underlying collection.- Parameters:
item
- the item to remove- Returns:
true
if the item was removed orfalse
otherwise
-
getTelephoneNumbers
public List<TelephoneNumber> getTelephoneNumbers()
-
setTelephoneNumbers
public void setTelephoneNumbers(List<TelephoneNumber> value)
-
addTelephoneNumber
public boolean addTelephoneNumber(TelephoneNumber item)
Add a newTelephoneNumber
item to the underlying collection.- Parameters:
item
- the item to add- Returns:
true
-
removeTelephoneNumber
public boolean removeTelephoneNumber(TelephoneNumber item)
Remove the first matchingTelephoneNumber
item from the underlying collection.- Parameters:
item
- the item to remove- Returns:
true
if the item was removed orfalse
otherwise
-
addUrl
public boolean addUrl(URI item)
Add a newURI
item to the underlying collection.- Parameters:
item
- the item to add- Returns:
true
-
removeUrl
public boolean removeUrl(URI item)
Remove the first matchingURI
item from the underlying collection.- Parameters:
item
- the item to remove- Returns:
true
if the item was removed orfalse
otherwise
-
addProp
public boolean addProp(Property item)
Add a newProperty
item to the underlying collection.- Parameters:
item
- the item to add- Returns:
true
-
removeProp
public boolean removeProp(Property item)
Remove the first matchingProperty
item from the underlying collection.- Parameters:
item
- the item to remove- Returns:
true
if the item was removed orfalse
otherwise
-
addLink
public boolean addLink(Link item)
Add a newLink
item to the underlying collection.- Parameters:
item
- the item to add- Returns:
true
-
removeLink
public boolean removeLink(Link item)
Remove the first matchingLink
item from the underlying collection.- Parameters:
item
- the item to remove- Returns:
true
if the item was removed orfalse
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)
-
-