|
Process API | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectfilenet.vw.api.VWAttachment
public final class VWAttachment
Use this class to access the identity, associated library or object store, type, Document ID, and version series of an attachment used in a workflow process.
Examples of retrieving and setting attachments follow:
VWAttachment vwattach = (VWAttachment) stepElement.getParameterValue("attachmentfield");
vwattach = new VWAttachment(); vwattach.setId(versionseries_id); vwattach.setVersion(versionid); vwattach.setLibraryName("myobjectstore"); vwattach.setLibraryType(VWLibraryType.LIBRARY_TYPE_CONTENT_ENGINE); vwattach.setType(VWAttachmentType.ATTACHMENT_TYPE_DOCUMENT); stepElement.setParameter("attachmentfield", vwattach, false);
VWDataField
,
VWParameter
,
Serialized FormField Summary | |
---|---|
static char |
SEPARATOR
Insert this separator ('|' or hex 7C) between attributes of a string-formatted attachment, as in an XML file or an XML transfer stream to the server. |
Constructor Summary | |
---|---|
VWAttachment()
Creates a VWAttachment object with empty values, initially. |
|
VWAttachment(java.lang.String theValue)
Creates a VWAttachment object and sets the initial value. |
Method Summary | |
---|---|
static java.lang.String |
_get_FILE_AUTHOR()
For FileNet internal use only, do not call. |
static java.lang.String |
_get_FILE_DATE()
For FileNet internal use only, do not call. |
static java.lang.String |
_get_FILE_REVISION()
For FileNet internal use only, do not call. |
java.lang.String |
getAttachmentDescription()
Gets the description for this attachment. |
java.lang.String |
getAttachmentName()
Gets the name associated with this attachment. |
java.lang.String |
getId()
Gets the object, version series, or document ID for the attachment. |
java.lang.String |
getLibraryName()
Gets the name of the library or object store where the attachment resides. |
int |
getLibraryType()
Gets the library type of the library or object store that contains this attachment. |
int |
getType()
Gets the attachment type value for the associated attachement. |
java.lang.String |
getVersion()
Gets the version of this attachment. |
void |
setAttachmentDescription(java.lang.String theAttachmentDescription)
Sets the description for an attachment. |
void |
setAttachmentName(java.lang.String theAttachmentName)
Sets the document name for this attachment. |
void |
setId(java.lang.String theId)
Sets the document ID associated with the attachment. |
void |
setLibraryName(java.lang.String theLibraryName)
Sets the name of the library or object store associated with this attachment. |
void |
setLibraryType(int theLibraryType)
Sets the library or object store type for the library or object store containing this attachment. |
void |
setType(int theAttachmentType)
Sets the attachment type value for the associated attachment. |
void |
setVersion(java.lang.String theVersion)
Sets the GUID for the attachment version for this attachment document. |
java.lang.String |
toString()
Gets the String representation of a VWAttachment object associated with a document contained in library or object store The String contains seven elements; each element is delimited by the SEPARATOR . |
void |
toXML(java.lang.StringBuffer theBuffer)
Appends an XML string representing this instance to the buffer specified. |
Methods inherited from class java.lang.Object |
---|
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Field Detail |
---|
public static final char SEPARATOR
Constructor Detail |
---|
public VWAttachment()
public VWAttachment(java.lang.String theValue) throws VWException
theValue
- A String representation of the attachment values
in the format produced by toString().
VWException
- Thrown if the passed in value is not valid, due
to either format or content.VWAttachmentType
,
VWLibraryType
,
toString()
Method Detail |
---|
public static java.lang.String _get_FILE_DATE()
public static java.lang.String _get_FILE_AUTHOR()
public static java.lang.String _get_FILE_REVISION()
public java.lang.String getId()
getVersion()
public void setId(java.lang.String theId) throws VWException
theId
- The document ID or version series GUID.
You cannot
include the SEPARATOR
character, which is reserved for
internal use. In addition, special ID values may be used, whose
values and their effects are as follows:
VWException
- Thrown for various causes, including
when the restricted <SEPARATOR> character is found
in the input String.public java.lang.String getVersion()
public void setVersion(java.lang.String theVersion) throws VWException
theVersion
- The String value of the new
version GUID for the attachment.
VWException
- Thrown if the method fails to set the
attachment version information.public java.lang.String getLibraryName()
public void setLibraryName(java.lang.String theLibraryName) throws VWException
theLibraryName
- String value to set as the
library or object store
name. You cannot use the SEPARATOR
character, which is
reserved for internal use.
Library and Object store names conform to the database naming convention rules for your database. In general, this means that an object store name may be up to 64 characters long and cannot contain any of the following characters:
\ / : * ? " < > |
See the documentation for your database for information on further restrictions that apply.
VWException
- This method throws an exception
if the restricted <SEPARATOR> character is found in
the String.public java.lang.String getAttachmentName()
Note: The translation is done only at runtime, so will not appear in design-time applications (such as the Process Designer or Configuration Console).
public void setAttachmentName(java.lang.String theAttachmentName) throws VWException
theAttachmentName
- A String containing the attachment name.
You cannot use the SEPARATOR
character, which is reserved
for internal use.
VWException
- Thrown if the restricted <SEPARATOR> character is found in the specified string.public java.lang.String getAttachmentDescription()
Note: The translation is done only at runtime, so will not appear in design-time applications (such as the Process Designer or Configuration Console).
public void setAttachmentDescription(java.lang.String theAttachmentDescription) throws VWException
theAttachmentDescription
- A String containing the
attachment description. You cannot use the SEPARATOR
character, which is reserved for internal use.
VWException
- This method throws an exception
if the restricted <SEPARATOR> character is found
in the String.public int getType()
VWAttachmentType
public void setType(int theAttachmentType) throws VWException
theAttachmentType
- Integer value of the new type for the
associated attachment. You cannot use the SEPARATOR
character, which is reserved for internal use.
VWException
- Thrown if the
restricted <SEPARATOR> character is found in the String.VWAttachmentType
public int getLibraryType()
VWLibraryType
,
setLibraryType(int)
public void setLibraryType(int theLibraryType) throws VWException
theLibraryType
- An integer value for the new
library or object store type of the attachment.
VWException
- Thrown if the
library or object store type is invalid.VWLibraryType
public java.lang.String toString()
SEPARATOR
. The String elements are:
toString
in class java.lang.Object
VWAttachmentType
,
VWLibraryType
public void toXML(java.lang.StringBuffer theBuffer) throws VWException
Warning: This XML string is nonextensible, and cannot be modified in any way.
theBuffer
- A StringBuffer that will be appended with the XML content.
VWException
- Thrown if the specified buffer is null.VWXMLUtil
|
Process API | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |