Process UI Toolkit API

filenet.vw.toolkit.runtime.step.core.attachments
Class VWAttachmentHelper

java.lang.Object
  |
  +--filenet.vw.toolkit.runtime.step.core.attachments.VWAttachmentHelper

public class VWAttachmentHelper
extends java.lang.Object

This class provides attachment functionality.

Since:
eProcess 5.0

Constructor Summary
VWAttachmentHelper(filenet.vw.toolkit.runtime.step.core.attachments.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
protected  boolean hasNameChanged()
          Return true if the name of the item referenced by the attachment has changed (this is not the same as a reassign)
 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 IS item
 void open()
          Open the attached item
 void showPropertiesDialog()
          Display the property window
 void showVersionListWindow()
          Display the version list window
 void updateCheckoutStatus()
          Updates the IDM checkout status of the item
 void view()
          Display the document in the configured viewer
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

VWAttachmentHelper

public VWAttachmentHelper(filenet.vw.toolkit.runtime.step.core.attachments.VWAttachment vwAttachment)
Constructor
Parameters:
vwAttachment -  
Since:
eProcess 5.0
Method Detail

canView

public boolean canView()
                throws java.lang.Exception
Return true if the item can be viewed
Returns:
true if the item can be viewed
Throws:
java.lang.Exception -  
Since:
eProcess 5.0

canOpen

public boolean canOpen()
                throws java.lang.Exception
Return true if the item can be opened
Returns:
true if the item can be opened
Throws:
java.lang.Exception -  
Since:
eProcess 5.0

canCheckin

public boolean canCheckin()
                   throws java.lang.Exception
Return true if the item can be checked in
Returns:
true if the item can be checked in
Throws:
java.lang.Exception -  
Since:
eProcess 5.0

canCheckout

public boolean canCheckout()
                    throws java.lang.Exception
Return true if the item can be checked out
Returns:
true if the item can be checked out
Throws:
java.lang.Exception -  
Since:
eProcess 5.0

canCancelCheckout

public boolean canCancelCheckout()
                          throws java.lang.Exception
Return true if the check out can be canceled
Returns:
true if the check out can be canceled
Throws:
java.lang.Exception -  
Since:
eProcess 5.0

isDocument

public boolean isDocument()
                   throws java.lang.Exception
Return true if the attachment is a document
Returns:
true if the attachment is a document
Throws:
java.lang.Exception -  
Since:
eProcess 5.0

isISItem

public boolean isISItem()
                 throws java.lang.Exception
Return true if the attachment is an IS item
Returns:
true if the attachment is an IS item
Throws:
java.lang.Exception -  
Since:
eProcess 5.0

isCheckedOut

public boolean isCheckedOut()
                     throws java.lang.Exception
Gets the checked out status of the item
Returns:
true if the item is checked out
Throws:
java.lang.Exception -  
Since:
eProcess 5.0

updateCheckoutStatus

public void updateCheckoutStatus()
                          throws java.lang.Exception
Updates the IDM checkout status of the item
Since:
eProcess 5.0

view

public void view()
          throws java.lang.Exception
Display the document in the configured viewer
Throws:
java.lang.Exception -  
Since:
eProcess 5.0

open

public void open()
          throws java.lang.Exception
Open the attached item
Throws:
java.lang.Exception -  
Since:
eProcess 5.0

checkout

public void checkout()
              throws java.lang.Exception
Check out the document
Throws:
java.lang.Exception -  
Since:
eProcess 5.0

checkoutAndOpen

public void checkoutAndOpen()
                     throws java.lang.Exception
Check out and open the document
Throws:
java.lang.Exception -  
Since:
eProcess 5.0

checkin

public void checkin()
             throws java.lang.Exception
Check in the document
Throws:
java.lang.Exception -  
Since:
eProcess 5.0

cancelCheckout

public void cancelCheckout()
                    throws java.lang.Exception
Cancel the document check out
Throws:
java.lang.Exception -  
Since:
eProcess 5.0

showVersionListWindow

public void showVersionListWindow()
                           throws java.lang.Exception
Display the version list window
Throws:
java.lang.Exception -  
Since:
eProcess 5.0

showPropertiesDialog

public void showPropertiesDialog()
                          throws java.lang.Exception
Display the property window
Throws:
java.lang.Exception -  
Since:
eProcess 5.0

hasNameChanged

protected boolean hasNameChanged()
                          throws java.lang.Exception
Return true if the name of the item referenced by the attachment has changed (this is not the same as a reassign)
Returns:
true if the name of the item referenced by the attachment has changed
Throws:
java.lang.Exception -  
Since:
eProcess 5.0


Copyright © 2002, 2003 FileNet Corporation. All rights reserved.