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

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

public class WcmEntryTemplate
extends BaseTemplate

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


Field Summary
static java.lang.String CLASS_ID
          Entry Template Class Id
static WcmString CLASS_NAME
          Entry Template Class Name
protected  WcmEProcessDataProvider edp
           
protected static java.lang.String ELEM_BEHAVIOR
           
protected static java.lang.String ELEM_CONVERT
           
protected static java.lang.String ELEM_RECORD
           
protected static java.lang.String ELEM_WEB
           
protected static java.lang.String ELEM_WORKFLOW
           
static java.lang.String INST_AUTO_CLASSIFY
          String specifying checkin document auto classify instruction.
static java.lang.String INST_CLASSIFYRECORD
          String specifying to classify record behavior.
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_PARTICIPANT
          String specifying to display participant selection instruction.
static java.lang.String INST_PROMPT_WORKFLOW
          String specifying to prompt before launching workflow instruction.
static java.lang.String INST_PROPERTIES
          String specifying properties selection instruction.
static java.lang.String INST_RECORDSTEMPLATE
          String specifying to records template are defined in template or not.
static java.lang.String INST_SECURITY
          String specifying security selection instruction.
static java.lang.String INST_USEFORCHECKIN
          String specifying that the entry template will be used for checkin.
static java.lang.String INST_WORKFLOW
          String specifying launch workflow instruction.
static java.lang.String KEY
          Class's key
static java.lang.String MIME_TYPE
          Entry Template Mime types (pre 3.0 release)
static java.lang.String MIME_TYPE_CUSTOMOBJECT
          Entry Template Mime type for add custom object
static java.lang.String MIME_TYPE_DOCUMENT
          Entry Template Mime type for add document
static java.lang.String MIME_TYPE_FOLDER
          Entry Template Mime type for add folder
static java.lang.String MIME_TYPE_FORMDATA
          Entry Template Mime type for add form data instance
static java.lang.String TEMPLATE_TYPE
          Template type
static java.lang.String TYPE_CUSTOM_OBJECT
          String representing a Custom Object object type.
static java.lang.String TYPE_DOCUMENT
          String representing a Document object type.
static java.lang.String TYPE_FOLDER
          String representing a Folder object type.
protected static java.lang.String XPATH_PERMISSIONS
           
protected static java.lang.String XPATH_RECORD
           
protected static java.lang.String XPATH_SECURITYPOLICY
           
protected static java.lang.String XPATH_STOREDSEARCH
           
protected static java.lang.String XPATH_WEB
           
protected static java.lang.String XPATH_WORKFLOW
           
 
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, 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
WcmEntryTemplate()
           
 
Method Summary
 java.lang.String addObject(com.filenet.wcm.api.TransportInputStream tis)
          Add the passed in content file to the Content Engine using the Entry Template specification If the object has no content, the input stream param will be null.
 java.lang.String addObject(com.filenet.wcm.api.TransportInputStream tis, java.lang.String mimeType)
          Add the passed in content file to the Content Engine using the Entry Template specification If the object has no content, the input stream param will be null.
protected  void checkInvalidChars(java.lang.String filename)
          Check for invalid file name characters
 org.w3c.dom.Document createWorkflow(java.lang.String attachmentName, java.lang.String attachmentId)
          Create the workflow specified in the Entry Template.
 void doLaunchWorkflow(java.lang.String objectStoreName, java.lang.String name, java.lang.String id, int type)
          Create and launches the workflow specified in the Entry Template.
 void doUpdateAndLaunchWorkflow(java.lang.String objectStoreName, java.lang.String name, java.lang.String id, int type, WcmWorkflowTemplate workflow)
          Create, update and launches the workflow specified in the Entry Template.
 void doUpdateWorkflow(java.lang.String objectStoreName, java.lang.String name, java.lang.String id, int type, WcmWorkflowTemplate workflow)
          Create and update the workflow specified in the Entry Template.
 void doUpdateWorkflowObject(java.lang.String objectStoreName, java.lang.String name, java.lang.String id, int type)
          Update the workflow object attachment created by the Entry Template with the running workflow number.
 org.w3c.dom.Node getPermission(java.lang.String granteeName)
          Return node of elements.
 org.w3c.dom.NodeList getPermissions()
          Return node list of elements.
 org.w3c.dom.Document getPermissionsNormalized()
          Return permissions xml in context on Buzz xml structure.
protected  org.w3c.dom.Document getPermissionsNormalized(java.lang.String typeName)
          Return permissions xml in context on Buzz xml structure.
 java.lang.String getRecordsTemplateId()
          Return the Id of Records Template
 java.lang.String getRecordsTemplateName()
          Return the name of Records Template
 java.lang.String getRecordsTemplateObjectStoreName()
          Return the name of RM Object Store from holding Object Store element
 org.w3c.dom.Node getSecurityPolicy()
          Return a Node holding security policy information
 java.lang.String getSecurityPolicyId()
          Return the Security Policy Id from node holding security policy information
 java.lang.String getSecurityPolicyName()
          Return the Security Policy Name from node holding security policy information
 org.w3c.dom.Node getStoredSearch()
          Returns the stored search node specified in the Entry Template.
protected  java.lang.String getTemplateName()
          Get or create a entry tempalte.
 org.w3c.dom.Node getVersion()
          Returns the version node specified in the Entry Template.
 boolean getVersionHidden()
          Returns the value of the hidden node in the Entry Template.
 boolean getVersionReadOnly()
          Returns the value of the readonly node in the Entry Template.
 java.lang.String getVersionValue()
          Returns the value of the version node in the Entry Template.
 org.w3c.dom.Node getWeb()
          Returns the web node specified in the Entry Template.
 java.lang.String getWebBehavior()
          Returns the value of the web/behavior node in the Entry Template.
 java.lang.String getWebConvert()
          Returns the value of the web/convert node in the Entry Template.
 java.lang.String getWebDefined()
          Returns the value of the web/defined node in the Entry Template.
 boolean getWebHidden()
          Returns the value of the hidden node in the Entry Template.
 boolean getWebReadOnly()
          Returns the value of the readonly node in the Entry Template.
 org.w3c.dom.Node getWorkflow()
          Return the node holding workflow informaiton.
 java.lang.String getWorkflowAttachmentId(java.lang.String objectStoreName, java.lang.String id, java.lang.String name, int type)
          Create the initating attachment Id in canonical format (multi-part key).
 java.lang.String getWorkflowId()
          Get the Id of the associated workflow
 java.lang.String getWorkflowName()
          Get the name of the associated workflow
 java.lang.String getWorkflowObjectStoreName()
          Get the Object Store name of the associated workflow
 java.lang.String getWorkflowStyle()
          Get the style of the associated workflow
 java.lang.String getWorkflowVersionSeriesId()
          Get the Version Series Id of the associated workflow
 boolean isPermissionUpgradeNeeded()
          Returns true if the entry template permissions xml needs to be upgrade to the latest schema.
 boolean isUIRequired()
          Returns true if the entry template requires some UI.
protected  boolean replaceValue(java.lang.String xPath, java.lang.String value)
          Replace element value with new value.
 void setEProcessDataProvider(WcmEProcessDataProvider dp)
          Set up the EProcess Data Provider.
 void setPermission(org.w3c.dom.Node permission)
          Add this node to permisssions node list
 void setPermissions(org.w3c.dom.NodeList permissionList)
          Set the permissions property that can be returned by getPropDescs call.
 void setRecordsManageData(java.lang.String templateId, java.lang.String label, java.lang.String objectStoreName)
          Set the Records Template's properties.
 void setSecurityPolicy(org.w3c.dom.Node securityPolicy)
          Set the security policy information
 void setSecurityPolicyData(java.lang.String id, java.lang.String name)
          Set the security policy information.
 void setStoredSearch(org.w3c.dom.Node storedSearch)
          Set the stored search information
 void setVersion(org.w3c.dom.Node version)
          Set the version information
 void setVersionData(java.lang.String value, boolean readonly, boolean hidden)
          Set the version data.
 void setWeb(org.w3c.dom.Node web)
          Set the web information
 void setWebData(java.lang.String defined, boolean readonly, boolean hidden)
          Set the web data.
 void setWebData(java.lang.String defined, java.lang.String convert, java.lang.String behavior)
          Set the web data.
 void setWebData(java.lang.String defined, java.lang.String convert, java.lang.String behavior, boolean readonly, boolean hidden)
          Set the web data.
 void setWorkflow(org.w3c.dom.Node workflow)
          Set the Workflow property.
 void setWorkflowData(java.lang.String osId, java.lang.String osName, java.lang.String id, java.lang.String vsId, java.lang.String name, java.lang.String style)
          Set each piece of data that specify the associated workflow
 void upgradePermissions()
          Upgrades to the latest permission XML schema.
 void upgradePermissions(org.w3c.dom.Document docGroups, org.w3c.dom.Document docUsers)
          Deprecated. Use the non parameter updatePermissions method.
 
