Source code for pyatlan.model.assets.cognos_module

# SPDX-License-Identifier: Apache-2.0
# Copyright 2025 Atlan Pte. Ltd.


from __future__ import annotations

from typing import ClassVar, List, Optional

from pydantic.v1 import Field, validator

from pyatlan.model.fields.atlan_fields import RelationField

from .cognos import Cognos




class CognosModule(Cognos):
    """Description"""

    type_name: str = Field(default="CognosModule", allow_mutation=False)

    @validator("type_name")
    def validate_type_name(cls, v):
        if v != "CognosModule":
            raise ValueError("must be CognosModule")
        return v

    def __setattr__(self, name, value):
        if name in CognosModule._convenience_properties:
            return object.__setattr__(self, name, value)
        super().__setattr__(name, value)

    COGNOS_COLUMNS: ClassVar[RelationField] = RelationField("cognosColumns")
    """
    TBC
    """
    COGNOS_FOLDER: ClassVar[RelationField] = RelationField("cognosFolder")
    """
    TBC
    """

    _convenience_properties: ClassVar[List[str]] = [
        "cognos_columns",
        "cognos_folder",
    ]

    @property
    def cognos_columns(self) -> Optional[List[CognosColumn]]:
        return None if self.attributes is None else self.attributes.cognos_columns

    @cognos_columns.setter
    def cognos_columns(self, cognos_columns: Optional[List[CognosColumn]]):
        if self.attributes is None:
            self.attributes = self.Attributes()
        self.attributes.cognos_columns = cognos_columns

    @property
    def cognos_folder(self) -> Optional[CognosFolder]:
        return None if self.attributes is None else self.attributes.cognos_folder

    @cognos_folder.setter
    def cognos_folder(self, cognos_folder: Optional[CognosFolder]):
        if self.attributes is None:
            self.attributes = self.Attributes()
        self.attributes.cognos_folder = cognos_folder

    class Attributes(Cognos.Attributes):
        cognos_columns: Optional[List[CognosColumn]] = Field(
            default=None, description=""
        )  # relationship
        cognos_folder: Optional[CognosFolder] = Field(
            default=None, description=""
        )  # relationship

    attributes: CognosModule.Attributes = Field(
        default_factory=lambda: CognosModule.Attributes(),
        description=(
            "Map of attributes in the instance and their values. "
            "The specific keys of this map will vary by type, "
            "so are described in the sub-types of this schema."
        ),
    )



from .cognos_column import CognosColumn  # noqa: E402, F401
from .cognos_folder import CognosFolder  # noqa: E402, F401

CognosModule.Attributes.update_forward_refs()