|
Process UI Toolkit API | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectfilenet.vw.toolkit.runtime.step.core.attachments.VWAttachmentHelper
public class VWAttachmentHelper
This class controls workflow attachments with management, access control, and document status methods.
The management method tasks include the following:
The access control method tasks include the following:
The document status method tasks include the following:
Constructor Summary | |
---|---|
VWAttachmentHelper(filenet.vw.api.VWAttachment vwAttachment)
Constructor |
Method Summary | |
---|---|
boolean |
canCancelCheckout()
Return true if the check out can be canceled. |
void |
cancelCheckout()
Cancel the document check out. |
boolean |
canCheckin()
Return true if the item can be checked in. |
boolean |
canCheckout()
Return true if the item can be checked out. |
boolean |
canOpen()
Return true if the item can be opened. |
boolean |
canView()
Return true if the item can be viewed. |
void |
checkin()
Check in the document. |
void |
checkout()
Check out the document. |
void |
checkoutAndOpen()
Check out and open the document. |
boolean |
isCheckedOut()
Gets the checked out status of the item. |
boolean |
isDocument()
Return true if the attachment is a document. |
boolean |
isISItem()
Return true if the attachment is an
Image Service item. |
void |
open()
Open the attached item. |
void |
showPropertiesDialog()
Display the property window. |
void |
showVersionListWindow()
Display the version list window. |
void |
updateCheckoutStatus()
Updates the checkout status of the item. |
void |
view()
Display the document in the configured viewer. |
Methods inherited from class java.lang.Object |
---|
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public VWAttachmentHelper(filenet.vw.api.VWAttachment vwAttachment)
vwAttachment
- Method Detail |
---|
public boolean canView() throws java.lang.Exception
true
if the item can be viewed.
true
if the item can be viewed.
java.lang.Exception
public boolean canOpen() throws java.lang.Exception
true
if the item can be opened.
true
if the item can be opened.
java.lang.Exception
public boolean canCheckin() throws java.lang.Exception
true
if the item can be checked in.
true
if the item can be checked in.
java.lang.Exception
public boolean canCheckout() throws java.lang.Exception
true
if the item can be checked out.
true
if the item can be checked out.
java.lang.Exception
public boolean canCancelCheckout() throws java.lang.Exception
true
if the check out can be canceled.
true
if the check out can be canceled.
java.lang.Exception
public boolean isDocument() throws java.lang.Exception
true
if the attachment is a document.
true
if the attachment is a document.
java.lang.Exception
public boolean isISItem() throws java.lang.Exception
true
if the attachment is an
Image Service item.
true
if the attachment is an
Image Service item.
java.lang.Exception
public boolean isCheckedOut() throws java.lang.Exception
true
if the item is checked out.
java.lang.Exception
public void updateCheckoutStatus() throws java.lang.Exception
java.lang.Exception
public void view() throws java.lang.Exception
java.lang.Exception
public void open() throws java.lang.Exception
java.lang.Exception
public void checkout() throws java.lang.Exception
java.lang.Exception
public void checkoutAndOpen() throws java.lang.Exception
java.lang.Exception
public void checkin() throws java.lang.Exception
java.lang.Exception
public void cancelCheckout() throws java.lang.Exception
java.lang.Exception
public void showVersionListWindow() throws java.lang.Exception
java.lang.Exception
public void showPropertiesDialog() throws java.lang.Exception
java.lang.Exception
|
Process UI Toolkit API | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |