com.filenet.wcm.toolkit.server.util
Class DeclareRecordsTemplate

java.lang.Object
  extended bycom.filenet.wcm.toolkit.server.util.BaseTemplate
      extended bycom.filenet.wcm.toolkit.server.util.DeclareRecordsTemplate

public class DeclareRecordsTemplate
extends BaseTemplate

Supplies functionality for creating, modifying, and maintaining the contents of an Declare Records Template and launching the specified workflow.


Field Summary
static java.lang.String CLASS_ID
          Declare Records Template Class Id
static WcmString CLASS_NAME
          Declare Records Template Class Name
protected static java.lang.String CLASSIFICATION_ID
           
static java.lang.String ELEM_CLASSIFICATION
           
static java.lang.String ELEM_CLASSIFICATIONS
           
static java.lang.String ELEM_OBJECTSET
           
static java.lang.String EMPTY_XML
          String represents empty XML response set
static java.lang.String INST_CLASSIFICATION_LIST_ACCESS
          String specifying to Classification page list view instruction.
static java.lang.String INST_CONSTRAIN_FOLDER
          String specifying to constrain user selecting a folder and its sub-folers only
static java.lang.String INST_FILE
          String specifying file section instruction.
static java.lang.String INST_FOLDER
          String specifying folder selection instruction.
static java.lang.String INST_PRIMARY_CLASSIFICATION
          String specifying primary classification id.
static java.lang.String INST_PROPERTIES
          String specifying properties selection instruction.
static java.lang.String INST_RECORD_CLASS_ACCESS
          String specifying to Classification page record class instruction.
static java.lang.String INST_RECORD_CLASSIFICATION
          String specifying to records template classifications page instruction
static java.lang.String INST_RECORD_PROPERTIES
          String specifying to records template properties page instruction.
static java.lang.String INST_RM_CLASSIFICATION
          String specifying RM classification instruction.
static java.lang.String INST_RM_CONSTRAIN_CLASSIFICATION
          String specifying to constrain user selecting a file plan or record folder and its sub-folers only
static java.lang.String INST_RM_STEPS_REQUIRED
          String specifying delcare document as record required.
static java.lang.String KEY
          Class's key
static java.lang.String MIME_TYPE
          Declare Records Template Mime type
static java.lang.String TEMPLATE_TYPE
          Template type
protected static WcmString wsClassificationID
           
protected static java.lang.String XPATH_CLASSIFICATION
           
protected static java.lang.String XPATH_CLASSIFICATIONS
           
 
Fields inherited from class com.filenet.wcm.toolkit.server.util.BaseTemplate
adp, doc, ELEM_DEFINED, ELEM_ENTRYTEMPLATE, ELEM_FILE, ELEM_INSTRUCTION, ELEM_INSTRUCTIONS, ELEM_NAME, ELEM_PROPERTIES, ELEM_PROPERTY, ELEM_STYLE, ELEM_TEMPLATETYPE, ELEM_TYPE, ELEM_VALUE, ELEM_VERSION, invalidChars, TYPE_CUSTOM_OBJECT, TYPE_DOCUMENT, TYPE_FOLDER, XPATH_CLASSDESC, XPATH_ENTRYTEMPLATE, XPATH_FILE, XPATH_FOLDER, XPATH_INSTNAME, XPATH_INSTRUCTION, XPATH_INSTRUCTIONS, XPATH_INSTVALUE, XPATH_OBJECTSTORE, XPATH_PROPDESCS, XPATH_PROPERTIES, XPATH_PROPERTY, XPATH_TEMPLATETYPE, XPATH_TYPE, XPATH_VERSION
 
Constructor Summary
DeclareRecordsTemplate()
           
 
Method Summary
 org.w3c.dom.Document getClassifications(WcmNavigationDataProvider ndp, java.lang.String[] props)
          return the classifications object back in term of Workplace required format.
 int getClassificationsCount()
          return the count of classifications.
protected  java.lang.String getTemplateName()
          Return the Declare Records Template name.
protected  java.lang.String prepareFolderSQLStatement(java.lang.String objectStoreName, java.lang.String[] props, java.lang.String[] folders)
          Return folder serarching query statement back.
protected  java.lang.String preparePropertyStatement(java.lang.String prefix, java.lang.String[] props)
          This method return query request property statement back with default of isHiddenContainer
protected static java.lang.String prepareWhereClause(java.lang.String prefix, java.lang.String[] folderIds)
          This method return folders query where clause back with default condition of IsHiddenContainer = false
 void setClassifications(org.w3c.dom.Document domClassifications)
          store classifications in template.
protected  org.w3c.dom.Document sortbyOriginalOrder(org.w3c.dom.Document domSource, java.lang.String[] folderIds)
          Resort classification back to original order
protected  org.w3c.dom.Document transformXML(org.w3c.dom.Document domSource, java.lang.String sName, java.lang.String name)
          Merge Record category identifier and Folder category identifier to a single field of classification id.
 
Methods inherited from class com.filenet.wcm.toolkit.server.util.BaseTemplate
addPropDescData, addPropDescData, checkInvalidChars, checkParam, doLoadFromId, doLoadFromStream, getClassDesc, getClassDescId, getClassDescName, getContents, getContents, getDocumentElement, getEntryTemplate, getFile, getFilePath, getFolder, getFolderId, getInstruction, getInstructions, getInstructionValue, getNormalizedDOM, getObjectStore, getObjectStoreName, getObjectTypeName, getPropDesc, getPropDescs, getPropDescsList, getPropDescsNormalized, getPropDescValue, getPropDescValue, getPropertiesNormalized, getPropertiesNormalized, getPropertiesNormalized, getPropertiesNormalized, getPropertiesNormalized, getPropertiesNormalized, getPropertiesNormalized, getPropertiesNormalized, getPropertiesNormalized, getPropertiesNormalized, getPropertiesNormalized, getPropertiesNormalized, getPropertyValue, getTemplateType, getType, getTypeName, removeChoicesList, replaceValue, setAuthoringDataProvider, setClassDesc, setFile, setFolder, setInstruction, setObjectStore, setPropDesc, setPropDescData, setPropDescData, setPropDescs, setPropDescValue, setPropDescValue, setTemplateType, setType, toXML, writeToFile
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

XPATH_CLASSIFICATIONS

protected static final java.lang.String XPATH_CLASSIFICATIONS
See Also:
Constant Field Values

XPATH_CLASSIFICATION

protected static final java.lang.String XPATH_CLASSIFICATION
See Also:
Constant Field Values

ELEM_CLASSIFICATIONS

public static final java.lang.String ELEM_CLASSIFICATIONS
See Also:
Constant Field Values

ELEM_CLASSIFICATION

public static final java.lang.String ELEM_CLASSIFICATION
See Also:
Constant Field Values

ELEM_OBJECTSET

public static final java.lang.String ELEM_OBJECTSET
See Also:
Constant Field Values

INST_RECORD_CLASSIFICATION

public static final java.lang.String INST_RECORD_CLASSIFICATION
String specifying to records template classifications page instruction

See Also:
Constant Field Values

INST_RECORD_PROPERTIES

public static final java.lang.String INST_RECORD_PROPERTIES
String specifying to records template properties page instruction.

See Also:
Constant Field Values

INST_RECORD_CLASS_ACCESS

public static final java.lang.String INST_RECORD_CLASS_ACCESS
String specifying to Classification page record class instruction.

See Also:
Constant Field Values

INST_CLASSIFICATION_LIST_ACCESS

public static final java.lang.String INST_CLASSIFICATION_LIST_ACCESS
String specifying to Classification page list view instruction.

See Also:
Constant Field Values

INST_PRIMARY_CLASSIFICATION

public static final java.lang.String INST_PRIMARY_CLASSIFICATION
String specifying primary classification id.

See Also:
Constant Field Values

EMPTY_XML

public static final java.lang.String EMPTY_XML
String represents empty XML response set

See Also:
Constant Field Values

wsClassificationID

protected static final WcmString wsClassificationID

CLASSIFICATION_ID

protected static final java.lang.String CLASSIFICATION_ID
See Also:
Constant Field Values

TEMPLATE_TYPE

public static final java.lang.String TEMPLATE_TYPE
Template type

See Also:
Constant Field Values

KEY

public static final java.lang.String KEY
Class's key

See Also:
Constant Field Values

INST_FOLDER

public static final java.lang.String INST_FOLDER
String specifying folder selection instruction.

See Also:
Constant Field Values

INST_PROPERTIES

public static final java.lang.String INST_PROPERTIES
String specifying properties selection instruction.

See Also:
Constant Field Values

INST_FILE

public static final java.lang.String INST_FILE
String specifying file section instruction.

See Also:
Constant Field Values

INST_CONSTRAIN_FOLDER

public static final java.lang.String INST_CONSTRAIN_FOLDER
String specifying to constrain user selecting a folder and its sub-folers only

See Also:
Constant Field Values

INST_RM_CONSTRAIN_CLASSIFICATION

public static final java.lang.String INST_RM_CONSTRAIN_CLASSIFICATION
String specifying to constrain user selecting a file plan or record folder and its sub-folers only

See Also:
Constant Field Values

INST_RM_STEPS_REQUIRED

public static final java.lang.String INST_RM_STEPS_REQUIRED
String specifying delcare document as record required.

See Also:
Constant Field Values

INST_RM_CLASSIFICATION

public static final java.lang.String INST_RM_CLASSIFICATION
String specifying RM classification instruction.

See Also:
Constant Field Values

MIME_TYPE

public static final java.lang.String MIME_TYPE
Declare Records Template Mime type

See Also:
Constant Field Values

CLASS_ID

public static final java.lang.String CLASS_ID
Declare Records Template Class Id

See Also:
Constant Field Values

CLASS_NAME

public static final WcmString CLASS_NAME
Declare Records Template Class Name

Constructor Detail

DeclareRecordsTemplate

public DeclareRecordsTemplate()
Method Detail

getTemplateName

protected java.lang.String getTemplateName()
Return the Declare Records Template name.

Overrides:
getTemplateName in class BaseTemplate
Returns:
an Declare Records Template element.

setClassifications

public void setClassifications(org.w3c.dom.Document domClassifications)
                        throws java.lang.Exception
store classifications in template. This method will not replace a classification if it is already in the template.

Parameters:
domClassifications - Classifications dom object
Throws:
java.lang.Exception

getClassificationsCount

public int getClassificationsCount()
                            throws java.lang.Exception
return the count of classifications.

Returns:
int classification's count.
Throws:
java.lang.Exception

getClassifications

public org.w3c.dom.Document getClassifications(WcmNavigationDataProvider ndp,
                                               java.lang.String[] props)
                                        throws java.lang.Exception
return the classifications object back in term of Workplace required format. This methods use input parameter, ndp to execute a serch retrieveing required properties from content server for ui display purpose

Parameters:
ndp - WcmNavigationDataProvider
Returns:
Classifications XML in DOM Format.
Throws:
java.lang.Exception

sortbyOriginalOrder

protected org.w3c.dom.Document sortbyOriginalOrder(org.w3c.dom.Document domSource,
                                                   java.lang.String[] folderIds)
                                            throws java.lang.Exception
Resort classification back to original order

Parameters:
domSource - Classification DOM object
folderIds - Classification Ids.
Returns:
sorted classification DOM object.
Throws:
java.lang.Exception

prepareFolderSQLStatement

protected java.lang.String prepareFolderSQLStatement(java.lang.String objectStoreName,
                                                     java.lang.String[] props,
                                                     java.lang.String[] folders)
Return folder serarching query statement back.

Parameters:
objectStoreName - object store name
props - required properties
folders - a list of folder id
Returns:
folder query statement

preparePropertyStatement

protected java.lang.String preparePropertyStatement(java.lang.String prefix,
                                                    java.lang.String[] props)
This method return query request property statement back with default of isHiddenContainer

Parameters:
prefix - table alias
props - a list of property
Returns:
query properties statement.

prepareWhereClause

protected static java.lang.String prepareWhereClause(java.lang.String prefix,
                                                     java.lang.String[] folderIds)
This method return folders query where clause back with default condition of IsHiddenContainer = false

Parameters:
prefix - table alias
folderIds - A list folder id
Returns:
query where statement

transformXML

protected org.w3c.dom.Document transformXML(org.w3c.dom.Document domSource,
                                            java.lang.String sName,
                                            java.lang.String name)
                                     throws java.lang.Exception
Merge Record category identifier and Folder category identifier to a single field of classification id.

Parameters:
domSource - Folder contents DOM object
Returns:
Merged property DOM object.
Throws:
java.lang.Exception


© Copyright IBM Corp. 2002, 2007. All Rights Reserved.