filenet.contentops

Class ContentOperations

  • java.lang.Object
    • filenet.contentops.ContentOperations
All Implemented Interfaces:
filenet.contentops.IContentOperations


public class ContentOperations
extends java.lang.Object
implements filenet.contentops.IContentOperations
Provides content operations on IBM FileNet Content Engine and IBM Content Manager repositories from Process Engine workflows. The methods are described primarily with regard to Content Engine. The content operations available for IBM Content Manager are dependent on the supporting IBM Content Manager release. For descriptions of the IBM Content Manager methods, refer to the DKContentOperationsICM API (which also implements the IContentOperations interface).

Note: Date values returned by IBM FileNet Content Engine use the ISO 8601 datetime format:

    YYYYMMDDThhmmss[,ffff]Z
 

Where "Z" is the UTC timezone (used when a timezone is not specified).

This class is used by the IBM FileNet Component Integrator.

Document Content Constraints

Because document content is stored by Process Engine as a String, the following constraints apply when working using this class:

  • These MIME types are supported for document content:
    • text/plain
    • text/css
    • text/html
    • text/xml
  • Attempting to get or set the content of any document format other than the MIME types listed above is not supported, and will cause unexpected behaviour. For example, you cannot get or set document content stored in Adobe Acrobat™ PDF, or Microsoft Word™ formats.
  • The size of the string containing the document content is limited. Getting or sending a large string can cause unexpected behaviour.
  • Document content should be UTF-8 encoded. Any other encoding format can cause unexpected behaviour.
