| public |
| addBookmark | Public Function addBookmark source: /usr/local/tomcat/webapps/ROOT/Components/ContentMngt/ObjectIO.cfc Adds a bookmark | | arguments | | label | name | required | type | default | hint | | bookmark | true | string | The name of the bookmark | | | so_id | true | numeric | null | The id of the object. | | ml_id | true | numeric | null | The id of the language. |
| | return type | struct |
|
| addData | Public Function addData source: /usr/local/tomcat/webapps/ROOT/Components/WIS/DataIO.cfc Adds data. You can specify a query to insert directly data, so the query must and can only contain a column named data and ml_id. | | arguments | | label | name | required | type | default | hint | | data_type | true | string | null | The data type of the data, it accepts a lot of values. You can give SQL types(don't worry about nx or x), or the id wich can be find in the table data_types. | | dataQuery | false | query | null | A query to fill the new data record set. |
| | return type | struct |
|
| addDisplayPage | Public Function addDisplayPage source: /usr/local/tomcat/webapps/ROOT/Components/ContentMngt/PageIO.cfc Adds a page to another page | | arguments | | label | name | required | type | default | hint | | sp_name_default | true | string | null | The default name in the default language of the page | | st_id | true | numeric | null | The id of the template | | site_id | true | numeric | null | The id of the site | | sst_id | false | numeric | -1 | |
| | return type | struct |
|
| addLanguage | Public Function addLanguage source: /usr/local/tomcat/webapps/ROOT/Components/WIS/DataIO.cfc Adds for every data_id a new record for the new language. | | arguments | | label | name | required | type | default | hint | | ml_id | true | numeric | null | The ml_id of the new language. |
| | return type | struct |
|
| addNewsLetterPage | Public Function addNewsLetterPage source: /usr/local/tomcat/webapps/ROOT/Components/ContentMngt/PageIO.cfc Adds a page of newletter type to the specified site | | arguments | | label | name | required | type | default | hint | | nl_name | true | string | null | The name of the newsletter page | | st_id | true | numeric | null | The ID of the template | | site_id | true | numeric | null | The ID of the site to which the newsletter page belongs |
| | return type | struct |
|
| addObject | Public Function addObject source: /usr/local/tomcat/webapps/ROOT/Components/ContentMngt/ObjectIO.cfc Creates an object | | arguments | | label | name | required | type | default | hint | | msot_id | true | numeric | null | The id of the type of the object | | sp_id | true | numeric | null | The id of the page to insert the object in | | so_name | true | string | null | The name of the new object. | | parameters | false | any | null | A structure with values for each object type. | | isClone | false | boolean | false | Internal variable. | | LiveEditObject | false | boolean | false | Internal variable for liveedit. |
| | return type | struct |
|
| addPage | Public Function addPage source: /usr/local/tomcat/webapps/ROOT/Components/ContentMngt/PageIO.cfc Adds a page to another page | | arguments | | label | name | required | type | default | hint | | sp_id | true | numeric | null | The id of the main page | | ml_id | true | numeric | null | The id of the language which is the language of sp_name | | sp_name | true | string | null | The name of the page | | sp_name_default | true | string | null | The default name in the default language of the page | | st_id | true | numeric | null | The id of the template | | fillEmpty | true | boolean | null | Fill the template with empty content fields? |
| | return type | struct |
|
| addSite | Public Function addSite source: /usr/local/tomcat/webapps/ROOT/Components/ContentMngt/SiteIO.cfc Adds a website. | | arguments | | label | name | required | type | default | hint | | valueStructure | true | struct | null | The siteproperties and their values. | | languages | true | string | null | The languages the site must be available for. |
| | return type | struct |
|
| addSiteAdmin | Public Function addSiteAdmin source: /usr/local/tomcat/webapps/ROOT/Components/ContentMngt/SiteIO.cfc Adds an admin to a website. One of the arguments can be specified as a list. | | arguments | | label | name | required | type | default | hint | | site_id_list | true | string | null | The ID(s) of the website. | | wu_id_list | true | string | null | The ID(s) of the administrator. |
| | return type | struct |
|
| addSiteValues | Public Function addSiteValues source: /usr/local/tomcat/webapps/ROOT/Components/ContentMngt/SiteIO.cfc Adds the standard values for a website. | | arguments | | label | name | required | type | default | hint | | valueStructure | true | struct | null | The site properties and their values. |
| | return type | struct |
|
| addTemplate | Public Function addTemplate source: /usr/local/tomcat/webapps/ROOT/Components/ContentMngt/SiteIO.cfc Adds a template in a website. Note, after this you need to add a template part. | | arguments | | label | name | required | type | default | hint | | site_id | true | numeric | null | The ID of the site. | | name | true | string | null | The name of the new template |
| | return type | struct |
|
| addTemplatePart | Public Function addTemplatePart source: /usr/local/tomcat/webapps/ROOT/Components/ContentMngt/SiteIO.cfc Adds a template part in a template. | | arguments | | label | name | required | type | default | hint | | st_id | true | numeric | null | The ID of the template. | | stp_parent_id | true | numeric | null | The id of the parent part. 0 is a main part. |
| | return type | struct |
|
| ALLSCOPES | |
| buildMenu | Public Function buildMenu source: /usr/local/tomcat/webapps/ROOT/Components/ContentMngt/webSelect.cfc Returns a menu ordered query from all pages below a page. | | arguments | | label | name | required | type | default | hint | | sp_id | true | numeric | null | The id of the page. | | ml_id | true | numeric | null | The id of the language. | | checkRights | false | string | none | Check user rights for pages. Can be none, page or tree. | | countChildren | false | boolean | false | Count the children of each page. | | includeHiddenPages | false | boolean | false | Include the hidden pages. | | structHierchy | false | boolean | false | Return struct with subPages as property. |
| | return type | any |
|
| changeTemplate | Public Function changeTemplate source: /usr/local/tomcat/webapps/ROOT/Components/ContentMngt/PageIO.cfc Changes the template of a page, removes the objects from the template | | arguments | | label | name | required | type | default | hint | | sp_id | true | numeric | null | The ID of the page. | | st_id | true | numeric | null | The ID of the template. |
| | return type | struct |
|
| checkDatabase | Public Function checkDatabase source: /usr/local/tomcat/webapps/ROOT/Components/WIS/DataIO.cfc This function can repair the data parte of the database. | | arguments | | label | name | required | type | default | hint | | definition | true | query | null | A query wich contains a column named table, a column named column and and a column named data_type. For every column wich a data part, you needs to specify the table and the column name. | | repair | false | boolean | false | What has the function to do, repair or only report? Default is no, thus report. |
| | 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 |
|
| cleanRights | Public Function cleanRights source: /usr/local/tomcat/webapps/ROOT/Components/ContentMngt/PageIO.cfc Removes all rights which are not relevant | | arguments | | label | name | required | type | default | hint | | sp_id | true | numeric | null | The id of the page | | deep | true | numeric | null | Clean also the sub pages? |
| | return type | struct |
|
| cloneObject | Public Function cloneObject source: /usr/local/tomcat/webapps/ROOT/Components/ContentMngt/ObjectIO.cfc Clones an object. | | arguments | | label | name | required | type | default | hint | | so_id | true | numeric | null | The ID of the object. | | sp_id | true | numeric | null | The ID of the page. |
| | return type | struct |
|
| compileTemplate | Public Function compileTemplate source: /usr/local/tomcat/webapps/ROOT/Components/ContentMngt/SiteIO.cfc Compiles a cfm template | | arguments | | label | name | required | type | default | hint | | templateName | true | string | null | The name of the template to compile | | siteName | true | string | null | The name of the website | | replaceSpecialCharacters | true | boolean | null | Replace characters in the compiled template | | dateMask | false | string | null | The datemask to use. Can be used when it cannot be retrieved from the session. | | timeMask | false | string | null | The timemask to use. Can be used when it cannot be retrieved from the session. |
| | return type | string |
|
| COMPONENTCACHE | | Struct | | xcenter.gateways.gateways | Component (Components.XCenter.Gateways.Gateways) Only the functions and data members that are accessible from your location are displayed | | Extends | Components.xCenter.Datasources | | Hint | This component handles all gateway specific actions. | | this | | public | | ACTIONPERMISSIONS | | ActionPermissions | | class | com.Egengroup.Spider.Plugins.XCenter.ActionPermissions | | fields | | name | pattern | value | | READ_PROPERTIES | public static final int com.Egengroup.Spider.Plugins.XCenter.ActionPermissions.READ_PROPERTIES | 1 | | MODIFY_PROPERTIES | public static final int com.Egengroup.Spider.Plugins.XCenter.ActionPermissions.MODIFY_PROPERTIES | 2 | | DELETE | public static final int com.Egengroup.Spider.Plugins.XCenter.ActionPermissions.DELETE | 3 |
| | constructors | | interface | exceptions | | <init>() | |
| | methods | | return | interface | exceptions |
| | | Methods inherited from java.lang.Object | | wait, wait, wait, equals, toString, hashCode, getClass, notify, notifyAll |
|
| | addActionListener | Public Function addActionListener source: /usr/local/tomcat/webapps/ROOT/Components/xCenter/Gateways/Gateways.cfc Registers a content definition as listener to an action. | | arguments | | label | name | required | type | default | hint | | scd_id | true | numeric | null | The ID of the content definition. | | ga_id | true | numeric | null | The ID of the action. | | gal_component | true | string | null | The component to be called. | | gal_method | true | string | null | The method to be called. |
| | return type | struct |
| | addDatasource | Public Function addDatasource source: /usr/local/tomcat/webapps/ROOT/Components/xCenter/Datasources.cfc This function creates a WIS datasource in WIS. It doesn't create a datasource in CF. The realy handling of connecting/creating a gate to the datasource is handled in connector.cfc | | arguments | | label | name | required | type | default | hint | | wc_id | true | numeric | null | The id of the company where you want to create the WIS datasource. | | mdt_id | true | numeric | null | The id of the type of the datasource | | datasource_name | true | string | null | The name of the new WIS datasource | | datasource_description | true | string | null | The description of the WIS datasource | | datasource_share | true | boolean | null | Share the WIS datasource to lower companies? | | datasource_default | true | boolean | null | Indicates whether this datasource is default. | | datasourceProperties | true | struct | null | A structur with keys depending in the type of the WIS datasource |
| | return type | struct |
| | addGateway | Public Function addGateway source: /usr/local/tomcat/webapps/ROOT/Components/xCenter/Gateways/Gateways.cfc Adds a gateway. | | arguments | | label | name | required | type | default | hint | | gateway_name | true | string | null | The name of the gateway. | | gateway_description | true | string | null | The description of the gateway. | | gateway_share | true | boolean | null | Indicates whether to share this gateway. | | datasource_id | true | numeric | null | The ID of the datasource. | | wc_id | true | numeric | null | The ID of the company. |
| | return type | struct |
| | addGatewayAction | Public Function addGatewayAction source: /usr/local/tomcat/webapps/ROOT/Components/xCenter/Gateways/Gateways.cfc Adds a gateway-action. | | arguments | | label | name | required | type | default | hint | | ga_name | true | string | null | The name of the gateway. | | ga_display_name | true | string | null | The displayname of the gateway. | | ga_description | true | string | null | The description of the gateway. | | ga_hide | true | boolean | null | Hide the action for CMS. | | gateway_id | true | numeric | null | The ID of the gateway. |
| | return type | struct |
| | addGatewaySubActionParam | Public Function addGatewaySubActionParam source: /usr/local/tomcat/webapps/ROOT/Components/xCenter/Gateways/Gateways.cfc Adds a subaction parameter. | | arguments | | label | name | required | type | default | hint | | gas_id | true | numeric | null | The ID of the subaction. | | gasp_name | true | string | null | The name of the subaction parameter. | | gasp_default | true | string | null | The default of the subaction parameter. | | mgaspt_id | true | numeric | null | The ID of the subaction parametertype. |
| | return type | struct |
| | areSubactionsEqual | Public Function areSubactionsEqual source: /usr/local/tomcat/webapps/ROOT/Components/xCenter/Gateways/Gateways.cfc Checks if the subactions for the given action have equal instances and columns. | | arguments | | label | name | required | type | default | hint | | ga_id | true | numeric | null | The ID of the gateway action. |
| | return type | boolean |
| | checkAction | Public Function checkAction source: /usr/local/tomcat/webapps/ROOT/Components/xCenter/Gateways/Gateways.cfc Checks if the specified action exists. | | arguments | | label | name | required | type | default | hint | | ga_id | true | numeric | null | The ID of the action. |
| | return type | boolean |
| | 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 | | | 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 |
| | CONSTRAINTBLOCKCOMBINATORS | | ObjectConditionConstraintBlock | | class | com.Egengroup.Spider.Services.ObjectStorage.ObjectConditionConstraintBlock | | fields | | name | pattern | value | | CONSTRAINT_COMBINATOR_AND | public static final int com.Egengroup.Spider.Services.ObjectStorage.ObjectConditionConstraintBlock.CONSTRAINT_COMBINATOR_AND | 1 | | CONSTRAINT_COMBINATOR_OR | public static final int com.Egengroup.Spider.Services.ObjectStorage.ObjectConditionConstraintBlock.CONSTRAINT_COMBINATOR_OR | 2 |
| | constructors | | interface | exceptions | | <init>(int) | java.lang.IllegalArgumentException |
| | methods | | return | interface | exceptions | | java.util.List | getInnerStatements() | | | void | addConstraint(com.Egengroup.Spider.Services.ObjectStorage.ObjectConditionConstraint) | | | void | addConstraints(com.Egengroup.Spider.Services.ObjectStorage.ObjectConditionConstraintBlock) | | | int | getCombinator() | |
| | | Methods inherited from java.lang.Object | | wait, wait, wait, equals, toString, hashCode, getClass, notify, notifyAll |
|
| | CONSTRAINTOPERATORS | | ObjectConditionConstraintOperators | | class | com.Egengroup.Spider.Services.ObjectStorage.ObjectConditionConstraintOperators | | fields | | name | pattern | value | | EQUALS | public static final int com.Egengroup.Spider.Services.ObjectStorage.ObjectConditionConstraintOperators.EQUALS | 1 | | NOT_EQUALS | public static final int com.Egengroup.Spider.Services.ObjectStorage.ObjectConditionConstraintOperators.NOT_EQUALS | 2 | | LIKE | public static final int com.Egengroup.Spider.Services.ObjectStorage.ObjectConditionConstraintOperators.LIKE | 3 | | RANGE | public static final int com.Egengroup.Spider.Services.ObjectStorage.ObjectConditionConstraintOperators.RANGE | 4 |
| | constructors | | interface | exceptions | | <init>() | |
| | methods | | return | interface | exceptions |
| | | Methods inherited from java.lang.Object | | wait, wait, wait, equals, toString, hashCode, getClass, notify, notifyAll |
|
| | countCompanyDatasources | Public Function countCompanyDatasources source: /usr/local/tomcat/webapps/ROOT/Components/xCenter/Datasources.cfc Returns the amount of datasources for a company. | | arguments | | label | name | required | type | default | hint | | wc_id | true | numeric | null | The ID of the company. |
| | return type | numeric |
| | countDatasourceGateways | Public Function countDatasourceGateways source: /usr/local/tomcat/webapps/ROOT/Components/xCenter/Datasources.cfc Returns the amount of gateways of a datasource. | | arguments | | label | name | required | type | default | hint | | datasource_id | true | numeric | null | The ID of the datasource. |
| | return type | numeric |
| | countGatewayActions | Public Function countGatewayActions source: /usr/local/tomcat/webapps/ROOT/Components/xCenter/Gateways/Gateways.cfc Returns the amount of actions for a gateway. | | arguments | | label | name | required | type | default | hint | | gateway_id | true | numeric | null | The ID of the gateway. |
| | return type | numeric |
| | countGatewaySubActionParams | Public Function countGatewaySubActionParams source: /usr/local/tomcat/webapps/ROOT/Components/xCenter/Gateways/Gateways.cfc Returns the amount of params for a subaction. | | arguments | | label | name | required | type | default | hint | | gas_id | true | numeric | null | The ID of the subaction. |
| | 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 |
| | createContentOfflineItemDataNew | Public Function createContentOfflineItemDataNew source: /usr/local/tomcat/webapps/ROOT/Components/xCenter/Gateways/Gateways.cfc Creates the xml data | | arguments | | label | name | required | type | default | hint | | ga_id | true | numeric | null | The id of the action | | argStruct | true | struct | null | The struct with values, if the datasource supports multilingual, we expect an innerstructure languages. |
| | return type | struct |
| | createContentOfflineItemDataUpdate | Public Function createContentOfflineItemDataUpdate source: /usr/local/tomcat/webapps/ROOT/Components/xCenter/Gateways/Gateways.cfc Creates the xml data | | arguments | | label | name | required | type | default | hint | | vmov_id | true | numeric | null | The id of the version | | ga_id | true | numeric | null | The id of the action | | argStruct | true | struct | null | The struct with values | | argStructOld | false | struct | null | The struct with values |
| | return type | struct |
| | createOfflineItem | Public Function createOfflineItem source: /usr/local/tomcat/webapps/ROOT/Components/xCenter/Gateways/Gateways.cfc Creates an offline item | | arguments | | label | name | required | type | default | hint | | ga_id | true | numeric | null | The ID of the action. | | argStruct | true | struct | null | The parameters for the action. |
| | return type | struct |
| | DATASOURCEOPERATIONS | | DatasourceOperations | | class | com.Egengroup.Spider.Plugins.XCenter.DatasourceOperations | | fields | | name | pattern | value | | OPERATION_READ | public static final int com.Egengroup.Spider.Plugins.XCenter.DatasourceOperations.OPERATION_READ | 1 | | OPERATION_ADD | public static final int com.Egengroup.Spider.Plugins.XCenter.DatasourceOperations.OPERATION_ADD | 2 | | OPERATION_CHANGE | public static final int com.Egengroup.Spider.Plugins.XCenter.DatasourceOperations.OPERATION_CHANGE | 3 | | OPERATION_REMOVE | public static final int com.Egengroup.Spider.Plugins.XCenter.DatasourceOperations.OPERATION_REMOVE | 4 | | OPERATION_DUPLICATE | public static final int com.Egengroup.Spider.Plugins.XCenter.DatasourceOperations.OPERATION_DUPLICATE | 5 | | OPERATION_ORDER | public static final int com.Egengroup.Spider.Plugins.XCenter.DatasourceOperations.OPERATION_ORDER | 6 | | OPERATION_HIDE | public static final int com.Egengroup.Spider.Plugins.XCenter.DatasourceOperations.OPERATION_HIDE | 7 | | OPERATION_PERSONALIZATION | public static final int com.Egengroup.Spider.Plugins.XCenter.DatasourceOperations.OPERATION_PERSONALIZATION | 8 | | OPERATION_AUTOSUBACTIONS | public static final int com.Egengroup.Spider.Plugins.XCenter.DatasourceOperations.OPERATION_AUTOSUBACTIONS | 9 | | OPERATION_MULTILINGUAL | public static final int com.Egengroup.Spider.Plugins.XCenter.DatasourceOperations.OPERATION_MULTILINGUAL | 10 | | OPERATION_CREATORCOMPANY | public static final int com.Egengroup.Spider.Plugins.XCenter.DatasourceOperations.OPERATION_CREATORCOMPANY | 11 |
| | constructors | | interface | exceptions | | <init>() | |
| | methods | | return | interface | exceptions |
| | | Methods inherited from java.lang.Object | | wait, wait, wait, equals, toString, hashCode, getClass, notify, notifyAll |
|
| | DATASOURCEPERMISSIONS | | DatasourcePermissions | | class | com.Egengroup.Spider.Plugins.XCenter.DatasourcePermissions | | fields | | name | pattern | value | | READ_PROPERTIES | public static final int com.Egengroup.Spider.Plugins.XCenter.DatasourcePermissions.READ_PROPERTIES | 1 | | MODIFY_PROPERTIES | public static final int com.Egengroup.Spider.Plugins.XCenter.DatasourcePermissions.MODIFY_PROPERTIES | 2 | | CONNECT | public static final int com.Egengroup.Spider.Plugins.XCenter.DatasourcePermissions.CONNECT | 3 | | DELETE | public static final int com.Egengroup.Spider.Plugins.XCenter.DatasourcePermissions.DELETE | 4 | | ADD_GATEWAY | public static final int com.Egengroup.Spider.Plugins.XCenter.DatasourcePermissions.ADD_GATEWAY | 5 | | TEST_CONNECTION | public static final int com.Egengroup.Spider.Plugins.XCenter.DatasourcePermissions.TEST_CONNECTION | 6 | | PERSONALIZE_DATA | public static final int com.Egengroup.Spider.Plugins.XCenter.DatasourcePermissions.PERSONALIZE_DATA | 7 |
| | constructors | | interface | exceptions | | <init>() | |
| | methods | | return | interface | exceptions |
| | | Methods inherited from java.lang.Object | | wait, wait, wait, equals, toString, hashCode, getClass, notify, notifyAll |
|
| | deleteAction | Public Function deleteAction source: /usr/local/tomcat/webapps/ROOT/Components/xCenter/Gateways/Gateways.cfc Removes a gateway-action. | | arguments | | label | name | required | type | default | hint | | ga_id | true | numeric | null | The ID of the gateway-action. |
| | return type | struct |
| | deleteGateway | Public Function deleteGateway source: /usr/local/tomcat/webapps/ROOT/Components/xCenter/Gateways/Gateways.cfc Removes a gateway. | | arguments | | label | name | required | type | default | hint | | gateway_id | true | numeric | null | The ID of the gateway. |
| | return type | struct |
| | deleteGatewaySubActionParameter | Public Function deleteGatewaySubActionParameter source: /usr/local/tomcat/webapps/ROOT/Components/xCenter/Gateways/Gateways.cfc Removes a subaction parameter. Cannot remove system parameters. | | arguments | | label | name | required | type | default | hint | | gasp_id | true | numeric | null | The ID of the subaction parameter. |
| | 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 |
| | dropDatasource | Public Function dropDatasource source: /usr/local/tomcat/webapps/ROOT/Components/xCenter/Datasources.cfc Removes a datasource. | | arguments | | label | name | required | type | default | hint | | datasource_id | true | numeric | null | The ID of the datasource. |
| | return type | struct |
| | duplicateItem | Public Function duplicateItem source: /usr/local/tomcat/webapps/ROOT/Components/xCenter/Gateways/Gateways.cfc Duplicates an item. | | arguments | | label | name | required | type | default | hint | | ga_id | true | numeric | null | The ID of the gateway action. | | vmov_id | true | numeric | null | The ID of the item. | | system_id | true | string | null | The ID of the item. |
| | return type | struct |
| | executeAddAction | Public Function executeAddAction source: /usr/local/tomcat/webapps/ROOT/Components/xCenter/Gateways/Gateways.cfc Executes an add action on a datasource. | | arguments | | label | name | required | type | default | hint | | ga_id | true | numeric | null | The ID of the action. | | argStruct | true | struct | null | The parameters for the action. | | publish | true | boolean | null | Directly publish the item? |
| | return type | struct |
| | executeChangeAction | Public Function executeChangeAction source: /usr/local/tomcat/webapps/ROOT/Components/xCenter/Gateways/Gateways.cfc Executes a change action on a datasource. | | arguments | | label | name | required | type | default | hint | | ga_id | true | numeric | null | The ID of the action. | | ml_id | true | numeric | null | The ID of the language. | | ga_argStruct | true | struct | null | The parameters for the action. | | vmov_id | true | numeric | null | The version of the item to update | | publish | true | boolean | null | Publish this version directly? | | ga_argStructOld | false | struct | null | The old parameters for the action. |
| | return type | struct |
| | executeReadAction | Public Function executeReadAction source: /usr/local/tomcat/webapps/ROOT/Components/xCenter/Gateways/Gateways.cfc Executes a read action on a datasource. | | arguments | | label | name | required | type | default | hint | | ga_id | true | numeric | null | The ID of the action. | | queryParamStruct | true | struct | null | Parameter structure containing parameters for the query itself. | | executeParamStruct | true | struct | null | Parameter structure containing parameters for the execution. |
| | return type | any |
| | executeRemoveAction | Public Function executeRemoveAction source: /usr/local/tomcat/webapps/ROOT/Components/xCenter/Gateways/Gateways.cfc Executes a remove action on a datasource. | | arguments | | label | name | required | type | default | hint | | ga_id | true | numeric | null | The ID of the action. | | system_id | true | string | null | The parameters for the action. | | vmov_id | true | numeric | null | The id of the version object. |
| | return type | any |
| | executeRemoveActionNow | Public Function executeRemoveActionNow source: /usr/local/tomcat/webapps/ROOT/Components/xCenter/Gateways/Gateways.cfc Executes a remove action on a datasource. | | arguments | | label | name | required | type | default | hint | | ga_id | true | numeric | null | The ID of the action. | | system_id | true | string | null | The parameters for the action. |
| | return type | any |
| | FACTORY | | XCenterFactoryProxy | | class | com.Egengroup.Spider.Plugins.XCenter.XCenterFactoryProxy | | methods | | return | interface | exceptions | | com.Egengroup.Spider.Plugins.XCenter.XCenterFactoryProxy | getInstance(com.Egengroup.Spider.Authorization.AuthToken) | | | com.Egengroup.Spider.Plugins.XCenter.IDatasource[] | getCompanyDatasources(com.Egengroup.Spider.Plugins.UserManagement.Company.Company, com.Egengroup.Spider.Plugins.XCenter.DatasourceCondition) | com.Egengroup.Spider.Authorization.UnauthorizedException
com.Egengroup.Spider.Plugins.XCenter.DatasourceException | | com.Egengroup.Spider.Plugins.XCenter.IDatasource[] | getCompanyDatasources(com.Egengroup.Spider.Plugins.UserManagement.Company.Company) | com.Egengroup.Spider.Authorization.UnauthorizedException
com.Egengroup.Spider.Plugins.XCenter.DatasourceException | | com.Egengroup.Spider.Plugins.XCenter.ISubaction | getSubAction(int) | com.Egengroup.Spider.Authorization.UnauthorizedException
com.Egengroup.Spider.Plugins.XCenter.NoSuchActionException
com.Egengroup.Spider.Plugins.XCenter.ActionException
com.Egengroup.Spider.Plugins.XCenter.SubactionException | | com.Egengroup.Spider.Plugins.XCenter.IGateway[] | getCompanyGateways(com.Egengroup.Spider.Plugins.UserManagement.Company.Company, com.Egengroup.Spider.Plugins.XCenter.GatewayCondition) | com.Egengroup.Spider.Authorization.UnauthorizedException
com.Egengroup.Spider.Plugins.XCenter.GatewayException | | com.Egengroup.Spider.Plugins.XCenter.IGateway[] | getCompanyGateways(com.Egengroup.Spider.Plugins.UserManagement.Company.Company) | com.Egengroup.Spider.Authorization.UnauthorizedException
com.Egengroup.Spider.Plugins.XCenter.GatewayException | | com.Egengroup.Spider.Plugins.XCenter.IAction | getAction(int) | com.Egengroup.Spider.Authorization.UnauthorizedException
com.Egengroup.Spider.Plugins.XCenter.NoSuchActionException
com.Egengroup.Spider.Plugins.XCenter.ActionException | | com.Egengroup.Spider.Plugins.XCenter.IGateway | getGateway(int) | com.Egengroup.Spider.Authorization.UnauthorizedException
com.Egengroup.Spider.Plugins.XCenter.NoSuchGatewayException
com.Egengroup.Spider.Plugins.XCenter.GatewayException | | com.Egengroup.Spider.Plugins.XCenter.IDatasource | getDatasource(int) | com.Egengroup.Spider.Authorization.UnauthorizedException
com.Egengroup.Spider.Plugins.XCenter.NoSuchDatasourceException
com.Egengroup.Spider.Plugins.XCenter.DatasourceException | | void | invalidateCache() | | | void | deleteCompanyReferences(com.Egengroup.Spider.Plugins.UserManagement.Company.Company) | com.Egengroup.Spider.Authorization.UnauthorizedException
com.Egengroup.Spider.Plugins.XCenter.XCenterException |
| | | Methods inherited from java.lang.Object | | wait, wait, wait, equals, toString, hashCode, getClass, notify, notifyAll |
|
| | FOREIGNITEMSCACHE | | | FOREIGNITEMSQUERYCACHE | | | GATEWAYPERMISSIONS | | GatewayPermissions | | class | com.Egengroup.Spider.Plugins.XCenter.GatewayPermissions | | fields | | name | pattern | value | | READ_PROPERTIES | public static final int com.Egengroup.Spider.Plugins.XCenter.GatewayPermissions.READ_PROPERTIES | 1 | | MODIFY_PROPERTIES | public static final int com.Egengroup.Spider.Plugins.XCenter.GatewayPermissions.MODIFY_PROPERTIES | 2 | | DELETE | public static final int com.Egengroup.Spider.Plugins.XCenter.GatewayPermissions.DELETE | 3 | | ADD_ACTION | public static final int com.Egengroup.Spider.Plugins.XCenter.GatewayPermissions.ADD_ACTION | 4 |
| | constructors | | interface | exceptions | | <init>() | |
| | methods | | return | interface | exceptions |
| | | Methods inherited from java.lang.Object | | wait, wait, wait, equals, toString, hashCode, getClass, notify, notifyAll |
|
| | 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 |
| | getAction | Public Function getAction source: /usr/local/tomcat/webapps/ROOT/Components/xCenter/Gateways/Gateways.cfc Returns the java-object of an action. | | arguments | | label | name | required | type | default | hint | | ga_id | true | numeric | null | The ID of the action. |
| | return type | any |
| | getActionDatasourceType | Public Function getActionDatasourceType source: /usr/local/tomcat/webapps/ROOT/Components/xCenter/Gateways/Gateways.cfc Returns the datasourcetype for an action. | | arguments | | label | name | required | type | default | hint | | ga_id | true | numeric | null | The ID of the action. |
| | return type | numeric |
| | getActionStructure | Public Function getActionStructure source: /usr/local/tomcat/webapps/ROOT/Components/xCenter/Gateways/Gateways.cfc Retrieves the structure for an action. | | arguments | | label | name | required | type | default | hint | | ga_id | true | numeric | null | The ID of the action. | | gas_type | true | numeric | null | The type of the subaction. |
| | return type | any |
| | getActionSubactionID | Public Function getActionSubactionID source: /usr/local/tomcat/webapps/ROOT/Components/xCenter/Gateways/Gateways.cfc Returns the ID of a subaction based on an actionID and a subaction type. | | arguments | | label | name | required | type | default | hint | | ga_id | true | numeric | null | The ID of the gateway-action. | | gas_type | true | numeric | null | The type of the subaction. |
| | return type | struct |
| | getAddActionColumns | Public Function getAddActionColumns source: /usr/local/tomcat/webapps/ROOT/Components/xCenter/Gateways/Gateways.cfc Retrieves the columns for an addaction. | | arguments | | label | name | required | type | default | hint | | ga_id | true | numeric | null | The ID of the action. |
| | return type | struct |
| | getAddActionRelations | Public Function getAddActionRelations source: /usr/local/tomcat/webapps/ROOT/Components/xCenter/Gateways/Gateways.cfc Retrieves the relations for an addaction. | | arguments | | label | name | required | type | default | hint | | ga_id | true | numeric | null | The ID of the action. |
| | return type | struct |
| | getAddActionTables | Public Function getAddActionTables source: /usr/local/tomcat/webapps/ROOT/Components/xCenter/Gateways/Gateways.cfc Returns the ID's of the tables involved in an add action. | | arguments | | label | name | required | type | default | hint | | ga_id | true | numeric | null | The ID of the action. |
| | return type | struct |
| | getChangeActionColumns | Public Function getChangeActionColumns source: /usr/local/tomcat/webapps/ROOT/Components/xCenter/Gateways/Gateways.cfc Retrieves the columns for a changeaction. | | arguments | | label | name | required | type | default | hint | | ga_id | true | numeric | null | The ID of the action. |
| | return type | struct |
| | getChangeActionRelations | Public Function getChangeActionRelations source: /usr/local/tomcat/webapps/ROOT/Components/xCenter/Gateways/Gateways.cfc Retrieves the relations for a changeaction. | | arguments | | label | name | required | type | default | hint | | ga_id | true | numeric | null | The ID of the action. |
| | return type | struct |
| | getChangeActionTables | Public Function getChangeActionTables source: /usr/local/tomcat/webapps/ROOT/Components/xCenter/Gateways/Gateways.cfc Returns the ID's of the tables involved in a change action. | | arguments | | label | name | required | type | default | hint | | ga_id | true | numeric | null | The ID of the action. |
| | return type | struct |
| | getCompanyDatasources | Public Function getCompanyDatasources source: /usr/local/tomcat/webapps/ROOT/Components/xCenter/Datasources.cfc Returns the datasources for a company. | | arguments | | label | name | required | type | default | hint | | wc_id | true | numeric | null | The ID of the company. | | search | false | string | | The searchstring. | | startRow | false | numeric | 1 | The startrow. | | maxRows | false | numeric | -1 | The maxrows. |
| | return type | any |
| | getCompanyDefaultDatasource | Public Function getCompanyDefaultDatasource source: /usr/local/tomcat/webapps/ROOT/Components/xCenter/Datasources.cfc Returns the ID of the default datasource for a company. | | arguments | | label | name | required | type | default | hint | | wc_id | true | numeric | null | The ID of the company. |
| | return type | struct |
| | getCompanyGateways | Public Function getCompanyGateways source: /usr/local/tomcat/webapps/ROOT/Components/xCenter/Gateways/Gateways.cfc Returns the gateways for a company. | | arguments | | label | name | required | type | default | hint | | wc_id | true | numeric | null | The ID of the company. |
| | return type | any |
| | 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 |
| | getDatasource | Public Function getDatasource source: /usr/local/tomcat/webapps/ROOT/Components/xCenter/Datasources.cfc Returns a datasource. | | arguments | | label | name | required | type | default | hint | | datasource_id | true | numeric | null | The ID of the datasource. |
| | return type | any |
| | getDatasourceDefaultCondition | Public Function getDatasourceDefaultCondition source: /usr/local/tomcat/webapps/ROOT/Components/xCenter/Datasources.cfc Returns the default condition for datasources. | | arguments | | label | name | required | type | default | hint |
| | return type | any |
| | getDatasourceGateways | Public Function getDatasourceGateways source: /usr/local/tomcat/webapps/ROOT/Components/xCenter/Datasources.cfc Returns the gateways of a datasource. | | arguments | | label | name | required | type | default | hint | | datasource_id | true | numeric | null | The ID of the datasource. | | search | false | string | | The searchstring. | | startRow | false | numeric | 1 | The startrow. | | maxRows | false | numeric | -1 | The maxrows. |
| | return type | array |
| | getDatasourceSupportedOperations | Public Function getDatasourceSupportedOperations source: /usr/local/tomcat/webapps/ROOT/Components/xCenter/Datasources.cfc Returns the supported operations for a datasourcetype. | | arguments | | label | name | required | type | default | hint | | datasource_id | true | numeric | null | The ID of the datasource. |
| | return type | struct |
| | getDatasourceTypeValues | Public Function getDatasourceTypeValues source: /usr/local/tomcat/webapps/ROOT/Components/xCenter/Datasources.cfc Returns the values of a datasourcetype. If no mdt_id is defined, it returns all types. | | arguments | | label | name | required | type | default | hint | | mdt_id | false | numeric | null | The ID of the type. |
| | return type | struct |
| | getGateway | Public Function getGateway source: /usr/local/tomcat/webapps/ROOT/Components/xCenter/Gateways/Gateways.cfc Returns a gateway. | | arguments | | label | name | required | type | default | hint | | gateway_id | true | numeric | null | The ID of the gateway. |
| | return type | any |
| | getGatewayActions | Public Function getGatewayActions source: /usr/local/tomcat/webapps/ROOT/Components/xCenter/Gateways/Gateways.cfc Returns the actions for a gateway. | | arguments | | label | name | required | type | default | hint | | gateway_id | true | numeric | null | The ID of the gateway. | | search | false | string | | The searchstring. | | startRow | false | numeric | 1 | The startrow. | | maxRows | false | numeric | -1 | The maxrows. |
| | return type | array |
| | getGatewaySubActionParams | Public Function getGatewaySubActionParams source: /usr/local/tomcat/webapps/ROOT/Components/xCenter/Gateways/Gateways.cfc Returns the ID's of the params for a subaction. | | arguments | | label | name | required | type | default | hint | | gas_id | true | numeric | null | The ID of the subaction. |
| | return type | struct |
| | getGatewaySubActionParamTypeValues | Public Function getGatewaySubActionParamTypeValues source: /usr/local/tomcat/webapps/ROOT/Components/xCenter/Gateways/Gateways.cfc Returns the values of subaction parameter types. | | arguments | | label | name | required | type | default | hint | | mgaspt_id_list | false | string | null | The ID(s) of the subaction parameter type(s). |
| | return type | struct |
| | getGatewaySubActionParamValues | Public Function getGatewaySubActionParamValues source: /usr/local/tomcat/webapps/ROOT/Components/xCenter/Gateways/Gateways.cfc Returns the values of a subaction parameter. | | arguments | | label | name | required | type | default | hint | | gasp_id_list | true | string | null | The ID(s) of the subaction parameter(s). |
| | return type | struct |
| | getHelperObject | Public Function getHelperObject source: /usr/local/tomcat/webapps/ROOT/Components/xCenter/Gateways/Gateways.cfc Returns the component for a specific datasourcetype. | | arguments | | label | name | required | type | default | hint | | ga_id | true | numeric | null | The ID of the action. | | gas_type | true | numeric | null | The type of the subaction. |
| | return type | any |
| | getItemPersonalizedGroups | Public Function getItemPersonalizedGroups source: /usr/local/tomcat/webapps/ROOT/Components/xCenter/Gateways/Gateways.cfc | | arguments | | label | name | required | type | default | hint | | ga_id | true | numeric | null | The ID of the gateway action. | | system_id | true | string | null | The ID of the item. | | vmov_id | true | numeric | null | The ID of the item. |
| | return type | struct |
| | getItemValues | Public Function getItemValues source: /usr/local/tomcat/webapps/ROOT/Components/xCenter/Gateways/Gateways.cfc Returns the values of an item. | | arguments | | label | name | required | type | default | hint | | vmo_id | true | numeric | null | The id of the item |
| | 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 |
| | getReadActionColumns | Public Function getReadActionColumns source: /usr/local/tomcat/webapps/ROOT/Components/xCenter/Gateways/Gateways.cfc Retrieves the columns for a readaction. | | arguments | | label | name | required | type | default | hint | | ga_id | true | numeric | null | The ID of the action. |
| | return type | struct |
| | getReadActionConstraints | Public Function getReadActionConstraints source: /usr/local/tomcat/webapps/ROOT/Components/xCenter/Gateways/Gateways.cfc Retrieves the constraints for an action. | | arguments | | label | name | required | type | default | hint | | ga_id | true | numeric | null | The ID of the action. |
| | return type | struct |
| | getReadActionConstraintsBlocks | Public Function getReadActionConstraintsBlocks source: /usr/local/tomcat/webapps/ROOT/Components/xCenter/Gateways/Gateways.cfc Retrieves the constraintblocks for an action. | | arguments | | label | name | required | type | default | hint | | ga_id | true | numeric | null | The ID of the action. |
| | return type | struct |
| | getReadActionDisplayColumn | Public Function getReadActionDisplayColumn source: /usr/local/tomcat/webapps/ROOT/Components/xCenter/Gateways/Gateways.cfc Retrieves the displaycolumn for a readaction. | | arguments | | label | name | required | type | default | hint | | ga_id | true | numeric | null | The ID of the action. |
| | return type | string |
| | getReadActionForeignItems | Public Function getReadActionForeignItems source: /usr/local/tomcat/webapps/ROOT/Components/xCenter/Gateways/Gateways.cfc Returns the linked items of a foreign table. | | arguments | | label | name | required | type | default | hint | | ga_id | true | numeric | null | The ID of the action. | | executeParamStruct | true | struct | null | Parameter structure containing parameters for the execution. |
| | return type | any |
| | getReadActionForeignItemsAsQuery | Public Function getReadActionForeignItemsAsQuery source: /usr/local/tomcat/webapps/ROOT/Components/xCenter/Gateways/Gateways.cfc Returns the linked items of a foreign table. | | arguments | | label | name | required | type | default | hint | | ga_id | true | numeric | null | The ID of the action. | | executeParamStruct | true | struct | null | Parameter structure containing parameters for the execution. |
| | return type | any |
| | getReadActionOrder | Public Function getReadActionOrder source: /usr/local/tomcat/webapps/ROOT/Components/xCenter/Gateways/Gateways.cfc Retrieves the order clause for an action. | | arguments | | label | name | required | type | default | hint | | ga_id | true | numeric | null | The ID of the action. |
| | return type | struct |
| | getReadActionParameters | Public Function getReadActionParameters source: /usr/local/tomcat/webapps/ROOT/Components/xCenter/Gateways/Gateways.cfc Returns the parameters involved in a read action. | | arguments | | label | name | required | type | default | hint | | ga_id | true | numeric | null | The ID of the action. |
| | return type | struct |
| | getReadActionRelations | Public Function getReadActionRelations source: /usr/local/tomcat/webapps/ROOT/Components/xCenter/Gateways/Gateways.cfc Retrieves the relations for a readaction. | | arguments | | label | name | required | type | default | hint | | ga_id | true | numeric | null | The ID of the action. |
| | return type | struct |
| | getReadActionSystemColumn | Public Function getReadActionSystemColumn source: /usr/local/tomcat/webapps/ROOT/Components/xCenter/Gateways/Gateways.cfc Retrieves the systemcolumn for a readaction. | | arguments | | label | name | required | type | default | hint | | ga_id | true | numeric | null | The ID of the action. |
| | return type | string |
| | getReadActionTables | Public Function getReadActionTables source: /usr/local/tomcat/webapps/ROOT/Components/xCenter/Gateways/Gateways.cfc Returns the ID's of the tables involved in a read action. | | arguments | | label | name | required | type | default | hint | | ga_id | true | numeric | null | The ID of the action. |
| | return type | struct |
| | getReadActionVisibleColumn | Public Function getReadActionVisibleColumn source: /usr/local/tomcat/webapps/ROOT/Components/xCenter/Gateways/Gateways.cfc Retrieves the visiblecolumn for a readaction. | | arguments | | label | name | required | type | default | hint | | ga_id | true | numeric | null | The ID of the action. |
| | return type | string |
| | getRemoveActionTables | Public Function getRemoveActionTables source: /usr/local/tomcat/webapps/ROOT/Components/xCenter/Gateways/Gateways.cfc Returns the ID's of the tables involved in a remove action. | | arguments | | label | name | required | type | default | hint | | ga_id | true | numeric | null | The ID of the action. |
| | return type | struct |
| | getSubActionValues | Public Function getSubActionValues source: /usr/local/tomcat/webapps/ROOT/Components/xCenter/Gateways/Gateways.cfc Retrieves the subaction values. | | arguments | | label | name | required | type | default | hint | | gas_id | true | numeric | null | The ID of the subaction. |
| | return type | struct |
| | getSupportedOperations | Public Function getSupportedOperations source: /usr/local/tomcat/webapps/ROOT/Components/xCenter/Gateways/Gateways.cfc Returns the supported operations of a gateway action | | arguments | | label | name | required | type | default | hint | | ga_id | true | numeric | null | The ID of the action. |
| | return type | struct |
| | 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 |
| | HELPEROBJECTS | | | isExistingDatasource | Public Function isExistingDatasource source: /usr/local/tomcat/webapps/ROOT/Components/xCenter/Datasources.cfc Checks if a datasource with that name already exists on a company | | arguments | | label | name | required | type | default | hint | | wc_id | true | numeric | null | The id of the company | | datasource_name | true | string | null | The name of the datasource |
| | 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 |
| | notifyListeners | Public Function notifyListeners source: /usr/local/tomcat/webapps/ROOT/Components/xCenter/Gateways/Gateways.cfc Notifies the listeners on an action. | | arguments | | label | name | required | type | default | hint | | ga_id | true | numeric | null | The ID of the action. | | invokeType | false | string | unknown | Indicates why the listener is notified. |
| | return type | struct |
| | 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 |
| | publishItem | Public Function publishItem source: /usr/local/tomcat/webapps/ROOT/Components/xCenter/Gateways/Gateways.cfc Creates an online version of an offline version from a item. | | arguments | | label | name | required | type | default | hint | | ga_id | true | numeric | null | The id of the action | | vmov_id | true | numeric | null | The id of the offline version to publish | | wu_id | true | numeric | null | The id of the offline version to publish |
| | return type | struct |
| | 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 |
| | READACTIONCOLUMNS | | | READACTIONRELATIONS | | | READACTIONTABLES | | | 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 |
| | removeActionListeners | Public Function removeActionListeners source: /usr/local/tomcat/webapps/ROOT/Components/xCenter/Gateways/Gateways.cfc Removes a content definition as listener to all actions. | | arguments | | label | name | required | type | default | hint | | scd_id | true | numeric | null | The ID of the content definition. |
| | return type | struct |
| | 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 |
| | setItemHide | Public Function setItemHide source: /usr/local/tomcat/webapps/ROOT/Components/xCenter/Gateways/Gateways.cfc Hides or unhides an item. | | arguments | | label | name | required | type | default | hint | | ga_id | true | numeric | null | The ID of the action. | | system_id | true | numeric | null | The ID of the item. | | ml_id | true | numeric | null | The ID of the language. | | hide | true | boolean | null | Hide or unhide the item. |
| | return type | struct |
| | setItemHideAllLanguages | Public Function setItemHideAllLanguages source: /usr/local/tomcat/webapps/ROOT/Components/xCenter/Gateways/Gateways.cfc Hides or unhides an item for all languages. | | arguments | | label | name | required | type | default | hint | | ga_id | true | numeric | null | The ID of the action. | | system_id | true | numeric | null | The ID of the item. | | hide | true | boolean | null | Hide or unhide the item. |
| | return type | struct |
| | setItemPersonalizedGroups | Public Function setItemPersonalizedGroups source: /usr/local/tomcat/webapps/ROOT/Components/xCenter/Gateways/Gateways.cfc | | arguments | | label | name | required | type | default | hint | | ga_id | true | numeric | null | The ID of the gateway action. | | system_id | true | string | null | The ID of the item. | | vmov_id | true | numeric | null | The ID of the item. | | groupQuery | true | query | null | The query containing the groups that should have access to the item. |
| | return type | struct |
| | setItemPersonalizedGroupsList | Public Function setItemPersonalizedGroupsList source: /usr/local/tomcat/webapps/ROOT/Components/xCenter/Gateways/Gateways.cfc | | arguments | | label | name | required | type | default | hint | | ga_id | true | numeric | null | The ID of the gateway action. | | system_id | true | string | null | The ID of the item. | | vmov_id | true | numeric | null | The ID of the item. | | groupList | true | struct | null | The query containing the groups that should have access to the item. |
| | return type | struct |
| | structureToExecutionParameters | Public Function structureToExecutionParameters source: /usr/local/tomcat/webapps/ROOT/Components/xCenter/Gateways/Gateways.cfc Converts a structure to a com.Egengroup.Spider.Plugins.XCenter.ExecutionParameters. | | arguments | | label | name | required | type | default | hint | | paramStructure | true | struct | null | The structure containing the parameters. |
| | return type | any |
| | SUBACTIONPERMISSIONS | | SubactionPermissions | | class | com.Egengroup.Spider.Plugins.XCenter.SubactionPermissions | | fields | | name | pattern | value | | READ_PROPERTIES | public static final int com.Egengroup.Spider.Plugins.XCenter.SubactionPermissions.READ_PROPERTIES | 1 | | MODIFY_PROPERTIES | public static final int com.Egengroup.Spider.Plugins.XCenter.SubactionPermissions.MODIFY_PROPERTIES | 2 | | DELETE | public static final int com.Egengroup.Spider.Plugins.XCenter.SubactionPermissions.DELETE | 3 |
| | constructors | | interface | exceptions | | <init>() | |
| | methods | | return | interface | exceptions |
| | | Methods inherited from java.lang.Object | | wait, wait, wait, equals, toString, hashCode, getClass, notify, notifyAll |
|
| | SUPPORTEDOPERATIONS | | | supportsOffline | Public Function supportsOffline source: /usr/local/tomcat/webapps/ROOT/Components/xCenter/Gateways/Gateways.cfc Checks if a gateway action supports offline-items. | | arguments | | label | name | required | type | default | hint | | ga_id | true | numeric | null | The id of the gateway action |
| | return type | boolean |
| | 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 |
| | updateContentOfflineItem | Public Function updateContentOfflineItem source: /usr/local/tomcat/webapps/ROOT/Components/xCenter/Gateways/Gateways.cfc Creates the content for an offline item | | arguments | | label | name | required | type | default | hint | | vmov_id | true | numeric | null | The id of the version | | ga_id | true | numeric | null | The id of the action | | argStruct | true | struct | null | The struct with values | | argStructOld | false | struct | null | The struct with values |
| | return type | struct |
|
| | package | | purgeSubactionDataStructure | Package Function purgeSubactionDataStructure source: /usr/local/tomcat/webapps/ROOT/Components/xCenter/Gateways/Gateways.cfc Purges the datastructure of a subaction. | | arguments | | label | name | required | type | default | hint | | gas_id | true | numeric | null | The ID of the subaction. |
| | return type | any |
| | resetSubactionsEquality | Package Function resetSubactionsEquality source: /usr/local/tomcat/webapps/ROOT/Components/xCenter/Gateways/Gateways.cfc Rechecks if the subactions for the given action have equal instances and columns. | | arguments | | label | name | required | type | default | hint | | ga_id | true | numeric | null | The ID of the gateway action. |
| | return type | any |
|
| | private | | createConstraint | Private Function createConstraint source: /usr/local/tomcat/webapps/ROOT/Components/xCenter/Datasources.cfc Creates a constraint for use with ObjectCondition. | | arguments | | label | name | required | type | default | hint | | propertyName | true | string | null | The name of the property. | | constraintOperator | true | numeric | null | The operator of the constraint. | | constraintValue | true | any | null | The value of the constraint. |
| | return type | any |
| | getGatewayDefaultCondition | Private Function getGatewayDefaultCondition source: /usr/local/tomcat/webapps/ROOT/Components/xCenter/Gateways/Gateways.cfc Returns the default condition for gateways. | | arguments | | label | name | required | type | default | hint |
| | return type | any |
| | getJDCResultSetFromVersion | Private Function getJDCResultSetFromVersion source: /usr/local/tomcat/webapps/ROOT/Components/xCenter/Gateways/Gateways.cfc Returns a structure from a version | | arguments | | label | name | required | type | default | hint | | ga_id | true | numeric | null | The id of the action | | ml_id | true | numeric | null | The id of the language | | vmov_id | true | numeric | null | The id of the offline version to publish |
| | return type | any |
| | getXCenterFactory | Private Function getXCenterFactory source: /usr/local/tomcat/webapps/ROOT/Components/xCenter/Datasources.cfc Returns the XCenter factory. | | arguments | | label | name | required | type | default | hint |
| | return type | any |
| | insertItemIntoVM | Private Function insertItemIntoVM source: /usr/local/tomcat/webapps/ROOT/Components/xCenter/Gateways/Gateways.cfc Inserts a item into the VM | | arguments | | label | name | required | type | default | hint | | ga_id | true | numeric | null | The ID of the action. | | system_id | true | string | null | The ID of the item. |
| | return type | struct |
| | updateDisplayColumnForCopy | Private Function updateDisplayColumnForCopy source: /usr/local/tomcat/webapps/ROOT/Components/xCenter/Gateways/Gateways.cfc Updates the display column data to indicate a copy. | | arguments | | label | name | required | type | default | hint | | ga_id | true | numeric | null | The ID of the gateway action. | | original | true | string | null | |
| | return type | xml |
|
|
|
|
|
| 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 |
|
| copyPersonalization | Public Function copyPersonalization source: /usr/local/tomcat/webapps/ROOT/Components/ContentMngt/PageIO.cfc Copies the personalization settings of a page to all lower subpages. | | arguments | | label | name | required | type | default | hint | | sp_id | true | numeric | null | The id of the page to get |
| | return type | struct |
|
| countCompanyPages | Public Function countCompanyPages source: /usr/local/tomcat/webapps/ROOT/Components/ContentMngt/PageIO.cfc Returns the number of pages for a company. | | arguments | | label | name | required | type | default | hint | | wc_id | true | numeric | null | The ID of the company. |
| | return type | struct |
|
| countCompanySites | Public Function countCompanySites source: /usr/local/tomcat/webapps/ROOT/Components/ContentMngt/SiteIO.cfc Returns the number of sites for a company. | | arguments | | label | name | required | type | default | hint | | wc_id | true | numeric | null | The ID of the company. |
| | 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 |
|
| createDataTimeNow | Public Function createDataTimeNow source: /usr/local/tomcat/webapps/ROOT/Components/WIS/DataIO.cfc Returns query which can be passed to the addData function when creating a datetime value with the current time | | arguments | | label | name | required | type | default | hint |
| | return type | any |
|
| createHTMLTemplate | Public Function createHTMLTemplate source: /usr/local/tomcat/webapps/ROOT/Components/ContentMngt/TemplateIO.cfc Writes the xml template to the disk. | | arguments | | label | name | required | type | default | hint | | st_id | true | numeric | null | The st_id of the template to write. |
| | return type | struct |
|
| createMenuValueStruct | Public Function createMenuValueStruct source: /usr/local/tomcat/webapps/ROOT/Components/ContentMngt/webSelect.cfc | | arguments | | label | name | required | type | default | hint | | sp_id | true | numeric | null | | | depth | true | numeric | null | | | allPagesQuery | true | query | null | | | currentRecord | true | numeric | null | | | countChildren | false | boolean | false | Count the children of each page. |
| | return type | any |
|
| createObjectShortcut | Public Function createObjectShortcut source: /usr/local/tomcat/webapps/ROOT/Components/ContentMngt/ObjectIO.cfc Creates a shortcut to an object. | | arguments | | label | name | required | type | default | hint | | so_id | true | numeric | null | The ID of the object. | | sp_id | true | numeric | null | The ID of the page. |
| | return type | struct |
|
| createSelectDate | Public Function createSelectDate source: /usr/local/tomcat/webapps/ROOT/Components/WIS/DataIO.cfc Generates the select clause for a datetime | | arguments | | label | name | required | type | default | hint | | tablePrefix | true | string | null | The prefix of the table | | format | true | string | null | The format of the date | | as | true | string | null | The select clause AS. |
| | return type | struct |
|
| createTemplate | Public Function createTemplate source: /usr/local/tomcat/webapps/ROOT/Components/ContentMngt/TemplateIO.cfc Creates an empty template, also creates the first part. | | arguments | | label | name | required | type | default | hint | | site_id | true | numeric | null | The site id of the new template | | st_name | false | string | null | The name of the new template | | st_description | true | string | null | The description of the new template | | st_custom | false | boolean | false | Indicator if this is a custom template |
| | return type | struct |
|
| createXMLTemplate | Public Function createXMLTemplate source: /usr/local/tomcat/webapps/ROOT/Components/ContentMngt/TemplateIO.cfc Writes the xml template to the disk. | | arguments | | label | name | required | type | default | hint | | st_id | true | numeric | null | The sp_id of the page to get. |
| | return type | struct |
|
| deletePage | Public Function deletePage source: /usr/local/tomcat/webapps/ROOT/Components/ContentMngt/PageIO.cfc Removes a page from the system | | arguments | | label | name | required | type | default | hint | | sp_id | true | numeric | null | The id of the page | | runMenuGenerator | false | boolean | true | Runs the menu generator or not |
| | return type | struct |
|
| deleteRights | Public Function deleteRights source: /usr/local/tomcat/webapps/ROOT/Components/ContentMngt/PageIO.cfc Deletes the rights for group for a page. | | arguments | | label | name | required | type | default | hint | | sp_id | true | numeric | null | The ID of the page. | | wg_id_list | true | string | null | The ID of the group. | | deep | false | boolean | false | Also delete grouprights from lower pages? |
| | return type | struct |
|
| deleteRightsForPage | Public Function deleteRightsForPage source: /usr/local/tomcat/webapps/ROOT/Components/ContentMngt/PageIO.cfc Deletes the rights for group for a page | | arguments | | label | name | required | type | default | hint | | sp_id | true | numeric | null | The id of the page |
| | return type | struct |
|
| deleteSite | Public Function deleteSite source: /usr/local/tomcat/webapps/ROOT/Components/ContentMngt/SiteIO.cfc Removes a website. | | arguments | | label | name | required | type | default | hint | | site_id | true | numeric | null | The ID of the website |
| | return type | struct |
|
| deleteTemplate | Public Function deleteTemplate source: /usr/local/tomcat/webapps/ROOT/Components/ContentMngt/TemplateIO.cfc Removes a template | | arguments | | label | name | required | type | default | hint | | st_id | true | numeric | null | The id of the template |
| | return type | struct |
|
| delPageFromCache | Public Function delPageFromCache source: /usr/local/tomcat/webapps/ROOT/Components/ContentMngt/PageIO.cfc Removes a page completely from the cache | | arguments | | label | name | required | type | default | hint | | sp_id | true | numeric | null | The id of the page |
| | return type | struct |
|
| delTemplatePart | Public Function delTemplatePart source: /usr/local/tomcat/webapps/ROOT/Components/ContentMngt/TemplateIO.cfc Delete a template part | | arguments | | label | name | required | type | default | hint | | st_id | true | numeric | null | The id of the template | | stp_id | true | numeric | null | The id of the template part to delete |
| | 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 |
|
| divideTemplatePart | Public Function divideTemplatePart source: /usr/local/tomcat/webapps/ROOT/Components/ContentMngt/TemplateIO.cfc Divides a template in two parts | | arguments | | label | name | required | type | default | hint | | st_id | true | numeric | null | The id of the template | | stp_id | true | numeric | null | The id of the template part | | stp_divide_mode | true | numeric | null | The divide mode, 1 is horizontal, 2 is vertical |
| | return type | struct |
|
| duplicateTemplate | Public Function duplicateTemplate source: /usr/local/tomcat/webapps/ROOT/Components/ContentMngt/TemplateIO.cfc Duplicates a given template | | arguments | | label | name | required | type | default | hint | | st_id | true | numeric | null | |
| | return type | struct |
|
| filterSites | Public Function filterSites source: /usr/local/tomcat/webapps/ROOT/Components/ContentMngt/SiteIO.cfc Returns the records of inputquery where the websites are below the company specified. | | arguments | | label | name | required | type | default | hint | | wc_id | true | numeric | null | The ID of the company. | | filterQuery | true | query | null | The query to be filtered. |
| | return type | struct |
|
| generalPageEditCheck | Public Function generalPageEditCheck source: /usr/local/tomcat/webapps/ROOT/Components/ContentMngt/PageIO.cfc Does some checks, checks for valid ID. | | arguments | | label | name | required | type | default | hint | | sp_id | true | any | null | The ID to check. |
| | 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 |
|
| generateListWCL | Public Function generateListWCL source: /usr/local/tomcat/webapps/ROOT/Components/ContentMngt/ObjectIO.cfc Generates list WCL | | arguments | | label | name | required | type | default | hint | | contentPropsQuery | true | query | null | This query must at least contain the scdv_id, ga_id columns | | ml_id | true | numeric | null | | | systemColumn | true | string | null | | | displayColumn | true | string | null | |
| | return type | string |
|
| 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 |
|
| getActivePageNames | Public Function getActivePageNames source: /usr/local/tomcat/webapps/ROOT/Components/ContentMngt/webSelect.cfc Gets the name of a list of pages. | | arguments | | label | name | required | type | default | hint | | sp_id_list | true | string | null | A list with the id's of the pages | | ml_id | true | numeric | null | The language ID in which language the properties need to be returned |
| | return type | struct |
|
| getAddableSiteAdmins | Public Function getAddableSiteAdmins source: /usr/local/tomcat/webapps/ROOT/Components/ContentMngt/SiteIO.cfc Returns the ID's of the site admins which the caller can add. | | arguments | | label | name | required | type | default | hint | | site_id | true | numeric | null | The ID of the website. | | wc_id | true | numeric | null | The ID of the company. |
| | return type | struct |
|
| getAllPages | Public Function getAllPages source: /usr/local/tomcat/webapps/ROOT/Components/ContentMngt/PageIO.cfc Gets all the id's of the pages of a website. | | arguments | | label | name | required | type | default | hint | | site_id | true | numeric | null | The id of the website |
| | return type | struct |
|
| getAllSiteObjects | Public Function getAllSiteObjects source: /usr/local/tomcat/webapps/ROOT/Components/ContentMngt/ObjectIO.cfc Returns all objects in a site | | arguments | | label | name | required | type | default | hint | | site_id | true | numeric | null | The id of the site |
| | return type | struct |
|
| getAllSites | Public Function getAllSites source: /usr/local/tomcat/webapps/ROOT/Components/ContentMngt/SiteIO.cfc Returns the ID's of all sites on an WIS-install. | | arguments | | label | name | required | type | default | hint |
| | return type | struct |
|
| getAllSitesBelow | Public Function getAllSitesBelow source: /usr/local/tomcat/webapps/ROOT/Components/ContentMngt/SiteIO.cfc Returns the ID's of the websites below the given company. | | arguments | | label | name | required | type | default | hint | | wc_id | true | numeric | null | The ID of the company. |
| | return type | struct |
|
| getAllTemplates | Public Function getAllTemplates source: /usr/local/tomcat/webapps/ROOT/Components/ContentMngt/TemplateIO.cfc Returns the id's of all templates of a website. | | arguments | | label | name | required | type | default | hint | | site_id | true | numeric | null | The id of the website | | fromAbove | false | boolean | false | Return the templates from above? | | showHidden | false | boolean | true | Return the hidden templates? |
| | return type | struct |
|
| getBookmarks | Public Function getBookmarks source: /usr/local/tomcat/webapps/ROOT/Components/ContentMngt/PageIO.cfc Returns all bookmarks for a list of pages | | arguments | | label | name | required | type | default | hint | | sp_id_list | true | string | null | A list with the id's of the pages | | ml_id | true | numeric | null | The ml_id of the bookmark |
| | return type | struct |
|
| getBookMarksFromContent | Public Function getBookMarksFromContent source: /usr/local/tomcat/webapps/ROOT/Components/ContentMngt/ObjectIO.cfc Parses content and returns the bookmarks | | arguments | | label | name | required | type | default | hint | | content | true | string | The content to check | |
| | return type | struct |
|
| getBookmarksFromSite | Public Function getBookmarksFromSite source: /usr/local/tomcat/webapps/ROOT/Components/ContentMngt/PageIO.cfc Returns all bookmarks for a site | | arguments | | label | name | required | type | default | hint | | site_id | true | numeric | null | The id of the site | | ml_id | true | numeric | null | The ml_id of the bookmark |
| | return type | struct |
|
| getBookmarkValues | Public Function getBookmarkValues source: /usr/local/tomcat/webapps/ROOT/Components/ContentMngt/PageIO.cfc Returns the values of a bookmark | | arguments | | label | name | required | type | default | hint | | spb_id | true | string | null | THe id of the bookmark |
| | return type | struct |
|
| getCompanyFromSite | Public Function getCompanyFromSite source: /usr/local/tomcat/webapps/ROOT/Components/ContentMngt/SiteIO.cfc Returns the wc_id of the website. | | arguments | | label | name | required | type | default | hint | | site_id | true | numeric | null | The ID of the website. |
| | return type | struct |
|
| getCompanySiteLanguages | Public Function getCompanySiteLanguages source: /usr/local/tomcat/webapps/ROOT/Components/ContentMngt/SiteIO.cfc Returns the (distinct) languages from all websites of a company. | | arguments | | label | name | required | type | default | hint | | wc_id | true | numeric | null | The ID of the company. |
| | return type | struct |
|
| getCompiledObjectContent | Public Function getCompiledObjectContent source: /usr/local/tomcat/webapps/ROOT/Components/ContentMngt/PageIO.cfc | | arguments | | label | name | required | type | default | hint | | so_id | true | numeric | null | |
| | return type | any |
|
| 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 |
|
| getContentListObject | Public Function getContentListObject source: /usr/local/tomcat/webapps/ROOT/Components/ContentMngt/ObjectIO.cfc Returns the content of a list object | | arguments | | label | name | required | type | default | hint | | so_id | true | numeric | null | The id of the object | | ml_id | true | numeric | null | The id of the language | | execute | true | boolean | null | Execute the content? |
| | return type | struct |
|
| getCurrentList | Public Function getCurrentList source: /usr/local/tomcat/webapps/ROOT/Components/ContentMngt/PageIO.cfc Gets the current itemvalues for a displaypage. | | arguments | | label | name | required | type | default | hint | | sp_id | true | numeric | null | The id of the page to get | | ml_id | false | numeric | 1 | The id of the language | | so_id | false | numeric | 0 | The id of the object | | system_id | false | numeric | 0 | The id of the list item |
| | return type | any |
|
| getCurrentPath | Public Function getCurrentPath source: /usr/local/tomcat/webapps/ROOT/Components/ContentMngt/PageIO.cfc Returns the path to the top of a website from the current page | | arguments | | label | name | required | type | default | hint | | getAbsoluteTop | true | boolean | null | Return the absolute top of the page? | | ml_id | false | numeric | 1 | return the path in which language | | showHidden | false | boolean | true | Return hidden pages? |
| | return type | struct |
|
| getCustomPropertiesForPage | Public Function getCustomPropertiesForPage source: /usr/local/tomcat/webapps/ROOT/Components/ContentMngt/PageIO.cfc Returns all the custom properties for the given page | | arguments | | label | name | required | type | default | hint | | sp_id | true | any | null | |
| | return type | any |
|
| getCustomPropertiesForSite | Public Function getCustomPropertiesForSite source: /usr/local/tomcat/webapps/ROOT/Components/ContentMngt/SiteIO.cfc returns all custom properties for the site | | arguments | | label | name | required | type | default | hint | | site_id | true | any | null | |
| | return type | any |
|
| getCustomPropertiesFromPage | Public Function getCustomPropertiesFromPage source: /usr/local/tomcat/webapps/ROOT/Components/ContentMngt/PageIO.cfc Returns all the custom properties for the given page | | arguments | | label | name | required | type | default | hint | | sp_id | true | any | null | |
| | return type | any |
|
| getCustomPropertyForPage | Public Function getCustomPropertyForPage source: /usr/local/tomcat/webapps/ROOT/Components/ContentMngt/PageIO.cfc | | arguments | | label | name | required | type | default | hint | | sp_id | true | any | null | | | property | true | any | null | | | default | false | any | | |
| | return type | any |
|
| getCustomPropertyForPageById | Public Function getCustomPropertyForPageById source: /usr/local/tomcat/webapps/ROOT/Components/ContentMngt/PageIO.cfc | | arguments | | label | name | required | type | default | hint | | spcp_id | true | any | null | |
| | return type | any |
|
| getCustomPropertyForSite | Public Function getCustomPropertyForSite source: /usr/local/tomcat/webapps/ROOT/Components/ContentMngt/SiteIO.cfc returns value of custom property for the site, or default | | arguments | | label | name | required | type | default | hint | | site_id | true | numeric | null | | | scp_key | true | any | null | | | default | false | any | | | | object | false | any | false | |
| | return type | any |
|
| getCustomPropertyFromPage | Public Function getCustomPropertyFromPage source: /usr/local/tomcat/webapps/ROOT/Components/ContentMngt/PageIO.cfc Returns the custom property value for the given custom property key, if not found, returns default | | arguments | | label | name | required | type | default | hint | | sp_id | true | any | null | | | property | true | any | null | | | default | false | any | | |
| | return type | any |
|
| getCustomTemplateCode | Public Function getCustomTemplateCode source: /usr/local/tomcat/webapps/ROOT/Components/ContentMngt/TemplateIO.cfc | | arguments | | label | name | required | type | default | hint | | st_id | true | numeric | null | The st_id of the template to get. |
| | return type | string |
|
| getData | Public Function getData source: /usr/local/tomcat/webapps/ROOT/Components/WIS/DataIO.cfc Gets the data. It can find the location of the data on it's own, you don't need to specify the type. | | arguments | | label | name | required | type | default | hint | | data_ID | true | numeric | null | The data_id of the data. | | ml_id | true | numeric | null | The ml_id of the data to get. |
| | return type | struct |
|
| getDataForAllLanguages | Public Function getDataForAllLanguages source: /usr/local/tomcat/webapps/ROOT/Components/WIS/DataIO.cfc Gets the data for all languages. It can find the location of the data on it's own, you don't need to specify the type. | | arguments | | label | name | required | type | default | hint | | data_ID | true | numeric | null | The data_id of the data. |
| | return type | struct |
|
| getDataNumeric | Public Function getDataNumeric source: /usr/local/tomcat/webapps/ROOT/Components/WIS/DataIO.cfc Gets numeric data. | | arguments | | label | name | required | type | default | hint | | data_id | true | numeric | null | The ID of the data. |
| | return type | struct |
|
| getDataReal | Public Function getDataReal source: /usr/local/tomcat/webapps/ROOT/Components/WIS/DataIO.cfc Gets real data. | | arguments | | label | name | required | type | default | hint | | data_id | true | numeric | null | The ID of the data. |
| | return type | struct |
|
| getDataText | Public Function getDataText source: /usr/local/tomcat/webapps/ROOT/Components/WIS/DataIO.cfc Gets the data. It can find the location of the data on it's own, you don't need to specify the type. | | arguments | | label | name | required | type | default | hint | | data_ID | true | numeric | null | The data_id of the data. | | ml_id | true | numeric | null | The ml_id of the data to get. |
| | return type | struct |
|
| getDataType | Public Function getDataType source: /usr/local/tomcat/webapps/ROOT/Components/WIS/DataIO.cfc Gets the data type of the given data_id | | arguments | | label | name | required | type | default | hint | | data_id | true | numeric | null | |
| | return type | struct |
|
| getDataVarchar | Public Function getDataVarchar source: /usr/local/tomcat/webapps/ROOT/Components/WIS/DataIO.cfc Gets the data. It can find the location of the data on it's own, you don't need to specify the type. | | arguments | | label | name | required | type | default | hint | | data_ID | true | numeric | null | The data_id of the data. | | ml_id | true | numeric | null | The ml_id of the data to get. |
| | return type | struct |
|
| getDateTime | Public Function getDateTime source: /usr/local/tomcat/webapps/ROOT/Components/WIS/DataIO.cfc Gets the datetime. | | arguments | | label | name | required | type | default | hint | | data_ID | true | numeric | null | The data_id of the data datetime. | | dateFormat | false | string | | Gives a CF formatted type, if not defined it returns a cftime format. | | timeFormat | false | string | | Gives a CF formatted type, if not defined it returns a cftime format. |
| | return type | struct |
|
| getDifferentHides | Public Function getDifferentHides source: /usr/local/tomcat/webapps/ROOT/Components/ContentMngt/PageIO.cfc Returns all pages wich hide modus is not the same in the two input languages. | | arguments | | label | name | required | type | default | hint | | site_id | true | numeric | null | The id of the website to get | | ml_id1 | true | numeric | null | The id of the language | | ml_id2 | true | numeric | null | The id of the language |
| | return type | struct |
|
| getEditPages | Public Function getEditPages source: /usr/local/tomcat/webapps/ROOT/Components/ContentMngt/PageIO.cfc Returns all hided pages for a language | | arguments | | label | name | required | type | default | hint | | site_id | true | numeric | null | The id of the page to get | | date_modified | false | Date | {ts '2026-08-10 14:52:34'} | The id of the language | | show_own | false | boolean | false | The id of the language |
| | return type | struct |
|
| getFormTemplates | Public Function getFormTemplates source: /usr/local/tomcat/webapps/ROOT/Components/ContentMngt/SiteIO.cfc Returns all form templates for a siteConfigContainer | | arguments | | label | name | required | type | default | hint | | scc_id | true | numeric | null | |
| | return type | any |
|
| getHidePages | Public Function getHidePages source: /usr/local/tomcat/webapps/ROOT/Components/ContentMngt/PageIO.cfc Returns all hided pages for a language | | arguments | | label | name | required | type | default | hint | | site_id | true | numeric | null | The id of the page to get | | ml_id | true | numeric | null | The id of the language |
| | return type | struct |
|
| getImageTemplates | Public Function getImageTemplates source: /usr/local/tomcat/webapps/ROOT/Components/ContentMngt/SiteIO.cfc Returns all image templates for a siteConfigContainer | | arguments | | label | name | required | type | default | hint | | scc_id | true | numeric | null | |
| | return type | any |
|
| getJavaPageObject | Public Function getJavaPageObject source: /usr/local/tomcat/webapps/ROOT/Components/ContentMngt/PageIO.cfc Get the JAVA object representing the page | | arguments | | label | name | required | type | default | hint | | sp_id | false | numeric | null | The ID of the page to get |
| | return type | any |
|
| getLicenses | Public Function getLicenses source: /usr/local/tomcat/webapps/ROOT/Components/ContentMngt/SiteIO.cfc This function calulates for a given company the number of website licenses. If the company has unlimited websites, it returns -1. If the license is not given for the company, it a void query. | | arguments | | label | name | required | type | default | hint | | wc_id | true | numeric | null | The ID of the company from wich you want to know the number of licenses. |
| | return type | struct |
|
| getLinkedPage | Public Function getLinkedPage source: /usr/local/tomcat/webapps/ROOT/Components/ContentMngt/PageIO.cfc Returns the linked page for a given page id. | | arguments | | label | name | required | type | default | hint | | sp_id | true | numeric | null | The id of the page |
| | return type | struct |
|
| getListObjectItems | Public Function getListObjectItems source: /usr/local/tomcat/webapps/ROOT/Components/ContentMngt/ObjectIO.cfc | | arguments | | label | name | required | type | default | hint | | so_id | false | numeric | null | the object id for the object to get the list items for | | ml_id | true | numeric | null | | | includeConstraints | false | boolean | false | | | includeHidden | false | boolean | false | | | includeOffline | false | boolean | false | | | isEmptyFlag | false | boolean | false | |
| | return type | any |
|
| getLockedParts | Public Function getLockedParts source: /usr/local/tomcat/webapps/ROOT/Components/ContentMngt/TemplateIO.cfc Returns all the locked template parts of a template | | arguments | | label | name | required | type | default | hint | | st_id | true | numeric | null | The id of the template |
| | return type | struct |
|
| getMainPage | Public Function getMainPage source: /usr/local/tomcat/webapps/ROOT/Components/ContentMngt/PageIO.cfc Returns the id of the main page of the website. | | arguments | | label | name | required | type | default | hint | | site_id | true | numeric | null | The id of the site |
| | return type | struct |
|
| getModifiedPages | Public Function getModifiedPages source: /usr/local/tomcat/webapps/ROOT/Components/ContentMngt/PageIO.cfc Gets a specified number of pages ordered by last modified | | arguments | | label | name | required | type | default | hint | | site_id | true | numeric | null | | | ml_id | true | numeric | null | | | amount | true | numeric | null | | | includeHiddenPages | false | boolean | false | |
| | return type | struct |
|
| getModifiedPagesSince | Public Function getModifiedPagesSince source: /usr/local/tomcat/webapps/ROOT/Components/ContentMngt/PageIO.cfc Gets all the pages that are last modified since the given date | | arguments | | label | name | required | type | default | hint | | site_id | true | numeric | null | | | sinceDate | true | date | null | | | ml_id | true | numeric | null | | | includeHiddenPages | false | boolean | false | |
| | return type | struct |
|
| getNONPageDisplayLanguages | Public Function getNONPageDisplayLanguages source: /usr/local/tomcat/webapps/ROOT/Components/ContentMngt/PageIO.cfc Returns the languages in which the page is not viewable. | | arguments | | label | name | required | type | default | hint | | sp_id | true | numeric | null | The ID of the page. |
| | return type | struct |
|
| getObject | Public Function getObject source: /usr/local/tomcat/webapps/ROOT/Components/ContentMngt/ObjectIO.cfc Gets an object. | | arguments | | label | name | required | type | default | hint | | so_id | true | numeric | null | The ID of the object. |
| | return type | any |
|
| getObjectContent | Public Function getObjectContent source: /usr/local/tomcat/webapps/ROOT/Components/ContentMngt/ObjectIO.cfc Returns the content of an object | | arguments | | label | name | required | type | default | hint | | so_id | true | numeric | null | The id of the object | | ml_id | true | numeric | null | The id of the language | | execute | true | boolean | null | Execute the content? | | isInStudio | false | boolean | false | Is the user in the studio? |
| | return type | struct |
|
| getObjectOwner | Public Function getObjectOwner source: /usr/local/tomcat/webapps/ROOT/Components/ContentMngt/ObjectIO.cfc Returns the id of the owner of the object. | | arguments | | label | name | required | type | default | hint | | so_id | true | numeric | null | The id of the page. | | readPage | false | boolean | false | For shared objects the read page and the original page are different, specify true if you want the page the shared object is placed on, only works is sp_id is defined in the url |
| | return type | struct |
|
| getObjectPlace | Public Function getObjectPlace source: /usr/local/tomcat/webapps/ROOT/Components/ContentMngt/ObjectIO.cfc Returns the template part of the object. | | arguments | | label | name | required | type | default | hint | | sp_id | true | numeric | null | The id of the page. | | so_id | true | numeric | null | The id of the object. |
| | return type | struct |
|
| getObjectsFromPageWithValues | Public Function getObjectsFromPageWithValues source: /usr/local/tomcat/webapps/ROOT/Components/ContentMngt/ObjectIO.cfc Returns the id's of all objects in a page. | | arguments | | label | name | required | type | default | hint | | sp_id | true | numeric | null | The id of the page. |
| | return type | struct |
|
| getObjectSpecificValues | Public Function getObjectSpecificValues source: /usr/local/tomcat/webapps/ROOT/Components/ContentMngt/ObjectIO.cfc Returns the specific values of an object | | arguments | | label | name | required | type | default | hint | | so_id | true | numeric | null | The id of the object |
| | return type | struct |
|
| getObjectsTypes | Public Function getObjectsTypes source: /usr/local/tomcat/webapps/ROOT/Components/ContentMngt/ObjectIO.cfc Returns all the object types. | | arguments | | label | name | required | type | default | hint | | msot_id | false | numeric | null | |
| | return type | struct |
|
| getObjectValues | Public Function getObjectValues source: /usr/local/tomcat/webapps/ROOT/Components/ContentMngt/ObjectIO.cfc Returns all the values of an object. | | arguments | | label | name | required | type | default | hint | | so_id_list | true | string | null | The id of the object. |
| | return type | struct |
|
| getPageContent | Public Function getPageContent source: /usr/local/tomcat/webapps/ROOT/Components/ContentMngt/PageIO.cfc Returns a complete page | | arguments | | label | name | required | type | default | hint | | sp_id | true | numeric | null | The id of the page to get | | ml_id | false | numeric | 1 | The id of the language | | ignore_from_sp | false | boolean | false | Tells this function to ignore the from_sp_id in the url and load the given page |
| | return type | struct |
|
| getPageDisplayLanguages | Public Function getPageDisplayLanguages source: /usr/local/tomcat/webapps/ROOT/Components/ContentMngt/PageIO.cfc Returns the languages in which the page is viewable. | | arguments | | label | name | required | type | default | hint | | sp_id | true | numeric | null | The ID of the page. |
| | return type | struct |
|
| getPageFromObject | Public Function getPageFromObject source: /usr/local/tomcat/webapps/ROOT/Components/ContentMngt/ObjectIO.cfc Returns the IDs of the pages where this object is used. | | arguments | | label | name | required | type | default | hint | | so_id | true | numeric | null | The id of the object |
| | return type | struct |
|
| getPageGroupRights | Public Function getPageGroupRights source: /usr/local/tomcat/webapps/ROOT/Components/ContentMngt/PageIO.cfc Returns the rights of a group for a page | | arguments | | label | name | required | type | default | hint | | sp_id | true | numeric | null | The id of the page | | wg_id | true | numeric | null | The id of the group |
| | return type | struct |
|
| getPageGroupsRights | Public Function getPageGroupsRights source: /usr/local/tomcat/webapps/ROOT/Components/ContentMngt/PageIO.cfc Returns the rights for all groups of a page | | arguments | | label | name | required | type | default | hint | | sp_id | true | numeric | null | The id of the page |
| | return type | struct |
|
| getPageMetaData | Public Function getPageMetaData source: /usr/local/tomcat/webapps/ROOT/Components/ContentMngt/PageIO.cfc Returns the metadata of a page for a language. | | arguments | | label | name | required | type | default | hint | | sp_id_list | true | string | null | The ID of the page(s). | | ml_id | true | numeric | null | The ID of the language. | | columnList | false | string | sp_name,sp_description,sp_custom,sp_title,sp_keywords,sp_robots | A list of columns with you want to get. |
| | return type | struct |
|
| getPageNames | Public Function getPageNames source: /usr/local/tomcat/webapps/ROOT/Components/ContentMngt/PageIO.cfc Gets the name of a list of pages. | | arguments | | label | name | required | type | default | hint | | sp_id_list | true | string | null | A list with the id's of the pages | | ml_id | true | numeric | null | The language ID in which language the properties need to be returned |
| | return type | struct |
|
| getPageObjectByName | Public Function getPageObjectByName source: /usr/local/tomcat/webapps/ROOT/Components/ContentMngt/ObjectIO.cfc Returns the object with the given name | | arguments | | label | name | required | type | default | hint | | sp_id | true | numeric | null | The id of the page to handle. | | object_name | true | string | null | The name of the object | | msot_id | false | numeric | 0 | The name of the object |
| | return type | struct |
|
| getPageObjects | Public Function getPageObjects source: /usr/local/tomcat/webapps/ROOT/Components/ContentMngt/ObjectIO.cfc Handles the update of a page. | | arguments | | label | name | required | type | default | hint | | sp_id | true | numeric | null | The id of the page to handle. | | ml_id | true | numeric | null | The id of the language to get. |
| | return type | struct |
|
| getPageObjectsByName | Public Function getPageObjectsByName source: /usr/local/tomcat/webapps/ROOT/Components/ContentMngt/ObjectIO.cfc Returns the object with the given name | | arguments | | label | name | required | type | default | hint | | sp_id | true | numeric | null | The id of the page to handle. | | object_name | true | string | null | The name of the object | | msot_id | false | numeric | 0 | The type of the object |
| | return type | struct |
|
| getPageOwner | Public Function getPageOwner source: /usr/local/tomcat/webapps/ROOT/Components/ContentMngt/PageIO.cfc Gets the owner of a page. | | arguments | | label | name | required | type | default | hint | | sp_id_list | true | string | null | A list with the id's of the pages |
| | return type | struct |
|
| getPagesForwardedToThisPage | Public Function getPagesForwardedToThisPage source: /usr/local/tomcat/webapps/ROOT/Components/ContentMngt/PageIO.cfc Returns the id's of the pages which are forwarded to this page. | | arguments | | label | name | required | type | default | hint | | sp_id | true | numeric | null | The id of the page |
| | return type | struct |
|
| getPageUsingUrl | Public Function getPageUsingUrl source: /usr/local/tomcat/webapps/ROOT/Components/ContentMngt/PageIO.cfc | | arguments | | label | name | required | type | default | hint | | sp_id | true | numeric | null | | | ml_id | true | numeric | null | | | sp_name | true | String | null | | | isNewPage | false | boolean | false | |
| | return type | any |
|
| getPageValues | Public Function getPageValues source: /usr/local/tomcat/webapps/ROOT/Components/ContentMngt/PageIO.cfc Gets all properties of a page. | | arguments | | label | name | required | type | default | hint | | sp_id_list | true | string | null | A list with the id's of the pages |
| | return type | struct |
|
| getParentPage | Public Function getParentPage source: /usr/local/tomcat/webapps/ROOT/Components/ContentMngt/PageIO.cfc Returns the parent page of a page. | | arguments | | label | name | required | type | default | hint | | sp_id | true | numeric | null | The id of the page |
| | return type | struct |
|
| getPath | Public Function getPath source: /usr/local/tomcat/webapps/ROOT/Components/ContentMngt/PageIO.cfc Returns the path to the top of a website from a page | | arguments | | label | name | required | type | default | hint | | sp_id | true | numeric | null | The id of the page | | getAbsoluteTop | true | boolean | null | Return the absolute top of the page? | | showHidden | false | boolean | true | Return hidden pages? | | ml_id | false | numeric | 1 | return the path in which language | | siteProperties | false | struct | null | the site properties of the page | | sortID | false | numeric | 1 | |
| | return type | struct |
|
| getPersonalizedGroups | Public Function getPersonalizedGroups source: /usr/local/tomcat/webapps/ROOT/Components/ContentMngt/PageIO.cfc Returns the personalized groupd of a page. | | arguments | | label | name | required | type | default | hint | | sp_id | true | numeric | null | The id of the page |
| | return type | struct |
|
| getPlainTemplateParts | Public Function getPlainTemplateParts source: /usr/local/tomcat/webapps/ROOT/Components/ContentMngt/TemplateIO.cfc Returns all the plain template parts of a template | | arguments | | label | name | required | type | default | hint | | st_id | true | numeric | null | The id of the template |
| | return type | struct |
|
| getProtocolToUse | Public Function getProtocolToUse source: /usr/local/tomcat/webapps/ROOT/Components/ContentMngt/SiteIO.cfc Returns the protocol to use for this website. | | arguments | | label | name | required | type | default | hint | | siteProperties | true | query | null | |
| | return type | string |
|
| 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 |
|
| getRemovableSiteAdmins | Public Function getRemovableSiteAdmins source: /usr/local/tomcat/webapps/ROOT/Components/ContentMngt/SiteIO.cfc Returns the ID's of the site admins which the caller can delete. | | arguments | | label | name | required | type | default | hint | | site_id | true | numeric | null | The ID of the website. |
| | return type | struct |
|
| getSharedObjects | Public Function getSharedObjects source: /usr/local/tomcat/webapps/ROOT/Components/ContentMngt/ObjectIO.cfc Returns all shared objects from above a website. | | arguments | | label | name | required | type | default | hint | | site_id | true | numeric | null | The id of the website |
| | return type | struct |
|
| getSharedObjectUsage | Public Function getSharedObjectUsage source: /usr/local/tomcat/webapps/ROOT/Components/ContentMngt/ObjectIO.cfc Returns the number of times a shared object is used | | arguments | | label | name | required | type | default | hint | | so_id | true | numeric | null | The id of the object | | includeUnused | false | boolean | false | Include objects not on a page |
| | return type | numeric |
|
| getShortcutPagesFromObject | Public Function getShortcutPagesFromObject source: /usr/local/tomcat/webapps/ROOT/Components/ContentMngt/ObjectIO.cfc Returns the IDs of the pages where this object is shared. | | arguments | | label | name | required | type | default | hint | | so_id | true | numeric | null | The id of the object | | includeUnused | false | boolean | false | Include objects not on a page |
| | return type | struct |
|
| getSite | Public Function getSite source: /usr/local/tomcat/webapps/ROOT/Components/ContentMngt/SiteIO.cfc Gets a site. | | arguments | | label | name | required | type | default | hint | | site_id | true | numeric | null | The ID of the site. |
| | return type | any |
|
| getSiteAdmins | Public Function getSiteAdmins source: /usr/local/tomcat/webapps/ROOT/Components/ContentMngt/SiteIO.cfc Get all admins of a website. | | arguments | | label | name | required | type | default | hint | | site_id | true | numeric | null | The ID of the website from wich you want the site administrators. |
| | return type | struct |
|
| getSiteConfigContainer | Public Function getSiteConfigContainer source: /usr/local/tomcat/webapps/ROOT/Components/ContentMngt/SiteIO.cfc Returns the configurationContainer | | arguments | | label | name | required | type | default | hint | | scc_id | true | numeric | null | |
| | return type | struct |
|
| getSiteConfigContainerPageCustomProperties | Public Function getSiteConfigContainerPageCustomProperties source: /usr/local/tomcat/webapps/ROOT/Components/ContentMngt/SiteIO.cfc returns the configured default page custom properties for this site | | arguments | | label | name | required | type | default | hint | | scc_id | true | numeric | null | |
| | return type | any |
|
| getSiteConfigContainerPageCustomProperty | Public Function getSiteConfigContainerPageCustomProperty source: /usr/local/tomcat/webapps/ROOT/Components/ContentMngt/SiteIO.cfc Get's a custom property bij sccpcp_id | | arguments | | label | name | required | type | default | hint | | sccpcp_id | true | numeric | null | |
| | return type | any |
|
| getSiteConfigContainerPageCustomPropertyByKey | Public Function getSiteConfigContainerPageCustomPropertyByKey source: /usr/local/tomcat/webapps/ROOT/Components/ContentMngt/SiteIO.cfc Get's a custom property bij spcp_key. You should either pass sp_id or scc_id because the siteConfigContainer should be found first | | arguments | | label | name | required | type | default | hint | | key | true | any | null | | | sp_id | false | any | -1 | | | scc_id | false | any | -1 | |
| | return type | any |
|
| getSiteConfigContainers | Public Function getSiteConfigContainers source: /usr/local/tomcat/webapps/ROOT/Components/ContentMngt/SiteIO.cfc Returns al configured config containers for a company | | arguments | | label | name | required | type | default | hint | | wc_id | true | any | null | |
| | return type | struct |
|
| getSiteCustomProperty | Public Function getSiteCustomProperty source: /usr/local/tomcat/webapps/ROOT/Components/ContentMngt/SiteIO.cfc returns custom property value | | arguments | | label | name | required | type | default | hint | | scp_id | true | numeric | null | |
| | return type | any |
|
| getSiteDefaultLanguage | Public Function getSiteDefaultLanguage source: /usr/local/tomcat/webapps/ROOT/Components/ContentMngt/SiteIO.cfc Returns the default ml_id for a website. | | arguments | | label | name | required | type | default | hint | | site_id | true | string | null | The ID of the website. |
| | return type | struct |
|
| getSiteFromPage | Public Function getSiteFromPage source: /usr/local/tomcat/webapps/ROOT/Components/ContentMngt/SiteIO.cfc Returns the site_id of a page. | | arguments | | label | name | required | type | default | hint | | sp_id | true | numeric | null | The ID of the page. |
| | return type | struct |
|
| getSiteLanguages | Public Function getSiteLanguages source: /usr/local/tomcat/webapps/ROOT/Components/ContentMngt/SiteIO.cfc Gets all languages from a website. | | arguments | | label | name | required | type | default | hint | | site_id | true | numeric | null | The ID of the website. |
| | return type | struct |
|
| getSiteLanguagesComplete | Public Function getSiteLanguagesComplete source: /usr/local/tomcat/webapps/ROOT/Components/ContentMngt/SiteIO.cfc Gets all languages from a website. | | arguments | | label | name | required | type | default | hint | | site_id | true | numeric | null | The ID of the website. |
| | return type | struct |
|
| getSiteObjectsTypes | Public Function getSiteObjectsTypes source: /usr/local/tomcat/webapps/ROOT/Components/ContentMngt/ObjectIO.cfc Returns all the objecttypes that can be used on a site. | | arguments | | label | name | required | type | default | hint | | site_id | true | numeric | null | The ID of the site. |
| | return type | struct |
|
| getSitesFromCompany | Public Function getSitesFromCompany source: /usr/local/tomcat/webapps/ROOT/Components/ContentMngt/SiteIO.cfc Returns a query with all sites direct below the given company. | | arguments | | label | name | required | type | default | hint | | wc_id | true | numeric | null | The ID of the company. | | includeInactive | false | boolean | true | Includes inactive websites? |
| | return type | struct |
|
| getSitesFromSiteAdmin | Public Function getSitesFromSiteAdmin source: /usr/local/tomcat/webapps/ROOT/Components/ContentMngt/SiteIO.cfc Gets all websites from a site administrator. Not the company websites. | | arguments | | label | name | required | type | default | hint | | wu_id | true | numeric | null | The ID of the site administrator. | | getCompany | false | boolean | true | Also return an admin website which is also a company website? | | includeInactive | false | boolean | true | |
| | return type | struct |
|
| getSiteStandardLanguage | Public Function getSiteStandardLanguage source: /usr/local/tomcat/webapps/ROOT/Components/ContentMngt/SiteIO.cfc Gets all information about a website. | | arguments | | label | name | required | type | default | hint | | site_id | true | string | null | The ID, or a list of ID's of the website(s) to get. |
| | return type | struct |
|
| getSiteValues | Public Function getSiteValues source: /usr/local/tomcat/webapps/ROOT/Components/ContentMngt/SiteIO.cfc Returns the values for one or more websites. | | arguments | | label | name | required | type | default | hint | | site_id_list | true | string | null | The ID(s) of the website(s). | | ml_id | false | numeric | 0 | The ml_id of the website(s). |
| | return type | struct |
|
| getStyleCSS | Public Function getStyleCSS source: /usr/local/tomcat/webapps/ROOT/Components/ContentMngt/PageIO.cfc Returns the cssfile of a page. | | arguments | | label | name | required | type | default | hint | | pageProperties | true | any | null | | | siteProperties | true | any | null | |
| | return type | string |
|
| getSubPages | Public Function getSubPages source: /usr/local/tomcat/webapps/ROOT/Components/ContentMngt/webSelect.cfc Returns all pages direct below a page. | | arguments | | label | name | required | type | default | hint | | sp_id | true | numeric | null | The id of the page | | ml_id | false | numeric | 1 | The id of the language |
| | return type | struct |
|
| getTemplatePartBorder | Public Function getTemplatePartBorder source: /usr/local/tomcat/webapps/ROOT/Components/ContentMngt/ObjectIO.cfc | | arguments | | label | name | required | type | default | hint | | st_id | false | any | null | | | innerContent | false | any | null | | | stp_id | false | any | null | | | sp_id | false | any | null | | | so_id | false | any | null | | | site_id | false | any | null | |
| | return type | any |
|
| getTemplatePartFromTemplate | Public Function getTemplatePartFromTemplate source: /usr/local/tomcat/webapps/ROOT/Components/ContentMngt/TemplateIO.cfc Returns the first part of a template for normal templates, for custom templates it returns all parts | | arguments | | label | name | required | type | default | hint | | st_id | true | numeric | null | The id of the template |
| | return type | struct |
|
| getTemplateParts | Public Function getTemplateParts source: /usr/local/tomcat/webapps/ROOT/Components/ContentMngt/TemplateIO.cfc Returns all the sub parts of a template part | | arguments | | label | name | required | type | default | hint | | stp_id | true | numeric | null | The id of the template part |
| | return type | struct |
|
| getTemplatePartValues | Public Function getTemplatePartValues source: /usr/local/tomcat/webapps/ROOT/Components/ContentMngt/TemplateIO.cfc Returns all values of a list of template parts | | arguments | | label | name | required | type | default | hint | | stp_id_list | true | string | null | The list of id's of the template parts |
| | return type | struct |
|
| getTemplateUsedPages | Public Function getTemplateUsedPages source: /usr/local/tomcat/webapps/ROOT/Components/ContentMngt/TemplateIO.cfc Returns the id's of all pages wich use this template | | arguments | | label | name | required | type | default | hint | | st_id | true | numeric | null | The st id of the template |
| | return type | struct |
|
| getTemplateValues | Public Function getTemplateValues source: /usr/local/tomcat/webapps/ROOT/Components/ContentMngt/TemplateIO.cfc Returns all the values of a list of templates. | | arguments | | label | name | required | type | default | hint | | st_id_list | true | string | null | The list of id's of templates to get. |
| | return type | struct |
|
| getTopLevelPages | Public Function getTopLevelPages source: /usr/local/tomcat/webapps/ROOT/Components/ContentMngt/SiteIO.cfc Returns the ID's of the toplevel pages for a site. | | arguments | | label | name | required | type | default | hint | | site_id | true | numeric | null | The ID of the site. |
| | return type | struct |
|
| getUnusedlicenses | Public Function getUnusedlicenses source: /usr/local/tomcat/webapps/ROOT/Components/ContentMngt/SiteIO.cfc Returns the amount of website licenses left; -1 is unlimited, -2 undefined. | | arguments | | label | name | required | type | default | hint | | wc_id | true | numeric | null | The ID of the company. |
| | return type | struct |
|
| getUsedDesignSites | Public Function getUsedDesignSites source: /usr/local/tomcat/webapps/ROOT/Components/ContentMngt/SiteIO.cfc Returns the websites which use the website as design. | | arguments | | label | name | required | type | default | hint | | site_id | true | numeric | null | The id of the website. |
| | return type | struct |
|
| getUseDesignsOfCompany | Public Function getUseDesignsOfCompany source: /usr/local/tomcat/webapps/ROOT/Components/ContentMngt/SiteIO.cfc Returns the designs with can be used for a company. | | arguments | | label | name | required | type | default | hint | | wc_id | true | numeric | null | The id of the company. |
| | return type | struct |
|
| getUseDesignsOfSite | Public Function getUseDesignsOfSite source: /usr/local/tomcat/webapps/ROOT/Components/ContentMngt/SiteIO.cfc Returns the designs with can be used. | | arguments | | label | name | required | type | default | hint | | site_id | true | numeric | null | The id of the website. |
| | return type | struct |
|
| getUsedObjectsFromPage | Public Function getUsedObjectsFromPage source: /usr/local/tomcat/webapps/ROOT/Components/ContentMngt/ObjectIO.cfc Returns the id's of all objects which are used in a page. | | arguments | | label | name | required | type | default | hint | | sp_id | true | numeric | null | The id of the page. |
| | return type | struct |
|
| getUserPageAuthorization | Public Function getUserPageAuthorization source: /usr/local/tomcat/webapps/ROOT/Components/ContentMngt/PageIO.cfc Returns a query with all rights of a page for a user. | | arguments | | label | name | required | type | default | hint | | sp_id | true | numeric | null | The id of the page | | wu_id | false | numeric | -1 | The id of the user |
| | return type | struct |
|
| getWisObjectFactory | Public Function getWisObjectFactory source: /usr/local/tomcat/webapps/ROOT/Components/ContentMngt/ObjectIO.cfc Gets the Java WisObjectFactory. | | arguments | | label | name | required | type | default | hint |
| | return type | any |
|
| getXsltForTemplate | Public Function getXsltForTemplate source: /usr/local/tomcat/webapps/ROOT/Components/ContentMngt/TemplateIO.cfc | | arguments | | label | name | required | type | default | hint | | st_id | true | numeric | null | The st_id of the template to write. |
| | return type | any |
|
| 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 |
|
| includeCurrentListCode | Public Function includeCurrentListCode source: /usr/local/tomcat/webapps/ROOT/Components/ContentMngt/PageIO.cfc | | arguments | | label | name | required | type | default | hint | | fileName | true | any | null | | | scope | true | any | null | | | fysPath | true | any | null | |
| | return type | void |
|
| insertTemplateParts | Public Function insertTemplateParts source: /usr/local/tomcat/webapps/ROOT/Components/ContentMngt/TemplateIO.cfc Inserts template parts from an XML structure in a template. Used for duplicating templates | | arguments | | label | name | required | type | default | hint | | st_id | true | numeric | null | | | parentID | true | numeric | null | | | currentNode | true | any | null | The current template part node that is processed |
| | return type | struct |
|
| isCachablePage | Public Function isCachablePage source: /usr/local/tomcat/webapps/ROOT/Components/ContentMngt/PageIO.cfc Checks if a page can be cached | | arguments | | label | name | required | type | default | hint | | sp_id | true | numeric | null | The page to check |
| | return type | boolean |
|
| isCustompart | Public Function isCustompart source: /usr/local/tomcat/webapps/ROOT/Components/ContentMngt/TemplateIO.cfc | | arguments | | label | name | required | type | default | hint | | stp_id | true | numeric | null | The id of the template part to check |
| | return type | boolean |
|
| isCustomTemplate | Public Function isCustomTemplate source: /usr/local/tomcat/webapps/ROOT/Components/ContentMngt/TemplateIO.cfc Returns true if this is a custom template | | arguments | | label | name | required | type | default | hint | | st_id | true | numeric | null | |
| | return type | boolean |
|
| isExistingPage | Public Function isExistingPage source: /usr/local/tomcat/webapps/ROOT/Components/ContentMngt/PageIO.cfc Checks if a page exists | | arguments | | label | name | required | type | default | hint | | sp_id | true | numeric | null | The id of the page to get |
| | return type | boolean |
|
| isExistingTemplate | Public Function isExistingTemplate source: /usr/local/tomcat/webapps/ROOT/Components/ContentMngt/TemplateIO.cfc Checks if a template already exists for a given name and site | | arguments | | label | name | required | type | default | hint | | site_id | true | numeric | null | The site to check for the template | | st_name | true | string | null | The name of the template to check |
| | return type | boolean |
|
| isLiveEdit | Public Function isLiveEdit source: /usr/local/tomcat/webapps/ROOT/Components/ContentMngt/webSelect.cfc | | arguments | | label | name | required | type | default | hint |
| | return type | any |
|
| isNameAvailableAsUrl | Public Function isNameAvailableAsUrl source: /usr/local/tomcat/webapps/ROOT/Components/ContentMngt/PageIO.cfc | | arguments | | label | name | required | type | default | hint | | sp_id | true | numeric | null | | | ml_id | true | numeric | null | | | sp_name | true | String | null | |
| | return type | boolean |
|
| isOwnBorderTemplate | Public Function isOwnBorderTemplate source: /usr/local/tomcat/webapps/ROOT/Components/ContentMngt/TemplateIO.cfc | | arguments | | label | name | required | type | default | hint | | st_id | true | numeric | null | The st_id of the template to write. |
| | return type | any |
|
| isPageHide | Public Function isPageHide source: /usr/local/tomcat/webapps/ROOT/Components/ContentMngt/PageIO.cfc Checks if a page is hided in a language | | arguments | | label | name | required | type | default | hint | | sp_id | true | numeric | null | The id of the page to get | | ml_id | true | numeric | null | The id of the language |
| | return type | boolean |
|
| isPersonalizationOn | Public Function isPersonalizationOn source: /usr/local/tomcat/webapps/ROOT/Components/ContentMngt/PageIO.cfc Checks if a page has personalisation. | | arguments | | label | name | required | type | default | hint | | sp_id | true | numeric | null | The id of the page |
| | return type | boolean |
|
| isPersonally | Public Function isPersonally source: /usr/local/tomcat/webapps/ROOT/Components/ContentMngt/PageIO.cfc Checks if a user has read rights to a page. | | arguments | | label | name | required | type | default | hint | | sp_id | true | numeric | null | The id of the page | | wu_id | false | numeric | -1 | The id of the user |
| | return type | boolean |
|
| isSiteAdmin | Public Function isSiteAdmin source: /usr/local/tomcat/webapps/ROOT/Components/ContentMngt/SiteIO.cfc Checks if the given user is a site administtor for the given site. | | arguments | | label | name | required | type | default | hint | | site_id | true | numeric | null | The ID of the website. | | wu_id | false | numeric | -1 | The ID of the user to check. |
| | return type | boolean |
|
| isSiteUser | Public Function isSiteUser source: /usr/local/tomcat/webapps/ROOT/Components/ContentMngt/SiteIO.cfc Checks if the given user is a valid editor of the given site. | | arguments | | label | name | required | type | default | hint | | site_id | true | numeric | null | The ID of the website. | | wu_id | false | numeric | -1 | The ID of the user to check. |
| | return type | boolean |
|
| isTemplateInUse | Public Function isTemplateInUse source: /usr/local/tomcat/webapps/ROOT/Components/ContentMngt/TemplateIO.cfc Checks if a template is in use by a page. | | arguments | | label | name | required | type | default | hint | | st_id | true | numeric | null | The id of the template |
| | return type | boolean |
|
| isTemplatePartInUse | Public Function isTemplatePartInUse source: /usr/local/tomcat/webapps/ROOT/Components/ContentMngt/TemplateIO.cfc Checks if a template part is in use by a content field. | | arguments | | label | name | required | type | default | hint | | stp_id | true | numeric | null | The id of the template part |
| | return type | boolean |
|
| isValidDisplayPageCombination | Public Function isValidDisplayPageCombination source: /usr/local/tomcat/webapps/ROOT/Components/ContentMngt/PageIO.cfc Checks if a combination of displaypage, frompage and object is valid. | | arguments | | label | name | required | type | default | hint | | display_sp_id | true | numeric | null | The ID of the displaypage. | | from_sp_id | true | numeric | null | The ID of the frompage. | | so_id | true | numeric | null | The ID of the object. |
| | return type | boolean |
|
| isValidPage | Public Function isValidPage source: /usr/local/tomcat/webapps/ROOT/Components/ContentMngt/PageIO.cfc Checks wether a page exists or not | | arguments | | label | name | required | type | default | hint | | sp_id | true | any | null | the sp_id to check |
| | return type | boolean |
|
| isValidSite | Public Function isValidSite source: /usr/local/tomcat/webapps/ROOT/Components/ContentMngt/SiteIO.cfc Returns true or false for the given site_id. | | arguments | | label | name | required | type | default | hint | | site_id | true | numeric | null | The ID of the website. |
| | return type | boolean |
|
| isValidSiteLanguage | Public Function isValidSiteLanguage source: /usr/local/tomcat/webapps/ROOT/Components/ContentMngt/SiteIO.cfc Checks if a language is valid for a site. | | arguments | | label | name | required | type | default | hint | | site_id | true | numeric | null | The ID of the website. | | ml_id | true | numeric | null | The ID of the language. |
| | 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 |
|
| keepAlive | Public Function keepAlive source: /usr/local/tomcat/webapps/ROOT/Components/ContentMngt/ObjectIO.cfc | | arguments | | label | name | required | type | default | hint |
| | return type | boolean |
|
| 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 |
|
| loginFromCookie | Public Function loginFromCookie source: /usr/local/tomcat/webapps/ROOT/Components/ContentMngt/webSelect.cfc Checks a user with a token to the token from the UserSetting, if it is a valid user, it sets the session.wu_id. | | arguments | | label | name | required | type | default | hint |
| | return type | boolean |
|
| loginSha1User | Public Function loginSha1User source: /usr/local/tomcat/webapps/ROOT/Components/ContentMngt/webSelect.cfc Checks a user, if it is a valid user, it sets the session.wu_id. For exchangeusers there is also an object session.exchangeAuthorization, this contains all exchangeproperties of the user. | | arguments | | label | name | required | type | default | hint | | wu_loginname | true | string | null | The login of the user. | | wu_password | true | string | null | The password of the user. |
| | return type | boolean |
|
| loginUser | Public Function loginUser source: /usr/local/tomcat/webapps/ROOT/Components/ContentMngt/webSelect.cfc Checks an user, if it is a valid user, it sets the session.wu_id. For exchangeusers there is also an object session.exchangeAuthorization, this contains all exchangeproperties of the user. | | arguments | | label | name | required | type | default | hint | | wu_loginname | true | string | null | The login of the user. | | wu_password | true | string | null | The password of the user. | | fromSHA1 | false | boolean | true | | | followEvents | false | boolean | true | |
| | return type | boolean |
|
| loginUserAdvanced | Public Function loginUserAdvanced source: /usr/local/tomcat/webapps/ROOT/Components/ContentMngt/webSelect.cfc Same as loginUser, but this functions doesn't catch exceptions, you'll have to do that yourself. | | arguments | | label | name | required | type | default | hint | | wu_loginname | true | string | null | The login of the user. | | wu_password | true | string | null | The password of the user. |
| | return type | any |
|
| loginUserForCompany | Public Function loginUserForCompany source: /usr/local/tomcat/webapps/ROOT/Components/ContentMngt/webSelect.cfc Checks an user, if it is a valid user, it sets the session.wu_id. For exchangeusers there is also an object session.exchangeAuthorization, this contains all exchangeproperties of the user. | | arguments | | label | name | required | type | default | hint | | wu_loginname | true | string | null | The login of the user. | | wu_password | true | string | null | The password of the user. | | wc_id | true | numeric | null | The company id of the user. | | fromSHA1 | false | boolean | true | | | followEvents | false | boolean | true | |
| | return type | boolean |
|
| loginUserWithDetailsOnFail | Public Function loginUserWithDetailsOnFail source: /usr/local/tomcat/webapps/ROOT/Components/ContentMngt/webSelect.cfc | | arguments | | label | name | required | type | default | hint | | wu_loginname | true | string | null | The login of the user. | | wu_password | true | string | null | The password of the user. | | wc_id | false | numeric | -1 | The company id of the user. | | fromSHA1 | false | boolean | true | | | followEvents | false | boolean | true | |
| | return type | any |
|
| logout | Public Function logout source: /usr/local/tomcat/webapps/ROOT/Components/ContentMngt/webSelect.cfc Logout, instead of all crappy session.wu_id = -1 | | arguments | | label | name | required | type | default | hint | | removeAllSessionVariables | false | any | true | |
| | 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 |
|
| movePage | Public Function movePage source: /usr/local/tomcat/webapps/ROOT/Components/ContentMngt/PageIO.cfc Moves a page to another parent | | arguments | | label | name | required | type | default | hint | | sp_id | true | numeric | null | The id of the page to move | | new_sp_parent_id | true | numeric | null | The id of the new parent |
| | return type | struct |
|
| 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 |
|
| placeObject | Public Function placeObject source: /usr/local/tomcat/webapps/ROOT/Components/ContentMngt/ObjectIO.cfc Places an object in a template part in a page | | arguments | | label | name | required | type | default | hint | | sp_id | true | numeric | null | The id of the page. | | so_id | true | numeric | null | The id of the object. | | stp_id | true | numeric | null | The id of the template part. |
| | return type | struct |
|
| printMenu | Public Function printMenu source: /usr/local/tomcat/webapps/ROOT/Components/ContentMngt/webSelect.cfc Prints the ul-li structure for the given page with subpages | | arguments | | label | name | required | type | default | hint | | page | true | Struct | null | Struct from buildMenu | | className | false | string | menu | | | maxDepth | false | any | max | How many levels do you want to print? | | currentDepth | false | any | 1 | The current depth, used for level class | | titleHTMLAttribute | false | any | false | Shows the HTML title attribute |
| | 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 |
|
| rememberLogin | Public Function rememberLogin source: /usr/local/tomcat/webapps/ROOT/Components/ContentMngt/webSelect.cfc Saves a token in UserSetting and Cookie. | | arguments | | label | name | required | type | default | hint | | wu_id | true | string | null | The wu_id of the user. | | numberOfDays | false | any | 14 | The number of days to remember the login. |
| | return type | any |
|
| removeCustomPropertiesForPage | Public Function removeCustomPropertiesForPage source: /usr/local/tomcat/webapps/ROOT/Components/ContentMngt/PageIO.cfc Removes all custom properties from a page | | arguments | | label | name | required | type | default | hint | | sp_id | true | numeric | null | |
| | return type | any |
|
| removeCustomProperty | Public Function removeCustomProperty source: /usr/local/tomcat/webapps/ROOT/Components/ContentMngt/PageIO.cfc Removes a custom property | | arguments | | label | name | required | type | default | hint | | spcp_id | true | numeric | null | |
| | return type | any |
|
| removeData | Public Function removeData source: /usr/local/tomcat/webapps/ROOT/Components/WIS/DataIO.cfc Removes the a data record. | | arguments | | label | name | required | type | default | hint | | data_id | true | numeric | null | The data_id to remove. |
| | return type | struct |
|
| removeFormTemplate | Public Function removeFormTemplate source: /usr/local/tomcat/webapps/ROOT/Components/ContentMngt/SiteIO.cfc Removes a form template | | arguments | | label | name | required | type | default | hint | | sccft_id | true | numeric | null | |
| | return type | any |
|
| removeImageTemplate | Public Function removeImageTemplate source: /usr/local/tomcat/webapps/ROOT/Components/ContentMngt/SiteIO.cfc Removes an image template | | arguments | | label | name | required | type | default | hint | | sccit_id | true | numeric | null | |
| | return type | any |
|
| removeObject | Public Function removeObject source: /usr/local/tomcat/webapps/ROOT/Components/ContentMngt/ObjectIO.cfc Removes an object. | | arguments | | label | name | required | type | default | hint | | so_id | true | numeric | null | The ID of the object. |
| | return type | struct |
|
| removeObjectFromTemplatePart | Public Function removeObjectFromTemplatePart source: /usr/local/tomcat/webapps/ROOT/Components/ContentMngt/ObjectIO.cfc Removes an object from a template part | | arguments | | label | name | required | type | default | hint | | sp_id | true | numeric | null | The id of the page. | | stp_id | true | numeric | null | The id of the template part. |
| | return type | struct |
|
| removeObjectPagesFromCache | Public Function removeObjectPagesFromCache source: /usr/local/tomcat/webapps/ROOT/Components/ContentMngt/ObjectIO.cfc Removes all pages from an object completely from the cache. | | arguments | | label | name | required | type | default | hint | | so_id | true | numeric | null | The ID of the object. |
| | return type | struct |
|
| removeObjectShortcut | Public Function removeObjectShortcut source: /usr/local/tomcat/webapps/ROOT/Components/ContentMngt/ObjectIO.cfc Removes a shortcut to an object. | | arguments | | label | name | required | type | default | hint | | so_id | true | numeric | null | The ID of the object. | | sp_id | true | numeric | null | The ID of the page. |
| | return type | struct |
|
| removePersonalizedGroups | Public Function removePersonalizedGroups source: /usr/local/tomcat/webapps/ROOT/Components/ContentMngt/PageIO.cfc Removes a personalized group from a page. | | arguments | | label | name | required | type | default | hint | | sp_id | true | numeric | null | The id of the page | | wg_id_list | true | string | null | The id list of the groups |
| | return type | struct |
|
| removePersonalizedGroupsFromPage | Public Function removePersonalizedGroupsFromPage source: /usr/local/tomcat/webapps/ROOT/Components/ContentMngt/PageIO.cfc Removes a personalized group from a page. | | arguments | | label | name | required | type | default | hint | | sp_id | true | numeric | null | The id of the page |
| | return type | struct |
|
| removeSiteAdmin | Public Function removeSiteAdmin source: /usr/local/tomcat/webapps/ROOT/Components/ContentMngt/SiteIO.cfc Removes a site administrator from a website. | | arguments | | label | name | required | type | default | hint | | site_id | true | numeric | null | The ID of the website. | | wu_id_list | true | string | null | The ID(s) of the site administrator(s). |
| | return type | struct |
|
| removeSiteCachedPages | Public Function removeSiteCachedPages source: /usr/local/tomcat/webapps/ROOT/Components/ContentMngt/SiteIO.cfc Removes all cached pages of a site. | | arguments | | label | name | required | type | default | hint | | site_id | true | numeric | null | The ID of the site. |
| | return type | struct |
|
| removeSiteConfigContainer | Public Function removeSiteConfigContainer source: /usr/local/tomcat/webapps/ROOT/Components/ContentMngt/SiteIO.cfc Removes a site_config_container | | arguments | | label | name | required | type | default | hint | | scc_id | true | numeric | null | |
| | return type | struct |
|
| removeSiteConfigContainerPageCustomProperty | Public Function removeSiteConfigContainerPageCustomProperty source: /usr/local/tomcat/webapps/ROOT/Components/ContentMngt/SiteIO.cfc removes a siteConfigContainer page custom property by sccpcp_id | | arguments | | label | name | required | type | default | hint | | sccpcp_id | true | numeric | null | |
| | return type | any |
|
| removeSiteConfigContainersFromCompany | Public Function removeSiteConfigContainersFromCompany source: /usr/local/tomcat/webapps/ROOT/Components/ContentMngt/SiteIO.cfc Removes all site_config_containers from a company | | arguments | | label | name | required | type | default | hint | | wc_id | true | numeric | null | |
| | return type | struct |
|
| removeSiteCustomProperty | Public Function removeSiteCustomProperty source: /usr/local/tomcat/webapps/ROOT/Components/ContentMngt/SiteIO.cfc removes a custom property by scp_id | | arguments | | label | name | required | type | default | hint | | scp_id | true | numeric | null | |
| | return type | any |
|
| 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 |
|
| saveCustomProperty | Public Function saveCustomProperty source: /usr/local/tomcat/webapps/ROOT/Components/ContentMngt/PageIO.cfc Saves a custom property | | arguments | | label | name | required | type | default | hint | | sp_id | true | numeric | null | | | spcp_key | true | any | null | | | spcp_type | true | numeric | null | 1: text, 2: varchar, 3: date, 4: numeric, 6: bit | | spcp_value | true | any | null | |
| | return type | any |
|
| saveFormTemplate | Public Function saveFormTemplate source: /usr/local/tomcat/webapps/ROOT/Components/ContentMngt/SiteIO.cfc Saves a new form template for a siteConfigContainer | | arguments | | label | name | required | type | default | hint | | scc_id | true | numeric | null | | | sccft_name | true | any | null | | | sccft_value | true | any | null | | | sccft_description | false | any | | |
| | return type | any |
|
| saveImageTemplate | Public Function saveImageTemplate source: /usr/local/tomcat/webapps/ROOT/Components/ContentMngt/SiteIO.cfc Saves a new image template for a siteConfigContainer | | arguments | | label | name | required | type | default | hint | | scc_id | true | numeric | null | | | sccit_name | true | any | null | | | sccit_width | true | any | null | | | sccit_height | true | any | null | | | sccit_description | false | any | | |
| | return type | any |
|
| saveListContent | Public Function saveListContent source: /usr/local/tomcat/webapps/ROOT/Components/ContentMngt/ObjectIO.cfc | | arguments | | label | name | required | type | default | hint | | so_id | false | numeric | null | the object id for the object to save the list items for | | ml_id | true | numeric | null | | | vmov_id | true | any | null | the vmomv id of the item you want to edit | | vmo_id | true | any | null | | | system_id | true | any | null | | | valueStruct | true | struct | null | |
| | return type | any |
|
| saveSiteConfigContainer | Public Function saveSiteConfigContainer source: /usr/local/tomcat/webapps/ROOT/Components/ContentMngt/SiteIO.cfc adds a configurationContainter | | arguments | | label | name | required | type | default | hint | | scc_name | true | any | null | | | wc_id | true | any | null | | | scc_sharemode | false | any | 0 | |
| | return type | struct |
|
| saveSiteConfigContainerPageCustomProperty | Public Function saveSiteConfigContainerPageCustomProperty source: /usr/local/tomcat/webapps/ROOT/Components/ContentMngt/SiteIO.cfc Saves a custom property | | arguments | | label | name | required | type | default | hint | | scc_id | true | numeric | null | | | spcp_key | true | any | null | | | spcp_type | true | numeric | null | 1: text, 2: varchar, 3: date, 4: numeric, 6: bit | | spcp_value | true | any | null | | | sccpcp_desc | false | any | | |
| | return type | any |
|
| saveSiteCustomProperty | Public Function saveSiteCustomProperty source: /usr/local/tomcat/webapps/ROOT/Components/ContentMngt/SiteIO.cfc Saves a custom property for a site | | arguments | | label | name | required | type | default | hint | | site_id | true | numeric | null | | | scp_key | true | any | null | | | scp_type | true | numeric | null | 1: text, 2: varchar, 3: date, 4: numeric, 6: bit | | scp_value | true | any | null | |
| | return type | any |
|
| searchSites | Public Function searchSites source: /usr/local/tomcat/webapps/ROOT/Components/ContentMngt/SiteIO.cfc Returns websites with a search constraint. Searches names and descriptions. | | arguments | | label | name | required | type | default | hint | | site_id_list | true | string | null | The ID(s) of the website. | | search | true | string | null | A string containing the search. |
| | return type | struct |
|
| searchTemplates | Public Function searchTemplates source: /usr/local/tomcat/webapps/ROOT/Components/ContentMngt/TemplateIO.cfc Returns the id's of templates which match in a search criteria. | | arguments | | label | name | required | type | default | hint | | st_id_list | true | string | null | The id list of the templates | | search | true | string | null | The search string |
| | return type | struct |
|
| setData | Public Function setData source: /usr/local/tomcat/webapps/ROOT/Components/WIS/DataIO.cfc Sets the data of a data_id and a ml_id. | | arguments | | label | name | required | type | default | hint | | data_id | true | numeric | null | The data_id of the data to set. | | ml_id | true | numeric | null | The ml_id of the data to set. | | data | true | string | null | The data to set. |
| | return type | struct |
|
| setDateTime | Public Function setDateTime source: /usr/local/tomcat/webapps/ROOT/Components/WIS/DataIO.cfc Updates the datarecord for a date_time value. | | arguments | | label | name | required | type | default | hint | | data_id | true | numeric | null | The data_id to update. | | date | false | numeric | {ts '2026-09-10 14:52:34'} | |
| | return type | struct |
|
| setDateTimeCF | Public Function setDateTimeCF source: /usr/local/tomcat/webapps/ROOT/Components/WIS/DataIO.cfc Updates the datarecord for a date_time value. | | arguments | | label | name | required | type | default | hint | | data_id | true | numeric | null | The data_id to update. | | datetime | false | date | {ts '2026-09-10 14:52:34'} | The Coldfusion formatted date. |
| | return type | struct |
|
| setLicenses | Public Function setLicenses source: /usr/local/tomcat/webapps/ROOT/Components/ContentMngt/SiteIO.cfc Sets the number of website licenses for a company. | | arguments | | label | name | required | type | default | hint | | wc_id | true | numeric | null | The ID of the company. | | licenses | true | numeric | null | The amount of sitelicenses. |
| | return type | struct |
|
| setListObjectValues | Public Function setListObjectValues source: /usr/local/tomcat/webapps/ROOT/Components/ContentMngt/ObjectIO.cfc Updates the values of a listobject. | | arguments | | label | name | required | type | default | hint | | so_id | true | numeric | null | The ID of the object. | | scdv_id | true | numeric | null | The ID of the listview. | | sp_id | true | numeric | null | The ID of the listdisplay. |
| | return type | struct |
|
| setObjectValues | Public Function setObjectValues source: /usr/local/tomcat/webapps/ROOT/Components/ContentMngt/ObjectIO.cfc Updates the values of an object. | | arguments | | label | name | required | type | default | hint | | so_id | true | numeric | null | The ID of the object. | | so_name | true | string | null | The name of the object. | | so_share | true | boolean | null | Share the object. |
| | return type | struct |
|
| setObjectValuesStruct | Public Function setObjectValuesStruct source: /usr/local/tomcat/webapps/ROOT/Components/ContentMngt/ObjectIO.cfc Updates the values of an object. | | arguments | | label | name | required | type | default | hint | | so_id | true | numeric | null | The ID of the object. | | structValue | true | struct | null | The name of the object. |
| | return type | struct |
|
| setPageHide | Public Function setPageHide source: /usr/local/tomcat/webapps/ROOT/Components/ContentMngt/PageIO.cfc Sets the page hided or not | | arguments | | label | name | required | type | default | hint | | sp_id | true | numeric | null | The id of the page to get | | ml_id | true | numeric | null | The id of the language | | hide_reason | true | numeric | null | The reason why the page must be hided. | | hide | true | boolean | null | Is the page hided for that reason? | | updateMenu | false | boolean | true | Update the menus. |
| | return type | struct |
|
| setPageHideAllLanguages | Public Function setPageHideAllLanguages source: /usr/local/tomcat/webapps/ROOT/Components/ContentMngt/PageIO.cfc Hides or unhides the page for all languages. | | arguments | | label | name | required | type | default | hint | | sp_id | true | numeric | null | The ID of the page. | | hide_reason | true | numeric | null | The reason why the page must be hidden or unhidden. | | hide | true | boolean | null | Is the page hidden for that reason? |
| | return type | struct |
|
| setPageMetaData | Public Function setPageMetaData source: /usr/local/tomcat/webapps/ROOT/Components/ContentMngt/PageIO.cfc Saves some meta data | | arguments | | label | name | required | type | default | hint | | sp_id | true | numeric | null | The id of the page | | ml_id | true | numeric | null | The id of the language to save | | columnList | true | string | null | A list of columns with you want to set | | arg1 | false | string | null | | | arg2 | false | string | null | | | arg3 | false | string | null | | | arg4 | false | string | null | | | arg5 | false | string | null | | | arg6 | false | string | null | |
| | return type | struct |
|
| setPageOwner | Public Function setPageOwner source: /usr/local/tomcat/webapps/ROOT/Components/ContentMngt/PageIO.cfc Changes the owner of the page | | arguments | | label | name | required | type | default | hint | | sp_id | true | numeric | null | The id of the page | | wu_id | true | numeric | null | The id of the new owner |
| | return type | struct |
|
| setPageValues | Public Function setPageValues source: /usr/local/tomcat/webapps/ROOT/Components/ContentMngt/PageIO.cfc Sets properties of a page. | | arguments | | label | name | required | type | default | hint | | sp_id | true | numeric | null | The ID of the page. | | structValue | true | struct | null | The structure with values. |
| | return type | struct |
|
| setPersonalizedGroups | Public Function setPersonalizedGroups source: /usr/local/tomcat/webapps/ROOT/Components/ContentMngt/PageIO.cfc Sets personalized groups | | arguments | | label | name | required | type | default | hint | | sp_id | true | numeric | null | The id of the page | | wg_id_list | true | string | null | The id list of the groups |
| | return type | struct |
|
| setRightsGroups | Public Function setRightsGroups source: /usr/local/tomcat/webapps/ROOT/Components/ContentMngt/PageIO.cfc Sets rights groups | | arguments | | label | name | required | type | default | hint | | sp_id | true | numeric | null | The id of the page | | wg_id_list | true | string | null | The id list of the groups |
| | return type | struct |
|
| setSessionAcrossDomains | Public Function setSessionAcrossDomains source: /usr/local/tomcat/webapps/ROOT/Components/ContentMngt/webSelect.cfc | | arguments | | label | name | required | type | default | hint | | domain | false | string | null | |
| | return type | any |
|
| setSessionFromToken | Public Function setSessionFromToken source: /usr/local/tomcat/webapps/ROOT/Components/ContentMngt/webSelect.cfc Sets some session variables from a token. | | arguments | | label | name | required | type | default | hint | | token | true | any | null | The token. |
| | return type | any |
|
| setSiteAllowedObjectTypes | Public Function setSiteAllowedObjectTypes source: /usr/local/tomcat/webapps/ROOT/Components/ContentMngt/SiteIO.cfc Sets the allowed objecttypes for a site. | | arguments | | label | name | required | type | default | hint | | site_id | true | numeric | null | The ID of the website. | | typeQuery | true | query | null | The query with allowed objecttypes. |
| | return type | struct |
|
| setSiteLanguages | Public Function setSiteLanguages source: /usr/local/tomcat/webapps/ROOT/Components/ContentMngt/SiteIO.cfc Sets the languages from a website. | | arguments | | label | name | required | type | default | hint | | site_id | true | numeric | null | The ID of the website. | | ml_id_list | true | string | null | The ID(s) of the languages(s). |
| | return type | struct |
|
| setSiteTitle | Public Function setSiteTitle source: /usr/local/tomcat/webapps/ROOT/Components/ContentMngt/SiteIO.cfc Set the site title for the given language | | arguments | | label | name | required | type | default | hint | | site_id | true | numeric | null | the site to set the title for | | title | true | String | null | the new title for the site | | ml_id | true | numeric | null | The language to set the title in, use 0 to set it in all active languages |
| | return type | any |
|
| setSiteValues | Public Function setSiteValues source: /usr/local/tomcat/webapps/ROOT/Components/ContentMngt/SiteIO.cfc Updates the site values. | | arguments | | label | name | required | type | default | hint | | site_id | true | numeric | null | The ID of the site. | | valueStructure | true | struct | null | The structure with all values. | | ml_id | false | numeric | 0 | The structure with all values. |
| | return type | struct |
|
| setTemplatePart | Public Function setTemplatePart source: /usr/local/tomcat/webapps/ROOT/Components/ContentMngt/SiteIO.cfc Sets the values of a template part. | | arguments | | label | name | required | type | default | hint | | stp_id | true | numeric | null | The ID of the template part. | | st_values | true | struct | null | A structure with the values. |
| | return type | struct |
|
| setTemplatePartValues | Public Function setTemplatePartValues source: /usr/local/tomcat/webapps/ROOT/Components/ContentMngt/TemplateIO.cfc Sets all the values of a template part | | arguments | | label | name | required | type | default | hint | | st_id | true | numeric | null | The id of the template to update | | stp_id | true | numeric | null | The id of the template part to update | | stp_width | true | string | null | | | stp_height | true | string | null | | | stp_padding | true | numeric | null | | | stp_margin_top | true | numeric | null | | | stp_margin_bottom | true | numeric | null | | | stp_margin_left | true | numeric | null | | | stp_margin_right | true | numeric | null | | | stp_background_color | true | string | null | | | stp_lock | true | boolean | null | |
| | return type | struct |
|
| setTemplateValues | Public Function setTemplateValues source: /usr/local/tomcat/webapps/ROOT/Components/ContentMngt/TemplateIO.cfc Changes the values of a template | | arguments | | label | name | required | type | default | hint | | st_id | true | numeric | null | The st id of the template | | st_name | false | string | null | The new name of the template | | st_description | true | string | null | The new description of the template | | st_share | true | boolean | null | Share the template to lower companies | | st_hidden | true | boolean | null | Hide the template for new use |
| | return type | struct |
|
| simpleAuthorize | Public Function simpleAuthorize source: /usr/local/tomcat/webapps/ROOT/Components/ContentMngt/webSelect.cfc | | arguments | | label | name | required | type | default | hint | | url | true | struct | null | |
| | return type | any |
|
| SITEPATH | Query Execution Time: 0 ms Record Count: 0 Cached: No Lazy: No
| | href | sc_id | site_id | sort_nr | sp_active | sp_created | sp_creator_id | sp_custom_data_id | sp_depth | sp_description_data_id | sp_external_address | sp_forward_external | sp_forward_id | sp_id | sp_include_template | sp_keywords_data_id | sp_last_modified | sp_last_modifier_id | sp_name | sp_name_data_id | sp_name_default | sp_no_cache | sp_order | sp_owner_id | sp_parent_id | sp_personalization | sp_robots_data_id | sp_schedule | sp_searchable | sp_title_data_is | sp_type | sst_id | st_id | ww_id |
|
| stringHTMLTemplate | Public Function stringHTMLTemplate source: /usr/local/tomcat/webapps/ROOT/Components/ContentMngt/TemplateIO.cfc Returns an HTML template. | | arguments | | label | name | required | type | default | hint | | st_id | true | numeric | null | The st_id of the template to get. | | view | false | any | | The view to get |
| | return type | string |
|
| stringWebsitePath | Public Function stringWebsitePath source: /usr/local/tomcat/webapps/ROOT/Components/ContentMngt/SiteIO.cfc Return the OS path to a website | | arguments | | label | name | required | type | default | hint | | site_id | true | numeric | null | The ID of the site. |
| | return type | string |
|
| switchTemplatePartSearch | Public Function switchTemplatePartSearch source: /usr/local/tomcat/webapps/ROOT/Components/ContentMngt/ObjectIO.cfc Switches the search for a template part of a page. | | arguments | | label | name | required | type | default | hint | | sp_id | true | numeric | null | The ID of the page. | | stp_id | true | numeric | null | The ID of the template part. |
| | 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 |
|
| updateAllBookmarks | Public Function updateAllBookmarks source: /usr/local/tomcat/webapps/ROOT/Components/ContentMngt/ObjectIO.cfc updates all bookmarks in the database | | arguments | | label | name | required | type | default | hint |
| | return type | struct |
|
| updateContentObject | Public Function updateContentObject source: /usr/local/tomcat/webapps/ROOT/Components/ContentMngt/ObjectIO.cfc Updates the content of a content object | | arguments | | label | name | required | type | default | hint | | so_id | true | numeric | null | The ID of the object. | | ml_id | true | numeric | null | The ID of the language. | | content | true | string | null | The new content for the object. |
| | return type | struct |
|
| updateCustomProperty | Public Function updateCustomProperty source: /usr/local/tomcat/webapps/ROOT/Components/ContentMngt/PageIO.cfc Updates a custom property | | arguments | | label | name | required | type | default | hint | | sp_id | true | numeric | null | | | spcp_key | true | any | null | | | spcp_value | true | any | null | |
| | return type | any |
|
| updateDepthForChildren | Public Function updateDepthForChildren source: /usr/local/tomcat/webapps/ROOT/Components/ContentMngt/PageIO.cfc | | arguments | | label | name | required | type | default | hint | | sp_id | true | numeric | null | The page of which the children need to be updated | | new_depth | true | numeric | null | the new depth for the children |
| | return type | any |
|
| updateFormTemplate | Public Function updateFormTemplate source: /usr/local/tomcat/webapps/ROOT/Components/ContentMngt/SiteIO.cfc Updates a form template | | arguments | | label | name | required | type | default | hint | | sccft_id | true | numeric | null | | | sccft_name | true | any | null | | | sccft_description | true | any | null | |
| | return type | any |
|
| updateImageTemplate | Public Function updateImageTemplate source: /usr/local/tomcat/webapps/ROOT/Components/ContentMngt/SiteIO.cfc Updates an image template | | arguments | | label | name | required | type | default | hint | | sccit_id | true | numeric | null | | | sccit_width | true | any | null | | | sccit_height | true | any | null | | | sccit_description | true | any | null | |
| | return type | any |
|
| updateMenu | Public Function updateMenu source: /usr/local/tomcat/webapps/ROOT/Components/ContentMngt/PageIO.cfc Invokes the menugenerator of the website to run. | | arguments | | label | name | required | type | default | hint | | site_id_arg | true | numeric | null | The id of the website |
| | return type | struct |
|
| updateMenuAsync | Public Function updateMenuAsync source: /usr/local/tomcat/webapps/ROOT/Components/ContentMngt/PageIO.cfc Invokes the menugenerator of the website to run. | | arguments | | label | name | required | type | default | hint | | site_id_arg | true | numeric | null | The id of the website |
| | return type | struct |
|
| updatePage | Public Function updatePage source: /usr/local/tomcat/webapps/ROOT/Components/ContentMngt/ObjectIO.cfc Handles the update of a page. | | arguments | | label | name | required | type | default | hint | | sp_id | true | numeric | null | The id of the page to handle | | cascade | true | boolean | true | Do not use this variable. Only for internal usage. |
| | return type | struct |
|
| updatePageAsync | Public Function updatePageAsync source: /usr/local/tomcat/webapps/ROOT/Components/ContentMngt/ObjectIO.cfc Handles the update of a page. | | arguments | | label | name | required | type | default | hint | | sp_id | true | numeric | null | The id of the page to handle | | cascade | true | boolean | true | Do not use this variable. Only for internal usage. | | updateLastModifier | false | boolean | true | Do not use this variable. Only for internal usage. |
| | return type | struct |
|
| updateSiteConfigContainer | Public Function updateSiteConfigContainer source: /usr/local/tomcat/webapps/ROOT/Components/ContentMngt/SiteIO.cfc Saves the fields of a configurationContainter | | arguments | | label | name | required | type | default | hint | | scc_id | true | numeric | null | | | scc_name | true | any | null | | | scc_sharemode | true | numeric | null | |
| | return type | struct |
|
| updateSiteConfigContainerPageCustomProperty | Public Function updateSiteConfigContainerPageCustomProperty source: /usr/local/tomcat/webapps/ROOT/Components/ContentMngt/SiteIO.cfc Updates a custom property | | arguments | | label | name | required | type | default | hint | | scc_id | true | numeric | null | | | spcp_key | true | any | null | | | spcp_value | true | any | null | | | sccpcp_desc | false | any | null | |
| | return type | any |
|
| updateSiteCustomProperty | Public Function updateSiteCustomProperty source: /usr/local/tomcat/webapps/ROOT/Components/ContentMngt/SiteIO.cfc Updates a custom property | | arguments | | label | name | required | type | default | hint | | site_id | true | numeric | null | | | scp_key | true | any | null | | | scp_value | true | any | null | |
| | return type | any |
|
| updateURLLinkedPages | Public Function updateURLLinkedPages source: /usr/local/tomcat/webapps/ROOT/Components/ContentMngt/PageIO.cfc Updates the URL's for the linked pages of given page | | arguments | | label | name | required | type | default | hint | | sp_id | true | any | null | | | ml_id | true | any | null | |
| | return type | any |
|
| writeRights | Public Function writeRights source: /usr/local/tomcat/webapps/ROOT/Components/ContentMngt/PageIO.cfc Writes authorizations of a page for a list of groups | | arguments | | label | name | required | type | default | hint | | sp_id | true | numeric | null | The id of the page | | wg_id | true | string | null | Accepts a list of groups. All values for each group are in a list in the other arguments. | | deep | true | string | null | | | spa_write | true | string | null | | | spa_add | true | string | null | | | spa_del | true | string | null | | | spa_admin | true | string | null | |
| | return type | struct |
|
| XmlEscapedToHtml | Public Function XmlEscapedToHtml source: /usr/local/tomcat/webapps/ROOT/Components/ContentMngt/PageIO.cfc | | arguments | | label | name | required | type | default | hint | | content | false | any | null | |
| | return type | any |
|
| xmlTemplate | Public Function xmlTemplate source: /usr/local/tomcat/webapps/ROOT/Components/ContentMngt/TemplateIO.cfc Returns an XML template. | | arguments | | label | name | required | type | default | hint | | st_id | true | numeric | null | The st_id of the template to get. | | view | false | any | | The view to get |
| | return type | any |
|