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

Class Metadata.Location

java.lang.Object
gov.nist.secauto.oscal.lib.model.Metadata.Location
All Implemented Interfaces:
gov.nist.secauto.metaschema.core.model.IBoundObject
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", moduleClass=OscalMetadataModule.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.", valueConstraints=@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.")}), modelConstraints=@HasCardinality(description="In most cases, it is useful to define a location. In some cases, defining an explicit location may represent a security risk.",level=WARNING,target="address",minOccurs=1) @HasCardinality(description="A location must have at least a title, address, email-address, or telephone number.",level=ERROR,target="title|address|email-address|telephone-number",minOccurs=1)) public static class Metadata.Location extends Object implements gov.nist.secauto.metaschema.core.model.IBoundObject
A physical point of presence, which may be associated with people, organizations, or other concepts within the current or linked OSCAL document.

  • Constructor Details

    • Location

      public Location()

    • Location

      public Location(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)

    • getTitle

      public gov.nist.secauto.metaschema.core.datatype.markup.MarkupLine getTitle()

    • setTitle

      public void setTitle(gov.nist.secauto.metaschema.core.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 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

    • getUrls

      public List<URI> getUrls()

    • setUrls

      public void setUrls(List<URI> value)

    • addUrl

      public boolean addUrl(URI item)
      Add a new URI item to the underlying collection.
      Parameters:
      item - the item to add
      Returns:
      true

    • removeUrl

      public boolean removeUrl(URI item)
      Remove the first matching URI 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

    • 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