|
Process Class Relationships | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object | +--filenet.vw.api.VWAttachment
Use this class to access the identity, associated library, type, and version of an attachment used in a workflow process.
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 | |
java.lang.String |
getAttachmentDescription()
Gets the description for an attachment. |
java.lang.String |
getAttachmentName()
Gets the document name associated with this attachment. |
java.lang.String |
getId()
Gets the document ID for the attachment. |
java.lang.String |
getLibraryName()
Gets the name of the library 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. |
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 associated with this attachment. |
void |
setLibraryType(int theLibraryType)
Sets the library |
void |
setType(int theAttachmentType)
Sets the attachment type} for this 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 a library. |
void |
toXML(java.lang.StringBuffer theBuffer)
Appends an XML string that represents this VWAttachment object to the buffer specified by the input parameter. |
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 java.lang.String getId()
getVersion()
public void setId(java.lang.String theId) throws VWException
theId
- A String value set as the
document ID.
You cannot
include 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 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
name. You cannot use the SEPARATOR
character, which is
reserved for internal use.
For Image Services libraries, formatting the library name string is described in the Network Options section of the Introduction to the Panagon Image Services System Administrator’s Handbook. For Content Services Libraries, library name string formatting is described in the library name reference in the Panagon Toolkit Help.
VWException
- This method throws an exception
if the restricted <SEPARATOR> character is found in
the String.public java.lang.String getAttachmentName()
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
- This method throws an exception
if the restricted <SEPARATOR> character is found in the
String.public java.lang.String getAttachmentDescription()
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
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
type of the attachment.VWException
- Thrown if the
library
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
theBuffer
- A string buffer that this method will append with
XML content.VWException
- VWXMLUtil
|
Process Class Relationships | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |