Component (Components.ContentMngt.PageIO)
Only the functions and data members that are accessible from your location are displayed
ExtendsTemplateIO
HintHandles website page IO.
this
remote
userCanDeletePage
Remote Function userCanDeletePage
source: /usr/local/tomcat/webapps/ROOT/Components/ContentMngt/PageIO.cfc
Returns whether the user can delete the page. Used remotely from ContentManagement-tree.
arguments
labelnamerequiredtypedefaulthint
sp_idtruenumericnullThe ID of the page.
wu_idfalsenumeric-1The ID of the user.
return typeboolean
public
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
labelnamerequiredtypedefaulthint
data_typetruestringnullThe 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.
dataQueryfalsequerynullA query to fill the new data record set.
return typestruct
addDisplayPage
Public Function addDisplayPage
source: /usr/local/tomcat/webapps/ROOT/Components/ContentMngt/PageIO.cfc
Adds a page to another page
arguments
labelnamerequiredtypedefaulthint
sp_name_defaulttruestringnullThe default name in the default language of the page
st_idtruenumericnullThe id of the template
site_idtruenumericnullThe id of the site
sst_idfalsenumeric-1
return typestruct
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
labelnamerequiredtypedefaulthint
ml_idtruenumericnullThe ml_id of the new language.
return typestruct
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
labelnamerequiredtypedefaulthint
nl_nametruestringnullThe name of the newsletter page
st_idtruenumericnullThe ID of the template
site_idtruenumericnullThe ID of the site to which the newsletter page belongs
return typestruct
addPage
Public Function addPage
source: /usr/local/tomcat/webapps/ROOT/Components/ContentMngt/PageIO.cfc
Adds a page to another page
arguments
labelnamerequiredtypedefaulthint
sp_idtruenumericnullThe id of the main page
ml_idtruenumericnullThe id of the language which is the language of sp_name
sp_nametruestringnullThe name of the page
sp_name_defaulttruestringnullThe default name in the default language of the page
st_idtruenumericnullThe id of the template
fillEmptytruebooleannullFill the template with empty content fields?
return typestruct
addSite
Public Function addSite
source: /usr/local/tomcat/webapps/ROOT/Components/ContentMngt/SiteIO.cfc
Adds a website.
arguments
labelnamerequiredtypedefaulthint
valueStructuretruestructnullThe siteproperties and their values.
languagestruestringnullThe languages the site must be available for.
return typestruct
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
labelnamerequiredtypedefaulthint
site_id_listtruestringnullThe ID(s) of the website.
wu_id_listtruestringnullThe ID(s) of the administrator.
return typestruct
addSiteValues
Public Function addSiteValues
source: /usr/local/tomcat/webapps/ROOT/Components/ContentMngt/SiteIO.cfc
Adds the standard values for a website.
arguments
labelnamerequiredtypedefaulthint
valueStructuretruestructnullThe site properties and their values.
return typestruct
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
labelnamerequiredtypedefaulthint
site_idtruenumericnullThe ID of the site.
nametruestringnullThe name of the new template
return typestruct
addTemplatePart
Public Function addTemplatePart
source: /usr/local/tomcat/webapps/ROOT/Components/ContentMngt/SiteIO.cfc
Adds a template part in a template.
arguments
labelnamerequiredtypedefaulthint
st_idtruenumericnullThe ID of the template.
stp_parent_idtruenumericnullThe id of the parent part. 0 is a main part.
return typestruct
ALLSCOPES
Struct
URL
Struct
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
labelnamerequiredtypedefaulthint
sp_idtruenumericnullThe ID of the page.
st_idtruenumericnullThe ID of the template.
return typestruct
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
labelnamerequiredtypedefaulthint
definitiontruequerynullA 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.
repairfalsebooleanfalseWhat has the function to do, repair or only report? Default is no, thus report.
return typestruct
checkNumericList
Public Function checkNumericList
source: /usr/local/tomcat/webapps/ROOT/Components/Result/ReturnStruct.cfc
Checks if each element in a list is numeric
arguments
labelnamerequiredtypedefaulthint
listtruestringnullThe list to check
addfalsenumericnullIf a list is empty, then add the add
return typeany
cleanRights
Public Function cleanRights
source: /usr/local/tomcat/webapps/ROOT/Components/ContentMngt/PageIO.cfc
Removes all rights which are not relevant
arguments
labelnamerequiredtypedefaulthint
sp_idtruenumericnullThe id of the page
deeptruenumericnullClean also the sub pages?
return typestruct
compileTemplate
Public Function compileTemplate
source: /usr/local/tomcat/webapps/ROOT/Components/ContentMngt/SiteIO.cfc
Compiles a cfm template
arguments
labelnamerequiredtypedefaulthint
templateNametruestringnullThe name of the template to compile
siteNametruestringnullThe name of the website
replaceSpecialCharacterstruebooleannullReplace characters in the compiled template
dateMaskfalsestringnullThe datemask to use. Can be used when it cannot be retrieved from the session.
timeMaskfalsestringnullThe timemask to use. Can be used when it cannot be retrieved from the session.
return typestring
COMPONENTCACHE
Struct
xcenter.gateways.gateways
Component (Components.XCenter.Gateways.Gateways)
Only the functions and data members that are accessible from your location are displayed
ExtendsComponents.xCenter.Datasources
HintThis component handles all gateway specific actions.
this
public
ACTIONPERMISSIONS
ActionPermissions
classcom.Egengroup.Spider.Plugins.XCenter.ActionPermissions
fields
namepatternvalue
READ_PROPERTIESpublic static final int com.Egengroup.Spider.Plugins.XCenter.ActionPermissions.READ_PROPERTIES1
MODIFY_PROPERTIESpublic static final int com.Egengroup.Spider.Plugins.XCenter.ActionPermissions.MODIFY_PROPERTIES2
DELETEpublic static final int com.Egengroup.Spider.Plugins.XCenter.ActionPermissions.DELETE3
constructors
interfaceexceptions
<init>()
methods
returninterfaceexceptions
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
labelnamerequiredtypedefaulthint
scd_idtruenumericnullThe ID of the content definition.
ga_idtruenumericnullThe ID of the action.
gal_componenttruestringnullThe component to be called.
gal_methodtruestringnullThe method to be called.
return typestruct
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
labelnamerequiredtypedefaulthint
wc_idtruenumericnullThe id of the company where you want to create the WIS datasource.
mdt_idtruenumericnullThe id of the type of the datasource
datasource_nametruestringnullThe name of the new WIS datasource
datasource_descriptiontruestringnullThe description of the WIS datasource
datasource_sharetruebooleannullShare the WIS datasource to lower companies?
datasource_defaulttruebooleannullIndicates whether this datasource is default.
datasourcePropertiestruestructnullA structur with keys depending in the type of the WIS datasource
return typestruct
addGateway
Public Function addGateway
source: /usr/local/tomcat/webapps/ROOT/Components/xCenter/Gateways/Gateways.cfc
Adds a gateway.
arguments
labelnamerequiredtypedefaulthint
gateway_nametruestringnullThe name of the gateway.
gateway_descriptiontruestringnullThe description of the gateway.
gateway_sharetruebooleannullIndicates whether to share this gateway.
datasource_idtruenumericnullThe ID of the datasource.
wc_idtruenumericnullThe ID of the company.
return typestruct
addGatewayAction
Public Function addGatewayAction
source: /usr/local/tomcat/webapps/ROOT/Components/xCenter/Gateways/Gateways.cfc
Adds a gateway-action.
arguments
labelnamerequiredtypedefaulthint
ga_nametruestringnullThe name of the gateway.
ga_display_nametruestringnullThe displayname of the gateway.
ga_descriptiontruestringnullThe description of the gateway.
ga_hidetruebooleannullHide the action for CMS.
gateway_idtruenumericnullThe ID of the gateway.
return typestruct
addGatewaySubActionParam
Public Function addGatewaySubActionParam
source: /usr/local/tomcat/webapps/ROOT/Components/xCenter/Gateways/Gateways.cfc
Adds a subaction parameter.
arguments
labelnamerequiredtypedefaulthint
gas_idtruenumericnullThe ID of the subaction.
gasp_nametruestringnullThe name of the subaction parameter.
gasp_defaulttruestringnullThe default of the subaction parameter.
mgaspt_idtruenumericnullThe ID of the subaction parametertype.
return typestruct
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
labelnamerequiredtypedefaulthint
ga_idtruenumericnullThe ID of the gateway action.
return typeboolean
checkAction
Public Function checkAction
source: /usr/local/tomcat/webapps/ROOT/Components/xCenter/Gateways/Gateways.cfc
Checks if the specified action exists.
arguments
labelnamerequiredtypedefaulthint
ga_idtruenumericnullThe ID of the action.
return typeboolean
checkNumericList
Public Function checkNumericList
source: /usr/local/tomcat/webapps/ROOT/Components/Result/ReturnStruct.cfc
Checks if each element in a list is numeric
arguments
labelnamerequiredtypedefaulthint
listtruestringnullThe list to check
addfalsenumericnullIf a list is empty, then add the add
return typeany
COMPONENTCACHE
Struct
concatQuery
Public Function concatQuery
source: /usr/local/tomcat/webapps/ROOT/Components/Result/ReturnStruct.cfc
Concats two queries, and returns one query
arguments
labelnamerequiredtypedefaulthint
query1truequerynullThe first query.
query2truequerynullThe second query.
columnListfalsestring*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 typequery
CONSTRAINTBLOCKCOMBINATORS
ObjectConditionConstraintBlock
classcom.Egengroup.Spider.Services.ObjectStorage.ObjectConditionConstraintBlock
fields
namepatternvalue
CONSTRAINT_COMBINATOR_ANDpublic static final int com.Egengroup.Spider.Services.ObjectStorage.ObjectConditionConstraintBlock.CONSTRAINT_COMBINATOR_AND1
CONSTRAINT_COMBINATOR_ORpublic static final int com.Egengroup.Spider.Services.ObjectStorage.ObjectConditionConstraintBlock.CONSTRAINT_COMBINATOR_OR2
constructors
interfaceexceptions
<init>(int)java.lang.IllegalArgumentException
methods
returninterfaceexceptions
java.util.ListgetInnerStatements()
voidaddConstraint(com.Egengroup.Spider.Services.ObjectStorage.ObjectConditionConstraint)
voidaddConstraints(com.Egengroup.Spider.Services.ObjectStorage.ObjectConditionConstraintBlock)
intgetCombinator()
Methods inherited from java.lang.Object
wait, wait, wait, equals, toString, hashCode, getClass, notify, notifyAll
CONSTRAINTOPERATORS
ObjectConditionConstraintOperators
classcom.Egengroup.Spider.Services.ObjectStorage.ObjectConditionConstraintOperators
fields
namepatternvalue
EQUALSpublic static final int com.Egengroup.Spider.Services.ObjectStorage.ObjectConditionConstraintOperators.EQUALS1
NOT_EQUALSpublic static final int com.Egengroup.Spider.Services.ObjectStorage.ObjectConditionConstraintOperators.NOT_EQUALS2
LIKEpublic static final int com.Egengroup.Spider.Services.ObjectStorage.ObjectConditionConstraintOperators.LIKE3
RANGEpublic static final int com.Egengroup.Spider.Services.ObjectStorage.ObjectConditionConstraintOperators.RANGE4
constructors
interfaceexceptions
<init>()
methods
returninterfaceexceptions
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
labelnamerequiredtypedefaulthint
wc_idtruenumericnullThe ID of the company.
return typenumeric
countDatasourceGateways
Public Function countDatasourceGateways
source: /usr/local/tomcat/webapps/ROOT/Components/xCenter/Datasources.cfc
Returns the amount of gateways of a datasource.
arguments
labelnamerequiredtypedefaulthint
datasource_idtruenumericnullThe ID of the datasource.
return typenumeric
countGatewayActions
Public Function countGatewayActions
source: /usr/local/tomcat/webapps/ROOT/Components/xCenter/Gateways/Gateways.cfc
Returns the amount of actions for a gateway.
arguments
labelnamerequiredtypedefaulthint
gateway_idtruenumericnullThe ID of the gateway.
return typenumeric
countGatewaySubActionParams
Public Function countGatewaySubActionParams
source: /usr/local/tomcat/webapps/ROOT/Components/xCenter/Gateways/Gateways.cfc
Returns the amount of params for a subaction.
arguments
labelnamerequiredtypedefaulthint
gas_idtruenumericnullThe ID of the subaction.
return typestruct
createComponent
Public Function createComponent
source: /usr/local/tomcat/webapps/ROOT/Components/Result/ReturnStruct.cfc
arguments
labelnamerequiredtypedefaulthint
return typeany
createContentOfflineItemDataNew
Public Function createContentOfflineItemDataNew
source: /usr/local/tomcat/webapps/ROOT/Components/xCenter/Gateways/Gateways.cfc
Creates the xml data
arguments
labelnamerequiredtypedefaulthint
ga_idtruenumericnullThe id of the action
argStructtruestructnullThe struct with values, if the datasource supports multilingual, we expect an innerstructure languages.
return typestruct
createContentOfflineItemDataUpdate
Public Function createContentOfflineItemDataUpdate
source: /usr/local/tomcat/webapps/ROOT/Components/xCenter/Gateways/Gateways.cfc
Creates the xml data
arguments
labelnamerequiredtypedefaulthint
vmov_idtruenumericnullThe id of the version
ga_idtruenumericnullThe id of the action
argStructtruestructnullThe struct with values
argStructOldfalsestructnullThe struct with values
return typestruct
createOfflineItem
Public Function createOfflineItem
source: /usr/local/tomcat/webapps/ROOT/Components/xCenter/Gateways/Gateways.cfc
Creates an offline item
arguments
labelnamerequiredtypedefaulthint
ga_idtruenumericnullThe ID of the action.
argStructtruestructnullThe parameters for the action.
return typestruct
DATASOURCEOPERATIONS
DatasourceOperations
classcom.Egengroup.Spider.Plugins.XCenter.DatasourceOperations
fields
namepatternvalue
OPERATION_READpublic static final int com.Egengroup.Spider.Plugins.XCenter.DatasourceOperations.OPERATION_READ1
OPERATION_ADDpublic static final int com.Egengroup.Spider.Plugins.XCenter.DatasourceOperations.OPERATION_ADD2
OPERATION_CHANGEpublic static final int com.Egengroup.Spider.Plugins.XCenter.DatasourceOperations.OPERATION_CHANGE3
OPERATION_REMOVEpublic static final int com.Egengroup.Spider.Plugins.XCenter.DatasourceOperations.OPERATION_REMOVE4
OPERATION_DUPLICATEpublic static final int com.Egengroup.Spider.Plugins.XCenter.DatasourceOperations.OPERATION_DUPLICATE5
OPERATION_ORDERpublic static final int com.Egengroup.Spider.Plugins.XCenter.DatasourceOperations.OPERATION_ORDER6
OPERATION_HIDEpublic static final int com.Egengroup.Spider.Plugins.XCenter.DatasourceOperations.OPERATION_HIDE7
OPERATION_PERSONALIZATIONpublic static final int com.Egengroup.Spider.Plugins.XCenter.DatasourceOperations.OPERATION_PERSONALIZATION8
OPERATION_AUTOSUBACTIONSpublic static final int com.Egengroup.Spider.Plugins.XCenter.DatasourceOperations.OPERATION_AUTOSUBACTIONS9
OPERATION_MULTILINGUALpublic static final int com.Egengroup.Spider.Plugins.XCenter.DatasourceOperations.OPERATION_MULTILINGUAL10
OPERATION_CREATORCOMPANYpublic static final int com.Egengroup.Spider.Plugins.XCenter.DatasourceOperations.OPERATION_CREATORCOMPANY11
constructors
interfaceexceptions
<init>()
methods
returninterfaceexceptions
Methods inherited from java.lang.Object
wait, wait, wait, equals, toString, hashCode, getClass, notify, notifyAll
DATASOURCEPERMISSIONS
DatasourcePermissions
classcom.Egengroup.Spider.Plugins.XCenter.DatasourcePermissions
fields
namepatternvalue
READ_PROPERTIESpublic static final int com.Egengroup.Spider.Plugins.XCenter.DatasourcePermissions.READ_PROPERTIES1
MODIFY_PROPERTIESpublic static final int com.Egengroup.Spider.Plugins.XCenter.DatasourcePermissions.MODIFY_PROPERTIES2
CONNECTpublic static final int com.Egengroup.Spider.Plugins.XCenter.DatasourcePermissions.CONNECT3
DELETEpublic static final int com.Egengroup.Spider.Plugins.XCenter.DatasourcePermissions.DELETE4
ADD_GATEWAYpublic static final int com.Egengroup.Spider.Plugins.XCenter.DatasourcePermissions.ADD_GATEWAY5
TEST_CONNECTIONpublic static final int com.Egengroup.Spider.Plugins.XCenter.DatasourcePermissions.TEST_CONNECTION6
PERSONALIZE_DATApublic static final int com.Egengroup.Spider.Plugins.XCenter.DatasourcePermissions.PERSONALIZE_DATA7
constructors
interfaceexceptions
<init>()
methods
returninterfaceexceptions
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
labelnamerequiredtypedefaulthint
ga_idtruenumericnullThe ID of the gateway-action.
return typestruct
deleteGateway
Public Function deleteGateway
source: /usr/local/tomcat/webapps/ROOT/Components/xCenter/Gateways/Gateways.cfc
Removes a gateway.
arguments
labelnamerequiredtypedefaulthint
gateway_idtruenumericnullThe ID of the gateway.
return typestruct
deleteGatewaySubActionParameter
Public Function deleteGatewaySubActionParameter
source: /usr/local/tomcat/webapps/ROOT/Components/xCenter/Gateways/Gateways.cfc
Removes a subaction parameter. Cannot remove system parameters.
arguments
labelnamerequiredtypedefaulthint
gasp_idtruenumericnullThe ID of the subaction parameter.
return typestruct
displayAlertError
Public Function displayAlertError
source: /usr/local/tomcat/webapps/ROOT/Components/Result/ReturnStruct.cfc
Alerts optional errormessages.
arguments
labelnamerequiredtypedefaulthint
inputStructuretruestructnullThe structure returned from another function
addScriptTagsfalsebooleantrueDo you want to add the script tags around the alert message?
return typestruct
displayHTMLError
Public Function displayHTMLError
source: /usr/local/tomcat/webapps/ROOT/Components/Result/ReturnStruct.cfc
Displays optional errormessages in HTML.
arguments
labelnamerequiredtypedefaulthint
inputStructuretruestructnullThe structure returned from another function.
return typestruct
dropDatasource
Public Function dropDatasource
source: /usr/local/tomcat/webapps/ROOT/Components/xCenter/Datasources.cfc
Removes a datasource.
arguments
labelnamerequiredtypedefaulthint
datasource_idtruenumericnullThe ID of the datasource.
return typestruct
duplicateItem
Public Function duplicateItem
source: /usr/local/tomcat/webapps/ROOT/Components/xCenter/Gateways/Gateways.cfc
Duplicates an item.
arguments
labelnamerequiredtypedefaulthint
ga_idtruenumericnullThe ID of the gateway action.
vmov_idtruenumericnullThe ID of the item.
system_idtruestringnullThe ID of the item.
return typestruct
executeAddAction
Public Function executeAddAction
source: /usr/local/tomcat/webapps/ROOT/Components/xCenter/Gateways/Gateways.cfc
Executes an add action on a datasource.
arguments
labelnamerequiredtypedefaulthint
ga_idtruenumericnullThe ID of the action.
argStructtruestructnullThe parameters for the action.
publishtruebooleannullDirectly publish the item?
return typestruct
executeChangeAction
Public Function executeChangeAction
source: /usr/local/tomcat/webapps/ROOT/Components/xCenter/Gateways/Gateways.cfc
Executes a change action on a datasource.
arguments
labelnamerequiredtypedefaulthint
ga_idtruenumericnullThe ID of the action.
ml_idtruenumericnullThe ID of the language.
ga_argStructtruestructnullThe parameters for the action.
vmov_idtruenumericnullThe version of the item to update
publishtruebooleannullPublish this version directly?
ga_argStructOldfalsestructnullThe old parameters for the action.
return typestruct
executeReadAction
Public Function executeReadAction
source: /usr/local/tomcat/webapps/ROOT/Components/xCenter/Gateways/Gateways.cfc
Executes a read action on a datasource.
arguments
labelnamerequiredtypedefaulthint
ga_idtruenumericnullThe ID of the action.
queryParamStructtruestructnullParameter structure containing parameters for the query itself.
executeParamStructtruestructnullParameter structure containing parameters for the execution.
return typeany
executeRemoveAction
Public Function executeRemoveAction
source: /usr/local/tomcat/webapps/ROOT/Components/xCenter/Gateways/Gateways.cfc
Executes a remove action on a datasource.
arguments
labelnamerequiredtypedefaulthint
ga_idtruenumericnullThe ID of the action.
system_idtruestringnullThe parameters for the action.
vmov_idtruenumericnullThe id of the version object.
return typeany
executeRemoveActionNow
Public Function executeRemoveActionNow
source: /usr/local/tomcat/webapps/ROOT/Components/xCenter/Gateways/Gateways.cfc
Executes a remove action on a datasource.
arguments
labelnamerequiredtypedefaulthint
ga_idtruenumericnullThe ID of the action.
system_idtruestringnullThe parameters for the action.
return typeany
FACTORY
XCenterFactoryProxy
classcom.Egengroup.Spider.Plugins.XCenter.XCenterFactoryProxy
methods
returninterfaceexceptions
com.Egengroup.Spider.Plugins.XCenter.XCenterFactoryProxygetInstance(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.ISubactiongetSubAction(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.IActiongetAction(int)com.Egengroup.Spider.Authorization.UnauthorizedException com.Egengroup.Spider.Plugins.XCenter.NoSuchActionException com.Egengroup.Spider.Plugins.XCenter.ActionException
com.Egengroup.Spider.Plugins.XCenter.IGatewaygetGateway(int)com.Egengroup.Spider.Authorization.UnauthorizedException com.Egengroup.Spider.Plugins.XCenter.NoSuchGatewayException com.Egengroup.Spider.Plugins.XCenter.GatewayException
com.Egengroup.Spider.Plugins.XCenter.IDatasourcegetDatasource(int)com.Egengroup.Spider.Authorization.UnauthorizedException com.Egengroup.Spider.Plugins.XCenter.NoSuchDatasourceException com.Egengroup.Spider.Plugins.XCenter.DatasourceException
voidinvalidateCache()
voiddeleteCompanyReferences(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
Struct
FOREIGNITEMSQUERYCACHE
Struct
GATEWAYPERMISSIONS
GatewayPermissions
classcom.Egengroup.Spider.Plugins.XCenter.GatewayPermissions
fields
namepatternvalue
READ_PROPERTIESpublic static final int com.Egengroup.Spider.Plugins.XCenter.GatewayPermissions.READ_PROPERTIES1
MODIFY_PROPERTIESpublic static final int com.Egengroup.Spider.Plugins.XCenter.GatewayPermissions.MODIFY_PROPERTIES2
DELETEpublic static final int com.Egengroup.Spider.Plugins.XCenter.GatewayPermissions.DELETE3
ADD_ACTIONpublic static final int com.Egengroup.Spider.Plugins.XCenter.GatewayPermissions.ADD_ACTION4
constructors
interfaceexceptions
<init>()
methods
returninterfaceexceptions
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
labelnamerequiredtypedefaulthint
addStructuretruestructnullThe columns and values to add.
return typestruct
generateUpdateSQL
Public Function generateUpdateSQL
source: /usr/local/tomcat/webapps/ROOT/Components/Result/ReturnStruct.cfc
Generates output for a SQL query statement (updating).
arguments
labelnamerequiredtypedefaulthint
updateStructuretruestructnullThe columns and values to update.
return typestruct
genPos
Public Function genPos
source: /usr/local/tomcat/webapps/ROOT/Components/Result/ReturnStruct.cfc
Creates an order id for queries
arguments
labelnamerequiredtypedefaulthint
keytruestringnullThe key the of id's
listtruestringnullThe list of id's
return typestring
getAction
Public Function getAction
source: /usr/local/tomcat/webapps/ROOT/Components/xCenter/Gateways/Gateways.cfc
Returns the java-object of an action.
arguments
labelnamerequiredtypedefaulthint
ga_idtruenumericnullThe ID of the action.
return typeany
getActionDatasourceType
Public Function getActionDatasourceType
source: /usr/local/tomcat/webapps/ROOT/Components/xCenter/Gateways/Gateways.cfc
Returns the datasourcetype for an action.
arguments
labelnamerequiredtypedefaulthint
ga_idtruenumericnullThe ID of the action.
return typenumeric
getActionStructure
Public Function getActionStructure
source: /usr/local/tomcat/webapps/ROOT/Components/xCenter/Gateways/Gateways.cfc
Retrieves the structure for an action.
arguments
labelnamerequiredtypedefaulthint
ga_idtruenumericnullThe ID of the action.
gas_typetruenumericnullThe type of the subaction.
return typeany
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
labelnamerequiredtypedefaulthint
ga_idtruenumericnullThe ID of the gateway-action.
gas_typetruenumericnullThe type of the subaction.
return typestruct
getAddActionColumns
Public Function getAddActionColumns
source: /usr/local/tomcat/webapps/ROOT/Components/xCenter/Gateways/Gateways.cfc
Retrieves the columns for an addaction.
arguments
labelnamerequiredtypedefaulthint
ga_idtruenumericnullThe ID of the action.
return typestruct
getAddActionRelations
Public Function getAddActionRelations
source: /usr/local/tomcat/webapps/ROOT/Components/xCenter/Gateways/Gateways.cfc
Retrieves the relations for an addaction.
arguments
labelnamerequiredtypedefaulthint
ga_idtruenumericnullThe ID of the action.
return typestruct
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
labelnamerequiredtypedefaulthint
ga_idtruenumericnullThe ID of the action.
return typestruct
getChangeActionColumns
Public Function getChangeActionColumns
source: /usr/local/tomcat/webapps/ROOT/Components/xCenter/Gateways/Gateways.cfc
Retrieves the columns for a changeaction.
arguments
labelnamerequiredtypedefaulthint
ga_idtruenumericnullThe ID of the action.
return typestruct
getChangeActionRelations
Public Function getChangeActionRelations
source: /usr/local/tomcat/webapps/ROOT/Components/xCenter/Gateways/Gateways.cfc
Retrieves the relations for a changeaction.
arguments
labelnamerequiredtypedefaulthint
ga_idtruenumericnullThe ID of the action.
return typestruct
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
labelnamerequiredtypedefaulthint
ga_idtruenumericnullThe ID of the action.
return typestruct
getCompanyDatasources
Public Function getCompanyDatasources
source: /usr/local/tomcat/webapps/ROOT/Components/xCenter/Datasources.cfc
Returns the datasources for a company.
arguments
labelnamerequiredtypedefaulthint
wc_idtruenumericnullThe ID of the company.
searchfalsestringThe searchstring.
startRowfalsenumeric1The startrow.
maxRowsfalsenumeric-1The maxrows.
return typeany
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
labelnamerequiredtypedefaulthint
wc_idtruenumericnullThe ID of the company.
return typestruct
getCompanyGateways
Public Function getCompanyGateways
source: /usr/local/tomcat/webapps/ROOT/Components/xCenter/Gateways/Gateways.cfc
Returns the gateways for a company.
arguments
labelnamerequiredtypedefaulthint
wc_idtruenumericnullThe ID of the company.
return typeany
getComponent
Public Function getComponent
source: /usr/local/tomcat/webapps/ROOT/Components/Result/ReturnStruct.cfc
arguments
labelnamerequiredtypedefaulthint
componentNametruestringnull
return typeany
getDatasource
Public Function getDatasource
source: /usr/local/tomcat/webapps/ROOT/Components/xCenter/Datasources.cfc
Returns a datasource.
arguments
labelnamerequiredtypedefaulthint
datasource_idtruenumericnullThe ID of the datasource.
return typeany
getDatasourceDefaultCondition
Public Function getDatasourceDefaultCondition
source: /usr/local/tomcat/webapps/ROOT/Components/xCenter/Datasources.cfc
Returns the default condition for datasources.
arguments
labelnamerequiredtypedefaulthint
return typeany
getDatasourceGateways
Public Function getDatasourceGateways
source: /usr/local/tomcat/webapps/ROOT/Components/xCenter/Datasources.cfc
Returns the gateways of a datasource.
arguments
labelnamerequiredtypedefaulthint
datasource_idtruenumericnullThe ID of the datasource.
searchfalsestringThe searchstring.
startRowfalsenumeric1The startrow.
maxRowsfalsenumeric-1The maxrows.
return typearray
getDatasourceSupportedOperations
Public Function getDatasourceSupportedOperations
source: /usr/local/tomcat/webapps/ROOT/Components/xCenter/Datasources.cfc
Returns the supported operations for a datasourcetype.
arguments
labelnamerequiredtypedefaulthint
datasource_idtruenumericnullThe ID of the datasource.
return typestruct
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
labelnamerequiredtypedefaulthint
mdt_idfalsenumericnullThe ID of the type.
return typestruct
getGateway
Public Function getGateway
source: /usr/local/tomcat/webapps/ROOT/Components/xCenter/Gateways/Gateways.cfc
Returns a gateway.
arguments
labelnamerequiredtypedefaulthint
gateway_idtruenumericnullThe ID of the gateway.
return typeany
getGatewayActions
Public Function getGatewayActions
source: /usr/local/tomcat/webapps/ROOT/Components/xCenter/Gateways/Gateways.cfc
Returns the actions for a gateway.
arguments
labelnamerequiredtypedefaulthint
gateway_idtruenumericnullThe ID of the gateway.
searchfalsestringThe searchstring.
startRowfalsenumeric1The startrow.
maxRowsfalsenumeric-1The maxrows.
return typearray
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
labelnamerequiredtypedefaulthint
gas_idtruenumericnullThe ID of the subaction.
return typestruct
getGatewaySubActionParamTypeValues
Public Function getGatewaySubActionParamTypeValues
source: /usr/local/tomcat/webapps/ROOT/Components/xCenter/Gateways/Gateways.cfc
Returns the values of subaction parameter types.
arguments
labelnamerequiredtypedefaulthint
mgaspt_id_listfalsestringnullThe ID(s) of the subaction parameter type(s).
return typestruct
getGatewaySubActionParamValues
Public Function getGatewaySubActionParamValues
source: /usr/local/tomcat/webapps/ROOT/Components/xCenter/Gateways/Gateways.cfc
Returns the values of a subaction parameter.
arguments
labelnamerequiredtypedefaulthint
gasp_id_listtruestringnullThe ID(s) of the subaction parameter(s).
return typestruct
getHelperObject
Public Function getHelperObject
source: /usr/local/tomcat/webapps/ROOT/Components/xCenter/Gateways/Gateways.cfc
Returns the component for a specific datasourcetype.
arguments
labelnamerequiredtypedefaulthint
ga_idtruenumericnullThe ID of the action.
gas_typetruenumericnullThe type of the subaction.
return typeany
getItemPersonalizedGroups
Public Function getItemPersonalizedGroups
source: /usr/local/tomcat/webapps/ROOT/Components/xCenter/Gateways/Gateways.cfc
arguments
labelnamerequiredtypedefaulthint
ga_idtruenumericnullThe ID of the gateway action.
system_idtruestringnullThe ID of the item.
vmov_idtruenumericnullThe ID of the item.
return typestruct
getItemValues
Public Function getItemValues
source: /usr/local/tomcat/webapps/ROOT/Components/xCenter/Gateways/Gateways.cfc
Returns the values of an item.
arguments
labelnamerequiredtypedefaulthint
vmo_idtruenumericnullThe id of the item
return typestruct
getQuery
Public Function getQuery
source: /usr/local/tomcat/webapps/ROOT/Components/Result/ReturnStruct.cfc
Allows you to create a query in a cfscript.
arguments
labelnamerequiredtypedefaulthint
bodytruestringnullThe body of the query
return typequery
getQueryRecords
Public Function getQueryRecords
source: /usr/local/tomcat/webapps/ROOT/Components/Result/ReturnStruct.cfc
Returns the specified amount of records.
arguments
labelnamerequiredtypedefaulthint
querytruequerynullThe query.
recordCounttruenumericnullThe amount of records to return.
return typequery
getReadActionColumns
Public Function getReadActionColumns
source: /usr/local/tomcat/webapps/ROOT/Components/xCenter/Gateways/Gateways.cfc
Retrieves the columns for a readaction.
arguments
labelnamerequiredtypedefaulthint
ga_idtruenumericnullThe ID of the action.
return typestruct
getReadActionConstraints
Public Function getReadActionConstraints
source: /usr/local/tomcat/webapps/ROOT/Components/xCenter/Gateways/Gateways.cfc
Retrieves the constraints for an action.
arguments
labelnamerequiredtypedefaulthint
ga_idtruenumericnullThe ID of the action.
return typestruct
getReadActionConstraintsBlocks
Public Function getReadActionConstraintsBlocks
source: /usr/local/tomcat/webapps/ROOT/Components/xCenter/Gateways/Gateways.cfc
Retrieves the constraintblocks for an action.
arguments
labelnamerequiredtypedefaulthint
ga_idtruenumericnullThe ID of the action.
return typestruct
getReadActionDisplayColumn
Public Function getReadActionDisplayColumn
source: /usr/local/tomcat/webapps/ROOT/Components/xCenter/Gateways/Gateways.cfc
Retrieves the displaycolumn for a readaction.
arguments
labelnamerequiredtypedefaulthint
ga_idtruenumericnullThe ID of the action.
return typestring
getReadActionForeignItems
Public Function getReadActionForeignItems
source: /usr/local/tomcat/webapps/ROOT/Components/xCenter/Gateways/Gateways.cfc
Returns the linked items of a foreign table.
arguments
labelnamerequiredtypedefaulthint
ga_idtruenumericnullThe ID of the action.
executeParamStructtruestructnullParameter structure containing parameters for the execution.
return typeany
getReadActionForeignItemsAsQuery
Public Function getReadActionForeignItemsAsQuery
source: /usr/local/tomcat/webapps/ROOT/Components/xCenter/Gateways/Gateways.cfc
Returns the linked items of a foreign table.
arguments
labelnamerequiredtypedefaulthint
ga_idtruenumericnullThe ID of the action.
executeParamStructtruestructnullParameter structure containing parameters for the execution.
return typeany
getReadActionOrder
Public Function getReadActionOrder
source: /usr/local/tomcat/webapps/ROOT/Components/xCenter/Gateways/Gateways.cfc
Retrieves the order clause for an action.
arguments
labelnamerequiredtypedefaulthint
ga_idtruenumericnullThe ID of the action.
return typestruct
getReadActionParameters
Public Function getReadActionParameters
source: /usr/local/tomcat/webapps/ROOT/Components/xCenter/Gateways/Gateways.cfc
Returns the parameters involved in a read action.
arguments
labelnamerequiredtypedefaulthint
ga_idtruenumericnullThe ID of the action.
return typestruct
getReadActionRelations
Public Function getReadActionRelations
source: /usr/local/tomcat/webapps/ROOT/Components/xCenter/Gateways/Gateways.cfc
Retrieves the relations for a readaction.
arguments
labelnamerequiredtypedefaulthint
ga_idtruenumericnullThe ID of the action.
return typestruct
getReadActionSystemColumn
Public Function getReadActionSystemColumn
source: /usr/local/tomcat/webapps/ROOT/Components/xCenter/Gateways/Gateways.cfc
Retrieves the systemcolumn for a readaction.
arguments
labelnamerequiredtypedefaulthint
ga_idtruenumericnullThe ID of the action.
return typestring
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
labelnamerequiredtypedefaulthint
ga_idtruenumericnullThe ID of the action.
return typestruct
getReadActionVisibleColumn
Public Function getReadActionVisibleColumn
source: /usr/local/tomcat/webapps/ROOT/Components/xCenter/Gateways/Gateways.cfc
Retrieves the visiblecolumn for a readaction.
arguments
labelnamerequiredtypedefaulthint
ga_idtruenumericnullThe ID of the action.
return typestring
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
labelnamerequiredtypedefaulthint
ga_idtruenumericnullThe ID of the action.
return typestruct
getSubActionValues
Public Function getSubActionValues
source: /usr/local/tomcat/webapps/ROOT/Components/xCenter/Gateways/Gateways.cfc
Retrieves the subaction values.
arguments
labelnamerequiredtypedefaulthint
gas_idtruenumericnullThe ID of the subaction.
return typestruct
getSupportedOperations
Public Function getSupportedOperations
source: /usr/local/tomcat/webapps/ROOT/Components/xCenter/Gateways/Gateways.cfc
Returns the supported operations of a gateway action
arguments
labelnamerequiredtypedefaulthint
ga_idtruenumericnullThe ID of the action.
return typestruct
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
labelnamerequiredtypedefaulthint
arrtrueanynull
proptrueanynull
valuetrueanynull
return typeany
HELPEROBJECTS
Struct
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
labelnamerequiredtypedefaulthint
wc_idtruenumericnullThe id of the company
datasource_nametruestringnullThe name of the datasource
return typeboolean
joinLists
Public Function joinLists
source: /usr/local/tomcat/webapps/ROOT/Components/Result/ReturnStruct.cfc
Joins two lists and filters the duplicates.
arguments
labelnamerequiredtypedefaulthint
list1truestringnullThe first (filtered) list.
list2truestringnullThe second (filtered) list.
return typestring
logDebug
Public Function logDebug
source: /usr/local/tomcat/webapps/ROOT/Components/Result/ReturnStruct.cfc
arguments
labelnamerequiredtypedefaulthint
messagefalseanynull
exceptionfalseanynullThe optional cfcatch structure.
return typeany
logError
Public Function logError
source: /usr/local/tomcat/webapps/ROOT/Components/Result/ReturnStruct.cfc
arguments
labelnamerequiredtypedefaulthint
messagefalseanynull
exceptionfalseanynullThe optional cfcatch structure.
return typeany
logInfo
Public Function logInfo
source: /usr/local/tomcat/webapps/ROOT/Components/Result/ReturnStruct.cfc
arguments
labelnamerequiredtypedefaulthint
messagefalseanynull
exceptionfalseanynullThe optional cfcatch structure.
return typeany
logWarn
Public Function logWarn
source: /usr/local/tomcat/webapps/ROOT/Components/Result/ReturnStruct.cfc
arguments
labelnamerequiredtypedefaulthint
messagefalseanynull
exceptionfalseanynullThe optional cfcatch structure.
return typeany
makeUniqueString
Public Function makeUniqueString
source: /usr/local/tomcat/webapps/ROOT/Components/Result/ReturnStruct.cfc
makes a string unique
arguments
labelnamerequiredtypedefaulthint
strtruestringnull
arrtruearraynull
countfalsenumeric0
return typestring
notifyListeners
Public Function notifyListeners
source: /usr/local/tomcat/webapps/ROOT/Components/xCenter/Gateways/Gateways.cfc
Notifies the listeners on an action.
arguments
labelnamerequiredtypedefaulthint
ga_idtruenumericnullThe ID of the action.
invokeTypefalsestringunknownIndicates why the listener is notified.
return typestruct
parseXMLFile
Public Function parseXMLFile
source: /usr/local/tomcat/webapps/ROOT/Components/Result/ReturnStruct.cfc
arguments
labelnamerequiredtypedefaulthint
filePathfalsestringnull
return typeany
placeImage
Public Function placeImage
source: /usr/local/tomcat/webapps/ROOT/Components/Result/ReturnStruct.cfc
arguments
labelnamerequiredtypedefaulthint
return typeany
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
labelnamerequiredtypedefaulthint
ga_idtruenumericnullThe id of the action
vmov_idtruenumericnullThe id of the offline version to publish
wu_idtruenumericnullThe id of the offline version to publish
return typestruct
queryToArray
Public Function queryToArray
source: /usr/local/tomcat/webapps/ROOT/Components/Result/ReturnStruct.cfc
Returns an array containing the items from the query.
arguments
labelnamerequiredtypedefaulthint
inputQuerytruequerynullThe query to convert to an array.
dataColumntruestringnullThe column containing the data to return.
return typearray
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
labelnamerequiredtypedefaulthint
Querytruequerynullthe query being converted to CSV.
Fieldstruestringnullthe list of query fields to be used when creating the CSV value.
CreateHeaderRowfalsebooleantrueflag whether or not to create a row of header values.
Delimiterfalsestring,the field delimiter in the CSV value.
return typestring
queryToList
Public Function queryToList
source: /usr/local/tomcat/webapps/ROOT/Components/Result/ReturnStruct.cfc
Returns a list containing the items from the query.
arguments
labelnamerequiredtypedefaulthint
inputQuerytruequerynullThe query to convert to a list.
dataColumnfalsestringnullThe optional column containing the data. If not specified, the first column is used.
return typestring
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
labelnamerequiredtypedefaulthint
Querytruequerynull
Rowfalsenumeric0which row? 0 = all
ColumnListfalsestringAllwhich columns do you want to convert?
DateToISO8601falsebooleanfalseConverts dates to ISO-8601 string
return typeany
READACTIONCOLUMNS
Struct
READACTIONRELATIONS
Struct
READACTIONTABLES
Struct
readFile
Public Function readFile
source: /usr/local/tomcat/webapps/ROOT/Components/Result/ReturnStruct.cfc
arguments
labelnamerequiredtypedefaulthint
filePathfalsestringnull
return typestring
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
labelnamerequiredtypedefaulthint
scd_idtruenumericnullThe ID of the content definition.
return typestruct
ReplaceListNoCase
Public Function ReplaceListNoCase
source: /usr/local/tomcat/webapps/ROOT/Components/Result/ReturnStruct.cfc
arguments
labelnamerequiredtypedefaulthint
inputtruestringnullThe string where to replace in.
list1truestringnullThe list of the strings to be replaced
list2truestringnullThe list of the strings which are the new items.
delimiterfalsestring,The delimiter of the lists.
return typestring
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
labelnamerequiredtypedefaulthint
me_idtruenumericnullThe code for this error, it will be used to get the errormessage.
errorStructurefalseanynullThe optional cfcatch structure.
dumpVariablefalseanynullAn optional variable to dump.
return typestruct
returnQueryFromString
Public Function returnQueryFromString
source: /usr/local/tomcat/webapps/ROOT/Components/Result/ReturnStruct.cfc
Generates a query with columns and multiple records.
arguments
labelnamerequiredtypedefaulthint
columnNametruestringnullThe columnname, this could be a list.
valuetruestringnullThe value. This could be a list
valueSeparatorfalsestring,A separator for the value list, default is ','. This separates the columns.
recordSeparatorfalsestring;A separator for the value list, default is ';'. This separates the records
return typequery
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
labelnamerequiredtypedefaulthint
resultQueryfalsequerynullThe optional query containing the result.
return typestruct
returnSecurity
Public Function returnSecurity
source: /usr/local/tomcat/webapps/ROOT/Components/Result/ReturnStruct.cfc
Returns a security breach.
arguments
labelnamerequiredtypedefaulthint
return typestruct
setItemHide
Public Function setItemHide
source: /usr/local/tomcat/webapps/ROOT/Components/xCenter/Gateways/Gateways.cfc
Hides or unhides an item.
arguments
labelnamerequiredtypedefaulthint
ga_idtruenumericnullThe ID of the action.
system_idtruenumericnullThe ID of the item.
ml_idtruenumericnullThe ID of the language.
hidetruebooleannullHide or unhide the item.
return typestruct
setItemHideAllLanguages
Public Function setItemHideAllLanguages
source: /usr/local/tomcat/webapps/ROOT/Components/xCenter/Gateways/Gateways.cfc
Hides or unhides an item for all languages.
arguments
labelnamerequiredtypedefaulthint
ga_idtruenumericnullThe ID of the action.
system_idtruenumericnullThe ID of the item.
hidetruebooleannullHide or unhide the item.
return typestruct
setItemPersonalizedGroups
Public Function setItemPersonalizedGroups
source: /usr/local/tomcat/webapps/ROOT/Components/xCenter/Gateways/Gateways.cfc
arguments
labelnamerequiredtypedefaulthint
ga_idtruenumericnullThe ID of the gateway action.
system_idtruestringnullThe ID of the item.
vmov_idtruenumericnullThe ID of the item.
groupQuerytruequerynullThe query containing the groups that should have access to the item.
return typestruct
setItemPersonalizedGroupsList
Public Function setItemPersonalizedGroupsList
source: /usr/local/tomcat/webapps/ROOT/Components/xCenter/Gateways/Gateways.cfc
arguments
labelnamerequiredtypedefaulthint
ga_idtruenumericnullThe ID of the gateway action.
system_idtruestringnullThe ID of the item.
vmov_idtruenumericnullThe ID of the item.
groupListtruestructnullThe query containing the groups that should have access to the item.
return typestruct
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
labelnamerequiredtypedefaulthint
paramStructuretruestructnullThe structure containing the parameters.
return typeany
SUBACTIONPERMISSIONS
SubactionPermissions
classcom.Egengroup.Spider.Plugins.XCenter.SubactionPermissions
fields
namepatternvalue
READ_PROPERTIESpublic static final int com.Egengroup.Spider.Plugins.XCenter.SubactionPermissions.READ_PROPERTIES1
MODIFY_PROPERTIESpublic static final int com.Egengroup.Spider.Plugins.XCenter.SubactionPermissions.MODIFY_PROPERTIES2
DELETEpublic static final int com.Egengroup.Spider.Plugins.XCenter.SubactionPermissions.DELETE3
constructors
interfaceexceptions
<init>()
methods
returninterfaceexceptions
Methods inherited from java.lang.Object
wait, wait, wait, equals, toString, hashCode, getClass, notify, notifyAll
SUPPORTEDOPERATIONS
Struct
supportsOffline
Public Function supportsOffline
source: /usr/local/tomcat/webapps/ROOT/Components/xCenter/Gateways/Gateways.cfc
Checks if a gateway action supports offline-items.
arguments
labelnamerequiredtypedefaulthint
ga_idtruenumericnullThe id of the gateway action
return typeboolean
textToNumber
Public Function textToNumber
source: /usr/local/tomcat/webapps/ROOT/Components/Result/ReturnStruct.cfc
Returns a number for the english word
arguments
labelnamerequiredtypedefaulthint
texttrueanynull
return typenumeric
trueFalseFormat
Public Function trueFalseFormat
source: /usr/local/tomcat/webapps/ROOT/Components/Result/ReturnStruct.cfc
convert cf string to boolean
arguments
labelnamerequiredtypedefaulthint
exptrueanynull
return typeany
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
labelnamerequiredtypedefaulthint
listtruestringnullThe list.
itemstruestringnullThe item(s) to add.
delimiterfalsestring,The delimiter (optional).
return typestring
updateContentOfflineItem
Public Function updateContentOfflineItem
source: /usr/local/tomcat/webapps/ROOT/Components/xCenter/Gateways/Gateways.cfc
Creates the content for an offline item
arguments
labelnamerequiredtypedefaulthint
vmov_idtruenumericnullThe id of the version
ga_idtruenumericnullThe id of the action
argStructtruestructnullThe struct with values
argStructOldfalsestructnullThe struct with values
return typestruct
package
purgeSubactionDataStructure
Package Function purgeSubactionDataStructure
source: /usr/local/tomcat/webapps/ROOT/Components/xCenter/Gateways/Gateways.cfc
Purges the datastructure of a subaction.
arguments
labelnamerequiredtypedefaulthint
gas_idtruenumericnullThe ID of the subaction.
return typeany
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
labelnamerequiredtypedefaulthint
ga_idtruenumericnullThe ID of the gateway action.
return typeany
private
createConstraint
Private Function createConstraint
source: /usr/local/tomcat/webapps/ROOT/Components/xCenter/Datasources.cfc
Creates a constraint for use with ObjectCondition.
arguments
labelnamerequiredtypedefaulthint
propertyNametruestringnullThe name of the property.
constraintOperatortruenumericnullThe operator of the constraint.
constraintValuetrueanynullThe value of the constraint.
return typeany
getGatewayDefaultCondition
Private Function getGatewayDefaultCondition
source: /usr/local/tomcat/webapps/ROOT/Components/xCenter/Gateways/Gateways.cfc
Returns the default condition for gateways.
arguments
labelnamerequiredtypedefaulthint
return typeany
getJDCResultSetFromVersion
Private Function getJDCResultSetFromVersion
source: /usr/local/tomcat/webapps/ROOT/Components/xCenter/Gateways/Gateways.cfc
Returns a structure from a version
arguments
labelnamerequiredtypedefaulthint
ga_idtruenumericnullThe id of the action
ml_idtruenumericnullThe id of the language
vmov_idtruenumericnullThe id of the offline version to publish
return typeany
getXCenterFactory
Private Function getXCenterFactory
source: /usr/local/tomcat/webapps/ROOT/Components/xCenter/Datasources.cfc
Returns the XCenter factory.
arguments
labelnamerequiredtypedefaulthint
return typeany
insertItemIntoVM
Private Function insertItemIntoVM
source: /usr/local/tomcat/webapps/ROOT/Components/xCenter/Gateways/Gateways.cfc
Inserts a item into the VM
arguments
labelnamerequiredtypedefaulthint
ga_idtruenumericnullThe ID of the action.
system_idtruestringnullThe ID of the item.
return typestruct
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
labelnamerequiredtypedefaulthint
ga_idtruenumericnullThe ID of the gateway action.
originaltruestringnull
return typexml
concatQuery
Public Function concatQuery
source: /usr/local/tomcat/webapps/ROOT/Components/Result/ReturnStruct.cfc
Concats two queries, and returns one query
arguments
labelnamerequiredtypedefaulthint
query1truequerynullThe first query.
query2truequerynullThe second query.
columnListfalsestring*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 typequery
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
labelnamerequiredtypedefaulthint
sp_idtruenumericnullThe id of the page to get
return typestruct
countCompanyPages
Public Function countCompanyPages
source: /usr/local/tomcat/webapps/ROOT/Components/ContentMngt/PageIO.cfc
Returns the number of pages for a company.
arguments
labelnamerequiredtypedefaulthint
wc_idtruenumericnullThe ID of the company.
return typestruct
countCompanySites
Public Function countCompanySites
source: /usr/local/tomcat/webapps/ROOT/Components/ContentMngt/SiteIO.cfc
Returns the number of sites for a company.
arguments
labelnamerequiredtypedefaulthint
wc_idtruenumericnullThe ID of the company.
return typestruct
createComponent
Public Function createComponent
source: /usr/local/tomcat/webapps/ROOT/Components/Result/ReturnStruct.cfc
arguments
labelnamerequiredtypedefaulthint
return typeany
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
labelnamerequiredtypedefaulthint
return typeany
createHTMLTemplate
Public Function createHTMLTemplate
source: /usr/local/tomcat/webapps/ROOT/Components/ContentMngt/TemplateIO.cfc
Writes the xml template to the disk.
arguments
labelnamerequiredtypedefaulthint
st_idtruenumericnullThe st_id of the template to write.
return typestruct
createSelectDate
Public Function createSelectDate
source: /usr/local/tomcat/webapps/ROOT/Components/WIS/DataIO.cfc
Generates the select clause for a datetime
arguments
labelnamerequiredtypedefaulthint
tablePrefixtruestringnullThe prefix of the table
formattruestringnullThe format of the date
astruestringnullThe select clause AS.
return typestruct
createTemplate
Public Function createTemplate
source: /usr/local/tomcat/webapps/ROOT/Components/ContentMngt/TemplateIO.cfc
Creates an empty template, also creates the first part.
arguments
labelnamerequiredtypedefaulthint
site_idtruenumericnullThe site id of the new template
st_namefalsestringnullThe name of the new template
st_descriptiontruestringnullThe description of the new template
st_customfalsebooleanfalseIndicator if this is a custom template
return typestruct
createXMLTemplate
Public Function createXMLTemplate
source: /usr/local/tomcat/webapps/ROOT/Components/ContentMngt/TemplateIO.cfc
Writes the xml template to the disk.
arguments
labelnamerequiredtypedefaulthint
st_idtruenumericnullThe sp_id of the page to get.
return typestruct
deletePage
Public Function deletePage
source: /usr/local/tomcat/webapps/ROOT/Components/ContentMngt/PageIO.cfc
Removes a page from the system
arguments
labelnamerequiredtypedefaulthint
sp_idtruenumericnullThe id of the page
runMenuGeneratorfalsebooleantrueRuns the menu generator or not
return typestruct
deleteRights
Public Function deleteRights
source: /usr/local/tomcat/webapps/ROOT/Components/ContentMngt/PageIO.cfc
Deletes the rights for group for a page.
arguments
labelnamerequiredtypedefaulthint
sp_idtruenumericnullThe ID of the page.
wg_id_listtruestringnullThe ID of the group.
deepfalsebooleanfalseAlso delete grouprights from lower pages?
return typestruct
deleteRightsForPage
Public Function deleteRightsForPage
source: /usr/local/tomcat/webapps/ROOT/Components/ContentMngt/PageIO.cfc
Deletes the rights for group for a page
arguments
labelnamerequiredtypedefaulthint
sp_idtruenumericnullThe id of the page
return typestruct
deleteSite
Public Function deleteSite
source: /usr/local/tomcat/webapps/ROOT/Components/ContentMngt/SiteIO.cfc
Removes a website.
arguments
labelnamerequiredtypedefaulthint
site_idtruenumericnullThe ID of the website
return typestruct
deleteTemplate
Public Function deleteTemplate
source: /usr/local/tomcat/webapps/ROOT/Components/ContentMngt/TemplateIO.cfc
Removes a template
arguments
labelnamerequiredtypedefaulthint
st_idtruenumericnullThe id of the template
return typestruct
delPageFromCache
Public Function delPageFromCache
source: /usr/local/tomcat/webapps/ROOT/Components/ContentMngt/PageIO.cfc
Removes a page completely from the cache
arguments
labelnamerequiredtypedefaulthint
sp_idtruenumericnullThe id of the page
return typestruct
delTemplatePart
Public Function delTemplatePart
source: /usr/local/tomcat/webapps/ROOT/Components/ContentMngt/TemplateIO.cfc
Delete a template part
arguments
labelnamerequiredtypedefaulthint
st_idtruenumericnullThe id of the template
stp_idtruenumericnullThe id of the template part to delete
return typestruct
displayAlertError
Public Function displayAlertError
source: /usr/local/tomcat/webapps/ROOT/Components/Result/ReturnStruct.cfc
Alerts optional errormessages.
arguments
labelnamerequiredtypedefaulthint
inputStructuretruestructnullThe structure returned from another function
addScriptTagsfalsebooleantrueDo you want to add the script tags around the alert message?
return typestruct
displayHTMLError
Public Function displayHTMLError
source: /usr/local/tomcat/webapps/ROOT/Components/Result/ReturnStruct.cfc
Displays optional errormessages in HTML.
arguments
labelnamerequiredtypedefaulthint
inputStructuretruestructnullThe structure returned from another function.
return typestruct
divideTemplatePart
Public Function divideTemplatePart
source: /usr/local/tomcat/webapps/ROOT/Components/ContentMngt/TemplateIO.cfc
Divides a template in two parts
arguments
labelnamerequiredtypedefaulthint
st_idtruenumericnullThe id of the template
stp_idtruenumericnullThe id of the template part
stp_divide_modetruenumericnullThe divide mode, 1 is horizontal, 2 is vertical
return typestruct
duplicateTemplate
Public Function duplicateTemplate
source: /usr/local/tomcat/webapps/ROOT/Components/ContentMngt/TemplateIO.cfc
Duplicates a given template
arguments
labelnamerequiredtypedefaulthint
st_idtruenumericnull
return typestruct
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
labelnamerequiredtypedefaulthint
wc_idtruenumericnullThe ID of the company.
filterQuerytruequerynullThe query to be filtered.
return typestruct
generalPageEditCheck
Public Function generalPageEditCheck
source: /usr/local/tomcat/webapps/ROOT/Components/ContentMngt/PageIO.cfc
Does some checks, checks for valid ID.
arguments
labelnamerequiredtypedefaulthint
sp_idtrueanynullThe ID to check.
return typestruct
generateAddSQL
Public Function generateAddSQL
source: /usr/local/tomcat/webapps/ROOT/Components/Result/ReturnStruct.cfc
Generates output for a SQL query statement (adding).
arguments
labelnamerequiredtypedefaulthint
addStructuretruestructnullThe columns and values to add.
return typestruct
generateUpdateSQL
Public Function generateUpdateSQL
source: /usr/local/tomcat/webapps/ROOT/Components/Result/ReturnStruct.cfc
Generates output for a SQL query statement (updating).
arguments
labelnamerequiredtypedefaulthint
updateStructuretruestructnullThe columns and values to update.
return typestruct
genPos
Public Function genPos
source: /usr/local/tomcat/webapps/ROOT/Components/Result/ReturnStruct.cfc
Creates an order id for queries
arguments
labelnamerequiredtypedefaulthint
keytruestringnullThe key the of id's
listtruestringnullThe list of id's
return typestring
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
labelnamerequiredtypedefaulthint
site_idtruenumericnullThe ID of the website.
wc_idtruenumericnullThe ID of the company.
return typestruct
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
labelnamerequiredtypedefaulthint
site_idtruenumericnullThe id of the website
return typestruct
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
labelnamerequiredtypedefaulthint
return typestruct
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
labelnamerequiredtypedefaulthint
wc_idtruenumericnullThe ID of the company.
return typestruct
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
labelnamerequiredtypedefaulthint
site_idtruenumericnullThe id of the website
fromAbovefalsebooleanfalseReturn the templates from above?
showHiddenfalsebooleantrueReturn the hidden templates?
return typestruct
getBookmarks
Public Function getBookmarks
source: /usr/local/tomcat/webapps/ROOT/Components/ContentMngt/PageIO.cfc
Returns all bookmarks for a list of pages
arguments
labelnamerequiredtypedefaulthint
sp_id_listtruestringnullA list with the id's of the pages
ml_idtruenumericnullThe ml_id of the bookmark
return typestruct
getBookmarksFromSite
Public Function getBookmarksFromSite
source: /usr/local/tomcat/webapps/ROOT/Components/ContentMngt/PageIO.cfc
Returns all bookmarks for a site
arguments
labelnamerequiredtypedefaulthint
site_idtruenumericnullThe id of the site
ml_idtruenumericnullThe ml_id of the bookmark
return typestruct
getBookmarkValues
Public Function getBookmarkValues
source: /usr/local/tomcat/webapps/ROOT/Components/ContentMngt/PageIO.cfc
Returns the values of a bookmark
arguments
labelnamerequiredtypedefaulthint
spb_idtruestringnullTHe id of the bookmark
return typestruct
getCompanyFromSite
Public Function getCompanyFromSite
source: /usr/local/tomcat/webapps/ROOT/Components/ContentMngt/SiteIO.cfc
Returns the wc_id of the website.
arguments
labelnamerequiredtypedefaulthint
site_idtruenumericnullThe ID of the website.
return typestruct
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
labelnamerequiredtypedefaulthint
wc_idtruenumericnullThe ID of the company.
return typestruct
getCompiledObjectContent
Public Function getCompiledObjectContent
source: /usr/local/tomcat/webapps/ROOT/Components/ContentMngt/PageIO.cfc
arguments
labelnamerequiredtypedefaulthint
so_idtruenumericnull
return typeany
getComponent
Public Function getComponent
source: /usr/local/tomcat/webapps/ROOT/Components/Result/ReturnStruct.cfc
arguments
labelnamerequiredtypedefaulthint
componentNametruestringnull
return typeany
getCurrentList
Public Function getCurrentList
source: /usr/local/tomcat/webapps/ROOT/Components/ContentMngt/PageIO.cfc
Gets the current itemvalues for a displaypage.
arguments
labelnamerequiredtypedefaulthint
sp_idtruenumericnullThe id of the page to get
ml_idfalsenumeric1The id of the language
so_idfalsenumeric0The id of the object
system_idfalsenumeric0The id of the list item
return typeany
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
labelnamerequiredtypedefaulthint
getAbsoluteToptruebooleannullReturn the absolute top of the page?
ml_idfalsenumeric1return the path in which language
showHiddenfalsebooleantrueReturn hidden pages?
return typestruct
getCustomPropertiesForPage
Public Function getCustomPropertiesForPage
source: /usr/local/tomcat/webapps/ROOT/Components/ContentMngt/PageIO.cfc
Returns all the custom properties for the given page
arguments
labelnamerequiredtypedefaulthint
sp_idtrueanynull
return typeany
getCustomPropertiesForSite
Public Function getCustomPropertiesForSite
source: /usr/local/tomcat/webapps/ROOT/Components/ContentMngt/SiteIO.cfc
returns all custom properties for the site
arguments
labelnamerequiredtypedefaulthint
site_idtrueanynull
return typeany
getCustomPropertiesFromPage
Public Function getCustomPropertiesFromPage
source: /usr/local/tomcat/webapps/ROOT/Components/ContentMngt/PageIO.cfc
Returns all the custom properties for the given page
arguments
labelnamerequiredtypedefaulthint
sp_idtrueanynull
return typeany
getCustomPropertyForPage
Public Function getCustomPropertyForPage
source: /usr/local/tomcat/webapps/ROOT/Components/ContentMngt/PageIO.cfc
arguments
labelnamerequiredtypedefaulthint
sp_idtrueanynull
propertytrueanynull
defaultfalseany
return typeany
getCustomPropertyForPageById
Public Function getCustomPropertyForPageById
source: /usr/local/tomcat/webapps/ROOT/Components/ContentMngt/PageIO.cfc
arguments
labelnamerequiredtypedefaulthint
spcp_idtrueanynull
return typeany
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
labelnamerequiredtypedefaulthint
site_idtruenumericnull
scp_keytrueanynull
defaultfalseany
objectfalseanyfalse
return typeany
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
labelnamerequiredtypedefaulthint
sp_idtrueanynull
propertytrueanynull
defaultfalseany
return typeany
getCustomTemplateCode
Public Function getCustomTemplateCode
source: /usr/local/tomcat/webapps/ROOT/Components/ContentMngt/TemplateIO.cfc
arguments
labelnamerequiredtypedefaulthint
st_idtruenumericnullThe st_id of the template to get.
return typestring
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
labelnamerequiredtypedefaulthint
data_IDtruenumericnullThe data_id of the data.
ml_idtruenumericnullThe ml_id of the data to get.
return typestruct
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
labelnamerequiredtypedefaulthint
data_IDtruenumericnullThe data_id of the data.
return typestruct
getDataNumeric
Public Function getDataNumeric
source: /usr/local/tomcat/webapps/ROOT/Components/WIS/DataIO.cfc
Gets numeric data.
arguments
labelnamerequiredtypedefaulthint
data_idtruenumericnullThe ID of the data.
return typestruct
getDataReal
Public Function getDataReal
source: /usr/local/tomcat/webapps/ROOT/Components/WIS/DataIO.cfc
Gets real data.
arguments
labelnamerequiredtypedefaulthint
data_idtruenumericnullThe ID of the data.
return typestruct
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
labelnamerequiredtypedefaulthint
data_IDtruenumericnullThe data_id of the data.
ml_idtruenumericnullThe ml_id of the data to get.
return typestruct
getDataType
Public Function getDataType
source: /usr/local/tomcat/webapps/ROOT/Components/WIS/DataIO.cfc
Gets the data type of the given data_id
arguments
labelnamerequiredtypedefaulthint
data_idtruenumericnull
return typestruct
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
labelnamerequiredtypedefaulthint
data_IDtruenumericnullThe data_id of the data.
ml_idtruenumericnullThe ml_id of the data to get.
return typestruct
getDateTime
Public Function getDateTime
source: /usr/local/tomcat/webapps/ROOT/Components/WIS/DataIO.cfc
Gets the datetime.
arguments
labelnamerequiredtypedefaulthint
data_IDtruenumericnullThe data_id of the data datetime.
dateFormatfalsestringGives a CF formatted type, if not defined it returns a cftime format.
timeFormatfalsestringGives a CF formatted type, if not defined it returns a cftime format.
return typestruct
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
labelnamerequiredtypedefaulthint
site_idtruenumericnullThe id of the website to get
ml_id1truenumericnullThe id of the language
ml_id2truenumericnullThe id of the language
return typestruct
getEditPages
Public Function getEditPages
source: /usr/local/tomcat/webapps/ROOT/Components/ContentMngt/PageIO.cfc
Returns all hided pages for a language
arguments
labelnamerequiredtypedefaulthint
site_idtruenumericnullThe id of the page to get
date_modifiedfalseDate{ts '2026-08-10 14:58:08'}The id of the language
show_ownfalsebooleanfalseThe id of the language
return typestruct
getFormTemplates
Public Function getFormTemplates
source: /usr/local/tomcat/webapps/ROOT/Components/ContentMngt/SiteIO.cfc
Returns all form templates for a siteConfigContainer
arguments
labelnamerequiredtypedefaulthint
scc_idtruenumericnull
return typeany
getHidePages
Public Function getHidePages
source: /usr/local/tomcat/webapps/ROOT/Components/ContentMngt/PageIO.cfc
Returns all hided pages for a language
arguments
labelnamerequiredtypedefaulthint
site_idtruenumericnullThe id of the page to get
ml_idtruenumericnullThe id of the language
return typestruct
getImageTemplates
Public Function getImageTemplates
source: /usr/local/tomcat/webapps/ROOT/Components/ContentMngt/SiteIO.cfc
Returns all image templates for a siteConfigContainer
arguments
labelnamerequiredtypedefaulthint
scc_idtruenumericnull
return typeany
getJavaPageObject
Public Function getJavaPageObject
source: /usr/local/tomcat/webapps/ROOT/Components/ContentMngt/PageIO.cfc
Get the JAVA object representing the page
arguments
labelnamerequiredtypedefaulthint
sp_idfalsenumericnullThe ID of the page to get
return typeany
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
labelnamerequiredtypedefaulthint
wc_idtruenumericnullThe ID of the company from wich you want to know the number of licenses.
return typestruct
getLinkedPage
Public Function getLinkedPage
source: /usr/local/tomcat/webapps/ROOT/Components/ContentMngt/PageIO.cfc
Returns the linked page for a given page id.
arguments
labelnamerequiredtypedefaulthint
sp_idtruenumericnullThe id of the page
return typestruct
getLockedParts
Public Function getLockedParts
source: /usr/local/tomcat/webapps/ROOT/Components/ContentMngt/TemplateIO.cfc
Returns all the locked template parts of a template
arguments
labelnamerequiredtypedefaulthint
st_idtruenumericnullThe id of the template
return typestruct
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
labelnamerequiredtypedefaulthint
site_idtruenumericnullThe id of the site
return typestruct
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
labelnamerequiredtypedefaulthint
site_idtruenumericnull
ml_idtruenumericnull
amounttruenumericnull
includeHiddenPagesfalsebooleanfalse
return typestruct
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
labelnamerequiredtypedefaulthint
site_idtruenumericnull
sinceDatetruedatenull
ml_idtruenumericnull
includeHiddenPagesfalsebooleanfalse
return typestruct
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
labelnamerequiredtypedefaulthint
sp_idtruenumericnullThe ID of the page.
return typestruct
getPageContent
Public Function getPageContent
source: /usr/local/tomcat/webapps/ROOT/Components/ContentMngt/PageIO.cfc
Returns a complete page
arguments
labelnamerequiredtypedefaulthint
sp_idtruenumericnullThe id of the page to get
ml_idfalsenumeric1The id of the language
ignore_from_spfalsebooleanfalseTells this function to ignore the from_sp_id in the url and load the given page
return typestruct
getPageDisplayLanguages
Public Function getPageDisplayLanguages
source: /usr/local/tomcat/webapps/ROOT/Components/ContentMngt/PageIO.cfc
Returns the languages in which the page is viewable.
arguments
labelnamerequiredtypedefaulthint
sp_idtruenumericnullThe ID of the page.
return typestruct
getPageGroupRights
Public Function getPageGroupRights
source: /usr/local/tomcat/webapps/ROOT/Components/ContentMngt/PageIO.cfc
Returns the rights of a group for a page
arguments
labelnamerequiredtypedefaulthint
sp_idtruenumericnullThe id of the page
wg_idtruenumericnullThe id of the group
return typestruct
getPageGroupsRights
Public Function getPageGroupsRights
source: /usr/local/tomcat/webapps/ROOT/Components/ContentMngt/PageIO.cfc
Returns the rights for all groups of a page
arguments
labelnamerequiredtypedefaulthint
sp_idtruenumericnullThe id of the page
return typestruct
getPageMetaData
Public Function getPageMetaData
source: /usr/local/tomcat/webapps/ROOT/Components/ContentMngt/PageIO.cfc
Returns the metadata of a page for a language.
arguments
labelnamerequiredtypedefaulthint
sp_id_listtruestringnullThe ID of the page(s).
ml_idtruenumericnullThe ID of the language.
columnListfalsestringsp_name,sp_description,sp_custom,sp_title,sp_keywords,sp_robotsA list of columns with you want to get.
return typestruct
getPageNames
Public Function getPageNames
source: /usr/local/tomcat/webapps/ROOT/Components/ContentMngt/PageIO.cfc
Gets the name of a list of pages.
arguments
labelnamerequiredtypedefaulthint
sp_id_listtruestringnullA list with the id's of the pages
ml_idtruenumericnullThe language ID in which language the properties need to be returned
return typestruct
getPageOwner
Public Function getPageOwner
source: /usr/local/tomcat/webapps/ROOT/Components/ContentMngt/PageIO.cfc
Gets the owner of a page.
arguments
labelnamerequiredtypedefaulthint
sp_id_listtruestringnullA list with the id's of the pages
return typestruct
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
labelnamerequiredtypedefaulthint
sp_idtruenumericnullThe id of the page
return typestruct
getPageUsingUrl
Public Function getPageUsingUrl
source: /usr/local/tomcat/webapps/ROOT/Components/ContentMngt/PageIO.cfc
arguments
labelnamerequiredtypedefaulthint
sp_idtruenumericnull
ml_idtruenumericnull
sp_nametrueStringnull
isNewPagefalsebooleanfalse
return typeany
getPageValues
Public Function getPageValues
source: /usr/local/tomcat/webapps/ROOT/Components/ContentMngt/PageIO.cfc
Gets all properties of a page.
arguments
labelnamerequiredtypedefaulthint
sp_id_listtruestringnullA list with the id's of the pages
return typestruct
getParentPage
Public Function getParentPage
source: /usr/local/tomcat/webapps/ROOT/Components/ContentMngt/PageIO.cfc
Returns the parent page of a page.
arguments
labelnamerequiredtypedefaulthint
sp_idtruenumericnullThe id of the page
return typestruct
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
labelnamerequiredtypedefaulthint
sp_idtruenumericnullThe id of the page
getAbsoluteToptruebooleannullReturn the absolute top of the page?
showHiddenfalsebooleantrueReturn hidden pages?
ml_idfalsenumeric1return the path in which language
sitePropertiesfalsestructnullthe site properties of the page
sortIDfalsenumeric1
return typestruct
getPersonalizedGroups
Public Function getPersonalizedGroups
source: /usr/local/tomcat/webapps/ROOT/Components/ContentMngt/PageIO.cfc
Returns the personalized groupd of a page.
arguments
labelnamerequiredtypedefaulthint
sp_idtruenumericnullThe id of the page
return typestruct
getPlainTemplateParts
Public Function getPlainTemplateParts
source: /usr/local/tomcat/webapps/ROOT/Components/ContentMngt/TemplateIO.cfc
Returns all the plain template parts of a template
arguments
labelnamerequiredtypedefaulthint
st_idtruenumericnullThe id of the template
return typestruct
getProtocolToUse
Public Function getProtocolToUse
source: /usr/local/tomcat/webapps/ROOT/Components/ContentMngt/SiteIO.cfc
Returns the protocol to use for this website.
arguments
labelnamerequiredtypedefaulthint
sitePropertiestruequerynull
return typestring
getQuery
Public Function getQuery
source: /usr/local/tomcat/webapps/ROOT/Components/Result/ReturnStruct.cfc
Allows you to create a query in a cfscript.
arguments
labelnamerequiredtypedefaulthint
bodytruestringnullThe body of the query
return typequery
getQueryRecords
Public Function getQueryRecords
source: /usr/local/tomcat/webapps/ROOT/Components/Result/ReturnStruct.cfc
Returns the specified amount of records.
arguments
labelnamerequiredtypedefaulthint
querytruequerynullThe query.
recordCounttruenumericnullThe amount of records to return.
return typequery
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
labelnamerequiredtypedefaulthint
site_idtruenumericnullThe ID of the website.
return typestruct
getSite
Public Function getSite
source: /usr/local/tomcat/webapps/ROOT/Components/ContentMngt/SiteIO.cfc
Gets a site.
arguments
labelnamerequiredtypedefaulthint
site_idtruenumericnullThe ID of the site.
return typeany
getSiteAdmins
Public Function getSiteAdmins
source: /usr/local/tomcat/webapps/ROOT/Components/ContentMngt/SiteIO.cfc
Get all admins of a website.
arguments
labelnamerequiredtypedefaulthint
site_idtruenumericnullThe ID of the website from wich you want the site administrators.
return typestruct
getSiteConfigContainer
Public Function getSiteConfigContainer
source: /usr/local/tomcat/webapps/ROOT/Components/ContentMngt/SiteIO.cfc
Returns the configurationContainer
arguments
labelnamerequiredtypedefaulthint
scc_idtruenumericnull
return typestruct
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
labelnamerequiredtypedefaulthint
scc_idtruenumericnull
return typeany
getSiteConfigContainerPageCustomProperty
Public Function getSiteConfigContainerPageCustomProperty
source: /usr/local/tomcat/webapps/ROOT/Components/ContentMngt/SiteIO.cfc
Get's a custom property bij sccpcp_id
arguments
labelnamerequiredtypedefaulthint
sccpcp_idtruenumericnull
return typeany
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
labelnamerequiredtypedefaulthint
keytrueanynull
sp_idfalseany-1
scc_idfalseany-1
return typeany
getSiteConfigContainers
Public Function getSiteConfigContainers
source: /usr/local/tomcat/webapps/ROOT/Components/ContentMngt/SiteIO.cfc
Returns al configured config containers for a company
arguments
labelnamerequiredtypedefaulthint
wc_idtrueanynull
return typestruct
getSiteCustomProperty
Public Function getSiteCustomProperty
source: /usr/local/tomcat/webapps/ROOT/Components/ContentMngt/SiteIO.cfc
returns custom property value
arguments
labelnamerequiredtypedefaulthint
scp_idtruenumericnull
return typeany
getSiteDefaultLanguage
Public Function getSiteDefaultLanguage
source: /usr/local/tomcat/webapps/ROOT/Components/ContentMngt/SiteIO.cfc
Returns the default ml_id for a website.
arguments
labelnamerequiredtypedefaulthint
site_idtruestringnullThe ID of the website.
return typestruct
getSiteFromPage
Public Function getSiteFromPage
source: /usr/local/tomcat/webapps/ROOT/Components/ContentMngt/SiteIO.cfc
Returns the site_id of a page.
arguments
labelnamerequiredtypedefaulthint
sp_idtruenumericnullThe ID of the page.
return typestruct
getSiteLanguages
Public Function getSiteLanguages
source: /usr/local/tomcat/webapps/ROOT/Components/ContentMngt/SiteIO.cfc
Gets all languages from a website.
arguments
labelnamerequiredtypedefaulthint
site_idtruenumericnullThe ID of the website.
return typestruct
getSiteLanguagesComplete
Public Function getSiteLanguagesComplete
source: /usr/local/tomcat/webapps/ROOT/Components/ContentMngt/SiteIO.cfc
Gets all languages from a website.
arguments
labelnamerequiredtypedefaulthint
site_idtruenumericnullThe ID of the website.
return typestruct
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
labelnamerequiredtypedefaulthint
wc_idtruenumericnullThe ID of the company.
includeInactivefalsebooleantrueIncludes inactive websites?
return typestruct
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
labelnamerequiredtypedefaulthint
wu_idtruenumericnullThe ID of the site administrator.
getCompanyfalsebooleantrueAlso return an admin website which is also a company website?
includeInactivefalsebooleantrue
return typestruct
getSiteStandardLanguage
Public Function getSiteStandardLanguage
source: /usr/local/tomcat/webapps/ROOT/Components/ContentMngt/SiteIO.cfc
Gets all information about a website.
arguments
labelnamerequiredtypedefaulthint
site_idtruestringnullThe ID, or a list of ID's of the website(s) to get.
return typestruct
getSiteValues
Public Function getSiteValues
source: /usr/local/tomcat/webapps/ROOT/Components/ContentMngt/SiteIO.cfc
Returns the values for one or more websites.
arguments
labelnamerequiredtypedefaulthint
site_id_listtruestringnullThe ID(s) of the website(s).
ml_idfalsenumeric0The ml_id of the website(s).
return typestruct
getStyleCSS
Public Function getStyleCSS
source: /usr/local/tomcat/webapps/ROOT/Components/ContentMngt/PageIO.cfc
Returns the cssfile of a page.
arguments
labelnamerequiredtypedefaulthint
pagePropertiestrueanynull
sitePropertiestrueanynull
return typestring
getSubPages
Public Function getSubPages
source: /usr/local/tomcat/webapps/ROOT/Components/ContentMngt/PageIO.cfc
Returns all pages direct below a page.
arguments
labelnamerequiredtypedefaulthint
sp_idtruenumericnullThe id of the page
return typestruct
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
labelnamerequiredtypedefaulthint
st_idtruenumericnullThe id of the template
return typestruct
getTemplateParts
Public Function getTemplateParts
source: /usr/local/tomcat/webapps/ROOT/Components/ContentMngt/TemplateIO.cfc
Returns all the sub parts of a template part
arguments
labelnamerequiredtypedefaulthint
stp_idtruenumericnullThe id of the template part
return typestruct
getTemplatePartValues
Public Function getTemplatePartValues
source: /usr/local/tomcat/webapps/ROOT/Components/ContentMngt/TemplateIO.cfc
Returns all values of a list of template parts
arguments
labelnamerequiredtypedefaulthint
stp_id_listtruestringnullThe list of id's of the template parts
return typestruct
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
labelnamerequiredtypedefaulthint
st_idtruenumericnullThe st id of the template
return typestruct
getTemplateValues
Public Function getTemplateValues
source: /usr/local/tomcat/webapps/ROOT/Components/ContentMngt/TemplateIO.cfc
Returns all the values of a list of templates.
arguments
labelnamerequiredtypedefaulthint
st_id_listtruestringnullThe list of id's of templates to get.
return typestruct
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
labelnamerequiredtypedefaulthint
site_idtruenumericnullThe ID of the site.
return typestruct
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
labelnamerequiredtypedefaulthint
wc_idtruenumericnullThe ID of the company.
return typestruct
getUsedDesignSites
Public Function getUsedDesignSites
source: /usr/local/tomcat/webapps/ROOT/Components/ContentMngt/SiteIO.cfc
Returns the websites which use the website as design.
arguments
labelnamerequiredtypedefaulthint
site_idtruenumericnullThe id of the website.
return typestruct
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
labelnamerequiredtypedefaulthint
wc_idtruenumericnullThe id of the company.
return typestruct
getUseDesignsOfSite
Public Function getUseDesignsOfSite
source: /usr/local/tomcat/webapps/ROOT/Components/ContentMngt/SiteIO.cfc
Returns the designs with can be used.
arguments
labelnamerequiredtypedefaulthint
site_idtruenumericnullThe id of the website.
return typestruct
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
labelnamerequiredtypedefaulthint
sp_idtruenumericnullThe id of the page
wu_idfalsenumeric-1The id of the user
return typestruct
getXsltForTemplate
Public Function getXsltForTemplate
source: /usr/local/tomcat/webapps/ROOT/Components/ContentMngt/TemplateIO.cfc
arguments
labelnamerequiredtypedefaulthint
st_idtruenumericnullThe st_id of the template to write.
return typeany
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
labelnamerequiredtypedefaulthint
arrtrueanynull
proptrueanynull
valuetrueanynull
return typeany
includeCurrentListCode
Public Function includeCurrentListCode
source: /usr/local/tomcat/webapps/ROOT/Components/ContentMngt/PageIO.cfc
arguments
labelnamerequiredtypedefaulthint
fileNametrueanynull
scopetrueanynull
fysPathtrueanynull
return typevoid
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
labelnamerequiredtypedefaulthint
st_idtruenumericnull
parentIDtruenumericnull
currentNodetrueanynullThe current template part node that is processed
return typestruct
isCachablePage
Public Function isCachablePage
source: /usr/local/tomcat/webapps/ROOT/Components/ContentMngt/PageIO.cfc
Checks if a page can be cached
arguments
labelnamerequiredtypedefaulthint
sp_idtruenumericnullThe page to check
return typeboolean
isCustompart
Public Function isCustompart
source: /usr/local/tomcat/webapps/ROOT/Components/ContentMngt/TemplateIO.cfc
arguments
labelnamerequiredtypedefaulthint
stp_idtruenumericnullThe id of the template part to check
return typeboolean
isCustomTemplate
Public Function isCustomTemplate
source: /usr/local/tomcat/webapps/ROOT/Components/ContentMngt/TemplateIO.cfc
Returns true if this is a custom template
arguments
labelnamerequiredtypedefaulthint
st_idtruenumericnull
return typeboolean
isExistingPage
Public Function isExistingPage
source: /usr/local/tomcat/webapps/ROOT/Components/ContentMngt/PageIO.cfc
Checks if a page exists
arguments
labelnamerequiredtypedefaulthint
sp_idtruenumericnullThe id of the page to get
return typeboolean
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
labelnamerequiredtypedefaulthint
site_idtruenumericnullThe site to check for the template
st_nametruestringnullThe name of the template to check
return typeboolean
isNameAvailableAsUrl
Public Function isNameAvailableAsUrl
source: /usr/local/tomcat/webapps/ROOT/Components/ContentMngt/PageIO.cfc
arguments
labelnamerequiredtypedefaulthint
sp_idtruenumericnull
ml_idtruenumericnull
sp_nametrueStringnull
return typeboolean
isOwnBorderTemplate
Public Function isOwnBorderTemplate
source: /usr/local/tomcat/webapps/ROOT/Components/ContentMngt/TemplateIO.cfc
arguments
labelnamerequiredtypedefaulthint
st_idtruenumericnullThe st_id of the template to write.
return typeany
isPageHide
Public Function isPageHide
source: /usr/local/tomcat/webapps/ROOT/Components/ContentMngt/PageIO.cfc
Checks if a page is hided in a language
arguments
labelnamerequiredtypedefaulthint
sp_idtruenumericnullThe id of the page to get
ml_idtruenumericnullThe id of the language
return typeboolean
isPersonalizationOn
Public Function isPersonalizationOn
source: /usr/local/tomcat/webapps/ROOT/Components/ContentMngt/PageIO.cfc
Checks if a page has personalisation.
arguments
labelnamerequiredtypedefaulthint
sp_idtruenumericnullThe id of the page
return typeboolean
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
labelnamerequiredtypedefaulthint
sp_idtruenumericnullThe id of the page
wu_idfalsenumeric-1The id of the user
return typeboolean
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
labelnamerequiredtypedefaulthint
site_idtruenumericnullThe ID of the website.
wu_idfalsenumeric-1The ID of the user to check.
return typeboolean
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
labelnamerequiredtypedefaulthint
site_idtruenumericnullThe ID of the website.
wu_idfalsenumeric-1The ID of the user to check.
return typeboolean
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
labelnamerequiredtypedefaulthint
st_idtruenumericnullThe id of the template
return typeboolean
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
labelnamerequiredtypedefaulthint
stp_idtruenumericnullThe id of the template part
return typeboolean
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
labelnamerequiredtypedefaulthint
display_sp_idtruenumericnullThe ID of the displaypage.
from_sp_idtruenumericnullThe ID of the frompage.
so_idtruenumericnullThe ID of the object.
return typeboolean
isValidPage
Public Function isValidPage
source: /usr/local/tomcat/webapps/ROOT/Components/ContentMngt/PageIO.cfc
Checks wether a page exists or not
arguments
labelnamerequiredtypedefaulthint
sp_idtrueanynullthe sp_id to check
return typeboolean
isValidSite
Public Function isValidSite
source: /usr/local/tomcat/webapps/ROOT/Components/ContentMngt/SiteIO.cfc
Returns true or false for the given site_id.
arguments
labelnamerequiredtypedefaulthint
site_idtruenumericnullThe ID of the website.
return typeboolean
isValidSiteLanguage
Public Function isValidSiteLanguage
source: /usr/local/tomcat/webapps/ROOT/Components/ContentMngt/SiteIO.cfc
Checks if a language is valid for a site.
arguments
labelnamerequiredtypedefaulthint
site_idtruenumericnullThe ID of the website.
ml_idtruenumericnullThe ID of the language.
return typeboolean
joinLists
Public Function joinLists
source: /usr/local/tomcat/webapps/ROOT/Components/Result/ReturnStruct.cfc
Joins two lists and filters the duplicates.
arguments
labelnamerequiredtypedefaulthint
list1truestringnullThe first (filtered) list.
list2truestringnullThe second (filtered) list.
return typestring
logDebug
Public Function logDebug
source: /usr/local/tomcat/webapps/ROOT/Components/Result/ReturnStruct.cfc
arguments
labelnamerequiredtypedefaulthint
messagefalseanynull
exceptionfalseanynullThe optional cfcatch structure.
return typeany
logError
Public Function logError
source: /usr/local/tomcat/webapps/ROOT/Components/Result/ReturnStruct.cfc
arguments
labelnamerequiredtypedefaulthint
messagefalseanynull
exceptionfalseanynullThe optional cfcatch structure.
return typeany
logInfo
Public Function logInfo
source: /usr/local/tomcat/webapps/ROOT/Components/Result/ReturnStruct.cfc
arguments
labelnamerequiredtypedefaulthint
messagefalseanynull
exceptionfalseanynullThe optional cfcatch structure.
return typeany
logWarn
Public Function logWarn
source: /usr/local/tomcat/webapps/ROOT/Components/Result/ReturnStruct.cfc
arguments
labelnamerequiredtypedefaulthint
messagefalseanynull
exceptionfalseanynullThe optional cfcatch structure.
return typeany
makeUniqueString
Public Function makeUniqueString
source: /usr/local/tomcat/webapps/ROOT/Components/Result/ReturnStruct.cfc
makes a string unique
arguments
labelnamerequiredtypedefaulthint
strtruestringnull
arrtruearraynull
countfalsenumeric0
return typestring
movePage
Public Function movePage
source: /usr/local/tomcat/webapps/ROOT/Components/ContentMngt/PageIO.cfc
Moves a page to another parent
arguments
labelnamerequiredtypedefaulthint
sp_idtruenumericnullThe id of the page to move
new_sp_parent_idtruenumericnullThe id of the new parent
return typestruct
parseXMLFile
Public Function parseXMLFile
source: /usr/local/tomcat/webapps/ROOT/Components/Result/ReturnStruct.cfc
arguments
labelnamerequiredtypedefaulthint
filePathfalsestringnull
return typeany
placeImage
Public Function placeImage
source: /usr/local/tomcat/webapps/ROOT/Components/Result/ReturnStruct.cfc
arguments
labelnamerequiredtypedefaulthint
return typeany
queryToArray
Public Function queryToArray
source: /usr/local/tomcat/webapps/ROOT/Components/Result/ReturnStruct.cfc
Returns an array containing the items from the query.
arguments
labelnamerequiredtypedefaulthint
inputQuerytruequerynullThe query to convert to an array.
dataColumntruestringnullThe column containing the data to return.
return typearray
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
labelnamerequiredtypedefaulthint
Querytruequerynullthe query being converted to CSV.
Fieldstruestringnullthe list of query fields to be used when creating the CSV value.
CreateHeaderRowfalsebooleantrueflag whether or not to create a row of header values.
Delimiterfalsestring,the field delimiter in the CSV value.
return typestring
queryToList
Public Function queryToList
source: /usr/local/tomcat/webapps/ROOT/Components/Result/ReturnStruct.cfc
Returns a list containing the items from the query.
arguments
labelnamerequiredtypedefaulthint
inputQuerytruequerynullThe query to convert to a list.
dataColumnfalsestringnullThe optional column containing the data. If not specified, the first column is used.
return typestring
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
labelnamerequiredtypedefaulthint
Querytruequerynull
Rowfalsenumeric0which row? 0 = all
ColumnListfalsestringAllwhich columns do you want to convert?
DateToISO8601falsebooleanfalseConverts dates to ISO-8601 string
return typeany
readFile
Public Function readFile
source: /usr/local/tomcat/webapps/ROOT/Components/Result/ReturnStruct.cfc
arguments
labelnamerequiredtypedefaulthint
filePathfalsestringnull
return typestring
removeCustomPropertiesForPage
Public Function removeCustomPropertiesForPage
source: /usr/local/tomcat/webapps/ROOT/Components/ContentMngt/PageIO.cfc
Removes all custom properties from a page
arguments
labelnamerequiredtypedefaulthint
sp_idtruenumericnull
return typeany
removeCustomProperty
Public Function removeCustomProperty
source: /usr/local/tomcat/webapps/ROOT/Components/ContentMngt/PageIO.cfc
Removes a custom property
arguments
labelnamerequiredtypedefaulthint
spcp_idtruenumericnull
return typeany
removeData
Public Function removeData
source: /usr/local/tomcat/webapps/ROOT/Components/WIS/DataIO.cfc
Removes the a data record.
arguments
labelnamerequiredtypedefaulthint
data_idtruenumericnullThe data_id to remove.
return typestruct
removeFormTemplate
Public Function removeFormTemplate
source: /usr/local/tomcat/webapps/ROOT/Components/ContentMngt/SiteIO.cfc
Removes a form template
arguments
labelnamerequiredtypedefaulthint
sccft_idtruenumericnull
return typeany
removeImageTemplate
Public Function removeImageTemplate
source: /usr/local/tomcat/webapps/ROOT/Components/ContentMngt/SiteIO.cfc
Removes an image template
arguments
labelnamerequiredtypedefaulthint
sccit_idtruenumericnull
return typeany
removePersonalizedGroups
Public Function removePersonalizedGroups
source: /usr/local/tomcat/webapps/ROOT/Components/ContentMngt/PageIO.cfc
Removes a personalized group from a page.
arguments
labelnamerequiredtypedefaulthint
sp_idtruenumericnullThe id of the page
wg_id_listtruestringnullThe id list of the groups
return typestruct
removePersonalizedGroupsFromPage
Public Function removePersonalizedGroupsFromPage
source: /usr/local/tomcat/webapps/ROOT/Components/ContentMngt/PageIO.cfc
Removes a personalized group from a page.
arguments
labelnamerequiredtypedefaulthint
sp_idtruenumericnullThe id of the page
return typestruct
removeSiteAdmin
Public Function removeSiteAdmin
source: /usr/local/tomcat/webapps/ROOT/Components/ContentMngt/SiteIO.cfc
Removes a site administrator from a website.
arguments
labelnamerequiredtypedefaulthint
site_idtruenumericnullThe ID of the website.
wu_id_listtruestringnullThe ID(s) of the site administrator(s).
return typestruct
removeSiteCachedPages
Public Function removeSiteCachedPages
source: /usr/local/tomcat/webapps/ROOT/Components/ContentMngt/SiteIO.cfc
Removes all cached pages of a site.
arguments
labelnamerequiredtypedefaulthint
site_idtruenumericnullThe ID of the site.
return typestruct
removeSiteConfigContainer
Public Function removeSiteConfigContainer
source: /usr/local/tomcat/webapps/ROOT/Components/ContentMngt/SiteIO.cfc
Removes a site_config_container
arguments
labelnamerequiredtypedefaulthint
scc_idtruenumericnull
return typestruct
removeSiteConfigContainerPageCustomProperty
Public Function removeSiteConfigContainerPageCustomProperty
source: /usr/local/tomcat/webapps/ROOT/Components/ContentMngt/SiteIO.cfc
removes a siteConfigContainer page custom property by sccpcp_id
arguments
labelnamerequiredtypedefaulthint
sccpcp_idtruenumericnull
return typeany
removeSiteConfigContainersFromCompany
Public Function removeSiteConfigContainersFromCompany
source: /usr/local/tomcat/webapps/ROOT/Components/ContentMngt/SiteIO.cfc
Removes all site_config_containers from a company
arguments
labelnamerequiredtypedefaulthint
wc_idtruenumericnull
return typestruct
removeSiteCustomProperty
Public Function removeSiteCustomProperty
source: /usr/local/tomcat/webapps/ROOT/Components/ContentMngt/SiteIO.cfc
removes a custom property by scp_id
arguments
labelnamerequiredtypedefaulthint
scp_idtruenumericnull
return typeany
ReplaceListNoCase
Public Function ReplaceListNoCase
source: /usr/local/tomcat/webapps/ROOT/Components/Result/ReturnStruct.cfc
arguments
labelnamerequiredtypedefaulthint
inputtruestringnullThe string where to replace in.
list1truestringnullThe list of the strings to be replaced
list2truestringnullThe list of the strings which are the new items.
delimiterfalsestring,The delimiter of the lists.
return typestring
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
labelnamerequiredtypedefaulthint
me_idtruenumericnullThe code for this error, it will be used to get the errormessage.
errorStructurefalseanynullThe optional cfcatch structure.
dumpVariablefalseanynullAn optional variable to dump.
return typestruct
returnQueryFromString
Public Function returnQueryFromString
source: /usr/local/tomcat/webapps/ROOT/Components/Result/ReturnStruct.cfc
Generates a query with columns and multiple records.
arguments
labelnamerequiredtypedefaulthint
columnNametruestringnullThe columnname, this could be a list.
valuetruestringnullThe value. This could be a list
valueSeparatorfalsestring,A separator for the value list, default is ','. This separates the columns.
recordSeparatorfalsestring;A separator for the value list, default is ';'. This separates the records
return typequery
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
labelnamerequiredtypedefaulthint
resultQueryfalsequerynullThe optional query containing the result.
return typestruct
returnSecurity
Public Function returnSecurity
source: /usr/local/tomcat/webapps/ROOT/Components/Result/ReturnStruct.cfc
Returns a security breach.
arguments
labelnamerequiredtypedefaulthint
return typestruct
saveCustomProperty
Public Function saveCustomProperty
source: /usr/local/tomcat/webapps/ROOT/Components/ContentMngt/PageIO.cfc
Saves a custom property
arguments
labelnamerequiredtypedefaulthint
sp_idtruenumericnull
spcp_keytrueanynull
spcp_typetruenumericnull1: text, 2: varchar, 3: date, 4: numeric, 6: bit
spcp_valuetrueanynull
return typeany
saveFormTemplate
Public Function saveFormTemplate
source: /usr/local/tomcat/webapps/ROOT/Components/ContentMngt/SiteIO.cfc
Saves a new form template for a siteConfigContainer
arguments
labelnamerequiredtypedefaulthint
scc_idtruenumericnull
sccft_nametrueanynull
sccft_valuetrueanynull
sccft_descriptionfalseany
return typeany
saveImageTemplate
Public Function saveImageTemplate
source: /usr/local/tomcat/webapps/ROOT/Components/ContentMngt/SiteIO.cfc
Saves a new image template for a siteConfigContainer
arguments
labelnamerequiredtypedefaulthint
scc_idtruenumericnull
sccit_nametrueanynull
sccit_widthtrueanynull
sccit_heighttrueanynull
sccit_descriptionfalseany
return typeany
saveSiteConfigContainer
Public Function saveSiteConfigContainer
source: /usr/local/tomcat/webapps/ROOT/Components/ContentMngt/SiteIO.cfc
adds a configurationContainter
arguments
labelnamerequiredtypedefaulthint
scc_nametrueanynull
wc_idtrueanynull
scc_sharemodefalseany0
return typestruct
saveSiteConfigContainerPageCustomProperty
Public Function saveSiteConfigContainerPageCustomProperty
source: /usr/local/tomcat/webapps/ROOT/Components/ContentMngt/SiteIO.cfc
Saves a custom property
arguments
labelnamerequiredtypedefaulthint
scc_idtruenumericnull
spcp_keytrueanynull
spcp_typetruenumericnull1: text, 2: varchar, 3: date, 4: numeric, 6: bit
spcp_valuetrueanynull
sccpcp_descfalseany
return typeany
saveSiteCustomProperty
Public Function saveSiteCustomProperty
source: /usr/local/tomcat/webapps/ROOT/Components/ContentMngt/SiteIO.cfc
Saves a custom property for a site
arguments
labelnamerequiredtypedefaulthint
site_idtruenumericnull
scp_keytrueanynull
scp_typetruenumericnull1: text, 2: varchar, 3: date, 4: numeric, 6: bit
scp_valuetrueanynull
return typeany
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
labelnamerequiredtypedefaulthint
site_id_listtruestringnullThe ID(s) of the website.
searchtruestringnullA string containing the search.
return typestruct
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
labelnamerequiredtypedefaulthint
st_id_listtruestringnullThe id list of the templates
searchtruestringnullThe search string
return typestruct
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
labelnamerequiredtypedefaulthint
data_idtruenumericnullThe data_id of the data to set.
ml_idtruenumericnullThe ml_id of the data to set.
datatruestringnullThe data to set.
return typestruct
setDateTime
Public Function setDateTime
source: /usr/local/tomcat/webapps/ROOT/Components/WIS/DataIO.cfc
Updates the datarecord for a date_time value.
arguments
labelnamerequiredtypedefaulthint
data_idtruenumericnullThe data_id to update.
datefalsenumeric{ts '2026-09-10 14:58:08'}
return typestruct
setDateTimeCF
Public Function setDateTimeCF
source: /usr/local/tomcat/webapps/ROOT/Components/WIS/DataIO.cfc
Updates the datarecord for a date_time value.
arguments
labelnamerequiredtypedefaulthint
data_idtruenumericnullThe data_id to update.
datetimefalsedate{ts '2026-09-10 14:58:08'}The Coldfusion formatted date.
return typestruct
setLicenses
Public Function setLicenses
source: /usr/local/tomcat/webapps/ROOT/Components/ContentMngt/SiteIO.cfc
Sets the number of website licenses for a company.
arguments
labelnamerequiredtypedefaulthint
wc_idtruenumericnullThe ID of the company.
licensestruenumericnullThe amount of sitelicenses.
return typestruct
setPageHide
Public Function setPageHide
source: /usr/local/tomcat/webapps/ROOT/Components/ContentMngt/PageIO.cfc
Sets the page hided or not
arguments
labelnamerequiredtypedefaulthint
sp_idtruenumericnullThe id of the page to get
ml_idtruenumericnullThe id of the language
hide_reasontruenumericnullThe reason why the page must be hided.
hidetruebooleannullIs the page hided for that reason?
updateMenufalsebooleantrueUpdate the menus.
return typestruct
setPageHideAllLanguages
Public Function setPageHideAllLanguages
source: /usr/local/tomcat/webapps/ROOT/Components/ContentMngt/PageIO.cfc
Hides or unhides the page for all languages.
arguments
labelnamerequiredtypedefaulthint
sp_idtruenumericnullThe ID of the page.
hide_reasontruenumericnullThe reason why the page must be hidden or unhidden.
hidetruebooleannullIs the page hidden for that reason?
return typestruct
setPageMetaData
Public Function setPageMetaData
source: /usr/local/tomcat/webapps/ROOT/Components/ContentMngt/PageIO.cfc
Saves some meta data
arguments
labelnamerequiredtypedefaulthint
sp_idtruenumericnullThe id of the page
ml_idtruenumericnullThe id of the language to save
columnListtruestringnullA list of columns with you want to set
arg1falsestringnull
arg2falsestringnull
arg3falsestringnull
arg4falsestringnull
arg5falsestringnull
arg6falsestringnull
return typestruct
setPageOwner
Public Function setPageOwner
source: /usr/local/tomcat/webapps/ROOT/Components/ContentMngt/PageIO.cfc
Changes the owner of the page
arguments
labelnamerequiredtypedefaulthint
sp_idtruenumericnullThe id of the page
wu_idtruenumericnullThe id of the new owner
return typestruct
setPageValues
Public Function setPageValues
source: /usr/local/tomcat/webapps/ROOT/Components/ContentMngt/PageIO.cfc
Sets properties of a page.
arguments
labelnamerequiredtypedefaulthint
sp_idtruenumericnullThe ID of the page.
structValuetruestructnullThe structure with values.
return typestruct
setPersonalizedGroups
Public Function setPersonalizedGroups
source: /usr/local/tomcat/webapps/ROOT/Components/ContentMngt/PageIO.cfc
Sets personalized groups
arguments
labelnamerequiredtypedefaulthint
sp_idtruenumericnullThe id of the page
wg_id_listtruestringnullThe id list of the groups
return typestruct
setRightsGroups
Public Function setRightsGroups
source: /usr/local/tomcat/webapps/ROOT/Components/ContentMngt/PageIO.cfc
Sets rights groups
arguments
labelnamerequiredtypedefaulthint
sp_idtruenumericnullThe id of the page
wg_id_listtruestringnullThe id list of the groups
return typestruct
setSiteAllowedObjectTypes
Public Function setSiteAllowedObjectTypes
source: /usr/local/tomcat/webapps/ROOT/Components/ContentMngt/SiteIO.cfc
Sets the allowed objecttypes for a site.
arguments
labelnamerequiredtypedefaulthint
site_idtruenumericnullThe ID of the website.
typeQuerytruequerynullThe query with allowed objecttypes.
return typestruct
setSiteLanguages
Public Function setSiteLanguages
source: /usr/local/tomcat/webapps/ROOT/Components/ContentMngt/SiteIO.cfc
Sets the languages from a website.
arguments
labelnamerequiredtypedefaulthint
site_idtruenumericnullThe ID of the website.
ml_id_listtruestringnullThe ID(s) of the languages(s).
return typestruct
setSiteTitle
Public Function setSiteTitle
source: /usr/local/tomcat/webapps/ROOT/Components/ContentMngt/SiteIO.cfc
Set the site title for the given language
arguments
labelnamerequiredtypedefaulthint
site_idtruenumericnullthe site to set the title for
titletrueStringnullthe new title for the site
ml_idtruenumericnullThe language to set the title in, use 0 to set it in all active languages
return typeany
setSiteValues
Public Function setSiteValues
source: /usr/local/tomcat/webapps/ROOT/Components/ContentMngt/SiteIO.cfc
Updates the site values.
arguments
labelnamerequiredtypedefaulthint
site_idtruenumericnullThe ID of the site.
valueStructuretruestructnullThe structure with all values.
ml_idfalsenumeric0The structure with all values.
return typestruct
setTemplatePart
Public Function setTemplatePart
source: /usr/local/tomcat/webapps/ROOT/Components/ContentMngt/SiteIO.cfc
Sets the values of a template part.
arguments
labelnamerequiredtypedefaulthint
stp_idtruenumericnullThe ID of the template part.
st_valuestruestructnullA structure with the values.
return typestruct
setTemplatePartValues
Public Function setTemplatePartValues
source: /usr/local/tomcat/webapps/ROOT/Components/ContentMngt/TemplateIO.cfc
Sets all the values of a template part
arguments
labelnamerequiredtypedefaulthint
st_idtruenumericnullThe id of the template to update
stp_idtruenumericnullThe id of the template part to update
stp_widthtruestringnull
stp_heighttruestringnull
stp_paddingtruenumericnull
stp_margin_toptruenumericnull
stp_margin_bottomtruenumericnull
stp_margin_lefttruenumericnull
stp_margin_righttruenumericnull
stp_background_colortruestringnull
stp_locktruebooleannull
return typestruct
setTemplateValues
Public Function setTemplateValues
source: /usr/local/tomcat/webapps/ROOT/Components/ContentMngt/TemplateIO.cfc
Changes the values of a template
arguments
labelnamerequiredtypedefaulthint
st_idtruenumericnullThe st id of the template
st_namefalsestringnullThe new name of the template
st_descriptiontruestringnullThe new description of the template
st_sharetruebooleannullShare the template to lower companies
st_hiddentruebooleannullHide the template for new use
return typestruct
stringHTMLTemplate
Public Function stringHTMLTemplate
source: /usr/local/tomcat/webapps/ROOT/Components/ContentMngt/TemplateIO.cfc
Returns an HTML template.
arguments
labelnamerequiredtypedefaulthint
st_idtruenumericnullThe st_id of the template to get.
viewfalseanyThe view to get
return typestring
stringWebsitePath
Public Function stringWebsitePath
source: /usr/local/tomcat/webapps/ROOT/Components/ContentMngt/SiteIO.cfc
Return the OS path to a website
arguments
labelnamerequiredtypedefaulthint
site_idtruenumericnullThe ID of the site.
return typestring
textToNumber
Public Function textToNumber
source: /usr/local/tomcat/webapps/ROOT/Components/Result/ReturnStruct.cfc
Returns a number for the english word
arguments
labelnamerequiredtypedefaulthint
texttrueanynull
return typenumeric
trueFalseFormat
Public Function trueFalseFormat
source: /usr/local/tomcat/webapps/ROOT/Components/Result/ReturnStruct.cfc
convert cf string to boolean
arguments
labelnamerequiredtypedefaulthint
exptrueanynull
return typeany
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
labelnamerequiredtypedefaulthint
listtruestringnullThe list.
itemstruestringnullThe item(s) to add.
delimiterfalsestring,The delimiter (optional).
return typestring
updateCustomProperty
Public Function updateCustomProperty
source: /usr/local/tomcat/webapps/ROOT/Components/ContentMngt/PageIO.cfc
Updates a custom property
arguments
labelnamerequiredtypedefaulthint
sp_idtruenumericnull
spcp_keytrueanynull
spcp_valuetrueanynull
return typeany
updateDepthForChildren
Public Function updateDepthForChildren
source: /usr/local/tomcat/webapps/ROOT/Components/ContentMngt/PageIO.cfc
arguments
labelnamerequiredtypedefaulthint
sp_idtruenumericnullThe page of which the children need to be updated
new_depthtruenumericnullthe new depth for the children
return typeany
updateFormTemplate
Public Function updateFormTemplate
source: /usr/local/tomcat/webapps/ROOT/Components/ContentMngt/SiteIO.cfc
Updates a form template
arguments
labelnamerequiredtypedefaulthint
sccft_idtruenumericnull
sccft_nametrueanynull
sccft_descriptiontrueanynull
return typeany
updateImageTemplate
Public Function updateImageTemplate
source: /usr/local/tomcat/webapps/ROOT/Components/ContentMngt/SiteIO.cfc
Updates an image template
arguments
labelnamerequiredtypedefaulthint
sccit_idtruenumericnull
sccit_widthtrueanynull
sccit_heighttrueanynull
sccit_descriptiontrueanynull
return typeany
updateMenu
Public Function updateMenu
source: /usr/local/tomcat/webapps/ROOT/Components/ContentMngt/PageIO.cfc
Invokes the menugenerator of the website to run.
arguments
labelnamerequiredtypedefaulthint
site_id_argtruenumericnullThe id of the website
return typestruct
updateMenuAsync
Public Function updateMenuAsync
source: /usr/local/tomcat/webapps/ROOT/Components/ContentMngt/PageIO.cfc
Invokes the menugenerator of the website to run.
arguments
labelnamerequiredtypedefaulthint
site_id_argtruenumericnullThe id of the website
return typestruct
updateSiteConfigContainer
Public Function updateSiteConfigContainer
source: /usr/local/tomcat/webapps/ROOT/Components/ContentMngt/SiteIO.cfc
Saves the fields of a configurationContainter
arguments
labelnamerequiredtypedefaulthint
scc_idtruenumericnull
scc_nametrueanynull
scc_sharemodetruenumericnull
return typestruct
updateSiteConfigContainerPageCustomProperty
Public Function updateSiteConfigContainerPageCustomProperty
source: /usr/local/tomcat/webapps/ROOT/Components/ContentMngt/SiteIO.cfc
Updates a custom property
arguments
labelnamerequiredtypedefaulthint
scc_idtruenumericnull
spcp_keytrueanynull
spcp_valuetrueanynull
sccpcp_descfalseanynull
return typeany
updateSiteCustomProperty
Public Function updateSiteCustomProperty
source: /usr/local/tomcat/webapps/ROOT/Components/ContentMngt/SiteIO.cfc
Updates a custom property
arguments
labelnamerequiredtypedefaulthint
site_idtruenumericnull
scp_keytrueanynull
scp_valuetrueanynull
return typeany
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
labelnamerequiredtypedefaulthint
sp_idtrueanynull
ml_idtrueanynull
return typeany
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
labelnamerequiredtypedefaulthint
sp_idtruenumericnullThe id of the page
wg_idtruestringnullAccepts a list of groups. All values for each group are in a list in the other arguments.
deeptruestringnull
spa_writetruestringnull
spa_addtruestringnull
spa_deltruestringnull
spa_admintruestringnull
return typestruct
XmlEscapedToHtml
Public Function XmlEscapedToHtml
source: /usr/local/tomcat/webapps/ROOT/Components/ContentMngt/PageIO.cfc
arguments
labelnamerequiredtypedefaulthint
contentfalseanynull
return typeany
xmlTemplate
Public Function xmlTemplate
source: /usr/local/tomcat/webapps/ROOT/Components/ContentMngt/TemplateIO.cfc
Returns an XML template.
arguments
labelnamerequiredtypedefaulthint
st_idtruenumericnullThe st_id of the template to get.
viewfalseanyThe view to get
return typeany
package
addPageFirst
Package Function addPageFirst
source: /usr/local/tomcat/webapps/ROOT/Components/ContentMngt/PageIO.cfc
Adds a page to another page
arguments
labelnamerequiredtypedefaulthint
site_idtruenumericnullThe id of the website
st_idtruenumericnullThe id of the template
sst_idtruenumeric-1
return typestruct
setPageModified
Package Function setPageModified
source: /usr/local/tomcat/webapps/ROOT/Components/ContentMngt/PageIO.cfc
Updates the lastmodifier and lastmodified-date of a page.
arguments
labelnamerequiredtypedefaulthint
sp_idtruenumericnullThe ID of the page.
wu_idfalsenumeric-1The ID of the lastmodifier.
return typestruct
private
addPageNow
Private Function addPageNow
source: /usr/local/tomcat/webapps/ROOT/Components/ContentMngt/PageIO.cfc
Adds a page to another page
arguments
labelnamerequiredtypedefaulthint
siteProptruequerynullStructure with site properties
sp_idtruenumericnullThe id of the main page
ml_idtruenumericnullThe id of the language which is the language of sp_name
sp_nametruestringnullThe name of the page
sp_name_defaulttruestringnullThe default name in the default language of the page
st_idtruenumericnullThe id of the template
fillEmptytruebooleannullFill the template with empty content fields?
sp_typetruenumericnullThe type of the page.
sst_idtruenumericnullThe type of the page.
return typestruct
addSiteAdminPrivate
Private Function addSiteAdminPrivate
source: /usr/local/tomcat/webapps/ROOT/Components/ContentMngt/SiteIO.cfc
Creates a site administrator.
arguments
labelnamerequiredtypedefaulthint
site_id_listtruestringnullThe ID(s) of the website.
wu_id_listtruestringnullThe ID(s) of the administrator.
return typestruct
createSQLLTTen
Private Function createSQLLTTen
source: /usr/local/tomcat/webapps/ROOT/Components/WIS/DataIO.cfc
Creates a SQL statement to Return a zero before a number when the number is less then 10.
arguments
labelnamerequiredtypedefaulthint
columntruestringnullThe SQL column name
return typestruct
createXMLTemplateSub
Private Function createXMLTemplateSub
source: /usr/local/tomcat/webapps/ROOT/Components/ContentMngt/TemplateIO.cfc
Returns parts of the template
arguments
labelnamerequiredtypedefaulthint
st_idtruenumericnullThe id of the template
stp_idtruenumericnullThe part id to create
xmlDoctrueanynullThe xml Structure to insert in
xmlRoottrueanynullThe xml Structure to insert in
return typeany
deleteRightsPrivate
Private Function deleteRightsPrivate
source: /usr/local/tomcat/webapps/ROOT/Components/ContentMngt/PageIO.cfc
Deletes the rights for group for a page Doesn't a site admin check
arguments
labelnamerequiredtypedefaulthint
sp_idtruenumericnullThe id of the page
wg_id_listtruestringnullThe id of the group
deepfalsebooleanfalseAlso delete grouprights from lower pages?
return typestruct
getAllParentPages
Private Function getAllParentPages
source: /usr/local/tomcat/webapps/ROOT/Components/ContentMngt/PageIO.cfc
Returns all parent pages recursively up to the root page.
arguments
labelnamerequiredtypedefaulthint
sp_idtruenumericnullThe id of the page
return typestruct
getTableName
Private Function getTableName
source: /usr/local/tomcat/webapps/ROOT/Components/WIS/DataIO.cfc
Gets the table name where the data is stored.
arguments
labelnamerequiredtypedefaulthint
data_idtruenumericnullThe data_id of the data.
return typestruct
getTemplateXML
Private Function getTemplateXML
source: /usr/local/tomcat/webapps/ROOT/Components/ContentMngt/TemplateIO.cfc
Gets the template values in XML
arguments
labelnamerequiredtypedefaulthint
st_idtruenumericnull
return typeany
isExistsHTMLTemplate
Private Function isExistsHTMLTemplate
source: /usr/local/tomcat/webapps/ROOT/Components/ContentMngt/TemplateIO.cfc
Checkes wether the HTML template exists on the disk.
arguments
labelnamerequiredtypedefaulthint
st_idtruenumericnullThe template ID of the template to get.
return typeany
isExistsXMLTemplate
Private Function isExistsXMLTemplate
source: /usr/local/tomcat/webapps/ROOT/Components/ContentMngt/TemplateIO.cfc
Checks wether the XML template exists on the disk.
arguments
labelnamerequiredtypedefaulthint
st_idtruenumericnullThe template ID of the template to check.
return typeany
isNameUniqueOnSameLevel
Private Function isNameUniqueOnSameLevel
source: /usr/local/tomcat/webapps/ROOT/Components/ContentMngt/PageIO.cfc
arguments
labelnamerequiredtypedefaulthint
sp_idtruenumericnull
ml_idtruenumericnull
sp_nametrueStringnull
return typeboolean
stringHTMLTemplatePath
Private Function stringHTMLTemplatePath
source: /usr/local/tomcat/webapps/ROOT/Components/ContentMngt/TemplateIO.cfc
Returns the path to the HTML template.
arguments
labelnamerequiredtypedefaulthint
st_idtruenumericnullThe template IS of the template to get.
return typeany
stringXMLTemplatePath
Private Function stringXMLTemplatePath
source: /usr/local/tomcat/webapps/ROOT/Components/ContentMngt/TemplateIO.cfc
Returns the path to the XML template.
arguments
labelnamerequiredtypedefaulthint
st_idtruenumericnullThe template ID of the template to get.
return typeany
updateRights
Private Function updateRights
source: /usr/local/tomcat/webapps/ROOT/Components/ContentMngt/PageIO.cfc
Updates the rights for a group. Doesn't check for site admin
arguments
labelnamerequiredtypedefaulthint
sp_idtruenumericnull
wg_idtruenumericnull
deeptruenumericnull
spa_writetruenumericnull
spa_addtruenumericnull
spa_deltruenumericnull
spa_admintruenumericnull
return typestruct