A.4 C

cacheCheckin

Called as a Java method by these services:

• CACHE_CHECKIN_NEW

• CACHE_CHECKIN_SEL

• CACHE_SUBMIT_HTML_FORM

• CACHE_WORKFLOW_CHECKIN

cacheTemplates

Caches templates. Called as a Java method by these services:

• Section 6.3.1, "ADD_WF_TEMPLATE"

• Section 6.3.2, "DELETE_WF_TEMPLATE"

• Section 6.3.3, "EDIT_WF_TEMPLATE"

cancelComponentInstall

Cancels the installation of a component. Called as a Java method by CANCEL_COMPONENT_INSTALL.

cancelCriteriaWorkflow

Cancels the criteria workflow and passes WfDocuments and Qdocuments as parameters. Called as a Java method by these services:

• CRITERIAWORKFLOW_DISABLE

• CRITERIAWORKFLOW_DISABLE_SUB

• DELETE_WORKFLOWCRITERIA

cancelSearchIndex

Cancels the search indexing session. Called as a Java method by CANCEL_SEARCH_INDEX.

cancelWorkflow

Cancels the workflow and passes WfDocuments and Qdocuments as parameters. Called as a Java method by DELETE_WORKFLOW and WORKFLOW_CANCEL.

canDeleteStep

Evaluates whether a workflow step can be deleted. Called as a Java method by DELETE_WORKFLOWSTEP.

checkCanCreateDocSecurity

Evaluates the assigned security level to verify that the user is authorized to perform this action. Called as a Java method by these services:

• CHECKIN_SEL_FORM

• CHECKOUT_SUB

• UNDO_CHECKOUT

• UNDO_CHECKOUT_BY_NAME

checkCollaborationAccess

Called as a Java method by these services:

• ADD_COLLABORATION

• ADD_COLLABORATION_FORM

• DELETE_COLLABORATION

• EDIT_CLBRA_ACCESS_LIST

• EDIT_CLBRA_ACCESS_LIST_FORM

• EDIT_COLLABORATION

• EDIT_COLLABORATION_FORM

• GET_CLBRA_DOCUMENTS

• GET_CLBRA_INFO

checkConversionCache

Called as a Java method by GET_DYNAMIC_CONVERSION_SUB.

checkCounters

Called as a Java method by INSERT_NATIVE.

checkCriteriaWorkflow

Evaluates the criteria workflow. Called as a Java method by these services:

• CHECKIN_BYNAME

• CHECKIN_NEW_SUB

• CHECKIN_SEL_SUB

checkDocRules

Evaluates the defined content item rules and passes checkout and isNotPublished as parameters. Called as a Java method by these services:

• CACHE_CHECKIN_NEW

• CHECKIN_NEW_SUB

• CHECKIN_SEL_FORM

• CHECKOUT_BY_NAME

• CHECKOUT_SUB

• GET_UPDATE_FORM

• UNDO_CHECKOUT

• UNDO_CHECKOUT_BY_NAME

• UPDATE_DOCINFO_SUB

checkDocState

Called as a Java method by ADD_WORKFLOWDOCUMENT_SUB.

checkForceLogin

Forces a log in. Called as a Java method by these services:

• GET_CLBRA_DOCUMENTS

• LOGIN

• PING_SERVER

• UPDATE_SUBSCRIPTION_NOTIFY

• UPDATE_SUBSCRIPTION_USED

checkForPublish

Called as a Java method by UPDATE_BYREV.

checkForRefreshingCachedResources

Called as a Java method by LOAD_RESOURCE_FILE.

checkInByID

Called as a Java method by CACHE_CHECKIN_SEL and CHECKIN_SEL_SUB.

checkInByName

Checks in the content item by name. Called as a Java method by CHECKIN_BYNAME.

checkIsLatestRev

Evaluates for the latest revision. Called as a Java method by CHECKOUT_BY_NAME and RESUBMIT_FOR_CONVERSION.

checkIsSelf

Checks whether the user is editing self. Called as a Java method by EDIT_USER_PROFILE.

checkParametersAgainstResultSet

Called as a Java method by DELETE_DOC.

checkProblemReportSecurity

Retrieves the data assigned to the parameter DOC_INFO and evaluates the problem report security information. Called as a Java method by these services:

• DELETE_PROBLEMREPORT

• GET_UPDATE_PROBLEMREPORT_FORM

• PROBLEMREPORT_INFO

• RESEND_PROBLEMREPORT

• UPDATE_PROBLEMREPORT

checkRefreshUsers

Updates the user information. Called as a Java method by these services:

• ADD_USER

• CHANGE_USER_AUTH_TYPE

• DELETE_USER

• EDIT_USER

• EDIT_USER_PROFILE

• REGISTER_USER

checkRevisionProperties

Retrieves the latest revision information and passes Qrevisions as a parameter. Called as a Java method by these services:

• CHECKIN_SEL_FORM

• CHECKOUT_OK

• CHECKOUT_SUB

• GET_UPDATE_FORM

checkSecurity

Retrieves the data assigned to the parameter DOC_INFO and evaluates the assigned security level to verify that the user is authorized to perform this action. The parameter varies by service. Called as a Java method by these services:

• ADD_PROBLEMREPORT

• ADD_WORKFLOW

• ADD_WORKFLOWALIASES

• ADD_WORKFLOWDOCUMENT

• ADD_WORKFLOWDOCUMENTS

• APPLET_DOCINFO

• CACHE_CHECKIN_NEW

• CACHE_CHECKIN_SEL

• CACHE_SUBMIT_HTML_FORM

• CACHE_WORKFLOW_CHECKIN

• CHECKIN_BYNAME

• CHECKIN_NEW

• CHECKIN_SEL

• CONTINUE_SUBMIT_HTML_FORM

• CONTINUE_CHECKIN

• CRITERIAWORKFLOW_DISABLE

• CRITERIAWORKFLOW_ENABLE

• DELETE_CHECKIN_CACHE

• DELETE_DOC

• DELETE_REV

• DELETE_REV_EX

• DELETE_WFCONTRIBUTORS

• DELETE_WORKFLOW

• DELETE_WORKFLOWCRITERIA

• DELETE_WORKFLOWDOCUMENTS

• DOC_INFO

• EDIT_WORKFLOW

• EDIT_WORKFLOWCRITERIA

• FORM_PROCESS

• GET_ARCHIVED_FILE

• GET_DOCUMENT_PROBLEMREPORTS

• GET_DYNAMIC_CONVERSION

• GET_EXTERNAL_DOC_INFO

• GET_EXTERNAL_HIGHLIGHT_INFO

• GET_EXTERNAL_XML_HIGHLIGHT_INFO

• GET_FILE

• GET_HIGHLIGHT_INFO

• GET_PREVIEW_LIST

• GET_PREVIEW_LIST_EX

• GET_UPDATE_FORM

• GET_WF_COMPANION_INFO

• GET_WORKFLOW_INFO

• GET_WORKFLOW_INFO_BYNAME

• GET_WORKFLOWDOCREVISIONS

• GET_WORKFLOWDOCUMENTS

• GET_XML_HIGHLIGHT_INFO

• LOAD_RESOURCE_FILE

• RESUBMIT_FOR_CONVERSION

• REV_HISTORY

• REVIEW_WORKFLOW_DOC

• SELECTDOC

• SUBMIT_HTML_FORM

• SUBSCRIBE

• UNSUBSCRIBE

• UPDATE_DOCINFO_SUB

• VALIDATE_DOCINFO

• VIEW_DOC

• WORKFLOW_APPROVE

• WORKFLOW_CANCEL

• WORKFLOW_CHECKIN

• WORKFLOW_REJECT

• WORKFLOW_REJECT_FORM

• WORKFLOW_START

checkSubAdmin

Checks if the user has the sub administrator role and passes a parameter, which varies depending which service is used. Called as a Java method by the following services:

• ADD_USER

• ADD_WORKFLOW

• ADD_WORKFLOW_SCRIPT

• ADD_WORKFLOW_TOKEN

• ADD_WORKFLOWALIASES

• ADD_WORKFLOWDOCUMENT

• ADD_WORKFLOWDOCUMENTS

• ADD_WORKFLOWSTEP

• CHANGE_USER_AUTH_TYPE

• CRITERIAWORKFLOW_DISABLE

• CRITERIAWORKFLOW_ENABLE

• DELETE_USER

• DELETE_WFCONTRIBUTORS

• DELETE_WORKFLOW

• DELETE_WORKFLOW_SCRIPT

• DELETE_WORKFLOW_TOKEN

• DELETE_WORKFLOWCRITERIA

• DELETE_WORKFLOWDOCUMENTS

• DELETE_WORKFLOWSTEP

• EDIT_USER

• EDIT_WORKFLOW

• EDIT_WORKFLOW_SCRIPT

• EDIT_WORKFLOW_TOKEN

• EDIT_WORKFLOWCRITERIA

• EDIT_WORKFLOWSTEP

• GET_ADMIN_PAGE

• GET_CRITERIA_WORKFLOWS_FOR_GROUP

• GET_PROJECT_INFO

• GET_PROJECT_REGISTRATION

• GET_REGISTEREDPROJECTS

• GET_USERS

• GET_WF_COMPANION_INFO

• GET_WORKFLOW_SCRIPT

• GET_WORKFLOWS_FOR_ALL

• PAGE_HANDLER

• QUERY_USER_ATTRIBUTES

• REGISTER_PROJECT

• UNREGISTER_PROJECT

• UPDATE_USEROPTION_LIST

• WORKFLOW_CANCEL

• WORKFLOW_START

checkUserAuthType

Called as a Java method by CHANGE_USER_AUTH_TYPE.

checkWorkflow

Checks workflow information by referencing WF_INFO and passes isNotActiveBasic as a parameter. Called as a Java method by these services:

• CACHE_CHECKIN_SEL

• CACHE_WORKFLOW_CHECKIN

• CHECKIN_BYNAME

• CHECKIN_SEL_SUB

• CHECKOUT_SUB

• DELETE_DOC

• DELETE_REV

• DELETE_REV_EX

• WORKFLOW_CHECKIN_SUB

• WORKFLOW_START

checkWorkflowAdminAccess

Called as a Java method by GET_WORKFLOWS.

computeCompanionDirectory

Called as a Java method by ADD_WORKFLOWDOCUMENT_SUB.

computeDeleteSecurity

Called as a Java method by DELETE_REV.

computeDocID

Computes the generated content item revision ID. Called as a Java method by these services:

• GET_ARCHIVED_FILE

• GET_DYNAMIC_CONVERSION

• GET_FILE

• LOAD_RESOURCE_FILE

computeDocInfoInHtmlPage

Evaluates the content information for the HTML page. Parameters vary by service. Called as a Java method by these services:

• CHECKIN_LIST

• CONTINUE_CHECKIN

• DELETE_CHECKIN_CACHE

• DOC_SUBS_LIST

• GET_EXPIRED

• SUBSCRIPTION_LIST

• UNSUBSCRIBE_FROM_LIST

• WORK_IN_PROGRESS

computeDocSubscribers

Evaluates the content item for subscribers. Called as a Java method by GET_DOC_SUBSCRIBERS.

computeProjectInfo

Computes project information. Called as a Java method by GET_PROJECT_INFO.

computeRejectTargetStep

Computes the reject target step. Called as a Java method by WORKFLOW_REJECT.

computeRemainingUsers

Called as a Java method by these services:

• GET_WORKFLOW_INFO

• GET_WORKFLOW_INFO_BYNAME

• WORKFLOW_REJECT

computeURLs

Evaluates URLS and passes REVISIONS as a parameter. Called as a Java method by REV_HISTORY.

computeWfDocumentsInfo

Evaluates the workflow content item information and passes WfDocuments as a parameter. Called as a Java method by GET_WORKFLOWDOCUMENTS.

conditionalDetermineCheckin

Prepares the form for check in. Called as a Java method by FORM_PROCESS.

continueCheckin

Called as a Java method by CONTINUE_CHECKIN.

controlIndexing

Executes the search indexing control. Called as a Java method by CONTROL_SEARCH_INDEX.

createAddEditProviderForm

Creates an Add/Edit provider form. Called as a Java method by GET_ADD_EDIT_PROVIDER_FORM.

createArchiveFileName

Creates the archive file name. Called as a Java method by GET_ARCHIVED_FILE.

createFileName

Creates a new file name. Called as a Java method by GET_FILE and LOAD_RESOURCE_FILE.

createNewRev

Called as a Java method by ADD_WORKFLOWDOCUMENT_SUB.

createResultSetSQL

Executes a query with parameters taken from the Data Binder (dataSource and whereClause local data) rather than from given parameters. It places the results in the local data using the ResultSet name found in the Data Binder (resultName). Called as a Java method by these services:

• CHECKIN_LIST

• CONTINUE_CHECKIN

• DELETE_CHECKIN_CACHE

• GET_ACTIVE_WORKFLOWS

• DOC_SUBS_LIST

• GET_CLBRA_DOCUMENTS

• GET_DATARESULTSET

• GET_EXPIRED

• GET_WORKFLOWS

• SUBSCRIBE_EX

• UNSUBSCRIBE_FROM_LIST_EX

• WORK_IN_PROGRESS

createSubscriptionType

Creates the subscription type. Called as a Java method by CREATE_SUBSCRIPTION_TYPE.

createWebFileNameFromRelativeUrl

Creates a Web file name from the provided relative URL and passes TEMPLATE_URL_INFO as a parameter. Called as a Java method by GET_DYNAMIC_URL.

createWorkflowID

Creates the workflow label. Called as a Java method by ADD_WORKFLOW.