ADF Docs - User contributions [en]

Utils 1 0-updateListItems

2010-04-09T14:00:26Z

Api:

__NOTOC__
Attention: Do not change any text in the description, signature, and paramter sections.

Return to [[Utils_1_0]]

== Description ==
Given a fieldType update the fields that use that field type to have list items

== Signature ==
public struct <strong>updateListItems</strong> ( string fieldType )

== Parameters ==

<table id="lib-params">
<tr class="header">
<td>Required</td>
<td>Name</td>
<td>Type</td>
<td>Description</td>
</tr>

<tr>

<td class="required">required</td>

<td>fieldType</td>
<td>string</td>
<td></td>
</tr>

</table>

Utils 1 0-updateListItems

2010-04-09T14:00:24Z

Api:

__NOTOC__
Attention: Do not change any text in the description, signature, and paramter sections.

Return to [[Utils_1_0]]

== Description ==
[[Utils_1_0|Return to Utils_1_0]]

Given a fieldType update the fields that use that field type to have list items

== Signature ==
public struct <strong>updateListItems</strong> ( string fieldType )

== Parameters ==

<table id="lib-params">
<tr class="header">
<td>Required</td>
<td>Name</td>
<td>Type</td>
<td>Description</td>
</tr>

<tr>

<td class="required">required</td>

<td>fieldType</td>
<td>string</td>
<td></td>
</tr>

</table>

Utils 1 0-updateCustomFieldType

2010-04-09T14:00:20Z

Api:

__NOTOC__
Attention: Do not change any text in the description, signature, and paramter sections.

Return to [[Utils_1_0]]

== Description ==
Updates a custom field type record

== Signature ==
public boolean <strong>updateCustomFieldType</strong> ( numeric ID, string propertyModule, string renderModule, string type, string JSValidator, string active )

== Parameters ==

<table id="lib-params">
<tr class="header">
<td>Required</td>
<td>Name</td>
<td>Type</td>
<td>Description</td>
</tr>

<tr>

<td class="required">required</td>

<td>ID</td>
<td>numeric</td>
<td>The Field ID for the field type</td>
</tr>

<tr>

<td> </td>

<td>propertyModule</td>
<td>string</td>
<td></td>
</tr>

<tr>

<td> </td>

<td>renderModule</td>
<td>string</td>
<td></td>
</tr>

<tr>

<td> </td>

<td>type</td>
<td>string</td>
<td></td>
</tr>

<tr>

<td> </td>

<td>JSValidator</td>
<td>string</td>
<td></td>
</tr>

<tr>

<td> </td>

<td>active</td>
<td>string</td>
<td></td>
</tr>

</table>

Utils 1 0-updateCustomFieldType

2010-04-09T14:00:18Z

Api:

__NOTOC__
Attention: Do not change any text in the description, signature, and paramter sections.

Return to [[Utils_1_0]]

== Description ==
[[Utils_1_0|Return to Utils_1_0]]

Updates a custom field type record

== Signature ==
public boolean <strong>updateCustomFieldType</strong> ( numeric ID, string propertyModule, string renderModule, string type, string JSValidator, string active )

== Parameters ==

<table id="lib-params">
<tr class="header">
<td>Required</td>
<td>Name</td>
<td>Type</td>
<td>Description</td>
</tr>

<tr>

<td class="required">required</td>

<td>ID</td>
<td>numeric</td>
<td>The Field ID for the field type</td>
</tr>

<tr>

<td> </td>

<td>propertyModule</td>
<td>string</td>
<td></td>
</tr>

<tr>

<td> </td>

<td>renderModule</td>
<td>string</td>
<td></td>
</tr>

<tr>

<td> </td>

<td>type</td>
<td>string</td>
<td></td>
</tr>

<tr>

<td> </td>

<td>JSValidator</td>
<td>string</td>
<td></td>
</tr>

<tr>

<td> </td>

<td>active</td>
<td>string</td>
<td></td>
</tr>

</table>

Utils 1 0-unzipFile

2010-04-09T14:00:13Z

Api:

Utils 1 0-unzipFile

2010-04-09T14:00:09Z

Api:

__NOTOC__
Attention: Do not change any text in the description, signature, and paramter sections.

Return to [[Utils_1_0]]

== Description ==
[[Utils_1_0|Return to Utils_1_0]]

== Signature ==
public void <strong>unzipFile</strong> ( string zipFilePath, string outputPath )

== Parameters ==

<table id="lib-params">
<tr class="header">
<td>Required</td>
<td>Name</td>
<td>Type</td>
<td>Description</td>
</tr>

<tr>

<td class="required">required</td>

<td>zipFilePath</td>
<td>string</td>
<td></td>
</tr>

<tr>

<td> </td>

<td>outputPath</td>
<td>string</td>
<td></td>
</tr>

</table>

Utils 1 0-setScheduledTask

2010-04-09T14:00:03Z

Api:

__NOTOC__
Attention: Do not change any text in the description, signature, and paramter sections.

Return to [[Utils_1_0]]

== Description ==

== Signature ==
public any <strong>setScheduledTask</strong> ( string url, string taskName, string schedLogFileName, string minuteDelay )

== Parameters ==

<table id="lib-params">
<tr class="header">
<td>Required</td>
<td>Name</td>
<td>Type</td>
<td>Description</td>
</tr>

<tr>

<td class="required">required</td>

<td>url</td>
<td>string</td>
<td></td>
</tr>

<tr>

<td> </td>

<td>taskName</td>
<td>string</td>
<td></td>
</tr>

<tr>

<td> </td>

<td>schedLogFileName</td>
<td>string</td>
<td></td>
</tr>

<tr>

<td> </td>

<td>minuteDelay</td>
<td>string</td>
<td></td>
</tr>

</table>

Utils 1 0-scriptExists

2010-04-09T13:59:59Z

Api:

__NOTOC__
Attention: Do not change any text in the description, signature, and paramter sections.

Return to [[Utils_1_0]]

== Description ==

== Signature ==
public boolean <strong>scriptExists</strong> ( string templatePath )

== Parameters ==

<table id="lib-params">
<tr class="header">
<td>Required</td>
<td>Name</td>
<td>Type</td>
<td>Description</td>
</tr>

<tr>

<td class="required">required</td>

<td>templatePath</td>
<td>string</td>
<td></td>
</tr>

</table>

Utils 1 0-scriptExists

2010-04-09T13:59:57Z

Api:

__NOTOC__
Attention: Do not change any text in the description, signature, and paramter sections.

Return to [[Utils_1_0]]

== Description ==
[[Utils_1_0|Return to Utils_1_0]]

== Signature ==
public boolean <strong>scriptExists</strong> ( string templatePath )

== Parameters ==

<table id="lib-params">
<tr class="header">
<td>Required</td>
<td>Name</td>
<td>Type</td>
<td>Description</td>
</tr>

<tr>

<td class="required">required</td>

<td>templatePath</td>
<td>string</td>
<td></td>
</tr>

</table>

Utils 1 0-logAppend

2010-04-09T13:59:52Z

Api:

__NOTOC__
Attention: Do not change any text in the description, signature, and paramter sections.

Return to [[Utils_1_0]]

== Description ==

== Signature ==
public void <strong>logAppend</strong> ( string msg, string logFile, boolean addTimeStamp, string logDir )

== Parameters ==

<table id="lib-params">
<tr class="header">
<td>Required</td>
<td>Name</td>
<td>Type</td>
<td>Description</td>
</tr>

<tr>

<td class="required">required</td>

<td>msg</td>
<td>string</td>
<td></td>
</tr>

<tr>

<td class="required">optional</td>

<td>logFile</td>
<td>string</td>
<td>[Default: debug.log] </td>
</tr>

<tr>

<td> </td>

<td>addTimeStamp</td>
<td>boolean</td>
<td>[Default: true] </td>
</tr>

<tr>

<td> </td>

<td>logDir</td>
<td>string</td>
<td>[Default: [runtime expression]] </td>
</tr>

</table>

Utils 1 0-ListRandomElements

2010-04-09T13:59:47Z

Api:

__NOTOC__
Attention: Do not change any text in the description, signature, and paramter sections.

Return to [[Utils_1_0]]

== Description ==
Returns specified number of random list elements without repeats.

== Signature ==
public string <strong>ListRandomElements</strong> ( string theList, numeric numElements, string theDelim )

== Parameters ==

<table id="lib-params">
<tr class="header">
<td>Required</td>
<td>Name</td>
<td>Type</td>
<td>Description</td>
</tr>

<tr>

<td class="required">required</td>

<td>theList</td>
<td>string</td>
<td></td>
</tr>

<tr>

<td> </td>

<td>numElements</td>
<td>numeric</td>
<td></td>
</tr>

<tr>

<td class="required">optional</td>

<td>theDelim</td>
<td>string</td>
<td>[Default: ,] </td>
</tr>

</table>

Utils 1 0-ListRandomElements

2010-04-09T13:59:46Z

Api:

__NOTOC__
Attention: Do not change any text in the description, signature, and paramter sections.

Return to [[Utils_1_0]]

== Description ==
[[Utils_1_0|Return to Utils_1_0]]

Returns specified number of random list elements without repeats.

== Signature ==
public string <strong>ListRandomElements</strong> ( string theList, numeric numElements, string theDelim )

== Parameters ==

<table id="lib-params">
<tr class="header">
<td>Required</td>
<td>Name</td>
<td>Type</td>
<td>Description</td>
</tr>

<tr>

<td class="required">required</td>

<td>theList</td>
<td>string</td>
<td></td>
</tr>

<tr>

<td> </td>

<td>numElements</td>
<td>numeric</td>
<td></td>
</tr>

<tr>

<td class="required">optional</td>

<td>theDelim</td>
<td>string</td>
<td>[Default: ,] </td>
</tr>

</table>

Utils 1 0-HTMLSafeFormattedTextBox

2010-04-09T13:59:37Z

Api:

__NOTOC__
Attention: Do not change any text in the description, signature, and paramter sections.

Return to [[Utils_1_0]]

== Description ==

== Signature ==
public string <strong>HTMLSafeFormattedTextBox</strong> ( string inString )

== Parameters ==

<table id="lib-params">
<tr class="header">
<td>Required</td>
<td>Name</td>
<td>Type</td>
<td>Description</td>
</tr>

<tr>

<td class="required">required</td>

<td>inString</td>
<td>string</td>
<td></td>
</tr>

</table>

Utils 1 0-getFieldTypes

2010-04-09T13:59:32Z

Api:

__NOTOC__
Attention: Do not change any text in the description, signature, and paramter sections.

Return to [[Utils_1_0]]

== Description ==
Returns back the details for any custom field type that is currently a list

== Signature ==
public Array <strong>getFieldTypes</strong> ( )

== Parameters ==

<table id="lib-params">
<tr class="header">
<td>Required</td>
<td>Name</td>
<td>Type</td>
<td>Description</td>
</tr>

</table>

Utils 1 0-getFieldTypes

2010-04-09T13:59:30Z

Api:

__NOTOC__
Attention: Do not change any text in the description, signature, and paramter sections.

Return to [[Utils_1_0]]

== Description ==
[[Utils_1_0|Return to Utils_1_0]]

Returns back the details for any custom field type that is currently a list

== Signature ==
public Array <strong>getFieldTypes</strong> ( )

== Parameters ==

<table id="lib-params">
<tr class="header">
<td>Required</td>
<td>Name</td>
<td>Type</td>
<td>Description</td>
</tr>

</table>

Utils 1 0-filterDirectoryQueryByType

2010-04-09T13:59:26Z

Api:

__NOTOC__
Attention: Do not change any text in the description, signature, and paramter sections.

Return to [[Utils_1_0]]

== Description ==
Filters the query to find the CFC file name.

== Signature ==
public query <strong>filterDirectoryQueryByType</strong> ( query dirQuery, string whereCondValue, string whereOperator, string queryType )

== Parameters ==

<table id="lib-params">
<tr class="header">
<td>Required</td>
<td>Name</td>
<td>Type</td>
<td>Description</td>
</tr>

<tr>

<td class="required">required</td>

<td>dirQuery</td>
<td>query</td>
<td></td>
</tr>

<tr>

<td> </td>

<td>whereCondValue</td>
<td>string</td>
<td></td>
</tr>

<tr>

<td class="required">optional</td>

<td>whereOperator</td>
<td>string</td>
<td>[Default: LIKE] </td>
</tr>

<tr>

<td> </td>

<td>queryType</td>
<td>string</td>
<td>[Default: File] </td>
</tr>

</table>

Utils 1 0-filterDirectoryQueryByType

2010-04-09T13:59:22Z

Api:

__NOTOC__
Attention: Do not change any text in the description, signature, and paramter sections.

Return to [[Utils_1_0]]

== Description ==
[[Utils_1_0|Return to Utils_1_0]]

Filters the query to find the CFC file name.

== Signature ==
public query <strong>filterDirectoryQueryByType</strong> ( query dirQuery, string whereCondValue, string whereOperator, string queryType )

== Parameters ==

<table id="lib-params">
<tr class="header">
<td>Required</td>
<td>Name</td>
<td>Type</td>
<td>Description</td>
</tr>

<tr>

<td class="required">required</td>

<td>dirQuery</td>
<td>query</td>
<td></td>
</tr>

<tr>

<td> </td>

<td>whereCondValue</td>
<td>string</td>
<td></td>
</tr>

<tr>

<td class="required">optional</td>

<td>whereOperator</td>
<td>string</td>
<td>[Default: LIKE] </td>
</tr>

<tr>

<td> </td>

<td>queryType</td>
<td>string</td>
<td>[Default: File] </td>
</tr>

</table>

Utils 1 0-fieldTypeIsList

2010-04-09T13:59:18Z

Api:

__NOTOC__
Attention: Do not change any text in the description, signature, and paramter sections.

Return to [[Utils_1_0]]

== Description ==
Determines if the field type is a 'list' field type

== Signature ==
public boolean <strong>fieldTypeIsList</strong> ( string fieldType )

== Parameters ==

<table id="lib-params">
<tr class="header">
<td>Required</td>
<td>Name</td>
<td>Type</td>
<td>Description</td>
</tr>

<tr>

<td class="required">required</td>

<td>fieldType</td>
<td>string</td>
<td></td>
</tr>

</table>

Utils 1 0-fieldTypeIsList

2010-04-09T13:59:16Z

Api:

__NOTOC__
Attention: Do not change any text in the description, signature, and paramter sections.

Return to [[Utils_1_0]]

== Description ==
[[Utils_1_0|Return to Utils_1_0]]

Determines if the field type is a 'list' field type

== Signature ==
public boolean <strong>fieldTypeIsList</strong> ( string fieldType )

== Parameters ==

<table id="lib-params">
<tr class="header">
<td>Required</td>
<td>Name</td>
<td>Type</td>
<td>Description</td>
</tr>

<tr>

<td class="required">required</td>

<td>fieldType</td>
<td>string</td>
<td></td>
</tr>

</table>

Utils 1 0-exit

2010-04-09T13:59:10Z

Api:

__NOTOC__
Attention: Do not change any text in the description, signature, and paramter sections.

Return to [[Utils_1_0]]

== Description ==

== Signature ==
public string <strong>exit</strong> ( )

== Parameters ==

<table id="lib-params">
<tr class="header">
<td>Required</td>
<td>Name</td>
<td>Type</td>
<td>Description</td>
</tr>

</table>

Utils 1 0-doDump

2010-04-09T13:59:06Z

Api:

__NOTOC__
Attention: Do not change any text in the description, signature, and paramter sections.

Return to [[Utils_1_0]]

== Description ==
ColdFusion dump of the variable argument.

== Signature ==
public string <strong>doDump</strong> ( any var, string label, boolean expand, numeric returnInVar )

== Parameters ==

<table id="lib-params">
<tr class="header">
<td>Required</td>
<td>Name</td>
<td>Type</td>
<td>Description</td>
</tr>

<tr>

<td class="required">required</td>

<td>var</td>
<td>any</td>
<td></td>
</tr>

<tr>

<td class="required">optional</td>

<td>label</td>
<td>string</td>
<td>[Default: no label] </td>
</tr>

<tr>

<td> </td>

<td>expand</td>
<td>boolean</td>
<td>[Default: true] </td>
</tr>

<tr>

<td> </td>

<td>returnInVar</td>
<td>numeric</td>
<td>[Default: 0] </td>
</tr>

</table>

Utils 1 0-doDump

2010-04-09T13:59:04Z

Api:

__NOTOC__
Attention: Do not change any text in the description, signature, and paramter sections.

Return to [[Utils_1_0]]

== Description ==
[[Utils_1_0|Return to Utils_1_0]]

ColdFusion dump of the variable argument.

== Signature ==
public string <strong>doDump</strong> ( any var, string label, boolean expand, numeric returnInVar )

== Parameters ==

<table id="lib-params">
<tr class="header">
<td>Required</td>
<td>Name</td>
<td>Type</td>
<td>Description</td>
</tr>

<tr>

<td class="required">required</td>

<td>var</td>
<td>any</td>
<td></td>
</tr>

<tr>

<td class="required">optional</td>

<td>label</td>
<td>string</td>
<td>[Default: no label] </td>
</tr>

<tr>

<td> </td>

<td>expand</td>
<td>boolean</td>
<td>[Default: true] </td>
</tr>

<tr>

<td> </td>

<td>returnInVar</td>
<td>numeric</td>
<td>[Default: 0] </td>
</tr>

</table>

Utils 1 0-directoryFiles

2010-04-09T13:59:00Z

Api:

__NOTOC__
Attention: Do not change any text in the description, signature, and paramter sections.

Return to [[Utils_1_0]]

== Description ==
Returns the files for the directory.

== Signature ==
public query <strong>directoryFiles</strong> ( string dirPath, string recurse )

== Parameters ==

<table id="lib-params">
<tr class="header">
<td>Required</td>
<td>Name</td>
<td>Type</td>
<td>Description</td>
</tr>

<tr>

<td class="required">required</td>

<td>dirPath</td>
<td>string</td>
<td></td>
</tr>

<tr>

<td class="required">optional</td>

<td>recurse</td>
<td>string</td>
<td>[Default: false] </td>
</tr>

</table>

Utils 1 0-directoryFiles

2010-04-09T13:58:59Z

Api:

__NOTOC__
Attention: Do not change any text in the description, signature, and paramter sections.

Return to [[Utils_1_0]]

== Description ==
[[Utils_1_0|Return to Utils_1_0]]

Returns the files for the directory.

== Signature ==
public query <strong>directoryFiles</strong> ( string dirPath, string recurse )

== Parameters ==

<table id="lib-params">
<tr class="header">
<td>Required</td>
<td>Name</td>
<td>Type</td>
<td>Description</td>
</tr>

<tr>

<td class="required">required</td>

<td>dirPath</td>
<td>string</td>
<td></td>
</tr>

<tr>

<td class="required">optional</td>

<td>recurse</td>
<td>string</td>
<td>[Default: false] </td>
</tr>

</table>

Utils 1 0-deleteScheduledTask

2010-04-09T13:58:52Z

Api:

__NOTOC__
Attention: Do not change any text in the description, signature, and paramter sections.

Return to [[Utils_1_0]]

== Description ==

== Signature ==
public any <strong>deleteScheduledTask</strong> ( string taskName )

== Parameters ==

<table id="lib-params">
<tr class="header">
<td>Required</td>
<td>Name</td>
<td>Type</td>
<td>Description</td>
</tr>

<tr>

<td class="required">required</td>

<td>taskName</td>
<td>string</td>
<td></td>
</tr>

</table>

Utils 1 0-createUniqueFileName

2010-04-09T13:58:46Z

Api:

__NOTOC__
Attention: Do not change any text in the description, signature, and paramter sections.

Return to [[Utils_1_0]]

== Description ==

== Signature ==
public string <strong>createUniqueFileName</strong> ( string fullPath )

== Parameters ==

<table id="lib-params">
<tr class="header">
<td>Required</td>
<td>Name</td>
<td>Type</td>
<td>Description</td>
</tr>

<tr>

<td class="required">required</td>

<td>fullPath</td>
<td>string</td>
<td></td>
</tr>

</table>

Utils 1 0-bulkLogAppend

2010-04-09T13:58:42Z

Api:

__NOTOC__
Attention: Do not change any text in the description, signature, and paramter sections.

Return to [[Utils_1_0]]

== Description ==
Takes an array of log writes and calls log append with each write

== Signature ==
public void <strong>bulkLogAppend</strong> ( array logs )

== Parameters ==

<table id="lib-params">
<tr class="header">
<td>Required</td>
<td>Name</td>
<td>Type</td>
<td>Description</td>
</tr>

<tr>

<td class="required">required</td>

<td>logs</td>
<td>array</td>
<td>Array of log append records</td>
</tr>

</table>

Utils 1 0-bulkLogAppend

2010-04-09T13:58:40Z

Api:

__NOTOC__
Attention: Do not change any text in the description, signature, and paramter sections.

Return to [[Utils_1_0]]

== Description ==
[[Utils_1_0|Return to Utils_1_0]]

Takes an array of log writes and calls log append with each write

== Signature ==
public void <strong>bulkLogAppend</strong> ( array logs )

== Parameters ==

<table id="lib-params">
<tr class="header">
<td>Required</td>
<td>Name</td>
<td>Type</td>
<td>Description</td>
</tr>

<tr>

<td class="required">required</td>

<td>logs</td>
<td>array</td>
<td>Array of log append records</td>
</tr>

</table>

Utils 1 0-buildPagination

2010-04-09T13:58:34Z

Api:

__NOTOC__
Attention: Do not change any text in the description, signature, and paramter sections.

Return to [[Utils_1_0]]

== Description ==

== Signature ==
public struct <strong>buildPagination</strong> ( numeric page, numeric itemCount, numeric pageSize, boolean showCount, string URLparams )

== Parameters ==

<table id="lib-params">
<tr class="header">
<td>Required</td>
<td>Name</td>
<td>Type</td>
<td>Description</td>
</tr>

<tr>

<td class="required">required</td>

<td>page</td>
<td>numeric</td>
<td></td>
</tr>

<tr>

<td> </td>

<td>itemCount</td>
<td>numeric</td>
<td></td>
</tr>

<tr>

<td> </td>

<td>pageSize</td>
<td>numeric</td>
<td></td>
</tr>

<tr>

<td class="required">optional</td>

<td>showCount</td>
<td>boolean</td>
<td>[Default: true] </td>
</tr>

<tr>

<td> </td>

<td>URLparams</td>
<td>string</td>
<td>[Default: ] </td>
</tr>

</table>

Utils 1 0-abort

2010-04-09T13:58:29Z

Api:

__NOTOC__
Attention: Do not change any text in the description, signature, and paramter sections.

Return to [[Utils_1_0]]

== Description ==

== Signature ==
public string <strong>abort</strong> ( )

== Parameters ==

<table id="lib-params">
<tr class="header">
<td>Required</td>
<td>Name</td>
<td>Type</td>
<td>Description</td>
</tr>

</table>

Utils 1 0

2010-04-09T13:58:27Z

Api:

__NOTOC__

Attention: Do not change any text in the description, properties, and functions sections.

Return to [[Library|Library (API)]]

== Description ==
Util functions for the ADF Library

== Properties ==
:dependency = ceData_1_0
:version = 1_0_0
:wikiTitle = Utils_1_0
:type = singleton

== Functions ==
<div id='library-api'>
:[[Utils_1_0-abort|abort]] ( )
:[[Utils_1_0-buildPagination|buildPagination]] ( numeric page, numeric itemCount, numeric pageSize, boolean showCount, string URLparams )
:[[Utils_1_0-bulkLogAppend|bulkLogAppend]] ( array logs )
::Takes an array of log writes and calls log append with each write
:[[Utils_1_0-createUniqueFileName|createUniqueFileName]] ( string fullPath )
:[[Utils_1_0-deleteScheduledTask|deleteScheduledTask]] ( string taskName )
:[[Utils_1_0-directoryFiles|directoryFiles]] ( string dirPath, string recurse )
::Returns the files for the directory.
:[[Utils_1_0-doDump|doDump]] ( any var, string label, boolean expand, numeric returnInVar )
::ColdFusion dump of the variable argument.
:[[Utils_1_0-exit|exit]] ( )
:[[Utils_1_0-fieldTypeIsList|fieldTypeIsList]] ( string fieldType )
::Determines if the field type is a 'list' field type
:[[Utils_1_0-filterDirectoryQueryByType|filterDirectoryQueryByType]] ( query dirQuery, string whereCondValue, string whereOperator, string queryType )
::Filters the query to find the CFC file name.
:[[Utils_1_0-getFieldTypes|getFieldTypes]] ( )
::Returns back the details for any custom field type that is currently a list
:[[Utils_1_0-HTMLSafeFormattedTextBox|HTMLSafeFormattedTextBox]] ( string inString )
:[[Utils_1_0-ListRandomElements|ListRandomElements]] ( string theList, numeric numElements, string theDelim )
::Returns specified number of random list elements without repeats.
:[[Utils_1_0-logAppend|logAppend]] ( string msg, string logFile, boolean addTimeStamp, string logDir )
:[[Utils_1_0-scriptExists|scriptExists]] ( string templatePath )
:[[Utils_1_0-setScheduledTask|setScheduledTask]] ( string url, string taskName, string schedLogFileName, string minuteDelay )
:[[Utils_1_0-unzipFile|unzipFile]] ( string zipFilePath, string outputPath )
:[[Utils_1_0-updateCustomFieldType|updateCustomFieldType]] ( numeric ID, string propertyModule, string renderModule, string type, string JSValidator, string active )
::Updates a custom field type record
:[[Utils_1_0-updateListItems|updateListItems]] ( string fieldType )
::Given a fieldType update the fields that use that field type to have list items
</div>

Utils 1 0

2010-04-09T13:58:25Z

Api:

Utils 1 0

2010-04-09T13:58:23Z

Api:

Taxonomy 1 0-getTopTermIDArrayForFacet

2010-04-09T13:58:16Z

Api:

__NOTOC__
Attention: Do not change any text in the description, signature, and paramter sections.

Return to [[Taxonomy_1_0]]

== Description ==

== Signature ==
public array <strong>getTopTermIDArrayForFacet</strong> ( numeric facetID, numeric taxonomyID )

== Parameters ==

<table id="lib-params">
<tr class="header">
<td>Required</td>
<td>Name</td>
<td>Type</td>
<td>Description</td>
</tr>

<tr>

<td class="required">required</td>

<td>facetID</td>
<td>numeric</td>
<td></td>
</tr>

<tr>

<td> </td>

<td>taxonomyID</td>
<td>numeric</td>
<td></td>
</tr>

</table>

Taxonomy 1 0-getTermIDs

2010-04-09T13:58:12Z

Api:

__NOTOC__
Attention: Do not change any text in the description, signature, and paramter sections.

Return to [[Taxonomy_1_0]]

== Description ==
Returns a list of termIDs from a list of terms and a given initialized taxonomy object

== Signature ==
public string <strong>getTermIDs</strong> ( any csTaxObj, string termList )

== Parameters ==

<table id="lib-params">
<tr class="header">
<td>Required</td>
<td>Name</td>
<td>Type</td>
<td>Description</td>
</tr>

<tr>

<td class="required">required</td>

<td>csTaxObj</td>
<td>any</td>
<td>CS Taxonomy API Object intialized to the proper taxonomy</td>
</tr>

<tr>

<td> </td>

<td>termList</td>
<td>string</td>
<td>List of Term String Names that will be converted to Ids</td>
</tr>

</table>

Taxonomy 1 0-getTermIDs

2010-04-09T13:58:10Z

Api:

__NOTOC__
Attention: Do not change any text in the description, signature, and paramter sections.

Return to [[Taxonomy_1_0]]

== Description ==
[[taxonomy_1_0|Return to taxonomy_1_0]]

Returns a list of termIDs from a list of terms and a given initialized taxonomy object

== Signature ==
public string <strong>getTermIDs</strong> ( any csTaxObj, string termList )

== Parameters ==

<table id="lib-params">
<tr class="header">
<td>Required</td>
<td>Name</td>
<td>Type</td>
<td>Description</td>
</tr>

<tr>

<td class="required">required</td>

<td>csTaxObj</td>
<td>any</td>
<td>CS Taxonomy API Object intialized to the proper taxonomy</td>
</tr>

<tr>

<td> </td>

<td>termList</td>
<td>string</td>
<td>List of Term String Names that will be converted to Ids</td>
</tr>

</table>

Taxonomy 1 0-getPageBindingsForTermID

2010-04-09T13:58:04Z

Api:

__NOTOC__
Attention: Do not change any text in the description, signature, and paramter sections.

Return to [[Taxonomy_1_0]]

== Description ==

== Signature ==
public struct <strong>getPageBindingsForTermID</strong> ( any csTaxObj, string TermID, string facet, numeric CEFormID, numeric CEFieldID, string currTermPageIdList )

== Parameters ==

<table id="lib-params">
<tr class="header">
<td>Required</td>
<td>Name</td>
<td>Type</td>
<td>Description</td>
</tr>

<tr>

<td class="required">required</td>

<td>csTaxObj</td>
<td>any</td>
<td>CS Taxonomy API Object intialized to the proper taxonomy</td>
</tr>

<tr>

<td> </td>

<td>TermID</td>
<td>string</td>
<td></td>
</tr>

<tr>

<td> </td>

<td>facet</td>
<td>string</td>
<td></td>
</tr>

<tr>

<td> </td>

<td>CEFormID</td>
<td>numeric</td>
<td></td>
</tr>

<tr>

<td> </td>

<td>CEFieldID</td>
<td>numeric</td>
<td></td>
</tr>

<tr>

<td class="required">optional</td>

<td>currTermPageIdList</td>
<td>string</td>
<td>[Default: ] </td>
</tr>

</table>

Taxonomy 1 0-getCSTaxObj

2010-04-09T13:57:59Z

Api:

__NOTOC__
Attention: Do not change any text in the description, signature, and paramter sections.

Return to [[Taxonomy_1_0]]

== Description ==
Returns the taxonomy object for a given taxonomy name

== Signature ==
public any <strong>getCSTaxObj</strong> ( string taxName )

== Parameters ==

<table id="lib-params">
<tr class="header">
<td>Required</td>
<td>Name</td>
<td>Type</td>
<td>Description</td>
</tr>

<tr>

<td class="required">required</td>

<td>taxName</td>
<td>string</td>
<td></td>
</tr>

</table>

Taxonomy 1 0-getCSTaxObj

2010-04-09T13:57:57Z

Api:

__NOTOC__
Attention: Do not change any text in the description, signature, and paramter sections.

Return to [[Taxonomy_1_0]]

== Description ==
[[taxonomy_1_0|Return to taxonomy_1_0]]

Returns the taxonomy object for a given taxonomy name

== Signature ==
public any <strong>getCSTaxObj</strong> ( string taxName )

== Parameters ==

<table id="lib-params">
<tr class="header">
<td>Required</td>
<td>Name</td>
<td>Type</td>
<td>Description</td>
</tr>

<tr>

<td class="required">required</td>

<td>taxName</td>
<td>string</td>
<td></td>
</tr>

</table>

Taxonomy 1 0

2010-04-09T13:57:55Z

Api:

__NOTOC__

Attention: Do not change any text in the description, properties, and functions sections.

Return to [[Library|Library (API)]]

== Description ==
Taxonomy functions for the ADF Library

== Properties ==
:version = 1_0_0
:wikiTitle = Taxonomy_1_0
:type = singleton

== Functions ==
<div id='library-api'>
:[[Taxonomy_1_0-getCSTaxObj|getCSTaxObj]] ( string taxName )
::Returns the taxonomy object for a given taxonomy name
:[[Taxonomy_1_0-getPageBindingsForTermID|getPageBindingsForTermID]] ( any csTaxObj, string TermID, string facet, numeric CEFormID, numeric CEFieldID, string currTermPageIdList )
:[[Taxonomy_1_0-getTermIDs|getTermIDs]] ( any csTaxObj, string termList )
::Returns a list of termIDs from a list of terms and a given initialized taxonomy object
:[[Taxonomy_1_0-getTopTermIDArrayForFacet|getTopTermIDArrayForFacet]] ( numeric facetID, numeric taxonomyID )
</div>

Taxonomy 1 0

2010-04-09T13:57:54Z

Api:

__NOTOC__

Attention: Do not change any text in the description, properties, and functions sections.

Return to [[Library|Library (API)]]

== Description ==
Taxonomy functions for the ADF Library

== Properties ==
:version = 1_0_0
:wikiTitle = Taxonomy_1_0
:type = singleton

== Functions ==
:[[taxonomy_1_0-getCSTaxObj|getCSTaxObj]]
::Returns the taxonomy object for a given taxonomy name

:[[taxonomy_1_0-getPageBindingsForTermID|getPageBindingsForTermID]]

:[[taxonomy_1_0-getTermIDs|getTermIDs]]
::Returns a list of termIDs from a list of terms and a given initialized taxonomy object

:[[taxonomy_1_0-getTopTermIDArrayForFacet|getTopTermIDArrayForFacet]]

Taxonomy 1 0

2010-04-09T13:57:51Z

Api:

__NOTOC__

Attention: Do not change any text in the description, properties, and functions sections.

Return to [[Library|Library (API)]]

== Description ==
Taxonomy functions for the ADF Library

== Properties ==
:version = 1_0_0
:type = singleton

== Functions ==
:[[taxonomy_1_0-getCSTaxObj|getCSTaxObj]]
::Returns the taxonomy object for a given taxonomy name

:[[taxonomy_1_0-getPageBindingsForTermID|getPageBindingsForTermID]]

:[[taxonomy_1_0-getTermIDs|getTermIDs]]
::Returns a list of termIDs from a list of terms and a given initialized taxonomy object

:[[taxonomy_1_0-getTopTermIDArrayForFacet|getTopTermIDArrayForFacet]]

ScriptsService 1 0-loadedScript

2010-04-09T13:57:43Z

Api:

__NOTOC__
Attention: Do not change any text in the description, signature, and paramter sections.

Return to [[ScriptsService_1_0]]

== Description ==

== Signature ==
public void <strong>loadedScript</strong> ( string scriptName )

== Parameters ==

<table id="lib-params">
<tr class="header">
<td>Required</td>
<td>Name</td>
<td>Type</td>
<td>Description</td>
</tr>

<tr>

<td class="required">required</td>

<td>scriptName</td>
<td>string</td>
<td></td>
</tr>

</table>

ScriptsService 1 0-isScriptLoaded

2010-04-09T13:57:35Z

Api:

__NOTOC__
Attention: Do not change any text in the description, signature, and paramter sections.

Return to [[ScriptsService_1_0]]

== Description ==

== Signature ==
public Boolean <strong>isScriptLoaded</strong> ( string scriptName )

== Parameters ==

<table id="lib-params">
<tr class="header">
<td>Required</td>
<td>Name</td>
<td>Type</td>
<td>Description</td>
</tr>

<tr>

<td class="required">required</td>

<td>scriptName</td>
<td>string</td>
<td></td>
</tr>

</table>

ScriptsService 1 0

2010-04-09T13:57:33Z

Api:

__NOTOC__

Attention: Do not change any text in the description, properties, and functions sections.

Return to [[Library|Library (API)]]

== Description ==
Scripts Service functions for the ADF Library

== Properties ==
:wikiTitle = ScriptsService_1_0
:type = singleton

== Functions ==
<div id='library-api'>
:[[ScriptsService_1_0-isScriptLoaded|isScriptLoaded]] ( string scriptName )
:[[ScriptsService_1_0-loadedScript|loadedScript]] ( string scriptName )
</div>

ScriptsService 1 0

2010-04-09T13:57:32Z

Api:

__NOTOC__

Attention: Do not change any text in the description, properties, and functions sections.

Return to [[Library|Library (API)]]

== Description ==
Scripts Service functions for the ADF Library

== Properties ==
:wikiTitle = ScriptsService_1_0
:type = singleton

== Functions ==
:[[ScriptsService_1_0-isScriptLoaded|isScriptLoaded]]

:[[ScriptsService_1_0-loadedScript|loadedScript]]

ScriptsService 1 0

2010-04-09T13:57:28Z

Api:

__NOTOC__

Attention: Do not change any text in the description, properties, and functions sections.

Return to [[Library|Library (API)]]

== Description ==
Scripts Service functions for the ADF Library

== Properties ==
:type = singleton

== Functions ==
:[[ScriptsService_1_0-isScriptLoaded|isScriptLoaded]]

:[[ScriptsService_1_0-loadedScript|loadedScript]]

Scripts 1 0-loadUsedKeyboard

2010-04-09T13:42:46Z

Api:

__NOTOC__
Attention: Do not change any text in the description, signature, and paramter sections.

Return to [[Scripts_1_0]]

== Description ==
Loads the used keyboard detection script for CFFormProtect if not already loaded.

== Signature ==
public void <strong>loadUsedKeyboard</strong> ( string version )

== Parameters ==

<table id="lib-params">
<tr class="header">
<td>Required</td>
<td>Name</td>
<td>Type</td>
<td>Description</td>
</tr>

<tr>

<td class="required">optional</td>

<td>version</td>
<td>string</td>
<td>[Default: 2.0.1] Used Keyboard script version to load.</td>
</tr>

</table>

Scripts 1 0-loadUsedKeyboard

2010-04-09T13:42:45Z

Api:

__NOTOC__
Attention: Do not change any text in the description, signature, and paramter sections.

Return to [[Scripts_1_0]]

== Description ==
[[Scripts_1_0|Return to Scripts_1_0]]

Loads the used keyboard detection script for CFFormProtect if not already loaded.

== Signature ==
public void <strong>loadUsedKeyboard</strong> ( string version )

== Parameters ==

<table id="lib-params">
<tr class="header">
<td>Required</td>
<td>Name</td>
<td>Type</td>
<td>Description</td>
</tr>

<tr>

<td class="required">optional</td>

<td>version</td>
<td>string</td>
<td>[Default: 2.0.1] Used Keyboard script version to load.</td>
</tr>

</table>

Scripts 1 0-loadThickbox

2010-04-09T13:42:41Z

Api:

__NOTOC__
Attention: Do not change any text in the description, signature, and paramter sections.

Return to [[Scripts_1_0]]

== Description ==
Loads the Thickbox Headers if not loaded.

== Signature ==
public void <strong>loadThickbox</strong> ( string version, boolean force )

== Parameters ==

<table id="lib-params">
<tr class="header">
<td>Required</td>
<td>Name</td>
<td>Type</td>
<td>Description</td>
</tr>

<tr>

<td class="required">optional</td>

<td>version</td>
<td>string</td>
<td>[Default: 3.1] JQuery version to load.</td>
</tr>

<tr>

<td> </td>

<td>force</td>
<td>boolean</td>
<td>[Default: 0] Forces JQuery script header to load.</td>
</tr>

</table>