Class 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.
    • 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)
      • 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
      • 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
      • 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
      • 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
      • 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.model.common.datatype.markup.MarkupMultiline getRemarks()
      • setRemarks

        public void setRemarks​(gov.nist.secauto.metaschema.model.common.datatype.markup.MarkupMultiline value)