|
Content Operations API | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectfilenet.contentops.ContentOperations
public class ContentOperations
Provides content operations on Content Engine and Content Manager repositories from Process Engine workflows.
This class is used by the IBM FileNet Component Integrator.
Constructor Summary | |
---|---|
ContentOperations()
|
Method Summary | |
---|---|
void |
applySecurityTemplate(filenet.vw.api.VWAttachment att,
java.lang.String templateGUID)
Applies a security template to an attachment. |
void |
applySecurityTemplateMany(filenet.vw.api.VWAttachment[] atts,
java.lang.String templateGUID)
Applies a security template to an array of homogeneous attachments. |
void |
changeClass(filenet.vw.api.VWAttachment att,
java.lang.String classId)
Changes the class of a supplied custom object, document or folder. |
filenet.vw.api.VWAttachment |
checkin(filenet.vw.api.VWAttachment att,
java.lang.String[] propArray,
java.lang.String fileName,
java.lang.String mimeType,
java.lang.String content)
Checks in an attached document as a new major version. |
void |
checkout(filenet.vw.api.VWAttachment att)
Checks out an attachment from a repository. |
filenet.vw.api.VWAttachment |
copy(filenet.vw.api.VWAttachment att,
boolean file)
Copies a document or custom object within the same repository. |
filenet.vw.api.VWAttachment[] |
copyMany(filenet.vw.api.VWAttachment[] atts,
boolean file)
Copies documents or custom objects within the same repository. |
filenet.vw.api.VWAttachment |
createCustomObject(filenet.vw.api.VWAttachment destFolder,
java.lang.String className,
java.lang.String[] propArray)
Creates a custom object using a specified class, and property values. |
filenet.vw.api.VWAttachment |
createDocument(filenet.vw.api.VWAttachment destFolder,
java.lang.String className,
java.lang.String[] propArray,
java.lang.String fileName,
java.lang.String mimeType,
java.lang.String content)
Creates a document using the specified class, properties, and content. |
filenet.vw.api.VWAttachment |
createFolder(filenet.vw.api.VWAttachment parentFolderAtt,
java.lang.String className,
java.lang.String[] propArray)
Creates a folder, either at the root of the object store or as a child of an attached folder. |
void |
delete(filenet.vw.api.VWAttachment objAtt)
Deletes the specified attachment. |
void |
deleteMany(filenet.vw.api.VWAttachment[] list)
Deletes an array of specified attachments. |
void |
file(filenet.vw.api.VWAttachment sourceDocument,
filenet.vw.api.VWAttachment destFolder)
Takes an object that is already in the repository and files it into a new folder. |
void |
fileMany(filenet.vw.api.VWAttachment folder,
filenet.vw.api.VWAttachment[] objects)
Files one or more objects (documents or custom objects) into a specified folder. |
java.lang.Boolean |
getBooleanProperty(filenet.vw.api.VWAttachment sourceDocument,
java.lang.String symbolicPropName)
Gets the Boolean value for the specified property from the specified document attachment. |
java.lang.String[] |
getContent(filenet.vw.api.VWAttachment att)
Gets the content of the attached document. |
java.util.Date |
getDateProperty(filenet.vw.api.VWAttachment sourceDocument,
java.lang.String symbolicPropName)
Gets the Date value for the specified property from the specified document attachment. |
java.lang.Double |
getDoubleProperty(filenet.vw.api.VWAttachment sourceDocument,
java.lang.String symbolicPropName)
Gets the Double value for the specified property from the specified document attachment. |
java.lang.Integer |
getIntegerProperty(filenet.vw.api.VWAttachment sourceDocument,
java.lang.String symbolicPropName)
Gets the Integer value for the specified property from the specified document attachment. |
java.lang.Boolean[] |
getMultiBooleanProperty(filenet.vw.api.VWAttachment objAtt,
java.lang.String propName)
Gets the Boolean values of a multivalued property. |
java.util.Date[] |
getMultiDateProperty(filenet.vw.api.VWAttachment objAtt,
java.lang.String propName)
Gets the Date values of a multivalued property. |
java.lang.Double[] |
getMultiDoubleProperty(filenet.vw.api.VWAttachment objAtt,
java.lang.String propName)
Gets the Double values of a multivalued property. |
java.lang.Integer[] |
getMultiIntegerProperty(filenet.vw.api.VWAttachment objAtt,
java.lang.String propName)
Gets the Integer values of a multivalued property. |
filenet.vw.api.VWAttachment[] |
getMultiObjectProperty(filenet.vw.api.VWAttachment objAtt,
java.lang.String propName)
Gets the object values of a multivalued property. |
java.lang.String[] |
getMultiStringProperty(filenet.vw.api.VWAttachment objAtt,
java.lang.String propName)
Gets the String values of a multivalued property. |
filenet.vw.api.VWAttachment |
getObjectProperty(filenet.vw.api.VWAttachment att,
java.lang.String propName)
Gets the object referenced by an attached object's object-valued property. |
filenet.vw.api.VWAttachment |
getObjFromPath(java.lang.String osName,
java.lang.String path,
java.lang.String objType)
Gets an object (custom object, folder or document) from a specified repository using a specified path. |
java.lang.String |
getStringProperty(filenet.vw.api.VWAttachment sourceDocument,
java.lang.String symbolicPropName)
Gets the String value for the specified property from the specified document attachment. |
java.lang.String |
getURLFromAttachment(filenet.vw.api.VWAttachment att,
java.lang.String baseURL)
Gets the URL for the document attachment. |
void |
move(filenet.vw.api.VWAttachment folder,
filenet.vw.api.VWAttachment object)
Moves the specified document or custom object from its existing folder to the specified folder (similar to an unfile and file operation). |
void |
moveMany(filenet.vw.api.VWAttachment folder,
filenet.vw.api.VWAttachment[] objects)
Moves the specified documents or custom objects from their existing folder to the specified folder (similar to an unfile and file operation). |
void |
PECMInit()
For FileNet internal use only. |
void |
PECMStop()
For FileNet internal use only. |
filenet.vw.api.VWAttachment |
publish(filenet.vw.api.VWAttachment sourceDocument,
filenet.vw.api.VWAttachment publishingTemplate)
Publishes the specified document attachment using the specified template. |
filenet.vw.api.VWAttachment[] |
searchForMany(filenet.vw.api.VWAttachment search,
java.lang.String objectType,
int[] itemIds,
java.lang.String[] values)
Executes the simple search template or stored search identified in an attachment, returning an array of objects matching the search criteria. |
filenet.vw.api.VWAttachment |
searchForOne(filenet.vw.api.VWAttachment search,
java.lang.String objectType,
int[] itemIds,
java.lang.String[] values)
Executes the simple search template or stored search identified in an attachment, returning the first object matching the search criteria. |
void |
sendMail(java.lang.String from,
java.lang.String to,
java.lang.String subject,
java.lang.String body)
Sends mail as text/plain with no attachment. |
void |
sendMailAttachment(java.lang.String from,
java.lang.String to,
java.lang.String subject,
java.lang.String body,
filenet.vw.api.VWAttachment[] att)
Sends mail with a document attachment. |
void |
sendMailTemplate(java.lang.String from,
java.lang.String to,
java.lang.String subject,
filenet.vw.api.VWAttachment template,
java.lang.String[] templateVals)
Sends mail using a template. |
void |
sendMailTemplateAttachment(java.lang.String from,
java.lang.String to,
java.lang.String subject,
filenet.vw.api.VWAttachment template,
java.lang.String[] templateVals,
filenet.vw.api.VWAttachment[] attList)
Sends mail using a template with a document attachment. |
void |
sendMailTemplateURL(java.lang.String from,
java.lang.String to,
java.lang.String subject,
filenet.vw.api.VWAttachment template,
java.lang.String[] templateVals,
filenet.vw.api.VWAttachment[] att,
java.lang.String workplaceUrl)
Sends mail using a template with the URLs of the attached documents appended to the end of the body of the email. |
void |
sendMailURL(java.lang.String from,
java.lang.String to,
java.lang.String subject,
java.lang.String body,
filenet.vw.api.VWAttachment[] att,
java.lang.String workplaceUrl)
Sends mail with the URLs of the attached documents appended to the end of the body of the email. |
void |
setBooleanProperty(filenet.vw.api.VWAttachment destDocument,
java.lang.String symbolicPropName,
java.lang.Boolean val)
Sets the Boolean value for the specified property on the specified document attachment. |
void |
setDateProperty(filenet.vw.api.VWAttachment destDocument,
java.lang.String symbolicPropName,
java.util.Date val)
Sets the Date value for the specified property on the specified document attachment. |
void |
setDoubleProperty(filenet.vw.api.VWAttachment destDocument,
java.lang.String symbolicPropName,
java.lang.Double val)
Sets the Double value for the specified property on the specified document attachment. |
void |
setIntegerProperty(filenet.vw.api.VWAttachment destDocument,
java.lang.String symbolicPropName,
java.lang.Integer val)
Sets the Integer value for the specified property on the specified document attachment. |
void |
setMultiBooleanProperty(filenet.vw.api.VWAttachment objAtt,
java.lang.String propName,
java.lang.Boolean[] values)
Sets the Boolean values of a multivalued property. |
void |
setMultiDateProperty(filenet.vw.api.VWAttachment objAtt,
java.lang.String propName,
java.util.Date[] values)
Sets the Date values of a multivalued property. |
void |
setMultiDoubleProperty(filenet.vw.api.VWAttachment objAtt,
java.lang.String propName,
java.lang.Double[] values)
Sets the Double values of a multivalued property. |
void |
setMultiIntegerProperty(filenet.vw.api.VWAttachment objAtt,
java.lang.String propName,
java.lang.Integer[] values)
Sets the Integer values of a multivalued property. |
void |
setMultiStringProperty(filenet.vw.api.VWAttachment objAtt,
java.lang.String propName,
java.lang.String[] values)
Sets the String values of a multivalued property. |
void |
setObjectProperty(filenet.vw.api.VWAttachment att,
java.lang.String propName,
filenet.vw.api.VWAttachment attVal)
Sets the object value of an object-valued property. |
void |
setStringProperty(filenet.vw.api.VWAttachment destDocument,
java.lang.String symbolicPropName,
java.lang.String val)
Sets the String value for the specified property on the specified document attachment. |
void |
unfile(filenet.vw.api.VWAttachment sourceDocument,
filenet.vw.api.VWAttachment fromFolder)
Unfiles the specified document attachment from the specified folder. |
Methods inherited from class java.lang.Object |
---|
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public ContentOperations()
Method Detail |
---|
public void sendMail(java.lang.String from, java.lang.String to, java.lang.String subject, java.lang.String body) throws java.lang.Exception
from
- A String containing the email address of the sender.to
- A String containing the email address(es) to which the email is to be sent. Separate multiple
addresses with commas.subject
- A String containing the subject of the email.body
- A String containing the body (text/plain) for the email.
java.lang.Exception
public void sendMailAttachment(java.lang.String from, java.lang.String to, java.lang.String subject, java.lang.String body, filenet.vw.api.VWAttachment[] att) throws java.lang.Exception
from
- A String containing the email address of the sender.to
- A String containing the email address(es) to which the email is to be sent. Separate multiple
addresses with commas.subject
- A String containing the subject of the email.body
- A String containing the body (text/plain) for the email.att
- An array of VWAttachment objects identifying the documents for the the email MIME attachments.
java.lang.Exception
public void sendMailTemplate(java.lang.String from, java.lang.String to, java.lang.String subject, filenet.vw.api.VWAttachment template, java.lang.String[] templateVals) throws java.lang.Exception
from
- A String containing the email address of the sender.to
- A String containing the email address or addresses to which the email is to be sent. Separate multiple
addresses with commas.subject
- A String containing the subject of the email.template
- A VWAttachment object identifying the template to use for the body of the email.templateVals
- A String array containing the replacement values to use for the template.
java.lang.Exception
public void sendMailTemplateAttachment(java.lang.String from, java.lang.String to, java.lang.String subject, filenet.vw.api.VWAttachment template, java.lang.String[] templateVals, filenet.vw.api.VWAttachment[] attList) throws java.lang.Exception
from
- A String containing the email address of the sender.to
- A String containing the email address or addresses to which the email is to be sent. Separate multiple
addresses with commas.subject
- A String containing the subject of the email.template
- A VWAttachment object identifying the template to use for the body of the email.templateVals
- A String array containing the replacement values to use for the template.attList
- An array of VWAttachment objects identifying the documents for the the email MIME attachments.
java.lang.Exception
public void sendMailTemplateURL(java.lang.String from, java.lang.String to, java.lang.String subject, filenet.vw.api.VWAttachment template, java.lang.String[] templateVals, filenet.vw.api.VWAttachment[] att, java.lang.String workplaceUrl) throws java.lang.Exception
from
- A String containing the email address of the sender.to
- A String containing the email address or addresses to which the email is to be sent. Separate
multiple addresses with commas.subject
- A String containing the subject of the email.template
- A VWAttachment object containing the template to use for the body of the email.templateVals
- A String array containing the replacement values to use for the template.att
- An array of VWAttachment objects identifying the documents for the the email MIME attachments.workplaceUrl
- A String containing the base Workplace URL to use for the document attachment
(such as, http://hqdemo:8080/Workplace).
java.lang.Exception
public void sendMailURL(java.lang.String from, java.lang.String to, java.lang.String subject, java.lang.String body, filenet.vw.api.VWAttachment[] att, java.lang.String workplaceUrl) throws java.lang.Exception
from
- A String containing the email address of the sender.to
- A String containing the email address(es) to which the email is to be sent. Separate multiple
addresses with commas.subject
- A String containing the subject of the email.body
- A String containing the body (text/plain) for the email.att
- An array of VWAttachment objects identifying the documents for the the email MIME attachments.workplaceUrl
- A String containing the base Workplace URL to use for the attachment
(such as, http://hqdemo:8080/Workplace).
java.lang.Exception
public java.lang.Boolean getBooleanProperty(filenet.vw.api.VWAttachment sourceDocument, java.lang.String symbolicPropName) throws java.lang.Exception
getBooleanProperty
in interface filenet.contentops.IContentOperations
sourceDocument
- A VWAttachment object for the document attachment.symbolicPropName
- A String containing the symbolic name of the document property. The property must be
of type Boolean.
java.lang.Exception
- Throws WcmException, PropertyNotFoundException when the requested property is not of
type Boolean.public java.util.Date getDateProperty(filenet.vw.api.VWAttachment sourceDocument, java.lang.String symbolicPropName) throws java.lang.Exception
getDateProperty
in interface filenet.contentops.IContentOperations
sourceDocument
- A VWAttachment object for the document attachment.symbolicPropName
- A String containing the symbolic name of the document property. The property must be
of type Date.
java.lang.Exception
- Throws WcmException, PropertyNotFoundException when the requested property is not of
type Date.public java.lang.Double getDoubleProperty(filenet.vw.api.VWAttachment sourceDocument, java.lang.String symbolicPropName) throws java.lang.Exception
getDoubleProperty
in interface filenet.contentops.IContentOperations
sourceDocument
- A VWAttachment object for the document attachment.symbolicPropName
- A String containing the symbolic name of the document property. The property must be
of type Double.
java.lang.Exception
- Throws WcmException, PropertyNotFoundException when the requested property is not of
type Double.public java.lang.Integer getIntegerProperty(filenet.vw.api.VWAttachment sourceDocument, java.lang.String symbolicPropName) throws java.lang.Exception
getIntegerProperty
in interface filenet.contentops.IContentOperations
sourceDocument
- A VWAttachment object for the document attachment.symbolicPropName
- A String containing the symbolic name of the document property. The property must be
of type Integer.
java.lang.Exception
- Throws WcmException, PropertyNotFoundException when the requested property is not of
type Integer.public java.lang.String getStringProperty(filenet.vw.api.VWAttachment sourceDocument, java.lang.String symbolicPropName) throws java.lang.Exception
getStringProperty
in interface filenet.contentops.IContentOperations
sourceDocument
- A VWAttachment object for the document attachment.symbolicPropName
- A String containing the symbolic name of the document property. The property must be
of type String.
java.lang.Exception
- Throws WcmException, PropertyNotFoundException when the requested property is not of
type String.public java.lang.String getURLFromAttachment(filenet.vw.api.VWAttachment att, java.lang.String baseURL) throws java.lang.Exception
getURLFromAttachment
in interface filenet.contentops.IContentOperations
att
- A VWAttachment object containing the information for the document attachment.baseURL
- A String containing the base Workplace URL (such as, http://hqdemo:8080/Workplace).
java.lang.Exception
public void setBooleanProperty(filenet.vw.api.VWAttachment destDocument, java.lang.String symbolicPropName, java.lang.Boolean val) throws java.lang.Exception
setBooleanProperty
in interface filenet.contentops.IContentOperations
destDocument
- A VWAttachment object for the document attachment.symbolicPropName
- A String containing the symbolic name of the property on destDocument.
The property must be of type Boolean.val
- The Boolean value to assign to the property specified in symbolicPropName.
java.lang.Exception
- Throws WcmException when the requested property is not of type Boolean.public void setDateProperty(filenet.vw.api.VWAttachment destDocument, java.lang.String symbolicPropName, java.util.Date val) throws java.lang.Exception
setDateProperty
in interface filenet.contentops.IContentOperations
destDocument
- A VWAttachment object for the document attachment.symbolicPropName
- A String containing the symbolic name of the property on destDocument.
The property must be of type Date.val
- The Date value to assign to the property specified in symbolicPropName.
java.lang.Exception
- Throws WcmException when the requested property is not of type Date.public void setDoubleProperty(filenet.vw.api.VWAttachment destDocument, java.lang.String symbolicPropName, java.lang.Double val) throws java.lang.Exception
setDoubleProperty
in interface filenet.contentops.IContentOperations
destDocument
- A VWAttachment object for the document attachment.symbolicPropName
- A String containing the symbolic name of the property on destDocument.
The property must be of type Double.val
- The Double value to assign to the property specified in symbolicPropName.
java.lang.Exception
- Throws WcmException when the requested property is not of type Double.public void setIntegerProperty(filenet.vw.api.VWAttachment destDocument, java.lang.String symbolicPropName, java.lang.Integer val) throws java.lang.Exception
setIntegerProperty
in interface filenet.contentops.IContentOperations
destDocument
- A VWAttachment object for the document attachment.symbolicPropName
- A String containing the symbolic name of the property on destDocument.
The property must be of type Integer.val
- The Integer value to assign to the property specified in symbolicPropName.
java.lang.Exception
- Throws WcmException when the requested property is not of type Integer.public void setStringProperty(filenet.vw.api.VWAttachment destDocument, java.lang.String symbolicPropName, java.lang.String val) throws java.lang.Exception
setStringProperty
in interface filenet.contentops.IContentOperations
destDocument
- A VWAttachment object for the document attachment.symbolicPropName
- A String containing the symbolic name of the property on destDocument.
The property must be of type String.val
- The String value to assign to the property specified in symbolicPropName.
java.lang.Exception
- Throws WcmException when the requested property is not of type String.public void file(filenet.vw.api.VWAttachment sourceDocument, filenet.vw.api.VWAttachment destFolder) throws java.lang.Exception
Note: Multiple requests to file the document in the same folder will be ignored, although the requests will appear to be successful.
file
in interface filenet.contentops.IContentOperations
sourceDocument
- A VWAttachment object for the document attachment to file.destFolder
- A VWAttachment object for the folder in which to file the document.
java.lang.Exception
public void unfile(filenet.vw.api.VWAttachment sourceDocument, filenet.vw.api.VWAttachment fromFolder) throws java.lang.Exception
Note: Multiple requests to unfile the document in the same folder will be ignored, although the requests will appear to be successful.
unfile
in interface filenet.contentops.IContentOperations
sourceDocument
- A VWAttachment object for the document attachment to unfile.fromFolder
- A VWAttachment object for the folder in which the document is filed.
java.lang.Exception
public filenet.vw.api.VWAttachment publish(filenet.vw.api.VWAttachment sourceDocument, filenet.vw.api.VWAttachment publishingTemplate) throws java.lang.Exception
publish
in interface filenet.contentops.IContentOperations
sourceDocument
- A VWAttachment object for the document attachment to file.publishingTemplate
- A VWAttachment object for the publishing template to use.
Note: The publishing template may not immediately return the published document. In this case, the return value can be null until the publishing template completes the operation.
java.lang.Exception
public void applySecurityTemplate(filenet.vw.api.VWAttachment att, java.lang.String templateGUID) throws java.lang.Exception
applySecurityTemplate
in interface filenet.contentops.IContentOperations
att
- A VWAttachment object (document type only) identifying the document to which to apply the security template.
This document must be associated with a security policy.templateGUID
- A String containing the GUID of a custom/application template. The template must be
associated with the same security policy as the attached document.
java.lang.Exception
public void applySecurityTemplateMany(filenet.vw.api.VWAttachment[] atts, java.lang.String templateGUID) throws java.lang.Exception
applySecurityTemplateMany
in interface filenet.contentops.IContentOperations
atts
- An array of VWAttachment objects (document type only) identifying the objects to which to apply
the security template. These objects must be associated with a security policy.templateGUID
- A String containing the GUID of a custom/application template. The template must be
associated with the same security policy as the attached objects.
java.lang.Exception
public void changeClass(filenet.vw.api.VWAttachment att, java.lang.String classId) throws java.lang.Exception
changeClass
in interface filenet.contentops.IContentOperations
att
- A VWAttachment object for the class to change. The object can be a custom object, folder or
document.classId
- A String containing the class ID for the new class to apply. The new class must be of the
same type (custom object, document or folder) as the object's previous class.
java.lang.Exception
public filenet.vw.api.VWAttachment checkin(filenet.vw.api.VWAttachment att, java.lang.String[] propArray, java.lang.String fileName, java.lang.String mimeType, java.lang.String content) throws java.lang.Exception
checkin
in interface filenet.contentops.IContentOperations
att
- A VWAttachment object (document or custom object) for the document to check in.
This document must already be checked out.propArray
- A String array of properties (if any) to apply to the new document version. If no
properties need to be set, specify a null string {""} as an empty set.fileName
- A String containing the file name for the attached document.mimeType
- A String containing the MIME type for any new content specified.content
- A String containing the content of the new version. For newlines, use "\n".
java.lang.Exception
public void checkout(filenet.vw.api.VWAttachment att) throws java.lang.Exception
checkout
in interface filenet.contentops.IContentOperations
att
- A VWAttachment object (document or custom object) for the document to check out.
This document must not currently be checked out.
java.lang.Exception
public filenet.vw.api.VWAttachment copy(filenet.vw.api.VWAttachment att, boolean file) throws java.lang.Exception
Note: If a document is specified, only the first content element is copied.
copy
in interface filenet.contentops.IContentOperations
att
- A VWAttachment object for the attached document or custom object to copy.file
- A boolean value. If true, the object copy will be filed into the same folder as the
originating object. If false, the object copy will not be filed at all.
java.lang.Exception
public filenet.vw.api.VWAttachment[] copyMany(filenet.vw.api.VWAttachment[] atts, boolean file) throws java.lang.Exception
Note: If documents are specified, only the first content element in each document is copied.
copyMany
in interface filenet.contentops.IContentOperations
atts
- An array of VWAttachment objects for the attached documents or custom objects to copy.file
- A boolean value. If true, the object copies will be filed into the same folder as the
originating objects. If false, the object copies will not be filed at all.
java.lang.Exception
public filenet.vw.api.VWAttachment createCustomObject(filenet.vw.api.VWAttachment destFolder, java.lang.String className, java.lang.String[] propArray) throws java.lang.Exception
createCustomObject
in interface filenet.contentops.IContentOperations
destFolder
- A VWAttachment object identifying the folder in which to create the new custom object.className
- A String containing the class name to use for the new custom object.propArray
- A String array containing the value pairs specifying the properties for the new
custom object. The format is: {propName1, dataType1, propValue1, propName2, dataType2, ...}.
java.lang.Exception
public filenet.vw.api.VWAttachment createDocument(filenet.vw.api.VWAttachment destFolder, java.lang.String className, java.lang.String[] propArray, java.lang.String fileName, java.lang.String mimeType, java.lang.String content) throws java.lang.Exception
createDocument
in interface filenet.contentops.IContentOperations
destFolder
- A VWAttachment object identifying the folder in which to create the new document.className
- A String containing the class name to use for the new document.propArray
- A String array containing the value pairs specifying the properties for the new
document. The format is: {propName1, dataType1, propValue1, propName2, dataType2, ...}.fileName
- A String containing the file name for the new document.mimeType
- A String containing the MIME type (such as, text/plain or text/xml) for the new content
specified.content
- A String containing the content of the new document. For newlines, use "\n".
java.lang.Exception
public filenet.vw.api.VWAttachment createFolder(filenet.vw.api.VWAttachment parentFolderAtt, java.lang.String className, java.lang.String[] propArray) throws java.lang.Exception
createFolder
in interface filenet.contentops.IContentOperations
parentFolderAtt
- A VWAttachment object identifying the parent location of the new folder.
If the desired location of the child folder is at the top of the object store, specify "||0|0||".
This represents an empty attachment.className
- A String containing the class name to use for the new folder.propArray
- A String array containing the value pairs specifying the properties for the new
folder. The format is: {propName1, dataType1, propValue1, propName2, dataType2, ...}. Note: The
folder name property must be set.
java.lang.Exception
public void delete(filenet.vw.api.VWAttachment objAtt) throws java.lang.Exception
delete
in interface filenet.contentops.IContentOperations
objAtt
- A VWAttachment object (custom object, document, or folder) identifying the object to delete.
java.lang.Exception
public void deleteMany(filenet.vw.api.VWAttachment[] list) throws java.lang.Exception
deleteMany
in interface filenet.contentops.IContentOperations
list
- An array of VWAttachment objects (custom object, document, or folder) to delete.
java.lang.Exception
public void fileMany(filenet.vw.api.VWAttachment folder, filenet.vw.api.VWAttachment[] objects) throws java.lang.Exception
fileMany
in interface filenet.contentops.IContentOperations
folder
- A VWAttachment object identifying the folder in which to file the object or objects.objects
- An array of VWAttachment objects identifying the objects to file.
java.lang.Exception
public java.lang.String[] getContent(filenet.vw.api.VWAttachment att) throws java.lang.Exception
getContent
in interface filenet.contentops.IContentOperations
att
- A VWAttachment object (custom object or document) from which the content is retrieved.
java.lang.Exception
public filenet.vw.api.VWAttachment getObjFromPath(java.lang.String osName, java.lang.String path, java.lang.String objType) throws java.lang.Exception
getObjFromPath
in interface filenet.contentops.IContentOperations
osName
- A String containing the name or GUID of the repository storing the object.path
- A String containing the path of the desired object (such as,
"/MyFolder/Mydoc.doc").objType
- A String containing the name of the object type. This must be one of the following:
"custom object", "document" or "folder".
java.lang.Exception
public filenet.vw.api.VWAttachment getObjectProperty(filenet.vw.api.VWAttachment att, java.lang.String propName) throws java.lang.Exception
An object-valued property is a property that has as its value a reference to an object.
getObjectProperty
in interface filenet.contentops.IContentOperations
att
- A VWAttachment object identifying the object having the object-valued property.propName
- A String containing the name of the object-valued property.
java.lang.Exception
- Throws WcmException, PropertyNotFoundException if the specified property name is not
found.public java.lang.Boolean[] getMultiBooleanProperty(filenet.vw.api.VWAttachment objAtt, java.lang.String propName) throws java.lang.Exception
getMultiBooleanProperty
in interface filenet.contentops.IContentOperations
objAtt
- A VWAttachment object identifying the object having the multivalued property.propName
- A String containing the name of the multivalued property.
java.lang.Exception
- Throws WcmException, PropertyNotFoundException if the specified property name is not
found.public java.util.Date[] getMultiDateProperty(filenet.vw.api.VWAttachment objAtt, java.lang.String propName) throws java.lang.Exception
getMultiDateProperty
in interface filenet.contentops.IContentOperations
objAtt
- A VWAttachment object identifying the object having the multivalued property.propName
- A String containing the name of the multivalued property.
java.lang.Exception
- Throws WcmException, PropertyNotFoundException if the specified property name is not
found.public java.lang.Double[] getMultiDoubleProperty(filenet.vw.api.VWAttachment objAtt, java.lang.String propName) throws java.lang.Exception
getMultiDoubleProperty
in interface filenet.contentops.IContentOperations
objAtt
- A VWAttachment object identifying the object having the multivalued property.propName
- A String containing the name of the multivalued property.
java.lang.Exception
- Throws WcmException, PropertyNotFoundException if the specified property name is not
found.public java.lang.Integer[] getMultiIntegerProperty(filenet.vw.api.VWAttachment objAtt, java.lang.String propName) throws java.lang.Exception
getMultiIntegerProperty
in interface filenet.contentops.IContentOperations
objAtt
- A VWAttachment object identifying the object having the multivalued property.propName
- A String containing the name of the multivalued property.
java.lang.Exception
- Throws WcmException, PropertyNotFoundException if the specified property name is not
found.public filenet.vw.api.VWAttachment[] getMultiObjectProperty(filenet.vw.api.VWAttachment objAtt, java.lang.String propName) throws java.lang.Exception
An object-valued property is a property that has as its value a reference to an object.
getMultiObjectProperty
in interface filenet.contentops.IContentOperations
objAtt
- A VWAttachment object identifying the object having the multivalued property.propName
- A String containing the name of the multivalued property.
java.lang.Exception
- Throws WcmException, PropertyNotFoundException if the specified property name is not
found.public java.lang.String[] getMultiStringProperty(filenet.vw.api.VWAttachment objAtt, java.lang.String propName) throws java.lang.Exception
getMultiStringProperty
in interface filenet.contentops.IContentOperations
objAtt
- A VWAttachment object identifying the object having the multivalued property.propName
- A String containing the name of the multivalued property.
java.lang.Exception
- Throws WcmException, PropertyNotFoundException if the specified property name is not
found.public void move(filenet.vw.api.VWAttachment folder, filenet.vw.api.VWAttachment object) throws java.lang.Exception
move
in interface filenet.contentops.IContentOperations
folder
- A VWAttachment object identifying the destination folder for the object.object
- A VWAttachment object identifying the object to move. This must be a document or custom
object.
java.lang.Exception
public void moveMany(filenet.vw.api.VWAttachment folder, filenet.vw.api.VWAttachment[] objects) throws java.lang.Exception
moveMany
in interface filenet.contentops.IContentOperations
folder
- A VWAttachment object identifying the destination folder for the object.object
- An array of VWAttachment objects identifying the objects to move. These must be a documents
or custom objects.
java.lang.Exception
public filenet.vw.api.VWAttachment[] searchForMany(filenet.vw.api.VWAttachment search, java.lang.String objectType, int[] itemIds, java.lang.String[] values) throws java.lang.Exception
Note: This method can be used solely for property-based search templates. It does not support content-based retrieval.
searchForMany
in interface filenet.contentops.IContentOperations
search
- A VWAttachment object identifying the stored search or search template to execute.objectType
- A String containing the type of object being searched for. This can be any one of the
following: "document", "customobject", or "folder". Note the lack of a space in "customobject".itemIds
- When a search template is specified in the search
parameter, this must be an array of int
values indicating the item IDs from the XML of the search template. When a stored search is specified in the
search
parameter, this must be {0}, the empty set.values
- When a search template is specified in the search
parameter, this must be a
String array of values correlated to the array of item IDs. When a stored search is specified in the
search
parameter, this must be {""}, the empty set.
java.lang.Exception
public filenet.vw.api.VWAttachment searchForOne(filenet.vw.api.VWAttachment search, java.lang.String objectType, int[] itemIds, java.lang.String[] values) throws java.lang.Exception
Note: This method can be used solely for property-based search templates. It does not support content-based retrieval.
searchForOne
in interface filenet.contentops.IContentOperations
search
- A VWAttachment object identifying the stored search or search template to execute.objectType
- A String containing the type of object being searched for. This can be any one of the
following: "document", "customobject", or "folder". Note the lack of a space in "customobject".itemIds
- When a search template is specified in the search
parameter, this must be an array of int
values indicating the item IDs from the XML of the search template. When a stored search is specified in the
search
parameter, this must be {0}, the empty set.values
- When a search template is specified in the search
parameter, this must be a
String array of values correlated to the array of item IDs. When a stored search is specified in the
search
parameter, this must be {""}, the empty set.
java.lang.Exception
public void setMultiBooleanProperty(filenet.vw.api.VWAttachment objAtt, java.lang.String propName, java.lang.Boolean[] values) throws java.lang.Exception
setMultiBooleanProperty
in interface filenet.contentops.IContentOperations
objAtt
- A VWAttachment object identifying the object having the multivalued property.propName
- A String containing the name of the multivalued property.values
- A Boolean array containing the new values for the multivalued property.
java.lang.Exception
public void setMultiDateProperty(filenet.vw.api.VWAttachment objAtt, java.lang.String propName, java.util.Date[] values) throws java.lang.Exception
setMultiDateProperty
in interface filenet.contentops.IContentOperations
objAtt
- A VWAttachment object identifying the object having the multivalued property.propName
- A String containing the name of the multivalued property.values
- A Date array containing the new values for the multivalued property.
java.lang.Exception
public void setMultiDoubleProperty(filenet.vw.api.VWAttachment objAtt, java.lang.String propName, java.lang.Double[] values) throws java.lang.Exception
setMultiDoubleProperty
in interface filenet.contentops.IContentOperations
objAtt
- A VWAttachment object identifying the object having the multivalued property.propName
- A String containing the name of the multivalued property.values
- A Double array containing the new values for the multivalued property.
java.lang.Exception
public void setMultiIntegerProperty(filenet.vw.api.VWAttachment objAtt, java.lang.String propName, java.lang.Integer[] values) throws java.lang.Exception
setMultiIntegerProperty
in interface filenet.contentops.IContentOperations
objAtt
- A VWAttachment object identifying the object having the multivalued property.propName
- A String containing the name of the multivalued property.values
- An Integer array containing the new values for the multivalued property.
java.lang.Exception
public void setMultiStringProperty(filenet.vw.api.VWAttachment objAtt, java.lang.String propName, java.lang.String[] values) throws java.lang.Exception
setMultiStringProperty
in interface filenet.contentops.IContentOperations
objAtt
- A VWAttachment object identifying the object having the multivalued property.propName
- A String containing the name of the multivalued property.values
- A String array containing the new values for the multivalued property.
java.lang.Exception
public void setObjectProperty(filenet.vw.api.VWAttachment att, java.lang.String propName, filenet.vw.api.VWAttachment attVal) throws java.lang.Exception
An object-valued property is a property that has as its value a reference to an object.
setObjectProperty
in interface filenet.contentops.IContentOperations
att
- A VWAttachment object identifying the object having the multivalued property.propName
- A String containing the name of the multivalued property.attVal
- A VWAttachment object identifying the new object value of the property.
java.lang.Exception
public void PECMInit() throws java.lang.Exception
PECMInit
in interface filenet.contentops.IContentOperations
java.lang.Exception
public void PECMStop() throws java.lang.Exception
PECMStop
in interface filenet.contentops.IContentOperations
java.lang.Exception
|
Content Operations API | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |