Package dev.metaschema.oscal.lib.model

Class Metadata.Party

java.lang.Object
dev.metaschema.oscal.lib.model.Metadata.Party
All Implemented Interfaces:
dev.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(id="oscal-metadata-party-prop-name-values",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 dev.metaschema.core.model.IBoundObject
An organization or person, which may be associated with roles or other concepts within the current or linked OSCAL document.

  • Constructor Details

    • Party

      public Party()
      Constructs a new dev.metaschema.oscal.lib.model.Metadata.Party instance with no metadata.

    • Party

      public Party(dev.metaschema.core.model.IMetaschemaData data)
      Constructs a new dev.metaschema.oscal.lib.model.Metadata.Party instance with the specified metadata.
      Parameters:
      data - the metaschema data, or null if none

  • Method Details

    • getMetaschemaData

      public dev.metaschema.core.model.IMetaschemaData getMetaschemaData()
      Specified by:
      getMetaschemaData in interface dev.metaschema.core.model.IBoundObject

    • getUuid

      @NonNull public UUID getUuid()
      Get the "Party Universally Unique Identifier".

      A unique identifier for the party.

      Returns:
      the uuid value

    • setUuid

      public void setUuid(@NonNull UUID value)
      Set the "Party Universally Unique Identifier".

      A unique identifier for the party.

      Parameters:
      value - the uuid value to set

    • getType

      @NonNull public String getType()
      Get the "Party Type".

      A category describing the kind of party the object describes.

      Returns:
      the type value

    • setType

      public void setType(@NonNull String value)
      Set the "Party Type".

      A category describing the kind of party the object describes.

      Parameters:
      value - the type value to set

    • getName

      @Nullable public String getName()
      Get the "Party Name".

      The full name of the party. This is typically the legal name associated with the party.

      Returns:
      the name value, or null if not set

    • setName

      public void setName(@Nullable String value)
      Set the "Party Name".

      The full name of the party. This is typically the legal name associated with the party.

      Parameters:
      value - the name value to set, or null to clear

    • getShortName

      @Nullable public String getShortName()
      Get the "Party Short Name".

      A short common name, abbreviation, or acronym for the party.

      Returns:
      the short-name value, or null if not set

    • setShortName

      public void setShortName(@Nullable String value)
      Set the "Party Short Name".

      A short common name, abbreviation, or acronym for the party.

      Parameters:
      value - the short-name value to set, or null to clear

    • getExternalIds

      @NonNull public List<Metadata.Party.ExternalId> getExternalIds()
      Get the "Party External Identifier".

      An identifier for a person or organization using a designated scheme. e.g. an Open Researcher and Contributor ID (ORCID).

      Returns:
      the external-id value

    • setExternalIds

      public void setExternalIds(@NonNull List<Metadata.Party.ExternalId> value)
      Set the "Party External Identifier".

      An identifier for a person or organization using a designated scheme. e.g. an Open Researcher and Contributor ID (ORCID).

      Parameters:
      value - the external-id value to set

    • 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

      @NonNull public List<Property> getProps()
      Get the "Property".

      An attribute, characteristic, or quality of the containing object expressed as a namespace qualified name/value pair.

      Returns:
      the prop value

    • setProps

      public void setProps(@NonNull List<Property> value)
      Set the "Property".

      An attribute, characteristic, or quality of the containing object expressed as a namespace qualified name/value pair.

      Parameters:
      value - the prop value to set

    • 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

      @NonNull public List<Link> getLinks()
      Get the "Link".

      A reference to a local or remote resource, that has a specific relation to the containing object.

      Returns:
      the link value

    • setLinks

      public void setLinks(@NonNull List<Link> value)
      Set the "Link".

      A reference to a local or remote resource, that has a specific relation to the containing object.

      Parameters:
      value - the link value to set

    • 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

      @NonNull public List<String> getEmailAddresses()
      Get the "Email Address".

      An email address as defined by RFC 5322 Section 3.4.1.

      Returns:
      the email-address value

    • setEmailAddresses

      public void setEmailAddresses(@NonNull List<String> value)
      Set the "Email Address".

      An email address as defined by RFC 5322 Section 3.4.1.

      Parameters:
      value - the email-address value to set

    • 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

      @NonNull public List<TelephoneNumber> getTelephoneNumbers()
      Get the "Telephone Number".

      A telephone service number as defined by ITU-T E.164.

      Returns:
      the telephone-number value

    • setTelephoneNumbers

      public void setTelephoneNumbers(@NonNull List<TelephoneNumber> value)
      Set the "Telephone Number".

      A telephone service number as defined by ITU-T E.164.

      Parameters:
      value - the telephone-number value to set

    • 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

      @NonNull public List<Address> getAddresses()
      Get the "Address".

      A postal address for the location.

      Returns:
      the address value

    • setAddresses

      public void setAddresses(@NonNull List<Address> value)
      Set the "Address".

      A postal address for the location.

      Parameters:
      value - the address value to set

    • 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

      @NonNull public List<UUID> getLocationUuids()
      Get the "Location Universally Unique Identifier Reference".

      Reference to a location by UUID.

      Returns:
      the location-uuid value

    • setLocationUuids

      public void setLocationUuids(@NonNull List<UUID> value)
      Set the "Location Universally Unique Identifier Reference".

      Reference to a location by UUID.

      Parameters:
      value - the location-uuid value to set

    • 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

      @NonNull public List<UUID> getMemberOfOrganizations()
      Get the "Organizational Affiliation".

      A reference to another party by UUID, typically an organization, that this subject is associated with.

      Returns:
      the member-of-organization value

    • setMemberOfOrganizations

      public void setMemberOfOrganizations(@NonNull List<UUID> value)
      Set the "Organizational Affiliation".

      A reference to another party by UUID, typically an organization, that this subject is associated with.

      Parameters:
      value - the member-of-organization value to set

    • 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

      @Nullable public dev.metaschema.core.datatype.markup.MarkupMultiline getRemarks()
      Get the "Remarks".

      Additional commentary about the containing object.

      Returns:
      the remarks value, or null if not set

    • setRemarks

      public void setRemarks(@Nullable dev.metaschema.core.datatype.markup.MarkupMultiline value)
      Set the "Remarks".

      Additional commentary about the containing object.

      Parameters:
      value - the remarks value to set, or null to clear

    • toString

      public String toString()
      Overrides:
      toString in class Object