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 ObjectA 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 booleanaddEmailAddress(String item)Add a newStringitem to the underlying collection.booleanaddLink(Link item)Add a newLinkitem to the underlying collection.booleanaddProp(Property item)Add a newPropertyitem to the underlying collection.booleanaddTelephoneNumber(TelephoneNumber item)Add a newTelephoneNumberitem to the underlying collection.booleanaddUrl(URI item)Add a newURIitem to the underlying collection.AddressgetAddress()List<String>getEmailAddresses()List<Link>getLinks()List<Property>getProps()gov.nist.secauto.metaschema.model.common.datatype.markup.MarkupMultilinegetRemarks()List<TelephoneNumber>getTelephoneNumbers()gov.nist.secauto.metaschema.model.common.datatype.markup.MarkupLinegetTitle()List<URI>getUrls()UUIDgetUuid()booleanremoveEmailAddress(String item)Remove the first matchingStringitem from the underlying collection.booleanremoveLink(Link item)Remove the first matchingLinkitem from the underlying collection.booleanremoveProp(Property item)Remove the first matchingPropertyitem from the underlying collection.booleanremoveTelephoneNumber(TelephoneNumber item)Remove the first matchingTelephoneNumberitem from the underlying collection.booleanremoveUrl(URI item)Remove the first matchingURIitem from the underlying collection.voidsetAddress(Address value)voidsetEmailAddresses(List<String> value)voidsetLinks(List<Link> value)voidsetProps(List<Property> value)voidsetRemarks(gov.nist.secauto.metaschema.model.common.datatype.markup.MarkupMultiline value)voidsetTelephoneNumbers(List<TelephoneNumber> value)voidsetTitle(gov.nist.secauto.metaschema.model.common.datatype.markup.MarkupLine value)voidsetUrls(List<URI> value)voidsetUuid(UUID value)StringtoString()
-
-
-
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 newStringitem to the underlying collection.- Parameters:
item- the item to add- Returns:
true
-
removeEmailAddress
public boolean removeEmailAddress(String item)
Remove the first matchingStringitem from the underlying collection.- Parameters:
item- the item to remove- Returns:
trueif the item was removed orfalseotherwise
-
getTelephoneNumbers
public List<TelephoneNumber> getTelephoneNumbers()
-
setTelephoneNumbers
public void setTelephoneNumbers(List<TelephoneNumber> value)
-
addTelephoneNumber
public boolean addTelephoneNumber(TelephoneNumber item)
Add a newTelephoneNumberitem to the underlying collection.- Parameters:
item- the item to add- Returns:
true
-
removeTelephoneNumber
public boolean removeTelephoneNumber(TelephoneNumber item)
Remove the first matchingTelephoneNumberitem from the underlying collection.- Parameters:
item- the item to remove- Returns:
trueif the item was removed orfalseotherwise
-
addUrl
public boolean addUrl(URI item)
Add a newURIitem to the underlying collection.- Parameters:
item- the item to add- Returns:
true
-
removeUrl
public boolean removeUrl(URI item)
Remove the first matchingURIitem from the underlying collection.- Parameters:
item- the item to remove- Returns:
trueif the item was removed orfalseotherwise
-
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
-
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)
-
-