Since:
P8 4.0.3
    • Method Summary

      Methods 
      Modifier and Type Method and Description
      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 cancelCheckout(filenet.vw.api.VWAttachment att)
      Cancels the checkout of an attachment that is currently checked out, by deleting the reservation object associated with it.
      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 attachment to the repository.
      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)
      Files a document attachment, currently existing in a repository, into a specified destination folder.
      void fileMany(filenet.vw.api.VWAttachment folder, filenet.vw.api.VWAttachment[] objects)
      Files one or more document attachments, currently existing in a repository, into a specified destination 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.util.Date getChildDateProperty(filenet.vw.api.VWAttachment objAtt, java.lang.String propName, java.lang.String[] childPropNames, java.lang.String[] childPropTypes, java.lang.String[] childPropValues)
      Gets a Date attribute value for an attribute from the specified document or folder attachment.
      java.lang.Double getChildDoubleProperty(filenet.vw.api.VWAttachment objAtt, java.lang.String propName, java.lang.String[] childPropNames, java.lang.String[] childPropTypes, java.lang.String[] childPropValues)
      Gets a Double attribute value for an attribute from the specified document or folder.
      java.lang.Integer getChildIntegerProperty(filenet.vw.api.VWAttachment objAtt, java.lang.String propName, java.lang.String[] childPropNames, java.lang.String[] childPropTypes, java.lang.String[] childPropValues)
      Gets an Integer attribute value for an attribute from the specified document or folder.
      java.lang.String getChildStringProperty(filenet.vw.api.VWAttachment objAtt, java.lang.String propName, java.lang.String[] childPropNames, java.lang.String[] childPropTypes, java.lang.String[] childPropValues)
      Gets a String attribute value for an attribute from the specified document or folder.
      java.lang.String[] getContent(filenet.vw.api.VWAttachment att)
      Gets the content of the attached document.
      int getContentCount(filenet.vw.api.VWAttachment att, java.lang.String contentType)
      Get the number of document content objects of the specified content type (or part type).
      java.lang.String[] getContentTypes(filenet.vw.api.VWAttachment att)
      Gets the content types (part types) of the specified document attachment.
      java.lang.String[] getContentWithIndex(filenet.vw.api.VWAttachment att, java.lang.String contentType, int index)
      Get the document content based on an index of all the content objects of the specified content type (or part type).
      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.String getDocumentId(filenet.vw.api.VWAttachment att)
      Gets the document identifier of 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.
      filenet.vw.api.VWAttachment getLatestAttachmentVersion(filenet.vw.api.VWAttachment att)
      Get the latest attachment version of the specified document.
      java.lang.Boolean[] getMultiBooleanProperty(filenet.vw.api.VWAttachment objAtt, java.lang.String propName)
      Gets the Boolean values of a multivalued property.
      java.util.Date[] getMultiChildDateProperty(filenet.vw.api.VWAttachment objAtt, java.lang.String propName, java.lang.String[] childPropNames, java.lang.String[] childPropTypes, java.lang.String[] childPropValues)
      Gets a list of Date values for the specified attribute of the specified document or folder in Content Manager.
      java.lang.Double[] getMultiChildDoubleProperty(filenet.vw.api.VWAttachment objAtt, java.lang.String propName, java.lang.String[] childPropNames, java.lang.String[] childPropTypes, java.lang.String[] childPropValues)
      Gets a list of Double values for the specified attribute of the specified document or folder in Content Manager.
      java.lang.Integer[] getMultiChildIntegerProperty(filenet.vw.api.VWAttachment objAtt, java.lang.String propName, java.lang.String[] childPropNames, java.lang.String[] childPropTypes, java.lang.String[] childPropValues)
      Gets a list of Integer values for the specified attribute of the specified document or folder in Content Manager.
      java.lang.String[] getMultiChildStringProperty(filenet.vw.api.VWAttachment objAtt, java.lang.String propName, java.lang.String[] childPropNames, java.lang.String[] childPropTypes, java.lang.String[] childPropValues)
      Gets a list of String values for the specified attribute of the specified document or folder in Content Manager.
      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.
      java.lang.String getURLFromAttachmentWithIndex(filenet.vw.api.VWAttachment att, java.lang.String contentType, int index)
      Retrieve the URL of the document content based on an index of all the content objects for the specified part type in Content Manager.
      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).
      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 one or more attached documents.
      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 one or more attached documents.
      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 setChildDateProperty(filenet.vw.api.VWAttachment objAtt, java.lang.String propName, java.lang.String[] childPropNames, java.lang.String[] childPropTypes, java.lang.String[] childPropValues, java.util.Date value)
      Sets a Date attribute value for an attribute from the specified document or folder.
      void setChildDoubleProperty(filenet.vw.api.VWAttachment objAtt, java.lang.String propName, java.lang.String[] childPropNames, java.lang.String[] childPropTypes, java.lang.String[] childPropValues, java.lang.Double value)
      Sets a Double attribute value for an attribute from the specified document or folder.
      void setChildIntegerProperty(filenet.vw.api.VWAttachment objAtt, java.lang.String propName, java.lang.String[] childPropNames, java.lang.String[] childPropTypes, java.lang.String[] childPropValues, java.lang.Integer value)
      Sets an Integer attribute value for an attribute from the specified document or folder.
      void setChildStringProperty(filenet.vw.api.VWAttachment objAtt, java.lang.String propName, java.lang.String[] childPropNames, java.lang.String[] childPropTypes, java.lang.String[] childPropValues, java.lang.String value)
      Sets a String attribute value for an attribute from the specified document or folder.
      void setContent(filenet.vw.api.VWAttachment att, java.lang.String[] content)
      Sets the content of the specified document attachment.
      void setContentWithIndex(filenet.vw.api.VWAttachment att, java.lang.String contentType, int index, java.lang.String[] content)
      Sets the content of 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 setMultiChildDateProperty(filenet.vw.api.VWAttachment objAtt, java.lang.String propName, java.lang.String[] childPropNames, java.lang.String[] childPropTypes, java.lang.String[] childPropValues, java.util.Date[] values)
      Sets a list of Date values for the specified attribute of the specified document or folder in Content Manager.
      void setMultiChildDoubleProperty(filenet.vw.api.VWAttachment objAtt, java.lang.String propName, java.lang.String[] childPropNames, java.lang.String[] childPropTypes, java.lang.String[] childPropValues, java.lang.Double[] values)
      Sets a list of Double values for specified attribute of the specified document or folder in Content Manager.
      void setMultiChildIntegerProperty(filenet.vw.api.VWAttachment objAtt, java.lang.String propName, java.lang.String[] childPropNames, java.lang.String[] childPropTypes, java.lang.String[] childPropValues, java.lang.Integer[] values)
      Sets a list of Integer values for specified attribute of the specified document or folder in Content Manager.
      void setMultiChildStringProperty(filenet.vw.api.VWAttachment objAtt, java.lang.String propName, java.lang.String[] childPropNames, java.lang.String[] childPropTypes, java.lang.String[] childPropValues, java.lang.String[] values)
      Sets a list of String values for specified attribute of the specified document or folder in Content Manager.
      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
      • Methods inherited from interface filenet.contentops.IContentOperations

        PECMInit, PECMStop
    • Constructor Detail

      • ContentOperations

        public ContentOperations()
    • Method Detail

      • sendMail

        public void sendMail(java.lang.String from,
                    java.lang.String to,
                    java.lang.String subject,
                    java.lang.String body)
                      throws java.lang.Exception
        Sends mail as text/plain with no attachment.

        Note: This method is not supported by Content Manager.

        Parameters:
        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.
        Throws:
        java.lang.Exception
        Since:
        P8 4.0.3
      • sendMailAttachment

        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
        Sends mail with one or more attached documents. The documents are added to the email as MIME attachments.

        Note: This method is not supported by Content Manager.

        Parameters:
        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 email MIME attachments.
        Throws:
        java.lang.Exception
        Since:
        P8 4.0.3
      • sendMailTemplate

        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
        Sends mail using a template. The template is used as the body of the email message.

        Note: This method is not supported by Content Manager.

        Parameters:
        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. The template is an HTML document. For example:
            <h1>Test Email template</h1>
            <p>Name: $1</p>
            <p>Acct Number: $2</p>
            <p>Hello, your request for a loan has been $3.</p>
            <p>Have a nice day.</p>
         
        templateVals - A String array containing the replacement values to use for the template. For example: {"John Doe","P34537","Approved"}.
        Throws:
        java.lang.Exception
        Since:
        P8 4.0.3
      • sendMailTemplateAttachment

        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
        Sends mail using a template with one or more attached documents. The documents are added to the email as MIME attachments.

        Note: This method is not supported by Content Manager.

        Parameters:
        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. The template is an HTML document. See sendMailTemplate for an example.
        templateVals - A String array containing the replacement values to use for the template. See sendMailTemplate for an example.
        attList - An array of VWAttachment objects identifying the documents for the email MIME attachments.
        Throws:
        java.lang.Exception
        Since:
        P8 4.0.3
      • sendMailTemplateURL

        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
        Sends mail using a template with the URLs of the attached documents appended to the end of the body of the email.

        Note: This method is not supported by Content Manager.

        Parameters:
        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. The template is an HTML document. See sendMailTemplate for an example.
        templateVals - A String array containing the replacement values to use for the template.See sendMailTemplate for an example.
        att - An array of VWAttachment objects identifying the documents for the email MIME attachments.
        workplaceUrl - A String containing the base URL to use for the document attachment (such as, http://hqdemo:8080/Workplace).
        Throws:
        java.lang.Exception
        Since:
        P8 4.0.3
      • sendMailURL

        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
        Sends mail with the URLs of the attached documents appended to the end of the body of the email.

        Note: This method is not supported by Content Manager.

        Parameters:
        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 email MIME attachments.
        workplaceUrl - A String containing the base URL to use for the attachment (such as, http://hqdemo:8080/Workplace).
        Throws:
        java.lang.Exception
        Since:
        P8 4.0.3
      • getBooleanProperty

        public java.lang.Boolean getBooleanProperty(filenet.vw.api.VWAttachment sourceDocument,
                                           java.lang.String symbolicPropName)
                                             throws java.lang.Exception
        Gets the Boolean value for the specified property from the specified document attachment.

        Note: This method is not supported by Content Manager.

        Specified by:
        getBooleanProperty in interface filenet.contentops.IContentOperations
        Parameters:
        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.
        Returns:
        The Boolean value of the document property identified by the symbolic name.
        Throws:
        java.lang.Exception - Throws WcmException, PropertyNotFoundException when the requested property is not of type Boolean.
        Since:
        P8 4.0.3
      • getDateProperty

        public java.util.Date getDateProperty(filenet.vw.api.VWAttachment sourceDocument,
                                     java.lang.String symbolicPropName)
                                       throws java.lang.Exception
        Gets the Date value for the specified property from the specified document attachment.
        Specified by:
        getDateProperty in interface filenet.contentops.IContentOperations
        Parameters:
        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.
        Returns:
        The Date value of the document property identified by the symbolic name.
        Throws:
        java.lang.Exception - Throws WcmException, PropertyNotFoundException when the requested property is not of type Date.
        Since:
        P8 4.0.3
      • getDoubleProperty

        public java.lang.Double getDoubleProperty(filenet.vw.api.VWAttachment sourceDocument,
                                         java.lang.String symbolicPropName)
                                           throws java.lang.Exception
        Gets the Double value for the specified property from the specified document attachment.
        Specified by:
        getDoubleProperty in interface filenet.contentops.IContentOperations
        Parameters:
        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.
        Returns:
        The Double value of the document property identified by the symbolic name.
        Throws:
        java.lang.Exception - Throws WcmException, PropertyNotFoundException when the requested property is not of type Double.
        Since:
        P8 4.0.3
      • getIntegerProperty

        public java.lang.Integer getIntegerProperty(filenet.vw.api.VWAttachment sourceDocument,
                                           java.lang.String symbolicPropName)
                                             throws java.lang.Exception
        Gets the Integer value for the specified property from the specified document attachment.
        Specified by:
        getIntegerProperty in interface filenet.contentops.IContentOperations
        Parameters:
        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.
        Returns:
        The Integer value of the document property identified by the symbolic name.
        Throws:
        java.lang.Exception - Throws WcmException, PropertyNotFoundException when the requested property is not of type Integer.
        Since:
        P8 4.0.3
      • getStringProperty

        public java.lang.String getStringProperty(filenet.vw.api.VWAttachment sourceDocument,
                                         java.lang.String symbolicPropName)
                                           throws java.lang.Exception
        Gets the String value for the specified property from the specified document attachment.
        Specified by:
        getStringProperty in interface filenet.contentops.IContentOperations
        Parameters:
        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.
        Returns:
        The String value of the document property identified by the symbolic name.
        Throws:
        java.lang.Exception - Throws WcmException, PropertyNotFoundException when the requested property is not of type String.
        Since:
        P8 4.0.3
      • getURLFromAttachment

        public java.lang.String getURLFromAttachment(filenet.vw.api.VWAttachment att,
                                            java.lang.String baseURL)
                                              throws java.lang.Exception
        Gets the URL for the document attachment.
        Specified by:
        getURLFromAttachment in interface filenet.contentops.IContentOperations
        Parameters:
        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).
        Returns:
        A String containing the URL of the document attachment (relative to the base Workplace URL).
        Throws:
        java.lang.Exception
        Since:
        P8 4.0.3
      • setBooleanProperty

        public void setBooleanProperty(filenet.vw.api.VWAttachment destDocument,
                              java.lang.String symbolicPropName,
                              java.lang.Boolean val)
                                throws java.lang.Exception
        Sets the Boolean value for the specified property on the specified document attachment.

        Note: This method is not supported by Content Manager.

        Specified by:
        setBooleanProperty in interface filenet.contentops.IContentOperations
        Parameters:
        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.
        Throws:
        java.lang.Exception - Throws WcmException when the requested property is not of type Boolean.
        Since:
        P8 4.0.3
      • setDateProperty

        public void setDateProperty(filenet.vw.api.VWAttachment destDocument,
                           java.lang.String symbolicPropName,
                           java.util.Date val)
                             throws java.lang.Exception
        Sets the Date value for the specified property on the specified document attachment.
        Specified by:
        setDateProperty in interface filenet.contentops.IContentOperations
        Parameters:
        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.
        Throws:
        java.lang.Exception - Throws WcmException when the requested property is not of type Date.
        Since:
        P8 4.0.3
      • setDoubleProperty

        public void setDoubleProperty(filenet.vw.api.VWAttachment destDocument,
                             java.lang.String symbolicPropName,
                             java.lang.Double val)
                               throws java.lang.Exception
        Sets the Double value for the specified property on the specified document attachment.
        Specified by:
        setDoubleProperty in interface filenet.contentops.IContentOperations
        Parameters:
        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.
        Throws:
        java.lang.Exception - Throws WcmException when the requested property is not of type Double.
        Since:
        P8 4.0.3
      • setIntegerProperty

        public void setIntegerProperty(filenet.vw.api.VWAttachment destDocument,
                              java.lang.String symbolicPropName,
                              java.lang.Integer val)
                                throws java.lang.Exception
        Sets the Integer value for the specified property on the specified document attachment.
        Specified by:
        setIntegerProperty in interface filenet.contentops.IContentOperations
        Parameters:
        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.

        Process Designer users can also use the <<NULL>> macro for this value to indicate a value is not set.

        Throws:
        java.lang.Exception - Throws WcmException when the requested property is not of type Integer.
        Since:
        P8 4.0.3
      • setStringProperty

        public void setStringProperty(filenet.vw.api.VWAttachment destDocument,
                             java.lang.String symbolicPropName,
                             java.lang.String val)
                               throws java.lang.Exception
        Sets the String value for the specified property on the specified document attachment.
        Specified by:
        setStringProperty in interface filenet.contentops.IContentOperations
        Parameters:
        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.
        Throws:
        java.lang.Exception - Throws WcmException when the requested property is not of type String.
        Since:
        P8 4.0.3
      • file

        public void file(filenet.vw.api.VWAttachment sourceDocument,
                filenet.vw.api.VWAttachment destFolder)
                  throws java.lang.Exception
        Files a document attachment, currently existing in a repository, into a specified destination folder. If the document attachment already exists in the specified destination, the request to file the object is ignored.

        Note: For Content Engine, this method calls the (Content Engine Java API) Folder.file method without supplying a containmentName parameter value. This value is left for the Content Engine to construct.

        Specified by:
        file in interface filenet.contentops.IContentOperations
        Parameters:
        sourceDocument - A VWAttachment object for the document attachment to file.
        destFolder - A VWAttachment object for the folder in which to file the document.
        Throws:
        java.lang.Exception
        Since:
        P8 4.0.3
      • unfile

        public void unfile(filenet.vw.api.VWAttachment sourceDocument,
                  filenet.vw.api.VWAttachment fromFolder)
                    throws java.lang.Exception
        Unfiles the specified document attachment from the specified folder. Upon successful completion of this method the document will no longer be filed in the folder.

        Note: If the object does not exist in the specified folder, the request to unfile the object is ignored.

        Specified by:
        unfile in interface filenet.contentops.IContentOperations
        Parameters:
        sourceDocument - A VWAttachment object for the document attachment to unfile.
        fromFolder - A VWAttachment object for the folder in which the document is filed.
        Throws:
        java.lang.Exception
        Since:
        P8 4.0.3
      • publish

        public filenet.vw.api.VWAttachment publish(filenet.vw.api.VWAttachment sourceDocument,
                                          filenet.vw.api.VWAttachment publishingTemplate)
                                            throws java.lang.Exception
        Publishes the specified document attachment using the specified template.

        Note: This method is not supported by Content Manager.

        Specified by:
        publish in interface filenet.contentops.IContentOperations
        Parameters:
        sourceDocument - A VWAttachment object for the document attachment to file.
        publishingTemplate - A VWAttachment object for the publishing template to use.
        Returns:
        A VWAttachment object for the target document created from the publishing request.

        Note: Currently, the resulting publication is not returned in the attachment object, because the publish request is processed asynchronously by the Content Engine.

        Throws:
        java.lang.Exception
        Since:
        P8 4.0.3
      • applySecurityTemplate

        public void applySecurityTemplate(filenet.vw.api.VWAttachment att,
                                 java.lang.String templateGUID)
                                   throws java.lang.Exception
        Applies a security template to an attachment. The object must be associated with a security policy and the specified template must belong to the policy. A SecurityTemplate object is a template for applying permissions to a Document object.

        Note: This method is not supported by Content Manager.

        Specified by:
        applySecurityTemplate in interface filenet.contentops.IContentOperations
        Parameters:
        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.
        Throws:
        java.lang.Exception
        Since:
        P8 4.0.3
      • applySecurityTemplateMany

        public void applySecurityTemplateMany(filenet.vw.api.VWAttachment[] atts,
                                     java.lang.String templateGUID)
                                       throws java.lang.Exception
        Applies a security template to an array of homogeneous attachments. The attachments must be associated with a security policy and that the template must belong to the policy. A SecurityTemplate object is a template for applying permissions to a Document object.

        Note: This method is not supported by Content Manager.

        Specified by:
        applySecurityTemplateMany in interface filenet.contentops.IContentOperations
        Parameters:
        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.
        Throws:
        java.lang.Exception
        Since:
        P8 4.0.3
      • changeClass

        public void changeClass(filenet.vw.api.VWAttachment att,
                       java.lang.String classId)
                         throws java.lang.Exception
        Changes the class of a supplied custom object, document or folder.

        Note: This method is not supported by Content Manager.

        Specified by:
        changeClass in interface filenet.contentops.IContentOperations
        Parameters:
        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.
        Throws:
        java.lang.Exception
        Since:
        P8 4.0.3
      • checkin

        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
        Checks in an attachment to the repository. For Content Engine, the document is checked in as a new major version. As part of the checkin operation, content and property values can also be set.
        Specified by:
        checkin in interface filenet.contentops.IContentOperations
        Parameters:
        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. The format is: {propName1, dataType1, propValue1, propName2, dataType2, ...}. 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. The following MIME types are supported:
        • text/plain
        • text/css
        • text/html
        • text/xml

        Attempting to check in a document of any other document format (such as, a PDF or a Microsoft Word™) is not supported and will cause unexpected behaviour.

        content - A String containing the content of the new version. For new lines, use "\n". If no content needs to be set, this can be the value "<<null>>" to signify an empty string.

        Note: Because the content is represented as a String, it is intended only for attachments having one of the MIME types supported by the mimeType parameter.

        IBM FileNet Process Designer users can use the NULL_STRING_VALUE_TEMPLATE macro function for the content value to indicate the content will not be updated (for example, checking in a document without updating the content).

        The size of this String value is limited. Sending a large string can cause unexpected behaviour.

        The content value is checked in as the first element of the content elements. If the attachment object had multiple content elements, the checkin operation will replace all of the existing content elements with this single content element.

        Returns:
        A VWAttachment object identifying the new document version.
        Throws:
        java.lang.Exception
        Since:
        P8 4.0.3
      • checkout

        public void checkout(filenet.vw.api.VWAttachment att)
                      throws java.lang.Exception
        Checks out an attachment from a repository.
        Specified by:
        checkout in interface filenet.contentops.IContentOperations
        Parameters:
        att - A VWAttachment object (document or custom object) for the document to check out. This document must not currently be checked out.
        Throws:
        java.lang.Exception
        Since:
        P8 4.0.3
      • copy

        public filenet.vw.api.VWAttachment copy(filenet.vw.api.VWAttachment att,
                                       boolean file)
                                         throws java.lang.Exception
        Copies a document or custom object within the same repository.

        Note: If a document is specified, only the first content element is copied.

        The following MIME types are supported for the document attachment being copied:

        • text/plain
        • text/css
        • text/html
        • text/xml

        Attempting to copy a document of any other document format (such as, a Adobe Acrobat PDF or Microsoft Word) is not supported and will cause unexpected behaviour.

        Specified by:
        copy in interface filenet.contentops.IContentOperations
        Parameters:
        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.
        Returns:
        A VWAttachment object referencing the new document or custom object copy.
        Throws:
        java.lang.Exception
        Since:
        P8 4.0.3
      • copyMany

        public filenet.vw.api.VWAttachment[] copyMany(filenet.vw.api.VWAttachment[] atts,
                                             boolean file)
                                               throws java.lang.Exception
        Copies documents or custom objects within the same repository.

        Note: If documents are specified, only the first content element in each document is copied.

        The following MIME types are supported for the document attachments being copied:

        • text/plain
        • text/css
        • text/html
        • text/xml

        Attempting to copy a document of any other document format (such as, a Adobe Acrobat PDF or Microsoft Word) is not supported and will cause unexpected behaviour.

        Specified by:
        copyMany in interface filenet.contentops.IContentOperations
        Parameters:
        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.
        Returns:
        An array of VWAttachment objects referencing the new document or custom object copies.
        Throws:
        java.lang.Exception
        Since:
        P8 4.0.3
      • createCustomObject

        public filenet.vw.api.VWAttachment createCustomObject(filenet.vw.api.VWAttachment destFolder,
                                                     java.lang.String className,
                                                     java.lang.String[] propArray)
                                                       throws java.lang.Exception
        Creates a custom object using a specified class, and property values. The object is filed into the specified folder.

        Note: This method is not supported by Content Manager.

        Specified by:
        createCustomObject in interface filenet.contentops.IContentOperations
        Parameters:
        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, ...}.
        Returns:
        A VWAttachment object referencing the new custom object.
        Throws:
        java.lang.Exception
        Since:
        P8 4.0.3
      • createDocument

        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
        Creates a document using the specified class, properties, and content. The document is filed into the specified folder.
        Specified by:
        createDocument in interface filenet.contentops.IContentOperations
        Parameters:
        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 for any new content specified. The following MIME types are supported:
        • text/plain
        • text/css
        • text/html
        • text/xml

        Attempting to create a document of any other document format (such as, a Adobe Acrobat PDF or Microsoft Word) is not supported and will cause unexpected behaviour.

        content - A String containing the content of the new version. For new lines, use "\n".

        Note: Because the content is represented as a String, it is intended only for attachments having one of the MIME types supported by the mimeType parameter.

        IBM FileNet Process Designer users can use the NULL_STRING_VALUE_TEMPLATE macro function for the content value to indicate the content will not be updated (for example, checking in a document without updating the content).

        The size of this String value is limited. Sending a large string can cause unexpected behaviour.

        Returns:
        A VWAttachment object referencing the new document.
        Throws:
        java.lang.Exception
        Since:
        P8 4.0.3
      • createFolder

        public filenet.vw.api.VWAttachment createFolder(filenet.vw.api.VWAttachment parentFolderAtt,
                                               java.lang.String className,
                                               java.lang.String[] propArray)
                                                 throws java.lang.Exception
        Creates a folder, either at the root of the object store or as a child of an attached folder.
        Specified by:
        createFolder in interface filenet.contentops.IContentOperations
        Parameters:
        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 "||2|3|CE_ObjectStore|" or "|||3|CE_ObjectStore|"; where "2" is the indicator for the Folder type (this value is ignored), 3 is the indicator for the Content Engine, and CE_ObjectStore is the Library name. 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.
        Returns:
        A VWAttachment object referencing the new folder object.
        Throws:
        java.lang.Exception
        Since:
        P8 4.0.3
      • delete

        public void delete(filenet.vw.api.VWAttachment objAtt)
                    throws java.lang.Exception
        Deletes the specified attachment.
        Specified by:
        delete in interface filenet.contentops.IContentOperations
        Parameters:
        objAtt - A VWAttachment object (custom object, document, or folder) identifying the object to delete.
        Throws:
        java.lang.Exception
        Since:
        P8 4.0.3
      • deleteMany

        public void deleteMany(filenet.vw.api.VWAttachment[] list)
                        throws java.lang.Exception
        Deletes an array of specified attachments.
        Specified by:
        deleteMany in interface filenet.contentops.IContentOperations
        Parameters:
        list - An array of VWAttachment objects (custom object, document, or folder) to delete.
        Throws:
        java.lang.Exception
        Since:
        P8 4.0.3
      • fileMany

        public void fileMany(filenet.vw.api.VWAttachment folder,
                    filenet.vw.api.VWAttachment[] objects)
                      throws java.lang.Exception
        Files one or more document attachments, currently existing in a repository, into a specified destination folder. If a document attachment already exists in the specified destination, the request to file the object is ignored.
        Specified by:
        fileMany in interface filenet.contentops.IContentOperations
        Parameters:
        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.
        Throws:
        java.lang.Exception
        Since:
        P8 4.0.3
      • getContent

        public java.lang.String[] getContent(filenet.vw.api.VWAttachment att)
                                      throws java.lang.Exception
        Gets the content of the attached document. For Content Engine, this method gets the first content element of the document.
        Specified by:
        getContent in interface filenet.contentops.IContentOperations
        Parameters:
        att - A VWAttachment object (custom object or document) from which the content is retrieved.
        Returns:
        A String array of three elements: Element 1 is the file name; element 2 is the MIME type; element 3 is the content.

        The following content MIME types are supported (in element 2), and identify the format of the content in element 3:

        • text/plain
        • text/css
        • text/html
        • text/xml

        Refer to Document Content Constraints for more information.

        Throws:
        java.lang.Exception
        Since:
        P8 4.0.3
      • getObjFromPath

        public filenet.vw.api.VWAttachment getObjFromPath(java.lang.String osName,
                                                 java.lang.String path,
                                                 java.lang.String objType)
                                                   throws java.lang.Exception
        Gets an object (custom object, folder or document) from a specified repository using a specified path.

        Note: This method is not supported by Content Manager.

        Specified by:
        getObjFromPath in interface filenet.contentops.IContentOperations
        Parameters:
        osName - A String containing the name or GUID of the repository storing the object.
        path - A String containing the path of the desired object.
        • For folder object types, use the folder path (such as, "/MyFolder").
        • For custom object or document object types, use the folder path with the containment name of the document or custom object (such as, "/MyFolder/MyDocA.txt").
        objType - A String containing the name of the object type. This must be one of the following: "custom object", "document" or "folder".
        Returns:
        A VWAttachment object referencing the object retrieved, or an empty attachment if the object does not exist.
        Throws:
        java.lang.Exception
        Since:
        P8 4.0.3
      • getObjectProperty

        public filenet.vw.api.VWAttachment getObjectProperty(filenet.vw.api.VWAttachment att,
                                                    java.lang.String propName)
                                                      throws java.lang.Exception
        Gets the object referenced by an attached object's object-valued property.

        An object-valued property is a property that has as its value a reference to an object.

        Note: This method is not supported by Content Manager.

        Specified by:
        getObjectProperty in interface filenet.contentops.IContentOperations
        Parameters:
        att - A VWAttachment object identifying the object having the object-valued property.
        propName - A String containing the name of the object-valued property.
        Returns:
        A VWAttachment object for the object referenced by the object-valued property.
        Throws:
        java.lang.Exception - Throws WcmException, PropertyNotFoundException if the specified property name is not found.
        Since:
        P8 4.0.3
      • getMultiBooleanProperty

        public java.lang.Boolean[] getMultiBooleanProperty(filenet.vw.api.VWAttachment objAtt,
                                                  java.lang.String propName)
                                                    throws java.lang.Exception
        Gets the Boolean values of a multivalued property.

        Note: This method is not supported by Content Manager.

        Specified by:
        getMultiBooleanProperty in interface filenet.contentops.IContentOperations
        Parameters:
        objAtt - A VWAttachment object identifying the object having the multivalued property.
        propName - A String containing the name of the multivalued property.
        Returns:
        An array of the Boolean property values stored in the multivalued property.
        Throws:
        java.lang.Exception - Throws WcmException, PropertyNotFoundException if the specified property name is not found.
        Since:
        P8 4.0.3
      • getMultiDateProperty

        public java.util.Date[] getMultiDateProperty(filenet.vw.api.VWAttachment objAtt,
                                            java.lang.String propName)
                                              throws java.lang.Exception
        Gets the Date values of a multivalued property.
        Specified by:
        getMultiDateProperty in interface filenet.contentops.IContentOperations
        Parameters:
        objAtt - A VWAttachment object identifying the object having the multivalued property.
        propName - A String containing the name of the multivalued property.
        Returns:
        An array of the Date property values stored in the multivalued property.
        Throws:
        java.lang.Exception - Throws WcmException, PropertyNotFoundException if the specified property name is not found.
        Since:
        P8 4.0.3
        See Also:
        Content Engine date format
      • getMultiDoubleProperty

        public java.lang.Double[] getMultiDoubleProperty(filenet.vw.api.VWAttachment objAtt,
                                                java.lang.String propName)
                                                  throws java.lang.Exception
        Gets the Double values of a multivalued property.
        Specified by:
        getMultiDoubleProperty in interface filenet.contentops.IContentOperations
        Parameters:
        objAtt - A VWAttachment object identifying the object having the multivalued property.
        propName - A String containing the name of the multivalued property.
        Returns:
        An array of the Double property values stored in the multivalued property.
        Throws:
        java.lang.Exception - Throws WcmException, PropertyNotFoundException if the specified property name is not found.
        Since:
        P8 4.0.3
      • getMultiIntegerProperty

        public java.lang.Integer[] getMultiIntegerProperty(filenet.vw.api.VWAttachment objAtt,
                                                  java.lang.String propName)
                                                    throws java.lang.Exception
        Gets the Integer values of a multivalued property.
        Specified by:
        getMultiIntegerProperty in interface filenet.contentops.IContentOperations
        Parameters:
        objAtt - A VWAttachment object identifying the object having the multivalued property.
        propName - A String containing the name of the multivalued property.
        Returns:
        An array of the Integer property values stored in the multivalued property.
        Throws:
        java.lang.Exception - Throws WcmException, PropertyNotFoundException if the specified property name is not found.
        Since:
        P8 4.0.3
      • getMultiObjectProperty

        public filenet.vw.api.VWAttachment[] getMultiObjectProperty(filenet.vw.api.VWAttachment objAtt,
                                                           java.lang.String propName)
                                                             throws java.lang.Exception
        Gets the object values of a multivalued property.

        An object-valued property is a property that has as its value a reference to an object.

        Note: This method is not supported by Content Manager.

        Specified by:
        getMultiObjectProperty in interface filenet.contentops.IContentOperations
        Parameters:
        objAtt - A VWAttachment object identifying the object having the multivalued property.
        propName - A String containing the name of the multivalued property.
        Returns:
        An array of VWAttachment objects identifying the objects referenced by the object values of the multivalued property.
        Throws:
        java.lang.Exception - Throws WcmException, PropertyNotFoundException if the specified property name is not found.
        Since:
        P8 4.0.3
      • getMultiStringProperty

        public java.lang.String[] getMultiStringProperty(filenet.vw.api.VWAttachment objAtt,
                                                java.lang.String propName)
                                                  throws java.lang.Exception
        Gets the String values of a multivalued property.
        Specified by:
        getMultiStringProperty in interface filenet.contentops.IContentOperations
        Parameters:
        objAtt - A VWAttachment object identifying the object having the multivalued property.
        propName - A String containing the name of the multivalued property.
        Returns:
        An array of the String property values stored in the multivalued property.
        Throws:
        java.lang.Exception - Throws WcmException, PropertyNotFoundException if the specified property name is not found.
        Since:
        P8 4.0.3
      • move

        public void move(filenet.vw.api.VWAttachment folder,
                filenet.vw.api.VWAttachment object)
                  throws java.lang.Exception
        Moves the specified document or custom object from its existing folder to the specified folder (similar to an unfile and file operation).
        Specified by:
        move in interface filenet.contentops.IContentOperations
        Parameters:
        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.
        Throws:
        java.lang.Exception
        Since:
        P8 4.0.3
      • moveMany

        public void moveMany(filenet.vw.api.VWAttachment folder,
                    filenet.vw.api.VWAttachment[] objects)
                      throws java.lang.Exception
        Moves the specified documents or custom objects from their existing folder to the specified folder (similar to an unfile and file operation).
        Specified by:
        moveMany in interface filenet.contentops.IContentOperations
        Parameters:
        folder - A VWAttachment object identifying the destination folder for the object.
        objects - An array of VWAttachment objects identifying the objects to move. These must be a documents or custom objects.
        Throws:
        java.lang.Exception
        Since:
        P8 4.0.3
      • searchForMany

        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
        Executes the simple search template or stored search identified in an attachment, returning an array of objects matching the search criteria.

        Note: This method can be used solely for property-based search templates. It does not support content-based retrieval.

        Specified by:
        searchForMany in interface filenet.contentops.IContentOperations
        Parameters:
        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.
        Returns:
        An array of VWAttachment objects identifying the objects matching the search criteria.
        Throws:
        java.lang.Exception
        Since:
        P8 4.0.3
        See Also:
        Content Engine date format
      • searchForOne

        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
        Executes the simple search template or stored search identified in an attachment, returning the first object matching the search criteria.

        Note: This method can be used solely for property-based search templates. It does not support content-based retrieval.

        Specified by:
        searchForOne in interface filenet.contentops.IContentOperations
        Parameters:
        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.
        Returns:
        A VWAttachment object identifying the first object found to match the search criteria. There is no guarantee that the object returned is the only object matching the search criteria.
        Throws:
        java.lang.Exception
        Since:
        P8 4.0.3
        See Also:
        Content Engine date format
      • setMultiBooleanProperty

        public void setMultiBooleanProperty(filenet.vw.api.VWAttachment objAtt,
                                   java.lang.String propName,
                                   java.lang.Boolean[] values)
                                     throws java.lang.Exception
        Sets the Boolean values of a multivalued property.

        Note: This method is not supported by Content Manager.

        Specified by:
        setMultiBooleanProperty in interface filenet.contentops.IContentOperations
        Parameters:
        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.
        Throws:
        java.lang.Exception
        Since:
        P8 4.0.3
      • setMultiDateProperty

        public void setMultiDateProperty(filenet.vw.api.VWAttachment objAtt,
                                java.lang.String propName,
                                java.util.Date[] values)
                                  throws java.lang.Exception
        Sets the Date values of a multivalued property.
        Specified by:
        setMultiDateProperty in interface filenet.contentops.IContentOperations
        Parameters:
        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.
        Throws:
        java.lang.Exception
        Since:
        P8 4.0.3
      • setMultiDoubleProperty

        public void setMultiDoubleProperty(filenet.vw.api.VWAttachment objAtt,
                                  java.lang.String propName,
                                  java.lang.Double[] values)
                                    throws java.lang.Exception
        Sets the Double values of a multivalued property.
        Specified by:
        setMultiDoubleProperty in interface filenet.contentops.IContentOperations
        Parameters:
        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.
        Throws:
        java.lang.Exception
        Since:
        P8 4.0.3
      • setMultiIntegerProperty

        public void setMultiIntegerProperty(filenet.vw.api.VWAttachment objAtt,
                                   java.lang.String propName,
                                   java.lang.Integer[] values)
                                     throws java.lang.Exception
        Sets the Integer values of a multivalued property.
        Specified by:
        setMultiIntegerProperty in interface filenet.contentops.IContentOperations
        Parameters:
        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.
        Throws:
        java.lang.Exception
        Since:
        P8 4.0.3
      • setMultiStringProperty

        public void setMultiStringProperty(filenet.vw.api.VWAttachment objAtt,
                                  java.lang.String propName,
                                  java.lang.String[] values)
                                    throws java.lang.Exception
        Sets the String values of a multivalued property.
        Specified by:
        setMultiStringProperty in interface filenet.contentops.IContentOperations
        Parameters:
        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.
        Throws:
        java.lang.Exception
        Since:
        P8 4.0.3
      • setObjectProperty

        public void setObjectProperty(filenet.vw.api.VWAttachment att,
                             java.lang.String propName,
                             filenet.vw.api.VWAttachment attVal)
                               throws java.lang.Exception
        Sets the object value of an object-valued property.

        An object-valued property is a property that has as its value a reference to an object.

        Note: This method is not supported by Content Manager.

        Specified by:
        setObjectProperty in interface filenet.contentops.IContentOperations
        Parameters:
        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.
        Throws:
        java.lang.Exception
        Since:
        P8 4.0.3
      • cancelCheckout

        public void cancelCheckout(filenet.vw.api.VWAttachment att)
                            throws java.lang.Exception
        Cancels the checkout of an attachment that is currently checked out, by deleting the reservation object associated with it.

        Note: This method is not supported by Content Manager.

        Specified by:
        cancelCheckout in interface filenet.contentops.IContentOperations
        Parameters:
        att - A VWAttachment object identifying the object for which the checkout is to be canceled.
        Throws:
        java.lang.Exception
        Since:
        P8 4.5.1
      • getContentWithIndex

        public java.lang.String[] getContentWithIndex(filenet.vw.api.VWAttachment att,
                                             java.lang.String contentType,
                                             int index)
                                               throws java.lang.Exception
        Get the document content based on an index of all the content objects of the specified content type (or part type).
        Specified by:
        getContentWithIndex in interface filenet.contentops.IContentOperations
        Parameters:
        att - A VWAttachment object (custom object or document) from which the content is retrieved.
        contentType - A String identifying the object content type to use in the search. For the Content Engine, the check for content type is ignored when this parameter is null (returning any content referenced by the specified index); otherwise, this method returns the document content that matches both the content type and the specified index.

        IBM FileNet Process Designer users can use the NULL_STRING_VALUE_TEMPLATE macro function for the contentType value to indicate the content will not be updated (for example, checking in a document without updating the content).

        index - An integer indicating the (nth) index element referencing the object of contentType. The index origin is 1 (one).
        Returns:
        A String array of three elements: Element 1 is the file name; element 2 is the MIME type; element 3 is the content.

        The following content MIME types are supported (in element 2), and identify the format of the content in element 3:

        • text/plain
        • text/css
        • text/html
        • text/xml

        If the contentType parameter is not specified, this method returns any document referenced by the specified index. When contentType is specified, this method returns the document that matches both the content type and the specified index.

        Refer to Document Content Constraints for more information.

        Throws:
        java.lang.Exception
        Since:
        P8 4.5.1
      • getContentCount

        public int getContentCount(filenet.vw.api.VWAttachment att,
                          java.lang.String contentType)
                            throws java.lang.Exception
        Get the number of document content objects of the specified content type (or part type).
        Specified by:
        getContentCount in interface filenet.contentops.IContentOperations
        Parameters:
        att - A VWAttachment object (custom object or document) from which the content object count is retrieved.
        contentType - A String identifying the object content type to use in the search. For the Content Engine, the check for content type is ignored when this parameter is null (returning any content referenced by the specified index); otherwise, this method returns the document content that matches both the content type and the specified index.

        IBM FileNet Process Designer users can use the NULL_STRING_VALUE_TEMPLATE macro function for the contentType value to indicate the content will not be updated (for example, checking in a document without updating the content).

        Returns:
        An integer indicating the number of content objects of the specified content type (or part type).

        If the contentType parameter is not specified, this method returns the total number of content elements attached in the document. When contentType is specified, this method returns the number of documents that match the content type.

        Throws:
        java.lang.Exception
        Since:
        P8 4.5.1
      • getLatestAttachmentVersion

        public filenet.vw.api.VWAttachment getLatestAttachmentVersion(filenet.vw.api.VWAttachment att)
                                                               throws java.lang.Exception
        Get the latest attachment version of the specified document.
        Specified by:
        getLatestAttachmentVersion in interface filenet.contentops.IContentOperations
        Parameters:
        att - A VWAttachment object (document) from which the latest version is retrieved.
        Returns:
        A VWAttachment object for the latest version of the document. For Content Engine, this is the current version, which can be either a minor or major version.
        Throws:
        java.lang.Exception
        Since:
        P8 4.5.1
      • getURLFromAttachmentWithIndex

        public java.lang.String getURLFromAttachmentWithIndex(filenet.vw.api.VWAttachment att,
                                                     java.lang.String contentType,
                                                     int index)
                                                       throws java.lang.Exception
        Retrieve the URL of the document content based on an index of all the content objects for the specified part type in Content Manager.

        Note: This method is not supported by Content Engine.

        Specified by:
        getURLFromAttachmentWithIndex in interface filenet.contentops.IContentOperations
        Parameters:
        att - A VWAttachment object (document) from which the URL is retrieved.
        contentType - A String containing the Content Manager part type for the document model document (such as, ICMBASE, ICMBASETEXT, ICMANNOTATION, ICMNOTELOG, or ICMBASESTREAM).
        index - An integer indicating the (nth) index element referencing the object of contentType. The index origin is 1 (one).
        Returns:
        A String containing the URL for the document part of the specified document.
        Throws:
        java.lang.Exception
        Since:
        P8 4.5.1
      • getMultiChildDateProperty

        public java.util.Date[] getMultiChildDateProperty(filenet.vw.api.VWAttachment objAtt,
                                                 java.lang.String propName,
                                                 java.lang.String[] childPropNames,
                                                 java.lang.String[] childPropTypes,
                                                 java.lang.String[] childPropValues)
                                                   throws java.lang.Exception
        Gets a list of Date values for the specified attribute of the specified document or folder in Content Manager.

        Note: This method is not supported by Content Engine.

        Specified by:
        getMultiChildDateProperty in interface filenet.contentops.IContentOperations
        Parameters:
        objAtt - A VWAttachment object referencing the document or folder information.
        propName - A String containing the name of the attribute having the Date values.
        childPropNames - A String array of child attribute names.
        childPropTypes - A String array of child attribute types.
        childPropValues - A String array of child attribute values.
        Returns:
        An array of Date values for the attribute specified.
        Throws:
        java.lang.Exception
        Since:
        P8 4.5.1
      • getMultiChildDoubleProperty

        public java.lang.Double[] getMultiChildDoubleProperty(filenet.vw.api.VWAttachment objAtt,
                                                     java.lang.String propName,
                                                     java.lang.String[] childPropNames,
                                                     java.lang.String[] childPropTypes,
                                                     java.lang.String[] childPropValues)
                                                       throws java.lang.Exception
        Gets a list of Double values for the specified attribute of the specified document or folder in Content Manager.

        Note: This method is not supported by Content Engine.

        Specified by:
        getMultiChildDoubleProperty in interface filenet.contentops.IContentOperations
        Parameters:
        objAtt - A VWAttachment object referencing the document or folder information.
        propName - A String containing the name of the attribute having the Date values.
        childPropNames - A String array of child attribute names.
        childPropTypes - A String array of child attribute types.
        childPropValues - A String array of child attribute values.
        Returns:
        An array of Double values for the attribute specified.
        Throws:
        java.lang.Exception
        Since:
        P8 4.5.1
      • getMultiChildIntegerProperty

        public java.lang.Integer[] getMultiChildIntegerProperty(filenet.vw.api.VWAttachment objAtt,
                                                       java.lang.String propName,
                                                       java.lang.String[] childPropNames,
                                                       java.lang.String[] childPropTypes,
                                                       java.lang.String[] childPropValues)
                                                         throws java.lang.Exception
        Gets a list of Integer values for the specified attribute of the specified document or folder in Content Manager.

        Note: This method is not supported by Content Engine.

        Specified by:
        getMultiChildIntegerProperty in interface filenet.contentops.IContentOperations
        Parameters:
        objAtt - A VWAttachment object referencing the document or folder information.
        propName - A String containing the name of the attribute having the Date values.
        childPropNames - A String array of child attribute names.
        childPropTypes - A String array of child attribute types.
        childPropValues - A String array of child attribute values.
        Returns:
        An array of Integer values for the attribute specified.
        Throws:
        java.lang.Exception
        Since:
        P8 4.5.1
      • getMultiChildStringProperty

        public java.lang.String[] getMultiChildStringProperty(filenet.vw.api.VWAttachment objAtt,
                                                     java.lang.String propName,
                                                     java.lang.String[] childPropNames,
                                                     java.lang.String[] childPropTypes,
                                                     java.lang.String[] childPropValues)
                                                       throws java.lang.Exception
        Gets a list of String values for the specified attribute of the specified document or folder in Content Manager.

        Note: This method is not supported by Content Engine.

        Specified by:
        getMultiChildStringProperty in interface filenet.contentops.IContentOperations
        Parameters:
        objAtt - A VWAttachment object referencing the document or folder information.
        propName - A String containing the name of the attribute having the Date values.
        childPropNames - A String array of child attribute names.
        childPropTypes - A String array of child attribute types.
        childPropValues - A String array of child attribute values.
        Returns:
        An array of String values for the attribute specified.
        Throws:
        java.lang.Exception
        Since:
        P8 4.5.1
      • setMultiChildDateProperty

        public void setMultiChildDateProperty(filenet.vw.api.VWAttachment objAtt,
                                     java.lang.String propName,
                                     java.lang.String[] childPropNames,
                                     java.lang.String[] childPropTypes,
                                     java.lang.String[] childPropValues,
                                     java.util.Date[] values)
                                       throws java.lang.Exception
        Sets a list of Date values for the specified attribute of the specified document or folder in Content Manager.

        Note: This method is not supported by Content Engine.

        Specified by:
        setMultiChildDateProperty in interface filenet.contentops.IContentOperations
        Parameters:
        objAtt - A VWAttachment object referencing the document or folder information.
        propName - A String containing the name of the attribute having the Date values.
        childPropNames - A String array of child attribute names.
        childPropTypes - A String array of child attribute types.
        values - An array of Date values to set for the attribute specified.
        Throws:
        java.lang.Exception
        Since:
        P8 4.5.1
      • setMultiChildDoubleProperty

        public void setMultiChildDoubleProperty(filenet.vw.api.VWAttachment objAtt,
                                       java.lang.String propName,
                                       java.lang.String[] childPropNames,
                                       java.lang.String[] childPropTypes,
                                       java.lang.String[] childPropValues,
                                       java.lang.Double[] values)
                                         throws java.lang.Exception
        Sets a list of Double values for specified attribute of the specified document or folder in Content Manager.

        Note: This method is not supported by Content Engine.

        Specified by:
        setMultiChildDoubleProperty in interface filenet.contentops.IContentOperations
        Parameters:
        objAtt - A VWAttachment object referencing the document or folder information.
        propName - A String containing the name of the attribute having the Date values.
        childPropNames - A String array of child attribute names.
        childPropTypes - A String array of child attribute types.
        values - An array of Double values to set for the attribute specified.
        Throws:
        java.lang.Exception
        Since:
        P8 4.5.1
      • setMultiChildIntegerProperty

        public void setMultiChildIntegerProperty(filenet.vw.api.VWAttachment objAtt,
                                        java.lang.String propName,
                                        java.lang.String[] childPropNames,
                                        java.lang.String[] childPropTypes,
                                        java.lang.String[] childPropValues,
                                        java.lang.Integer[] values)
                                          throws java.lang.Exception
        Sets a list of Integer values for specified attribute of the specified document or folder in Content Manager.

        Note: This method is not supported by Content Engine.

        Specified by:
        setMultiChildIntegerProperty in interface filenet.contentops.IContentOperations
        Parameters:
        objAtt - A VWAttachment object referencing the document or folder information.
        propName - A String containing the name of the attribute having the Date values.
        childPropNames - A String array of child attribute names.
        childPropTypes - A String array of child attribute types.
        values - An array of Integer values to set for the attribute specified.
        Throws:
        java.lang.Exception
        Since:
        P8 4.5.1
      • setMultiChildStringProperty

        public void setMultiChildStringProperty(filenet.vw.api.VWAttachment objAtt,
                                       java.lang.String propName,
                                       java.lang.String[] childPropNames,
                                       java.lang.String[] childPropTypes,
                                       java.lang.String[] childPropValues,
                                       java.lang.String[] values)
                                         throws java.lang.Exception
        Sets a list of String values for specified attribute of the specified document or folder in Content Manager.

        Note: This method is not supported by Content Engine.

        Specified by:
        setMultiChildStringProperty in interface filenet.contentops.IContentOperations
        Parameters:
        objAtt - A VWAttachment object referencing the document or folder information.
        propName - A String containing the name of the attribute having the Date values.
        childPropNames - A String array of child attribute names.
        childPropTypes - A String array of child attribute types.
        values - An array of String values to set for the attribute specified.
        Throws:
        java.lang.Exception
        Since:
        P8 4.5.1
      • getDocumentId

        public java.lang.String getDocumentId(filenet.vw.api.VWAttachment att)
                                       throws java.lang.Exception
        Gets the document identifier of the specified document attachment.
        Specified by:
        getDocumentId in interface filenet.contentops.IContentOperations
        Parameters:
        att - A VWAttachment object (document) from which the document id is retrieved.
        Returns:
        A String containing the document id of the attachment.
        Throws:
        java.lang.Exception
        Since:
        P8 5.0
      • getContentTypes

        public java.lang.String[] getContentTypes(filenet.vw.api.VWAttachment att)
                                           throws java.lang.Exception
        Gets the content types (part types) of the specified document attachment.

        Note: This method is not supported by Content Engine.

        Specified by:
        getContentTypes in interface filenet.contentops.IContentOperations
        Parameters:
        att - A VWAttachment object from which the number of content types is retrieved.
        Returns:
        A String array containing the Content Manager part type for the document model document (such as, ICMBASE, ICMBASETEXT, ICMANNOTATION, ICMNOTELOG, or ICMBASESTREAM).
        Throws:
        java.lang.Exception
        Since:
        P8 5.0
      • setContent

        public void setContent(filenet.vw.api.VWAttachment att,
                      java.lang.String[] content)
                        throws java.lang.Exception
        Sets the content of the specified document attachment.

        Note: This method is not supported by Content Engine.

        Specified by:
        setContent in interface filenet.contentops.IContentOperations
        Parameters:
        att - A VWAttachment object (document) for which to set the content.
        content - A three-element String array. Element 1 is the filename, element 2 is the mimeType, and element 3 is the content.
        Throws:
        java.lang.Exception
        Since:
        P8 5.0
      • setContentWithIndex

        public void setContentWithIndex(filenet.vw.api.VWAttachment att,
                               java.lang.String contentType,
                               int index,
                               java.lang.String[] content)
                                 throws java.lang.Exception
        Sets the content of the specified document attachment.

        Note: This method is not supported by Content Engine.

        Specified by:
        setContentWithIndex in interface filenet.contentops.IContentOperations
        Parameters:
        att - A VWAttachment object (document) for which to set the content.
        contentType - A String containing the specified content type for the document attachment. This is the Content Manager part type for the document model document (such as, ICMBASE, ICMBASETEXT, ICMANNOTATION, ICMNOTELOG, or ICMBASESTREAM).
        index - An integer indicating the (nth) index element referencing the object of contentType. The index origin is 1 (one).
        content - A three-element String array. Element 1 is the filename, element 2 is the mimeType, and element 3 is the content.
        Throws:
        java.lang.Exception
        Since:
        P8 5.0
      • getChildDateProperty

        public java.util.Date getChildDateProperty(filenet.vw.api.VWAttachment objAtt,
                                          java.lang.String propName,
                                          java.lang.String[] childPropNames,
                                          java.lang.String[] childPropTypes,
                                          java.lang.String[] childPropValues)
                                            throws java.lang.Exception
        Gets a Date attribute value for an attribute from the specified document or folder attachment.

        Note: This method is not supported by Content Engine.

        Specified by:
        getChildDateProperty in interface filenet.contentops.IContentOperations
        Parameters:
        objAtt - A VWAttachment object for the document or folder information.
        propName - A String containing the attribute name. Attribute names are in the form: ChildComponentName1/ChildComponentName2/�/attributeName or ChildComponentName1/ChildComponentName2/�/attributeGroup.attributeName).
        childPropNames - A String array of child attribute names.
        childPropTypes - A String array of child attribute types.
        childPropValues - An String array of values to set for the attribute specified.
        Returns:
        A Date attribute value.
        Throws:
        java.lang.Exception
        Since:
        P8 5.0
      • getChildDoubleProperty

        public java.lang.Double getChildDoubleProperty(filenet.vw.api.VWAttachment objAtt,
                                              java.lang.String propName,
                                              java.lang.String[] childPropNames,
                                              java.lang.String[] childPropTypes,
                                              java.lang.String[] childPropValues)
                                                throws java.lang.Exception
        Gets a Double attribute value for an attribute from the specified document or folder.

        Note: This method is not supported by Content Engine.

        Specified by:
        getChildDoubleProperty in interface filenet.contentops.IContentOperations
        Parameters:
        objAtt - A VWAttachment object for the document or folder information.
        propName - A String containing the attribute name. Attribute names are in the form: ChildComponentName1/ChildComponentName2/�/attributeName or ChildComponentName1/ChildComponentName2/�/attributeGroup.attributeName).
        childPropNames - A String array of child attribute names.
        childPropTypes - A String array of child attribute types.
        childPropValues - An String array of values to set for the attribute specified.
        Returns:
        A Double attribute value.
        Throws:
        java.lang.Exception
        Since:
        P8 5.0
      • getChildIntegerProperty

        public java.lang.Integer getChildIntegerProperty(filenet.vw.api.VWAttachment objAtt,
                                                java.lang.String propName,
                                                java.lang.String[] childPropNames,
                                                java.lang.String[] childPropTypes,
                                                java.lang.String[] childPropValues)
                                                  throws java.lang.Exception
        Gets an Integer attribute value for an attribute from the specified document or folder.

        Note: This method is not supported by Content Engine.

        Specified by:
        getChildIntegerProperty in interface filenet.contentops.IContentOperations
        Parameters:
        objAtt - A VWAttachment object for the document or folder information.
        propName - A String containing the attribute name. Attribute names are in the form: ChildComponentName1/ChildComponentName2/�/attributeName or ChildComponentName1/ChildComponentName2/�/attributeGroup.attributeName).
        childPropNames - A String array of child attribute names.
        childPropTypes - A String array of child attribute types.
        childPropValues - An String array of values to set for the attribute specified.
        Returns:
        An Integer attribute value.
        Throws:
        java.lang.Exception
        Since:
        P8 5.0
      • getChildStringProperty

        public java.lang.String getChildStringProperty(filenet.vw.api.VWAttachment objAtt,
                                              java.lang.String propName,
                                              java.lang.String[] childPropNames,
                                              java.lang.String[] childPropTypes,
                                              java.lang.String[] childPropValues)
                                                throws java.lang.Exception
        Gets a String attribute value for an attribute from the specified document or folder.

        Note: This method is not supported by Content Engine.

        Specified by:
        getChildStringProperty in interface filenet.contentops.IContentOperations
        Parameters:
        objAtt - A VWAttachment object for the document or folder information.
        propName - A String containing the attribute name. Attribute names are in the form: ChildComponentName1/ChildComponentName2/�/attributeName or ChildComponentName1/ChildComponentName2/�/attributeGroup.attributeName).
        childPropNames - A String array of child attribute names.
        childPropTypes - A String array of child attribute types.
        childPropValues - An String array of values to set for the attribute specified.
        Returns:
        A String attribute value.
        Throws:
        java.lang.Exception
        Since:
        P8 5.0
      • setChildDateProperty

        public void setChildDateProperty(filenet.vw.api.VWAttachment objAtt,
                                java.lang.String propName,
                                java.lang.String[] childPropNames,
                                java.lang.String[] childPropTypes,
                                java.lang.String[] childPropValues,
                                java.util.Date value)
                                  throws java.lang.Exception
        Sets a Date attribute value for an attribute from the specified document or folder.

        Note: This method is not supported by Content Engine.

        Specified by:
        setChildDateProperty in interface filenet.contentops.IContentOperations
        Parameters:
        objAtt - A VWAttachment object for the document or folder information.
        propName - A String containing the attribute name. Attribute names are in the form: ChildComponentName1/ChildComponentName2/�/attributeName or ChildComponentName1/ChildComponentName2/�/attributeGroup.attributeName).
        childPropNames - A String array of child attribute names.
        childPropTypes - A String array of child attribute types.
        childPropValues - An String array of values to set for the attribute specified.
        Throws:
        java.lang.Exception
        Since:
        P8 5.0
      • setChildDoubleProperty

        public void setChildDoubleProperty(filenet.vw.api.VWAttachment objAtt,
                                  java.lang.String propName,
                                  java.lang.String[] childPropNames,
                                  java.lang.String[] childPropTypes,
                                  java.lang.String[] childPropValues,
                                  java.lang.Double value)
                                    throws java.lang.Exception
        Sets a Double attribute value for an attribute from the specified document or folder.

        Note: This method is not supported by Content Engine.

        Specified by:
        setChildDoubleProperty in interface filenet.contentops.IContentOperations
        Parameters:
        objAtt - A VWAttachment object for the document or folder information.
        propName - A String containing the attribute name. Attribute names are in the form: ChildComponentName1/ChildComponentName2/�/attributeName or ChildComponentName1/ChildComponentName2/�/attributeGroup.attributeName).
        childPropNames - A String array of child attribute names.
        childPropTypes - A String array of child attribute types.
        childPropValues - An String array of values to set for the attribute specified.
        Throws:
        java.lang.Exception
        Since:
        P8 5.0
      • setChildIntegerProperty

        public void setChildIntegerProperty(filenet.vw.api.VWAttachment objAtt,
                                   java.lang.String propName,
                                   java.lang.String[] childPropNames,
                                   java.lang.String[] childPropTypes,
                                   java.lang.String[] childPropValues,
                                   java.lang.Integer value)
                                     throws java.lang.Exception
        Sets an Integer attribute value for an attribute from the specified document or folder.

        Note: This method is not supported by Content Engine.

        Specified by:
        setChildIntegerProperty in interface filenet.contentops.IContentOperations
        Parameters:
        objAtt - A VWAttachment object for the document or folder information.
        propName - A String containing the attribute name. Attribute names are in the form: ChildComponentName1/ChildComponentName2/�/attributeName or ChildComponentName1/ChildComponentName2/�/attributeGroup.attributeName).
        childPropNames - A String array of child attribute names.
        childPropTypes - A String array of child attribute types.
        childPropValues - An String array of values to set for the attribute specified.
        Throws:
        java.lang.Exception
        Since:
        P8 5.0
      • setChildStringProperty

        public void setChildStringProperty(filenet.vw.api.VWAttachment objAtt,
                                  java.lang.String propName,
                                  java.lang.String[] childPropNames,
                                  java.lang.String[] childPropTypes,
                                  java.lang.String[] childPropValues,
                                  java.lang.String value)
                                    throws java.lang.Exception
        Sets a String attribute value for an attribute from the specified document or folder.

        Note: This method is not supported by Content Engine.

        Specified by:
        setChildStringProperty in interface filenet.contentops.IContentOperations
        Parameters:
        objAtt - A VWAttachment object for the document or folder information.
        propName - A String containing the attribute name. Attribute names are in the form: ChildComponentName1/ChildComponentName2/�/attributeName or ChildComponentName1/ChildComponentName2/�/attributeGroup.attributeName).
        childPropNames - A String array of child attribute names.
        childPropTypes - A String array of child attribute types.
        childPropValues - An String array of values to set for the attribute specified.
        Throws:
        java.lang.Exception
        Since:
        P8 5.0

© Copyright IBM Corporation 2002, 2013. All rights reserved.