Methods inherited from class com.filenet.wcm.toolkit.server.util.BaseTemplate
addPropDescData, addPropDescData, 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, 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

KEY

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

See Also:
Constant Field Values

TYPE_DOCUMENT

public static final java.lang.String TYPE_DOCUMENT
String representing a Document object type.

See Also:
Constant Field Values

TYPE_FOLDER

public static final java.lang.String TYPE_FOLDER
String representing a Folder object type.

See Also:
Constant Field Values

TYPE_CUSTOM_OBJECT

public static final java.lang.String TYPE_CUSTOM_OBJECT
String representing a Custom Object object type.

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_SECURITY

public static final java.lang.String INST_SECURITY
String specifying security 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_USEFORCHECKIN

public static final java.lang.String INST_USEFORCHECKIN
String specifying that the entry template will be used for checkin.

See Also:
Constant Field Values

INST_WORKFLOW

public static final java.lang.String INST_WORKFLOW
String specifying launch workflow instruction.

See Also:
Constant Field Values

INST_AUTO_CLASSIFY

public static final java.lang.String INST_AUTO_CLASSIFY
String specifying checkin document auto classify instruction.

See Also:
Constant Field Values

INST_PROMPT_WORKFLOW

public static final java.lang.String INST_PROMPT_WORKFLOW
String specifying to prompt before launching workflow instruction.

See Also:
Constant Field Values

INST_PARTICIPANT

public static final java.lang.String INST_PARTICIPANT
String specifying to display participant selection 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_RECORDSTEMPLATE

public static final java.lang.String INST_RECORDSTEMPLATE
String specifying to records template are defined in template or not.

See Also:
Constant Field Values

INST_CLASSIFYRECORD

public static final java.lang.String INST_CLASSIFYRECORD
String specifying to classify record behavior.

See Also:
Constant Field Values

TEMPLATE_TYPE

public static final java.lang.String TEMPLATE_TYPE
Template type

See Also:
Constant Field Values

MIME_TYPE

public static final java.lang.String MIME_TYPE
Entry Template Mime types (pre 3.0 release)

See Also:
Constant Field Values

MIME_TYPE_DOCUMENT

public static final java.lang.String MIME_TYPE_DOCUMENT
Entry Template Mime type for add document

See Also:
Constant Field Values

MIME_TYPE_FOLDER

public static final java.lang.String MIME_TYPE_FOLDER
Entry Template Mime type for add folder

See Also:
Constant Field Values

MIME_TYPE_CUSTOMOBJECT

public static final java.lang.String MIME_TYPE_CUSTOMOBJECT
Entry Template Mime type for add custom object

See Also:
Constant Field Values

MIME_TYPE_FORMDATA

public static final java.lang.String MIME_TYPE_FORMDATA
Entry Template Mime type for add form data instance

See Also:
Constant Field Values

CLASS_ID

public static final java.lang.String CLASS_ID
Entry Template Class Id

See Also:
Constant Field Values

CLASS_NAME

public static final WcmString CLASS_NAME
Entry Template Class Name


XPATH_PERMISSIONS

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

XPATH_RECORD

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

XPATH_SECURITYPOLICY

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

XPATH_WEB

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

XPATH_WORKFLOW

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

XPATH_STOREDSEARCH

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

ELEM_BEHAVIOR

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

ELEM_CONVERT

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

ELEM_RECORD

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

ELEM_WEB

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

ELEM_WORKFLOW

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

edp

protected WcmEProcessDataProvider edp
Constructor Detail

WcmEntryTemplate

public WcmEntryTemplate()
Method Detail

getTemplateName

protected java.lang.String getTemplateName()
Get or create a entry tempalte.

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

setEProcessDataProvider

public void setEProcessDataProvider(WcmEProcessDataProvider dp)
Set up the EProcess Data Provider. If this is not being set before calling doLoad.. method then those methods will throw.

Parameters:
dp - EProcess Data Provider

getRecordsTemplateObjectStoreName

public java.lang.String getRecordsTemplateObjectStoreName()
                                                   throws java.lang.Exception
Return the name of RM Object Store from holding Object Store element

Returns:
Object Store name.
Throws:
java.lang.Exception

getRecordsTemplateId

public java.lang.String getRecordsTemplateId()
                                      throws java.lang.Exception
Return the Id of Records Template

Returns:
Object Store name.
Throws:
java.lang.Exception

getRecordsTemplateName

public java.lang.String getRecordsTemplateName()
                                        throws java.lang.Exception
Return the name of Records Template

Returns:
Object Store name.
Throws:
java.lang.Exception

setRecordsManageData

public void setRecordsManageData(java.lang.String templateId,
                                 java.lang.String label,
                                 java.lang.String objectStoreName)
                          throws java.lang.Exception
Set the Records Template's properties.

Parameters:
templateId - Records Template id.
label - The template label.
objectStoreName - Object Store name.
Throws:
java.lang.Exception

getPermissions

public org.w3c.dom.NodeList getPermissions()
                                    throws java.lang.Exception
Return node list of elements.

Returns:
NodeList A node list of permissions.
Throws:
java.lang.Exception

getPermissionsNormalized

public org.w3c.dom.Document getPermissionsNormalized()
                                              throws java.lang.Exception
Return permissions xml in context on Buzz xml structure. The element structure looks somethings like:

Returns:
Document Normalized Docuemnt object.
Throws:
java.lang.Exception

getPermissionsNormalized

protected org.w3c.dom.Document getPermissionsNormalized(java.lang.String typeName)
                                                 throws java.lang.Exception
Return permissions xml in context on Buzz xml structure. The element structure looks somethings like:

Returns:
Document Normalized Docuemnt object.
Throws:
java.lang.Exception

setPermissions

public void setPermissions(org.w3c.dom.NodeList permissionList)
                    throws java.lang.Exception
Set the permissions property that can be returned by getPropDescs call. Remove previous permissions to avoid duplication.

Parameters:
permissionList - A node list of permission.
Throws:
java.lang.Exception

getPermission

public org.w3c.dom.Node getPermission(java.lang.String granteeName)
                               throws java.lang.Exception
Return node of elements.

Parameters:
granteeName - Grantee name.
Returns:
A node of permission.
Throws:
java.lang.Exception

setPermission

public void setPermission(org.w3c.dom.Node permission)
                   throws java.lang.Exception
Add this node to permisssions node list

Parameters:
permission - A node of permission.
Throws:
java.lang.Exception

isPermissionUpgradeNeeded

public boolean isPermissionUpgradeNeeded()
                                  throws java.lang.Exception
Returns true if the entry template permissions xml needs to be upgrade to the latest schema.

Returns:
true if permissions are from previous security model
Throws:
java.lang.Exception

upgradePermissions

public void upgradePermissions(org.w3c.dom.Document docGroups,
                               org.w3c.dom.Document docUsers)
                        throws java.lang.Exception
Deprecated. Use the non parameter updatePermissions method.

Upgrades to the latest permission XML schema.

Parameters:
docGroups - Groups XML
docUsers - Users XML
Throws:
java.lang.Exception

upgradePermissions

public void upgradePermissions()
                        throws java.lang.Exception
Upgrades to the latest permission XML schema.

Throws:
java.lang.Exception

getSecurityPolicy

public org.w3c.dom.Node getSecurityPolicy()
                                   throws java.lang.Exception
Return a Node holding security policy information

Returns:
Node Security policy node.
Throws:
java.lang.Exception

getSecurityPolicyId

public java.lang.String getSecurityPolicyId()
                                     throws java.lang.Exception
Return the Security Policy Id from node holding security policy information

Returns:
the security policy id.
Throws:
java.lang.Exception

getSecurityPolicyName

public java.lang.String getSecurityPolicyName()
                                       throws java.lang.Exception
Return the Security Policy Name from node holding security policy information

Returns:
the security policy name.
Throws:
java.lang.Exception

setSecurityPolicyData

public void setSecurityPolicyData(java.lang.String id,
                                  java.lang.String name)
                           throws java.lang.Exception
Set the security policy information.

Parameters:
id - Security Policy id.
name - Security Policy name.
Throws:
java.lang.Exception

setSecurityPolicy

public void setSecurityPolicy(org.w3c.dom.Node securityPolicy)
                       throws java.lang.Exception
Set the security policy information

Parameters:
securityPolicy - Node holding security policy information.
Throws:
java.lang.Exception

getStoredSearch

public org.w3c.dom.Node getStoredSearch()
                                 throws java.lang.Exception
Returns the stored search node specified in the Entry Template.

Returns:
Node Object stored search node.
Throws:
java.lang.Exception

setStoredSearch

public void setStoredSearch(org.w3c.dom.Node storedSearch)
                     throws java.lang.Exception
Set the stored search information

Parameters:
storedSearch - Node holding stored search information.
Throws:
java.lang.Exception

getVersion

public org.w3c.dom.Node getVersion()
                            throws java.lang.Exception
Returns the version node specified in the Entry Template.

Returns:
Node Object versioning node.
Throws:
java.lang.Exception

getVersionValue

public java.lang.String getVersionValue()
                                 throws java.lang.Exception
Returns the value of the version node in the Entry Template.

Returns:
String value of the version setting ("0" = Add as Major version (released), "1" = Add as Minor version (in process)).
Throws:
java.lang.Exception

getVersionReadOnly

public boolean getVersionReadOnly()
                           throws java.lang.Exception
Returns the value of the readonly node in the Entry Template.

Returns:
boolean read only setting (true = read only, false = can edit).
Throws:
java.lang.Exception

getVersionHidden

public boolean getVersionHidden()
                         throws java.lang.Exception
Returns the value of the hidden node in the Entry Template.

Returns:
String hidden setting (false = displayed, true = not displayed).
Throws:
java.lang.Exception

setVersion

public void setVersion(org.w3c.dom.Node version)
                throws java.lang.Exception
Set the version information

Parameters:
version - Node holding version information.
Throws:
java.lang.Exception

setVersionData

public void setVersionData(java.lang.String value,
                           boolean readonly,
                           boolean hidden)
                    throws java.lang.Exception
Set the version data.

Parameters:
value - String value of the version setting ("0" = Add as Major version (released), "1" = Add as Minor version (in process)).
readonly - boolean whether the value is editable?
hidden - boolean whether the value is hidden?
Throws:
java.lang.Exception

getWeb

public org.w3c.dom.Node getWeb()
                        throws java.lang.Exception
Returns the web node specified in the Entry Template.

Returns:
Node Object web node.
Throws:
java.lang.Exception

getWebDefined

public java.lang.String getWebDefined()
                               throws java.lang.Exception
Returns the value of the web/defined node in the Entry Template.

Returns:
String value for the Add to Web options ("0" = Use Default, "1" = User Defined).
Throws:
java.lang.Exception

getWebConvert

public java.lang.String getWebConvert()
                               throws java.lang.Exception
Returns the value of the web/convert node in the Entry Template.

Returns:
String value for the Convert document setting ("0" = No convertion, "1" = Yes, convert to HTML, "2" = Yes, convert to HTML and assign template).
Throws:
java.lang.Exception

getWebBehavior

public java.lang.String getWebBehavior()
                                throws java.lang.Exception
Returns the value of the web/behavior node in the Entry Template.

Returns:
String value for the Add to Web behavior ("0" = Next major release version only, "1" Automatically on every major release version).
Throws:
java.lang.Exception

getWebReadOnly

public boolean getWebReadOnly()
                       throws java.lang.Exception
Returns the value of the readonly node in the Entry Template.

Returns:
boolean read only setting (true = read only, false = can edit).
Throws:
java.lang.Exception

getWebHidden

public boolean getWebHidden()
                     throws java.lang.Exception
Returns the value of the hidden node in the Entry Template.

Returns:
String hidden setting (false = displayed, true = not displayed).
Throws:
java.lang.Exception

setWeb

public void setWeb(org.w3c.dom.Node web)
            throws java.lang.Exception
Set the web information

Parameters:
web - Node holding web information.
Throws:
java.lang.Exception

setWebData

public void setWebData(java.lang.String defined,
                       boolean readonly,
                       boolean hidden)
                throws java.lang.Exception
Set the web data.

Parameters:
defined - String value for the Add to Web options ("0" = Use Default, "1" = User Defined).
readonly - boolean whether the value is editable?
hidden - boolean whether the value is hidden?
Throws:
java.lang.Exception

setWebData

public void setWebData(java.lang.String defined,
                       java.lang.String convert,
                       java.lang.String behavior,
                       boolean readonly,
                       boolean hidden)
                throws java.lang.Exception
Set the web data.

Parameters:
defined - String value for the Add to Web options ("0" = Use Default, "1" = User Defined).
convert - String value for the Convert document setting ("0" = No convertion, "1" = Yes, convert to HTML, "2" = Yes, convert to HTML and assign template).
behavior - String value for the Add to Web behavior ("0" = Next major release version only, "1" Automatically on every major release version).
readonly - boolean whether the value is editable?
hidden - boolean whether the value is hidden?
Throws:
java.lang.Exception

setWebData

public void setWebData(java.lang.String defined,
                       java.lang.String convert,
                       java.lang.String behavior)
                throws java.lang.Exception
Set the web data.

Parameters:
defined - String value for the Add to Web options ("0" = Use Default, "1" = User Defined).
convert - String value for the Convert document setting ("0" = No convertion, "1" = Yes, convert to HTML, "2" = Yes, convert to HTML and assign template).
behavior - String value for the Add to Web behavior ("0" = Next major release version only, "1" Automatically on every major release version).
Throws:
java.lang.Exception

getWorkflow

public org.w3c.dom.Node getWorkflow()
                             throws java.lang.Exception
Return the node holding workflow informaiton.

Returns:
A node of workflow.
Throws:
java.lang.Exception

setWorkflow

public void setWorkflow(org.w3c.dom.Node workflow)
                 throws java.lang.Exception
Set the Workflow property.

Parameters:
workflow - Workflow node.
Throws:
java.lang.Exception

setWorkflowData

public void setWorkflowData(java.lang.String osId,
                            java.lang.String osName,
                            java.lang.String id,
                            java.lang.String vsId,
                            java.lang.String name,
                            java.lang.String style)
                     throws java.lang.Exception
Set each piece of data that specify the associated workflow

Parameters:
osId - Object Store id.
osName - Object Store name.
id - Workflow id.
vsId - Workflow version series id.
name - Workflow name.
style - Workflow style.
Throws:
java.lang.Exception

getWorkflowStyle

public java.lang.String getWorkflowStyle()
                                  throws java.lang.Exception
Get the style of the associated workflow

Returns:
String style
Throws:
java.lang.Exception

getWorkflowName

public java.lang.String getWorkflowName()
                                 throws java.lang.Exception
Get the name of the associated workflow

Returns:
String name
Throws:
java.lang.Exception

getWorkflowObjectStoreName

public java.lang.String getWorkflowObjectStoreName()
                                            throws java.lang.Exception
Get the Object Store name of the associated workflow

Returns:
String Object Store name
Throws:
java.lang.Exception

getWorkflowId

public java.lang.String getWorkflowId()
                               throws java.lang.Exception
Get the Id of the associated workflow

Returns:
String Id
Throws:
java.lang.Exception

getWorkflowVersionSeriesId

public java.lang.String getWorkflowVersionSeriesId()
                                            throws java.lang.Exception
Get the Version Series Id of the associated workflow

Returns:
String Version Series Id
Throws:
java.lang.Exception

addObject

public java.lang.String addObject(com.filenet.wcm.api.TransportInputStream tis)
                           throws java.lang.Exception
Add the passed in content file to the Content Engine using the Entry Template specification If the object has no content, the input stream param will be null.

Parameters:
tis - File input stream.
Returns:
Returns the id of the object just added.
Throws:
java.lang.Exception

addObject

public java.lang.String addObject(com.filenet.wcm.api.TransportInputStream tis,
                                  java.lang.String mimeType)
                           throws java.lang.Exception
Add the passed in content file to the Content Engine using the Entry Template specification If the object has no content, the input stream param will be null.

Parameters:
tis - File input stream.
mimeType - String holding mime type value.
Returns:
Returns the id of the object just added.
Throws:
java.lang.Exception

doLaunchWorkflow

public void doLaunchWorkflow(java.lang.String objectStoreName,
                             java.lang.String name,
                             java.lang.String id,
                             int type)
                      throws java.lang.Exception
Create and launches the workflow specified in the Entry Template. It will set the initiating attachment.

Parameters:
objectStoreName - Object Store id of initiating attachment object.
name - Object name of initiating attachment object.
id - Object id of initiating attachment object.
type - Object type of initiating attachment object.
Throws:
java.lang.Exception

doUpdateAndLaunchWorkflow

public void doUpdateAndLaunchWorkflow(java.lang.String objectStoreName,
                                      java.lang.String name,
                                      java.lang.String id,
                                      int type,
                                      WcmWorkflowTemplate workflow)
                               throws java.lang.Exception
Create, update and launches the workflow specified in the Entry Template. Any changes to the list of participants in a workflow group will be updated before being launched. It will set the initiating attachment. Also sets the running workflow number on the initiating attachment (typically added with the entry template wizard).

Parameters:
objectStoreName - Object Store id of initiating attachment object.
name - Object name of initiating attachment object.
id - Object id of initiating attachment object.
type - Object type of initiating attachment object.
workflow - Workflow Template Object used to update workflow.
Throws:
java.lang.Exception

doUpdateWorkflow

public void doUpdateWorkflow(java.lang.String objectStoreName,
                             java.lang.String name,
                             java.lang.String id,
                             int type,
                             WcmWorkflowTemplate workflow)
                      throws java.lang.Exception
Create and update the workflow specified in the Entry Template. Any changes to the list of participants in a workflow group will be updated. It will also set the initiating attachment information. The workflow is not launched.

Parameters:
objectStoreName - Object Store id of initiating attachment object.
name - Object name of initiating attachment object.
id - Object id of initiating attachment object.
type - Object type of initiating attachment object.
workflow - Workflow Template Object used to update workflow.
Throws:
java.lang.Exception

doUpdateWorkflowObject

public void doUpdateWorkflowObject(java.lang.String objectStoreName,
                                   java.lang.String name,
                                   java.lang.String id,
                                   int type)
                            throws java.lang.Exception
Update the workflow object attachment created by the Entry Template with the running workflow number.

Parameters:
objectStoreName - Object Store id of initiating attachment object.
name - Object name of initiating attachment object.
id - Object id of initiating attachment object.
type - Object type of initiating attachment object.
Throws:
java.lang.Exception

createWorkflow

public org.w3c.dom.Document createWorkflow(java.lang.String attachmentName,
                                           java.lang.String attachmentId)
                                    throws java.lang.Exception
Create the workflow specified in the Entry Template.

Parameters:
attachmentName - Attachment name property value
attachmentId - AttachmentId in canonical form
Returns:
org.w3c.dom.Document the created workflow xml.
Throws:
java.lang.Exception

getWorkflowAttachmentId

public java.lang.String getWorkflowAttachmentId(java.lang.String objectStoreName,
                                                java.lang.String id,
                                                java.lang.String name,
                                                int type)
                                         throws java.lang.Exception
Create the initating attachment Id in canonical format (multi-part key).

Parameters:
objectStoreName - Object Store id of initiating attachment object.
id - Object id of initiating attachment object.
name - Object name of initiating attachment object.
type - Object type of initiating attachment object.
Returns:
String attachment Id.
Throws:
java.lang.Exception

isUIRequired

public boolean isUIRequired()
                     throws java.lang.Exception
Returns true if the entry template requires some UI. The show/hide page instructions are used to determine if UI is required.

Returns:
boolean True to indicate the entry template requires some UI.
Throws:
java.lang.Exception

replaceValue

protected boolean replaceValue(java.lang.String xPath,
                               java.lang.String value)
                        throws java.lang.Exception
Replace element value with new value.

Overrides:
replaceValue in class BaseTemplate
Parameters:
xPath - XPath expression of node location.
value - New value.
Returns:
boolean Operation success or not.
Throws:
java.lang.Exception

checkInvalidChars

protected void checkInvalidChars(java.lang.String filename)
                          throws java.lang.Exception
Check for invalid file name characters

Overrides:
checkInvalidChars in class BaseTemplate
Parameters:
filename - File Name to check.
Throws:
java.lang.Exception


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