| org.objectweb.salome_tmf.api.sql.ISQLEnvironment
All known Subclasses: org.objectweb.salome_tmf.soap.SQLEnvironmentSoapBindingStub, org.objectweb.salome_tmf.databaseSQL.SQLEnvironment,
ISQLEnvironment | public interface ISQLEnvironment extends Remote(Code) | | |
Method Summary | |
public int | addAttachFile(int idEnv, SalomeFileWrapper f, String description) | public int | addAttachUrl(int idEnv, String url, String description) | public void | addParamValue(int idEnv, int idParam, String value, String description) | public int | addScript(int idEnv, SalomeFileWrapper file, String description, String name, String extention, String arg2) | public void | delete(int idEnv) | public void | deleteAllAttach(int idEnv) | public void | deleteAttach(int idEnv, int idAttach) | public void | deleteDefParam(int idEnv, int paramId) | public void | deleteScript(int idEnv) | public FileAttachementWrapper[] | getAttachFiles(int idEnv) | public UrlAttachementWrapper[] | getAttachUrls(int idEnv) | public AttachementWrapper[] | getAttachs(int idEnv) | public ValuedParameterWrapper[] | getDefinedParameters(int idEnv) | public int | getID(int idProject, String name) | public String | getParameterValue(int idEnv, int idParameter) | public SalomeFileWrapper | getScript(int idEnv) | public ScriptWrapper | getScriptWrapper(int idEnv) | public EnvironmentWrapper | getWrapper(int idEnv) | public int | insert(int idProject, String name, String description) | public void | update(int idEnv, String name, String description) | public void | updateParamValue(int idEnv, int idParam, String value, String description) |
addAttachFile | public int addAttachFile(int idEnv, SalomeFileWrapper f, String description) throws Exception(Code) | | Attach a file to the environment (table ENV_ATTACHEMENT)
Parameters: idEnv - Parameters: f - the file Parameters: description - of the file the Id of the attachment in the table ATTACHEMENT throws: Exception - See Also: ISQLFileAttachment.insert(File, String) See Also: no permission needed |
addAttachUrl | public int addAttachUrl(int idEnv, String url, String description) throws Exception(Code) | | Attach an Url to the environment (table ENV_ATTACHEMENT)
Parameters: idEnv - Parameters: url - Parameters: description - of the url the Id of the attachment in the table ATTACHEMENT throws: Exception - See Also: ISQLUrlAttachment.insert(String, String) See Also: no permission needed |
addParamValue | public void addParamValue(int idEnv, int idParam, String value, String description) throws Exception(Code) | | Map a value for the parameter idParam in the environment idEnv (table VALEUR_PARAM)
Parameters: idEnv - Parameters: idParam - Parameters: value - Parameters: description - throws: Exception - need permission canCreateCamp or canExecutCamp |
addScript | public int addScript(int idEnv, SalomeFileWrapper file, String description, String name, String extention, String arg2) throws Exception(Code) | | Insert a script (type ApiConstants.INIT_SCRIPT) to the environment idEnv
If a script already exist, this previous script is deleted
Parameters: idExec - Parameters: file - of the script Parameters: description - : the description of the script Parameters: name - : the name of the script Parameters: extention - : argument 1 of the script (plug-in extention) Parameters: arg2 - : argument 2 of the script (free use for plug-in) the Id of the script throws: Exception - no permission needed |
delete | public void delete(int idEnv) throws Exception(Code) | | Delete the environment idEnv in the Database
then delete mapped parameters, mapped attachments and related execution
Parameters: idEnv - throws: Exception - See Also: ISQLExecution.delete(int) See Also: need permission canExecutCamp |
deleteAllAttach | public void deleteAllAttach(int idEnv) throws Exception(Code) | | Delete all attchements of the environments idEnv
Parameters: idEnv - throws: Exception - no permission needed |
deleteAttach | public void deleteAttach(int idEnv, int idAttach) throws Exception(Code) | | Delete an attchement idAttach of the environments idEnv
Parameters: idEnv - Parameters: attachId - throws: Exception - See Also: ISQLAttachment.delete(int) See Also: no permission needed |
deleteDefParam | public void deleteDefParam(int idEnv, int paramId) throws Exception(Code) | | Deleted mapped reference to the parameter paramId in the environment idEnv
Parameters: idEnv - Parameters: paramId - throws: Exception - need permission canExecutCamp |
deleteScript | public void deleteScript(int idEnv) throws Exception(Code) | | Delete the script of the environnement idEnv
then delete reference in SCRIPT, SCRIPT_ATTACHEMENT, ATTACHEMENT
Parameters: idExec - throws: Exception - no permission needed |
getID | public int getID(int idProject, String name) throws Exception(Code) | | Get the id of the environment name in the project idProject
Parameters: idProject - Parameters: name - throws: Exception - |
getParameterValue | public String getParameterValue(int idEnv, int idParameter) throws Exception(Code) | | Get the value of the parameter idParameter in the environnement idEnv
Parameters: idEnv - Parameters: idParameter - the value or null if the parameter is not use by the environement throws: Exception - |
getScriptWrapper | public ScriptWrapper getScriptWrapper(int idEnv) throws Exception(Code) | | Get a ScriptWrapper representing the script of the Environnement
Parameters: idEnv - throws: Exception - |
insert | public int insert(int idProject, String name, String description) throws Exception(Code) | | Insert a Environment in the database (table ENVIRONNEMENT)
Parameters: idProject - : id of the project wich contain the environment Parameters: name - of the environment Parameters: description - of the environment id of the environment in the table ENVIRONNEMENT throws: Exception - need permission canCreateCamp or canExecutCamp |
update | public void update(int idEnv, String name, String description) throws Exception(Code) | | Update the name and the description of the environment idEnv
Parameters: idEnv - Parameters: name - Parameters: description - throws: Exception - need permission canUpdateCamp or canExecutCamp |
updateParamValue | public void updateParamValue(int idEnv, int idParam, String value, String description) throws Exception(Code) | | Update a mapped value for the parameter idParam in the environment idEnv
Parameters: idEnv - Parameters: idParam - Parameters: value - : the new value Parameters: description - : the new description throws: Exception - need permission canUpdateCamp or canExecutCamp |
|
|