Repository Class: Difference between revisions
Jump to navigation
Jump to search
Albert Szeto (talk | contribs) No edit summary |
Albert Szeto (talk | contribs) No edit summary |
||
| Line 6: | Line 6: | ||
== Methods == | == Methods == | ||
===== Connection ===== | ===== Connection ===== | ||
*'''[[Repository.ConnectToRepository]]''' {{APIComment|Connects to any (MS Access, MS SQL or Oracle) repository.}} | *'''[[Repository.ConnectToRepository|ConnectToRepository]]''' {{APIComment|Connects to any (MS Access, MS SQL or Oracle) repository.}} | ||
*'''[[Repository.ConnectToAccessRepository]]''' {{APIComment|Connects to an MS Access repository.}} | *'''[[Repository.ConnectToAccessRepository|ConnectToAccessRepository]]''' {{APIComment|Connects to an MS Access repository.}} | ||
*'''[[Repository.ConnectToSQLRepository]]''' {{APIComment|Connects to an MS SQL repository.}} | *'''[[Repository.ConnectToSQLRepository|ConnectToSQLRepository]]''' {{APIComment|Connects to an MS SQL repository.}} | ||
*'''[[Repository.ConnectToOracleRepository]]''' {{APIComment|Connects to an Oracle repository.}} | *'''[[Repository.ConnectToOracleRepository|ConnectToOracleRepository]]''' {{APIComment|Connects to an Oracle repository.}} | ||
*'''[[Repository.DisconnectFromRepository]]''' {{APIComment|Disconnects from current repository.}} | *'''[[Repository.DisconnectFromRepository|DisconnectFromRepository]]''' {{APIComment|Disconnects from current repository.}} | ||
===== Project ===== | ===== Project ===== | ||
*'''[[Repository.GetAllProjects]]''' {{APIComment|Returns an array containing all project names and their IDs from the current repository.}} | *'''[[Repository.GetAllProjects|GetAllProjects]]''' {{APIComment|Returns an array containing all project names and their IDs from the current repository.}} | ||
*'''[[Repository.GetCurrentProject]]''' {{APIComment|Returns the name and ID of the current project.}} | *'''[[Repository.GetCurrentProject|GetCurrentProject]]''' {{APIComment|Returns the name and ID of the current project.}} | ||
*'''[[Repository.SetCurrentProject]]''' {{APIComment|Opens (sets as current) a project with the specified ID. If 0 is passed, a fist available project will be set as current.}} | *'''[[Repository.SetCurrentProject|SetCurrentProject]]''' {{APIComment|Opens (sets as current) a project with the specified ID. If 0 is passed, a fist available project will be set as current.}} | ||
===== Unit ===== | ===== Unit ===== | ||
*'''[[Repository.GetAllUnits]]''' {{APIComment|Returns the default unit ID.}} | *'''[[Repository.GetAllUnits|GetAllUnits]]''' {{APIComment|Returns the default unit ID.}} | ||
===== Models ===== | ===== Models ===== | ||
*'''[[Repository.GetAllModelsInfo]]''' {{APIComment|Returns an array containing all model names and their IDs from the current project.}} | *'''[[Repository.GetAllModelsInfo|GetAllModelsInfo]]''' {{APIComment|Returns an array containing all model names and their IDs from the current project.}} | ||
*'''[[Repository.GetModel]]''' {{APIComment|Returns the model from the current project with the specified ID. Returns nothing if the model does not exist or is not in the current project.}} | *'''[[Repository.GetModel|GetModel]]''' {{APIComment|Returns the model from the current project with the specified ID. Returns nothing if the model does not exist or is not in the current project.}} | ||
*'''[[Repository.GetAllModels]]''' {{APIComment|Returns an array containing all models from the current project.}} | *'''[[Repository.GetAllModels|GetAllModels]]''' {{APIComment|Returns an array containing all models from the current project.}} | ||
*'''[[Repository.AddModel]]''' {{APIComment|Saves a new model in the repository. }} | *'''[[Repository.AddModel|AddModel]]''' {{APIComment|Saves a new model in the repository. }} | ||
*'''[[Repository.UpdateModel]]''' {{APIComment|Updates the model in the repository. }} | *'''[[Repository.UpdateModel|UpdateModel]]''' {{APIComment|Updates the model in the repository. }} | ||
===== URDs ===== | ===== URDs ===== | ||
*'''[[Repository.GetAllURDs]]''' {{APIComment|Returns an array containing all URDs from the current project.}} | *'''[[Repository.GetAllURDs|GetAllURDs]]''' {{APIComment|Returns an array containing all URDs from the current project.}} | ||
*'''[[Repository.AddURD]]''' {{APIComment|Saves a new URD in the repository. }} | *'''[[Repository.AddURD|AddURD]]''' {{APIComment|Saves a new URD in the repository. }} | ||
*'''[[Repository.UpdateURD]]''' {{APIComment|Updates the URD in the repository.}} | *'''[[Repository.UpdateURD|UpdateURD]]''' {{APIComment|Updates the URD in the repository.}} | ||
===== Variables ===== | ===== Variables ===== | ||
*'''[[Repository.GetAllVariables]]''' {{APIComment|Returns an array containing all Variables from the current project.}} | *'''[[Repository.GetAllVariables|GetAllVariables]]''' {{APIComment|Returns an array containing all Variables from the current project.}} | ||
*'''[[Repository.AddVariable]]''' {{APIComment|Saves a new Variable in the repository.}} | *'''[[Repository.AddVariable|AddVariable]]''' {{APIComment|Saves a new Variable in the repository.}} | ||
*'''[[Repository.UpdateVariable]]''' {{APIComment|Updates the Variable in the repository.}} | *'''[[Repository.UpdateVariable|UpdateVariable]]''' {{APIComment|Updates the Variable in the repository.}} | ||
===== Corrective Tasks ===== | ===== Corrective Tasks ===== | ||
*'''[[Repository.GetAllCorrectiveTasks]]''' {{APIComment|Returns an array containing all corrective tasks from the current project.}} | *'''[[Repository.GetAllCorrectiveTasks|GetAllCorrectiveTasks]]''' {{APIComment|Returns an array containing all corrective tasks from the current project.}} | ||
*'''[[Repository.AddCorrectiveTask]]''' {{APIComment|Saves the corrective task in the repository. }} | *'''[[Repository.AddCorrectiveTask|AddCorrectiveTask]]''' {{APIComment|Saves the corrective task in the repository. }} | ||
*'''[[Repository.UpdateCorrectiveTask]]''' {{APIComment|Updates the Corrective task in the repository.}} | *'''[[Repository.UpdateCorrectiveTask|UpdateCorrectiveTask]]''' {{APIComment|Updates the Corrective task in the repository.}} | ||
===== Scheduled Tasks ===== | ===== Scheduled Tasks ===== | ||
*'''[[Repository.GetAllScheduledTasks]]''' {{APIComment|Returns an array containing all scheduled tasks from the current project.}} | *'''[[Repository.GetAllScheduledTasks|GetAllScheduledTasks]]''' {{APIComment|Returns an array containing all scheduled tasks from the current project.}} | ||
*'''[[Repository.AddScheduledTask]]''' {{APIComment|Saves the scheduled task in the repository. }} | *'''[[Repository.AddScheduledTask|AddScheduledTask]]''' {{APIComment|Saves the scheduled task in the repository. }} | ||
*'''[[Repository.UpdateScheduledTask]]''' {{APIComment|Updates the scheduled task in the repository.}} | *'''[[Repository.UpdateScheduledTask|UpdateScheduledTask]]''' {{APIComment|Updates the scheduled task in the repository.}} | ||
===== Task Types ===== | ===== Task Types ===== | ||
*'''[[Repository.GetAllTaskTypes]]''' {{APIComment|Retuns an array containing all task types in the repository.}} | *'''[[Repository.GetAllTaskTypes|GetAllTaskTypes]]''' {{APIComment|Retuns an array containing all task types in the repository.}} | ||
===== Crews ===== | ===== Crews ===== | ||
*'''[[Repository.GetAllCrews]]''' {{APIComment|Returns an array containing all crews from the current project.}} | *'''[[Repository.GetAllCrews|GetAllCrews]]''' {{APIComment|Returns an array containing all crews from the current project.}} | ||
*'''[[Repository.AddCrew]]''' {{APIComment|Saves the crew in the repository. }} | *'''[[Repository.AddCrew|AddCrew]]''' {{APIComment|Saves the crew in the repository. }} | ||
*'''[[Repository.UpdateCrew]]''' {{APIComment|Updates the Crew in the repository. }} | *'''[[Repository.UpdateCrew|UpdateCrew]]''' {{APIComment|Updates the Crew in the repository. }} | ||
===== Pools ===== | ===== Pools ===== | ||
*'''[[Repository.GetAllPools]]''' {{APIComment|Returns an array containing all spare parts pools from the current project.}} | *'''[[Repository.GetAllPools|GetAllPools]]''' {{APIComment|Returns an array containing all spare parts pools from the current project.}} | ||
*'''[[Repository.AddPool]]''' {{APIComment|Saves the spare parts pool in the repository.}} | *'''[[Repository.AddPool|AddPool]]''' {{APIComment|Saves the spare parts pool in the repository.}} | ||
*'''[[Repository.UpdatePool]]''' {{APIComment|Updates the spare parts Pool in the repository.}} | *'''[[Repository.UpdatePool|UpdatePool]]''' {{APIComment|Updates the spare parts Pool in the repository.}} | ||
===== Action ===== | ===== Action ===== | ||
*'''[[Repository.GetAllActions]]''' {{APIComment|Returns an array containing all actions from the current project.}} | *'''[[Repository.GetAllActions|GetAllActions]]''' {{APIComment|Returns an array containing all actions from the current project.}} | ||
*'''[[Repository.AddAction]]''' {{APIComment|Saves the action in the repository.}} | *'''[[Repository.AddAction|AddAction]]''' {{APIComment|Saves the action in the repository.}} | ||
*'''[[Repository.UpdateAction]]''' {{APIComment|Updates the Action in the repository.}} | *'''[[Repository.UpdateAction|UpdateAction]]''' {{APIComment|Updates the Action in the repository.}} | ||
===== XFRACAS ===== | ===== XFRACAS ===== | ||
*'''[[Repository.ImportBlockSimXMLFile]]''' {{APIComment|Imports from XML file to the current project.}} | *'''[[Repository.ImportBlockSimXMLFile|ImportBlockSimXMLFile]]''' {{APIComment|Imports from XML file to the current project.}} | ||
*'''[[Repository.SaveRawDataSet]]''' {{APIComment|Saves the raw data set in the repository.}} | *'''[[Repository.SaveRawDataSet|SaveRawDataSet]]''' {{APIComment|Saves the raw data set in the repository.}} | ||
*'''[[Repository.GetAllXFRACASEntities]]''' {{APIComment|Returns an array containing all entity names and and their IDs from the current repository.}} | *'''[[Repository.GetAllXFRACASEntities|GetAllXFRACASEntities]]''' {{APIComment|Returns an array containing all entity names and and their IDs from the current repository.}} | ||
*'''[[Repository.ImportXFRACASXMLFile]]''' {{APIComment|Uploads an import file for processing and returns the system ID of the uploaded}} | *'''[[Repository.ImportXFRACASXMLFile|ImportXFRACASXMLFile]]''' {{APIComment|Uploads an import file for processing and returns the system ID of the uploaded}} | ||
*'''[[Repository.ProcessXfracasImports]]''' {{APIComment|Runs the import process}} | *'''[[Repository.ProcessXfracasImports|ProcessXfracasImports]]''' {{APIComment|Runs the import process}} | ||
== Properties == | == Properties == | ||
*'''[[Repository.EnforceRENOCompliance]]''' {{APIComment|Defines the restrictions on model names. True by default.}} | *'''[[Repository.EnforceRENOCompliance|EnforceRENOCompliance]]''' {{APIComment|Defines the restrictions on model names. True by default.}} | ||
*'''[[XFRACASImportType ]]''' {{APIComment|Enum for the XFRACAS Import Types}} | *'''[[XFRACASImportType]]''' {{APIComment|Enum for the XFRACAS Import Types}} | ||
*'''[[NameIdPair Class]]''' {{APIComment|Class to describe a Name and ID pair}} | *'''[[NameIdPair Class]]''' {{APIComment|Class to describe a Name and ID pair}} | ||
*'''[[UnitInfo Class]]''' {{APIComment|Class to describe a Unit}} | *'''[[UnitInfo Class]]''' {{APIComment|Class to describe a Unit}} | ||
Revision as of 00:46, 1 October 2013
Provides an application the ability to access and edit Synthesis Repositories.
Constructors
- New Repository Creates a new Synthesis Repository connection class.
Methods
Connection
- ConnectToRepository Connects to any (MS Access, MS SQL or Oracle) repository.
- ConnectToAccessRepository Connects to an MS Access repository.
- ConnectToSQLRepository Connects to an MS SQL repository.
- ConnectToOracleRepository Connects to an Oracle repository.
- DisconnectFromRepository Disconnects from current repository.
Project
- GetAllProjects Returns an array containing all project names and their IDs from the current repository.
- GetCurrentProject Returns the name and ID of the current project.
- SetCurrentProject Opens (sets as current) a project with the specified ID. If 0 is passed, a fist available project will be set as current.
Unit
- GetAllUnits Returns the default unit ID.
Models
- GetAllModelsInfo Returns an array containing all model names and their IDs from the current project.
- GetModel Returns the model from the current project with the specified ID. Returns nothing if the model does not exist or is not in the current project.
- GetAllModels Returns an array containing all models from the current project.
- AddModel Saves a new model in the repository.
- UpdateModel Updates the model in the repository.
URDs
- GetAllURDs Returns an array containing all URDs from the current project.
- AddURD Saves a new URD in the repository.
- UpdateURD Updates the URD in the repository.
Variables
- GetAllVariables Returns an array containing all Variables from the current project.
- AddVariable Saves a new Variable in the repository.
- UpdateVariable Updates the Variable in the repository.
Corrective Tasks
- GetAllCorrectiveTasks Returns an array containing all corrective tasks from the current project.
- AddCorrectiveTask Saves the corrective task in the repository.
- UpdateCorrectiveTask Updates the Corrective task in the repository.
Scheduled Tasks
- GetAllScheduledTasks Returns an array containing all scheduled tasks from the current project.
- AddScheduledTask Saves the scheduled task in the repository.
- UpdateScheduledTask Updates the scheduled task in the repository.
Task Types
- GetAllTaskTypes Retuns an array containing all task types in the repository.
Crews
- GetAllCrews Returns an array containing all crews from the current project.
- AddCrew Saves the crew in the repository.
- UpdateCrew Updates the Crew in the repository.
Pools
- GetAllPools Returns an array containing all spare parts pools from the current project.
- AddPool Saves the spare parts pool in the repository.
- UpdatePool Updates the spare parts Pool in the repository.
Action
- GetAllActions Returns an array containing all actions from the current project.
- AddAction Saves the action in the repository.
- UpdateAction Updates the Action in the repository.
XFRACAS
- ImportBlockSimXMLFile Imports from XML file to the current project.
- SaveRawDataSet Saves the raw data set in the repository.
- GetAllXFRACASEntities Returns an array containing all entity names and and their IDs from the current repository.
- ImportXFRACASXMLFile Uploads an import file for processing and returns the system ID of the uploaded
- ProcessXfracasImports Runs the import process
Properties
- EnforceRENOCompliance Defines the restrictions on model names. True by default.
- XFRACASImportType Enum for the XFRACAS Import Types
- NameIdPair Class Class to describe a Name and ID pair
- UnitInfo Class Class to describe a Unit