|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.filenet.wcm.toolkit.server.util.BaseTemplate
com.filenet.wcm.toolkit.server.util.WcmEntryTemplate
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 |
org.w3c.dom.NodeList |
getPermissions()
Return node list of |
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 java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
public static final java.lang.String KEY
public static final java.lang.String TYPE_DOCUMENT
public static final java.lang.String TYPE_FOLDER
public static final java.lang.String TYPE_CUSTOM_OBJECT
public static final java.lang.String INST_FOLDER
public static final java.lang.String INST_PROPERTIES
public static final java.lang.String INST_SECURITY
public static final java.lang.String INST_FILE
public static final java.lang.String INST_USEFORCHECKIN
public static final java.lang.String INST_WORKFLOW
public static final java.lang.String INST_AUTO_CLASSIFY
public static final java.lang.String INST_PROMPT_WORKFLOW
public static final java.lang.String INST_PARTICIPANT
public static final java.lang.String INST_CONSTRAIN_FOLDER
public static final java.lang.String INST_RECORDSTEMPLATE
public static final java.lang.String INST_CLASSIFYRECORD
public static final java.lang.String TEMPLATE_TYPE
public static final java.lang.String MIME_TYPE
public static final java.lang.String MIME_TYPE_DOCUMENT
public static final java.lang.String MIME_TYPE_FOLDER
public static final java.lang.String MIME_TYPE_CUSTOMOBJECT
public static final java.lang.String MIME_TYPE_FORMDATA
public static final java.lang.String CLASS_ID
public static final WcmString CLASS_NAME
protected static final java.lang.String XPATH_PERMISSIONS
protected static final java.lang.String XPATH_RECORD
protected static final java.lang.String XPATH_SECURITYPOLICY
protected static final java.lang.String XPATH_WEB
protected static final java.lang.String XPATH_WORKFLOW
protected static final java.lang.String XPATH_STOREDSEARCH
protected static final java.lang.String ELEM_BEHAVIOR
protected static final java.lang.String ELEM_CONVERT
protected static final java.lang.String ELEM_RECORD
protected static final java.lang.String ELEM_WEB
protected static final java.lang.String ELEM_WORKFLOW
protected WcmEProcessDataProvider edp
Constructor Detail |
public WcmEntryTemplate()
Method Detail |
protected java.lang.String getTemplateName()
getTemplateName
in class BaseTemplate
public void setEProcessDataProvider(WcmEProcessDataProvider dp)
dp
- EProcess Data Providerpublic java.lang.String getRecordsTemplateObjectStoreName() throws java.lang.Exception
java.lang.Exception
public java.lang.String getRecordsTemplateId() throws java.lang.Exception
java.lang.Exception
public java.lang.String getRecordsTemplateName() throws java.lang.Exception
java.lang.Exception
public void setRecordsManageData(java.lang.String templateId, java.lang.String label, java.lang.String objectStoreName) throws java.lang.Exception
templateId
- Records Template id.label
- The template label.objectStoreName
- Object Store name.
java.lang.Exception
public org.w3c.dom.NodeList getPermissions() throws java.lang.Exception
java.lang.Exception
public org.w3c.dom.Document getPermissionsNormalized() throws java.lang.Exception
java.lang.Exception
protected org.w3c.dom.Document getPermissionsNormalized(java.lang.String typeName) throws java.lang.Exception
java.lang.Exception
public void setPermissions(org.w3c.dom.NodeList permissionList) throws java.lang.Exception
permissionList
- A node list of permission.
java.lang.Exception
public org.w3c.dom.Node getPermission(java.lang.String granteeName) throws java.lang.Exception
granteeName
- Grantee name.
java.lang.Exception
public void setPermission(org.w3c.dom.Node permission) throws java.lang.Exception
permission
- A node of permission.
java.lang.Exception
public boolean isPermissionUpgradeNeeded() throws java.lang.Exception
java.lang.Exception
public void upgradePermissions(org.w3c.dom.Document docGroups, org.w3c.dom.Document docUsers) throws java.lang.Exception
docGroups
- Groups XMLdocUsers
- Users XML
java.lang.Exception
public void upgradePermissions() throws java.lang.Exception
java.lang.Exception
public org.w3c.dom.Node getSecurityPolicy() throws java.lang.Exception
java.lang.Exception
public java.lang.String getSecurityPolicyId() throws java.lang.Exception
java.lang.Exception
public java.lang.String getSecurityPolicyName() throws java.lang.Exception
java.lang.Exception
public void setSecurityPolicyData(java.lang.String id, java.lang.String name) throws java.lang.Exception
id
- Security Policy id.name
- Security Policy name.
java.lang.Exception
public void setSecurityPolicy(org.w3c.dom.Node securityPolicy) throws java.lang.Exception
securityPolicy
- Node holding security policy information.
java.lang.Exception
public org.w3c.dom.Node getStoredSearch() throws java.lang.Exception
java.lang.Exception
public void setStoredSearch(org.w3c.dom.Node storedSearch) throws java.lang.Exception
storedSearch
- Node holding stored search information.
java.lang.Exception
public org.w3c.dom.Node getVersion() throws java.lang.Exception
java.lang.Exception
public java.lang.String getVersionValue() throws java.lang.Exception
java.lang.Exception
public boolean getVersionReadOnly() throws java.lang.Exception
java.lang.Exception
public boolean getVersionHidden() throws java.lang.Exception
java.lang.Exception
public void setVersion(org.w3c.dom.Node version) throws java.lang.Exception
version
- Node holding version information.
java.lang.Exception
public void setVersionData(java.lang.String value, boolean readonly, boolean hidden) throws java.lang.Exception
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?
java.lang.Exception
public org.w3c.dom.Node getWeb() throws java.lang.Exception
java.lang.Exception
public java.lang.String getWebDefined() throws java.lang.Exception
java.lang.Exception
public java.lang.String getWebConvert() throws java.lang.Exception
java.lang.Exception
public java.lang.String getWebBehavior() throws java.lang.Exception
java.lang.Exception
public boolean getWebReadOnly() throws java.lang.Exception
java.lang.Exception
public boolean getWebHidden() throws java.lang.Exception
java.lang.Exception
public void setWeb(org.w3c.dom.Node web) throws java.lang.Exception
web
- Node holding web information.
java.lang.Exception
public void setWebData(java.lang.String defined, boolean readonly, boolean hidden) throws java.lang.Exception
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?
java.lang.Exception
public void setWebData(java.lang.String defined, java.lang.String convert, java.lang.String behavior, boolean readonly, boolean hidden) throws java.lang.Exception
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?
java.lang.Exception
public void setWebData(java.lang.String defined, java.lang.String convert, java.lang.String behavior) throws java.lang.Exception
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).
java.lang.Exception
public org.w3c.dom.Node getWorkflow() throws java.lang.Exception
java.lang.Exception
public void setWorkflow(org.w3c.dom.Node workflow) throws java.lang.Exception
workflow
- Workflow node.
java.lang.Exception
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
osId
- Object Store id.osName
- Object Store name.id
- Workflow id.vsId
- Workflow version series id.name
- Workflow name.style
- Workflow style.
java.lang.Exception
public java.lang.String getWorkflowStyle() throws java.lang.Exception
java.lang.Exception
public java.lang.String getWorkflowName() throws java.lang.Exception
java.lang.Exception
public java.lang.String getWorkflowObjectStoreName() throws java.lang.Exception
java.lang.Exception
public java.lang.String getWorkflowId() throws java.lang.Exception
java.lang.Exception
public java.lang.String getWorkflowVersionSeriesId() throws java.lang.Exception
java.lang.Exception
public java.lang.String addObject(com.filenet.wcm.api.TransportInputStream tis) throws java.lang.Exception
tis
- File input stream.
java.lang.Exception
public java.lang.String addObject(com.filenet.wcm.api.TransportInputStream tis, java.lang.String mimeType) throws java.lang.Exception
tis
- File input stream.mimeType
- String holding mime type value.
java.lang.Exception
public void doLaunchWorkflow(java.lang.String objectStoreName, java.lang.String name, java.lang.String id, int type) throws java.lang.Exception
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.
java.lang.Exception
public void doUpdateAndLaunchWorkflow(java.lang.String objectStoreName, java.lang.String name, java.lang.String id, int type, WcmWorkflowTemplate workflow) throws java.lang.Exception
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.
java.lang.Exception
public void doUpdateWorkflow(java.lang.String objectStoreName, java.lang.String name, java.lang.String id, int type, WcmWorkflowTemplate workflow) throws java.lang.Exception
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.
java.lang.Exception
public void doUpdateWorkflowObject(java.lang.String objectStoreName, java.lang.String name, java.lang.String id, int type) throws java.lang.Exception
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.
java.lang.Exception
public org.w3c.dom.Document createWorkflow(java.lang.String attachmentName, java.lang.String attachmentId) throws java.lang.Exception
attachmentName
- Attachment name property valueattachmentId
- AttachmentId in canonical form
java.lang.Exception
public java.lang.String getWorkflowAttachmentId(java.lang.String objectStoreName, java.lang.String id, java.lang.String name, int type) throws java.lang.Exception
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.
java.lang.Exception
public boolean isUIRequired() throws java.lang.Exception
java.lang.Exception
protected boolean replaceValue(java.lang.String xPath, java.lang.String value) throws java.lang.Exception
replaceValue
in class BaseTemplate
xPath
- XPath expression of node location.value
- New value.
java.lang.Exception
protected void checkInvalidChars(java.lang.String filename) throws java.lang.Exception
checkInvalidChars
in class BaseTemplate
filename
- File Name to check.
java.lang.Exception
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |