Component (Components.AdminCtrl.ModuleIO) Only the functions and data members that are accessible from your location are displayed
Extends	Components.Result.ReturnStruct
Hint	This component provides basic module functions.
this	public addModulesForType Public Function addModulesForType source: /usr/local/tomcat/webapps/ROOT/Components/AdminCtrl/ModuleIO.cfc Adds modules for a company or group. arguments label name required type default hint type true string null The type, values: company or group. mm_id true string null The ID(s) of the modules. id true numeric null The ID of the company or group. return type struct checkNumericList Public Function checkNumericList source: /usr/local/tomcat/webapps/ROOT/Components/Result/ReturnStruct.cfc Checks if each element in a list is numeric arguments label name required type default hint list true string null The list to check add false numeric null If a list is empty, then add the add return type any COMPONENTCACHE Struct concatQuery Public Function concatQuery source: /usr/local/tomcat/webapps/ROOT/Components/Result/ReturnStruct.cfc Concats two queries, and returns one query arguments label name required type default hint query1 true query null The first query. query2 true query null The second query. columnList false string * If you want to select only some columns in stead of of all columns. Usefull if you want to concat queries with different columns. return type query countModules Public Function countModules source: /usr/local/tomcat/webapps/ROOT/Components/AdminCtrl/ModuleIO.cfc Returns the amount of modules. arguments label name required type default hint return type struct countModulesForType Public Function countModulesForType source: /usr/local/tomcat/webapps/ROOT/Components/AdminCtrl/ModuleIO.cfc Returns the amount of modules for a company or group. arguments label name required type default hint type true string null The type, values: company or group. id true numeric null The ID of the company or group. getOnlyActive false boolean false Specifies whether only active modules should be counted. return type struct createComponent Public Function createComponent source: /usr/local/tomcat/webapps/ROOT/Components/Result/ReturnStruct.cfc arguments label name required type default hint return type any deleteAllModulesForType Public Function deleteAllModulesForType source: /usr/local/tomcat/webapps/ROOT/Components/AdminCtrl/ModuleIO.cfc Deletes all modules for a company or group. arguments label name required type default hint type true string null The type, values: company or group. id true numeric null The ID of the company or group. return type struct deleteModulesForType Public Function deleteModulesForType source: /usr/local/tomcat/webapps/ROOT/Components/AdminCtrl/ModuleIO.cfc Deletes modules for a company or group. arguments label name required type default hint type true string null The type, values: company or group. mm_id true string null The ID(s) of the modules. id true numeric null The ID of the company or group. return type struct displayAlertError Public Function displayAlertError source: /usr/local/tomcat/webapps/ROOT/Components/Result/ReturnStruct.cfc Alerts optional errormessages. arguments label name required type default hint inputStructure true struct null The structure returned from another function addScriptTags false boolean true Do you want to add the script tags around the alert message? return type struct displayHTMLError Public Function displayHTMLError source: /usr/local/tomcat/webapps/ROOT/Components/Result/ReturnStruct.cfc Displays optional errormessages in HTML. arguments label name required type default hint inputStructure true struct null The structure returned from another function. return type struct generateAddSQL Public Function generateAddSQL source: /usr/local/tomcat/webapps/ROOT/Components/Result/ReturnStruct.cfc Generates output for a SQL query statement (adding). arguments label name required type default hint addStructure true struct null The columns and values to add. return type struct generateUpdateSQL Public Function generateUpdateSQL source: /usr/local/tomcat/webapps/ROOT/Components/Result/ReturnStruct.cfc Generates output for a SQL query statement (updating). arguments label name required type default hint updateStructure true struct null The columns and values to update. return type struct genPos Public Function genPos source: /usr/local/tomcat/webapps/ROOT/Components/Result/ReturnStruct.cfc Creates an order id for queries arguments label name required type default hint key true string null The key the of id's list true string null The list of id's return type string getAllSystemModules Public Function getAllSystemModules source: /usr/local/tomcat/webapps/ROOT/Components/AdminCtrl/ModuleIO.cfc Returns all modules in WIS. arguments label name required type default hint getOnlyActive false boolean false Specifies whether only active modules should be retrieved. return type struct getAllUserModules Public Function getAllUserModules source: /usr/local/tomcat/webapps/ROOT/Components/AdminCtrl/ModuleIO.cfc Returns all modules for a user. arguments label name required type default hint wu_id false numeric -1 The id of the user for which you want to get his modules. return type struct getComponent Public Function getComponent source: /usr/local/tomcat/webapps/ROOT/Components/Result/ReturnStruct.cfc arguments label name required type default hint componentName true string null return type any getModulesForType Public Function getModulesForType source: /usr/local/tomcat/webapps/ROOT/Components/AdminCtrl/ModuleIO.cfc Returns the modules for a company or group. arguments label name required type default hint type true string null The type, values: company or group. id true numeric null The ID of the company or group. getOnlyActive false boolean false Specifies whether only active modules should be retrieved. return type struct getModuleValues Public Function getModuleValues source: /usr/local/tomcat/webapps/ROOT/Components/AdminCtrl/ModuleIO.cfc Returns module info. arguments label name required type default hint mm_id true string null The ID(s) of the modules. return type struct getQuery Public Function getQuery source: /usr/local/tomcat/webapps/ROOT/Components/Result/ReturnStruct.cfc Allows you to create a query in a cfscript. arguments label name required type default hint body true string null The body of the query return type query getQueryRecords Public Function getQueryRecords source: /usr/local/tomcat/webapps/ROOT/Components/Result/ReturnStruct.cfc Returns the specified amount of records. arguments label name required type default hint query true query null The query. recordCount true numeric null The amount of records to return. return type query grep Public Function grep source: /usr/local/tomcat/webapps/ROOT/Components/Result/ReturnStruct.cfc finds a struct with given property value in array of structs arguments label name required type default hint arr true any null prop true any null value true any null return type any hasModuleForType Public Function hasModuleForType source: /usr/local/tomcat/webapps/ROOT/Components/AdminCtrl/ModuleIO.cfc Returns wheter a company or group has access to the specified module arguments label name required type default hint type true string null The type, values: company or group. id true numeric null The ID of the company or group. module_id true numeric null The id of the module which has to be checked. return type boolean joinLists Public Function joinLists source: /usr/local/tomcat/webapps/ROOT/Components/Result/ReturnStruct.cfc Joins two lists and filters the duplicates. arguments label name required type default hint list1 true string null The first (filtered) list. list2 true string null The second (filtered) list. return type string logDebug Public Function logDebug source: /usr/local/tomcat/webapps/ROOT/Components/Result/ReturnStruct.cfc arguments label name required type default hint message false any null exception false any null The optional cfcatch structure. return type any logError Public Function logError source: /usr/local/tomcat/webapps/ROOT/Components/Result/ReturnStruct.cfc arguments label name required type default hint message false any null exception false any null The optional cfcatch structure. return type any logInfo Public Function logInfo source: /usr/local/tomcat/webapps/ROOT/Components/Result/ReturnStruct.cfc arguments label name required type default hint message false any null exception false any null The optional cfcatch structure. return type any logWarn Public Function logWarn source: /usr/local/tomcat/webapps/ROOT/Components/Result/ReturnStruct.cfc arguments label name required type default hint message false any null exception false any null The optional cfcatch structure. return type any makeUniqueString Public Function makeUniqueString source: /usr/local/tomcat/webapps/ROOT/Components/Result/ReturnStruct.cfc makes a string unique arguments label name required type default hint str true string null arr true array null count false numeric 0 return type string parseXMLFile Public Function parseXMLFile source: /usr/local/tomcat/webapps/ROOT/Components/Result/ReturnStruct.cfc arguments label name required type default hint filePath false string null return type any placeImage Public Function placeImage source: /usr/local/tomcat/webapps/ROOT/Components/Result/ReturnStruct.cfc arguments label name required type default hint return type any queryToArray Public Function queryToArray source: /usr/local/tomcat/webapps/ROOT/Components/Result/ReturnStruct.cfc Returns an array containing the items from the query. arguments label name required type default hint inputQuery true query null The query to convert to an array. dataColumn true string null The column containing the data to return. return type array QueryToCSV Public Function QueryToCSV source: /usr/local/tomcat/webapps/ROOT/Components/Result/ReturnStruct.cfc take a query and convert it to a comma separated value string. arguments label name required type default hint Query true query null the query being converted to CSV. Fields true string null the list of query fields to be used when creating the CSV value. CreateHeaderRow false boolean true flag whether or not to create a row of header values. Delimiter false string , the field delimiter in the CSV value. return type string queryToList Public Function queryToList source: /usr/local/tomcat/webapps/ROOT/Components/Result/ReturnStruct.cfc Returns a list containing the items from the query. arguments label name required type default hint inputQuery true query null The query to convert to a list. dataColumn false string null The optional column containing the data. If not specified, the first column is used. return type string QueryToStruct Public Function QueryToStruct source: /usr/local/tomcat/webapps/ROOT/Components/Result/ReturnStruct.cfc Converts an entire query or the given record to a struct. This might return a structure (single record) or an array of structures. arguments label name required type default hint Query true query null Row false numeric 0 which row? 0 = all ColumnList false string All which columns do you want to convert? DateToISO8601 false boolean false Converts dates to ISO-8601 string return type any readFile Public Function readFile source: /usr/local/tomcat/webapps/ROOT/Components/Result/ReturnStruct.cfc arguments label name required type default hint filePath false string null return type string ReplaceListNoCase Public Function ReplaceListNoCase source: /usr/local/tomcat/webapps/ROOT/Components/Result/ReturnStruct.cfc arguments label name required type default hint input true string null The string where to replace in. list1 true string null The list of the strings to be replaced list2 true string null The list of the strings which are the new items. delimiter false string , The delimiter of the lists. return type string returnError Public Function returnError source: /usr/local/tomcat/webapps/ROOT/Components/Result/ReturnStruct.cfc Returns a structure containing detailed error info. It also logs the error in the CF-admin. arguments label name required type default hint me_id true numeric null The code for this error, it will be used to get the errormessage. errorStructure false any null The optional cfcatch structure. dumpVariable false any null An optional variable to dump. return type struct returnQueryFromString Public Function returnQueryFromString source: /usr/local/tomcat/webapps/ROOT/Components/Result/ReturnStruct.cfc Generates a query with columns and multiple records. arguments label name required type default hint columnName true string null The columnname, this could be a list. value true string null The value. This could be a list valueSeparator false string , A separator for the value list, default is ','. This separates the columns. recordSeparator false string ; A separator for the value list, default is ';'. This separates the records return type query returnResult Public Function returnResult source: /usr/local/tomcat/webapps/ROOT/Components/Result/ReturnStruct.cfc Returns a structure containing status info and a resultquery (optional). arguments label name required type default hint resultQuery false query null The optional query containing the result. return type struct returnSecurity Public Function returnSecurity source: /usr/local/tomcat/webapps/ROOT/Components/Result/ReturnStruct.cfc Returns a security breach. arguments label name required type default hint return type struct searchModules Public Function searchModules source: /usr/local/tomcat/webapps/ROOT/Components/AdminCtrl/ModuleIO.cfc Returns module info with a search constraint. arguments label name required type default hint mm_id true string null The ID(s) of the modules. search false string A string containing the search. return type struct textToNumber Public Function textToNumber source: /usr/local/tomcat/webapps/ROOT/Components/Result/ReturnStruct.cfc Returns a number for the english word arguments label name required type default hint text true any null return type numeric trueFalseFormat Public Function trueFalseFormat source: /usr/local/tomcat/webapps/ROOT/Components/Result/ReturnStruct.cfc convert cf string to boolean arguments label name required type default hint exp true any null return type any uniqueListAppend Public Function uniqueListAppend source: /usr/local/tomcat/webapps/ROOT/Components/Result/ReturnStruct.cfc Adds an item to the list if that list does not contain it already. arguments label name required type default hint list true string null The list. items true string null The item(s) to add. delimiter false string , The delimiter (optional). return type string private getType Private Function getType source: /usr/local/tomcat/webapps/ROOT/Components/AdminCtrl/ModuleIO.cfc Returns the module tablename and primary key. arguments label name required type default hint type true string null The type, values: company, group. return type struct