cosProperty(3)

💖 cosProperty 💖

okay bestie, welcome to cosProperty — the main character module of the cosProperty application, no cap. she's the one who runs the whole show, and i'm gonna walk you through every single thing she does. grab a snack. 🍓

---

✨ NAME ✨

cosProperty — literally just the main module of the cosProperty application. that's the whole vibe check. 👑

---

🦋 DESCRIPTION 🦋

first things first, if you wanna get access to the record definitions for the structures, you use this include:

-include_lib("cosProperty/include/*.hrl").

periodt. that's how you get in. 💅

so like, this module contains the functions for starting and stopping the application. that's her job. start her up, shut her down, that's it. iconic behaviour honestly. ✨

---

🌸 EXPORTS 🌸

every function, every type, nothing skipped, i promised you. 🫶

💜 install() -> Return

Types:

Return = ok | {'EXIT', Reason}

this operation installs the cosProperty application in the IFR. slay.

---

💜 install_db() -> Return

Types:

Return = ok | {'EXIT', Reason}

this one installs data in mnesia that's necessary for running the cosProperty application. like, mnesia needs her little snacks before she can function, yk? 🍓

---

💜 uninstall() -> Return

Types:

Return = ok | {'EXIT', Reason}

this operation removes all data in the IFR related to the cosProperty application. she's gone. ghosted. 💀

---

💜 uninstall_db() -> Return

Types:

Return = ok | {'EXIT', Reason}

this operation removes all data from mnesia related to the cosProperty application. mnesia said clean slate bestie ✨

---

💜 start() -> Return

Types:

Return = ok | {error, Reason}

this operation starts the cosProperty application. main character energy, activated. 👑

---

💜 start_SetDefFactory() -> Return

Types:

Return = Factory | {'EXCEPTION', E}
Factory = CosPropertyService::PropertySetDefFactory reference.

this operation starts a PropertySetDef Factory. she's born. 🎀

---

💜 start_SetFactory() -> Return

Types:

Return = Factory | {'EXCEPTION', E}
Factory = CosPropertyService::PropertySetDefFactory reference.

this operation starts a PropertySet Factory. new factory just dropped. 🔥

---

💜 stop_SetDefFactory(Factory) -> Return

Types:

Factory = CosPropertyService::PropertySetDefFactory reference.
Return = ok | {'EXCEPTION', E}

this operation stops the supplied PropertySetDef Factory. give her a lil rest, she earned it. 😭

---

💜 stop_SetFactory(Factory) -> Return

Types:

Factory = CosPropertyService::PropertySetFactory reference.
Return = ok | {'EXCEPTION', E}

this operation stops the supplied PropertySet Factory. bye girl, we love you 💖

---

💜 stop() -> Return

Types:

Return = ok | {error, Reason}

this operation stops the cosProperty application. closing time, lights off, we out. 🌙

---

fr fr bestie: every one of these returns is either the good one (ok, or a Factory) or the "oop" one ({'EXIT', Reason}, {error, Reason}, or {'EXCEPTION', E}). match on them, don't ignore them, iykyk. 💅

---

and that's the whole page!! this lil manual came to you courtesy of Ericsson AB, running cosProperty 5.2.2 — she's the version, she's the moment, she's giving cosProperty(3). mwah, go forth and start/stop things responsibly. 🌈⭐🧚