Island: Add documentation for IConfigRepository

This commit is contained in:
Mike Salvatore 2022-06-17 11:08:45 -04:00
parent 62056175a1
commit ae0c440603
1 changed files with 14 additions and 1 deletions

View File

@ -4,8 +4,21 @@ from common.configuration import AgentConfiguration
class IConfigRepository(ABC):
"""
A repository used to store and retrieve the agent configuration.
"""
def get_config(self) -> AgentConfiguration:
"""
Retrieve the agent configuration from the repository
:return: The agent configuration
"""
pass
def set_config(self, config: AgentConfiguration):
def set_config(self, agent_config: AgentConfiguration):
"""
Store the agent configuration in the repository
:param agent_config: The agent configuration to store in the repository
"""
pass