cyclonedx.model.definition
==========================

.. py:module:: cyclonedx.model.definition


Classes
-------

.. autoapisummary::

   cyclonedx.model.definition.CreId
   cyclonedx.model.definition.Requirement
   cyclonedx.model.definition.Level
   cyclonedx.model.definition.Standard
   cyclonedx.model.definition.Definitions


Module Contents
---------------

.. py:class:: CreId(id: str)

   Helper class that allows us to perform validation on data strings that must conform to
   Common Requirements Enumeration (CRE) identifier(s).


   .. py:property:: id
      :type: str



   .. py:method:: serialize(o: Any) -> str
      :classmethod:



   .. py:method:: deserialize(o: Any) -> _T_CreId
      :classmethod:



.. py:class:: Requirement

   A requirement comprising a standard.

   .. note::
       See the CycloneDX Schema for hashType:
       https://cyclonedx.org/docs/1.7/json/#definitions_standards_items_requirements


   .. py:attribute:: identifier
      :type:  Optional[str]

      The identifier of the requirement.



   .. py:attribute:: title
      :type:  Optional[str]

      The title of the requirement.



   .. py:attribute:: text
      :type:  Optional[str]

      The text of the requirement.



   .. py:property:: bom_ref
      :type: cyclonedx.model.bom_ref.BomRef


      An optional identifier which can be used to reference the requirement elsewhere in the BOM.



   .. py:property:: descriptions
      :type: SortedSet[str]


      A SortedSet of descriptions of the requirement.



   .. py:property:: open_cre
      :type: SortedSet[CreId]


      The Common Requirements Enumeration (CRE) identifier(s).



   .. py:property:: parent
      :type: Optional[cyclonedx.model.bom_ref.BomRef]


      The optional bom-ref to a parent requirement.



   .. py:property:: properties
      :type: SortedSet[Property]


      Properties in a key/value store.



   .. py:property:: external_references
      :type: SortedSet[ExternalReference]


      External references related to the component.



.. py:class:: Level

   Level of compliance for a standard.

   .. note::
       See the CycloneDX Schema for hashType: https://cyclonedx.org/docs/1.7/json/#definitions_standards_items_levels


   .. py:attribute:: identifier
      :type:  Optional[str]

      The identifier of the level.



   .. py:attribute:: title
      :type:  Optional[str]

      The title of the level.



   .. py:attribute:: description
      :type:  Optional[str]

      The description of the level.



   .. py:property:: bom_ref
      :type: cyclonedx.model.bom_ref.BomRef


      An optional identifier which can be used to reference the level elsewhere in the BOM.



   .. py:property:: requirements
      :type: SortedSet[BomRef]


      A SortedSet of requirements associated with the level.



.. py:class:: Standard

   A standard of regulations, industry or organizational-specific standards, maturity models, best practices,
   or any other requirements.

   .. note::
       See the CycloneDX Schema for hashType: https://cyclonedx.org/docs/1.7/xml/#type_standard


   .. py:attribute:: name
      :type:  Optional[str]

      The name of the standard.



   .. py:attribute:: version
      :type:  Optional[str]

      The version of the standard.



   .. py:attribute:: description
      :type:  Optional[str]

      The description of the standard.



   .. py:attribute:: owner
      :type:  Optional[str]

      The owner of the standard.



   .. py:property:: bom_ref
      :type: cyclonedx.model.bom_ref.BomRef


      An optional identifier which can be used to reference the standard elsewhere in the BOM.



   .. py:property:: requirements
      :type: SortedSet[Requirement]


      A SortedSet of requirements comprising the standard.



   .. py:property:: levels
      :type: SortedSet[Level]


      A SortedSet of levels associated with the standard.



   .. py:property:: external_references
      :type: SortedSet[ExternalReference]


      A SortedSet of external references associated with the standard.



.. py:class:: Definitions

   The repository for definitions

   .. note::
       See the CycloneDX Schema for hashType: https://cyclonedx.org/docs/1.7/xml/#type_definitionsType


   .. py:property:: standards
      :type: SortedSet[Standard]


      A SortedSet of Standards.