Overview  Package   Class  Use  Deprecated  Index
Home >> All >> org >> mitre >> [ cvw overview ]	PREV CLASS  NEXT CLASS
SUMMARY:  JAVADOC |  SOURCE |  DOWNLOAD | NESTED | FIELD | CONSTR | METHOD	DETAIL: FIELD | CONSTR | METHOD

---

org.mitre.cvw
Class CVWDocument  

java.lang.Object
  java.util.Observable
      org.mitre.cvw.CVWObject
          org.mitre.cvw.CVWDocument

All Implemented Interfaces:

ObjectValues, java.io.Serializable

---

class CVWDocument

extends CVWObject

This class represents the Document object of the CVW server.

Version:

1.0

---

Field Summary
private  CVWDocument	changedDoc
(package private)  boolean	checked_out
(package private)  java.lang.String	docID
(package private)  java.lang.String	docServer
(package private)  java.lang.String	docType

 

Fields inherited from class org.mitre.cvw.CVWObject

ACCESS, ACL, cached, createdOn, desc, GETINFO, icon, jcvw, lastModifiedBy, lastModifiedOn, location, MEMBERS, metaDataType, name, ObjectTypes, objNum, owner, owners, sessile, type, typeValue

 

Fields inherited from class java.util.Observable

 

Fields inherited from interface org.mitre.cvw.ObjectValues

BALLOT, CHECKEDOUTDOC, CHECKOUT, CURRONLINEUSER, CURRUSER, DISCONNECTED, DOC, DOC_SC, DOCBUSY, DOCCHECKIN, DOCCOPY, DOCCREATE, DOCCREATEBACKGROUND, DOCCREATEDATE, DOCCREATOR, DOCCREATORONLY, DOCDELETE, DOCDESC, DOCEDITORS, DOCEXPORT, DOCINFO, DOCMIMETYPE, DOCOPEN, DOCSETDESC, DOCSTATUS, DOCTYPE, DOCUMENT, DROP, FLOOR, FOLDER, FOLDER_SC, FORM, FORMFOLDER, GETALLTYPES, GETCHECKEDDOCS, GETDOCTEXTS, GETDOCTEXTSCO, GETEXTDESC, GROUP, IMAGEMENU, NOTCHECKEDOUTDOC, NOTE, NOTE_SC, ONLINEUSER, PROXY, PROXYWIN, RECORDER, REMOTE, REMOTEUSER, REVERT, REVISION, ROOM, ROOMKEY, SETDOCATTRS, SETDOCNAME, STANDARD, TAKE, UNKNOWN, URL, URL_SC, USER, USERSTAT, WB, WHITEBOARD, WHITEBOARD_SC

 

Constructor Summary

CVWDocument()           Constructor

CVWDocument(int type, java.lang.String id)           Constructor

CVWDocument(java.lang.String docServer)           Constructor

CVWDocument(java.lang.String docServer, int type, java.lang.String id)

 

Method Summary
void	checkIn(java.lang.String save)           Processes a checkin for this document from the CVW server.
void	checkInError(java.lang.String errMsg)           Processes a checkin error for this document from the CVW server.
void	checkOut()
void	checkOutError(java.lang.String errMsg)           Processes a checkout error for this document from the CVW server.
void	confirmDelete(java.lang.String name, int finalTime)           Either notifies the user that the object has been deleted or confirms the delete of the object with the user because the CVW server has okayed the user to delete the object (i.e.
void	create()           Imports a document by showing the standard system file open dialog and then a standard CVW document get information dialog.
void	createWhiteboard()
void	createWhiteboardError(java.lang.String err)
void	createWhiteboardInit()           Creates a whiteboard from this document by opening a a standard CVW whiteboard get information dialog.
void	doDocCopy(java.lang.String newObjNum)           When the user requests a document to be copied, the CVWServer sends an object number of a new CVW document object with the doc id to be copied.
boolean	doDocDelete(boolean finalTime)           Tries to delete the document on the Doc server, sends whether the the deletion was successful to the CVW server.
boolean	doDocFunction(java.lang.String funct)           Processes a function performed on this CVWDocument
void	export()           Processes an export for this document from the CVW server.
java.lang.String	getDocID()           Returns the document id for this document
static java.lang.String	getDocTypeFromFile(java.lang.String path)           Returns the document type as stored on the Document server given a full filename.
static java.util.Vector	getDocTypes(java.util.Vector docidVec)           Get the Doc Types information vector This uses the default operation (DSIController.GETDOCTEXTS) 8/28/98 srj - changed this method to call the other getDocTypes 3/24/98 dage - moved from CVWCoordinator
static java.util.Vector	getDocTypes(java.util.Vector docidVec, boolean checkOutCheck)           Get user specified Doc Types 12/23/98 dage - Changed Op parameter to type boolean 8/27/98 srj - Added Op parameter 3/24/98 dage - moved from CVWCoordinator '
static void	getDocTypes(java.util.Vector docs, java.util.Vector docids, boolean checkOutCheck)
void	getInfo(java.lang.String desc, java.lang.String perms, java.lang.String owners)           Opens the Get Info window for this object.
boolean	isCheckedOut()           Returns if this document is currently checked out/has been opened for editing
boolean	isShortcut()           Returns whether this document is a shortcut.
void	objectCopy(java.lang.String copyType)           Copy or create Shortcut of this document.
void	objectCreate(java.lang.String name, java.lang.String mimeType, boolean sessile, java.lang.String desc, java.lang.String path)           Starts the process of creating the MCP to be sent to the CVW server when the user creates a new document, tries to create it on the document server first and if that is successfull, then creates it on the CVW server.
void	objectCreate(java.lang.String name, java.lang.String mimeType, boolean sessile, java.lang.String desc, java.lang.String path, java.lang.Integer docID)           Starts the process of building the MCP to be sent to the CVW server to create a new document when it has been created succesfully on the document server 3/25/98
void	objectModify(java.lang.String newName, boolean newMove, java.lang.String newDesc)           Starts building the MCP for notifying the server of any change to the information of this object, also notifies the document server of any change to the name or description of this document.
void	objectModifyResult()           Starts building the MCP for notifying the server of any change to the information of this object, also notifies the document server of any change to the name or description of this document.
void	objectModifyResultError(java.lang.String errMsg)           Processes a modify object error for this document from the CVW server.
void	open()           Processes a open for view for this document from the CVW server.
java.lang.String	paramString()           Returns a string representing the state of this component.
static java.lang.String	parseDocType(java.lang.String dType)           Returns the document type of the passed in parameter with out the trailing "document"
void	setCheckOut(boolean checkout_value)           Sets the checked out state of this document
static void	setDocCheckOut(boolean state, java.lang.String oNum)           Sets the checked out state of a document given the object number.
void	startOpen()

 

Methods inherited from class org.mitre.cvw.CVWObject

autoOpenObject, buildObjNumStrVector, changed, checkQuota, convertBooleanToIntString, deleteResultError, displayError, doDropTake, get3rdPanel, getBaseName, getBaseType, getCreatedDateForDisplay, getDateForDetailDisplay, getDateForDisplay, getDetailName, getFederatedName, getIcon, getImage, getMetaDataType, getModifiedBy, getModifiedByName, getModifiedDateForDisplay, getName, getObjectCreateMCP, getObjectFrame, getObjectModifyMCP, getObjectPanel, getObjectPanel, getObjectTypes, getObjectTypeStrings, getObjNum, getObjNumStr, getOwnerName, getOwners, getRawDetailName, getStringFromType, getStringFromType, getTopLocation, getType, getTypeFromString, handleShortcutError, has3rdPanel, initObjectTypes, isCached, moveObject, moveObject, moveResult, newCommand, newObjNumString, objectCopyResult, objectCreate, objectCreate, objectCreateError, objectCreateResult, objectModify, prepTextForServer, setCached, setMetaDataType, setName, setOwners, setRawDetailName, setValues, setValues, showDeleteDialog, startDeleteDialog, startInfoDialog, startInfoDialog, toString, updateACLResult, updateDetailInfo, updateOwners, updateOwnersResult

 

Methods inherited from class java.util.Observable

addObserver, clearChanged, countObservers, deleteObserver, deleteObservers, hasChanged, notifyObservers, notifyObservers, setChanged

 

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

 

Field Detail

docID

java.lang.String docID

---

docType

java.lang.String docType

---

docServer

java.lang.String docServer

---

checked_out

boolean checked_out

---

changedDoc

private CVWDocument changedDoc

Constructor Detail

CVWDocument

public CVWDocument(int type,
                   java.lang.String id)

Constructor

---

CVWDocument

public CVWDocument(java.lang.String docServer,
                   int type,
                   java.lang.String id)

---

CVWDocument

public CVWDocument(java.lang.String docServer)

Constructor

---

CVWDocument

public CVWDocument()

Constructor

Method Detail

getDocTypes

public static java.util.Vector getDocTypes(java.util.Vector docidVec,
                                           boolean checkOutCheck)

Get user specified Doc Types 12/23/98 dage - Changed Op parameter to type boolean 8/27/98 srj - Added Op parameter 3/24/98 dage - moved from CVWCoordinator '

---

getDocTypes

public static java.util.Vector getDocTypes(java.util.Vector docidVec)

Get the Doc Types information vector This uses the default operation (DSIController.GETDOCTEXTS) 8/28/98 srj - changed this method to call the other getDocTypes 3/24/98 dage - moved from CVWCoordinator

---

getDocTypes

public static void getDocTypes(java.util.Vector docs,
                               java.util.Vector docids,
                               boolean checkOutCheck)

---

parseDocType

public static java.lang.String parseDocType(java.lang.String dType)

Returns the document type of the passed in parameter with out the trailing "document"

---

getDocTypeFromFile

public static java.lang.String getDocTypeFromFile(java.lang.String path)

Returns the document type as stored on the Document server given a full filename. This is store in the trans table on the Document server

---

setDocCheckOut

public static void setDocCheckOut(boolean state,
                                  java.lang.String oNum)

Sets the checked out state of a document given the object number.

---

doDocCopy

public void doDocCopy(java.lang.String newObjNum)

When the user requests a document to be copied, the CVWServer sends an object number of a new CVW document object with the doc id to be copied. The doc id of the document is sent to the document server. If the copy was successful, the document server returns a new doc id of the copy of the original document. Either the new doc id is sent to the CVW server or a message noting that there was an error on the document server.
MCP receive cvw-document-copy
MCP send cvw-document-copy-result

---

isShortcut

public boolean isShortcut()

Returns whether this document is a shortcut.

Overrides:

isShortcut in class CVWObject

---

getInfo

public void getInfo(java.lang.String desc,
                    java.lang.String perms,
                    java.lang.String owners)

Opens the Get Info window for this object.
MCP receive cvw-object-detail

Overrides:

getInfo in class CVWObject

---

getDocID

public java.lang.String getDocID()

Returns the document id for this document

---

objectModify

public void objectModify(java.lang.String newName,
                         boolean newMove,
                         java.lang.String newDesc)

Starts building the MCP for notifying the server of any change to the information of this object, also notifies the document server of any change to the name or description of this document.

Overrides:

objectModify in class CVWObject

---

objectModifyResult

public void objectModifyResult()

Starts building the MCP for notifying the server of any change to the information of this object, also notifies the document server of any change to the name or description of this document.

---

objectModifyResultError

public void objectModifyResultError(java.lang.String errMsg)

Processes a modify object error for this document from the CVW server.
MCP receive cvw-document-modify

---

objectCreate

public void objectCreate(java.lang.String name,
                         java.lang.String mimeType,
                         boolean sessile,
                         java.lang.String desc,
                         java.lang.String path)

Starts the process of creating the MCP to be sent to the CVW server when the user creates a new document, tries to create it on the document server first and if that is successfull, then creates it on the CVW server.

---

objectCreate

public void objectCreate(java.lang.String name,
                         java.lang.String mimeType,
                         boolean sessile,
                         java.lang.String desc,
                         java.lang.String path,
                         java.lang.Integer docID)

Starts the process of building the MCP to be sent to the CVW server to create a new document when it has been created succesfully on the document server 3/25/98

---

create

public void create()

Imports a document by showing the standard system file open dialog and then a standard CVW document get information dialog.

Overrides:

create in class CVWObject

---

createWhiteboardInit

public void createWhiteboardInit()

Creates a whiteboard from this document by opening a a standard CVW whiteboard get information dialog.

---

createWhiteboard

public void createWhiteboard()

---

createWhiteboardError

public void createWhiteboardError(java.lang.String err)

---

startOpen

public void startOpen()

Overrides:

startOpen in class CVWObject

---

doDocDelete

public boolean doDocDelete(boolean finalTime)

Tries to delete the document on the Doc server, sends whether the the deletion was successful to the CVW server.
MCP receive cvw-document-delete
MCP send cvw-document-delete

---

confirmDelete

public void confirmDelete(java.lang.String name,
                          int finalTime)

Either notifies the user that the object has been deleted or confirms the delete of the object with the user because the CVW server has okayed the user to delete the object (i.e. the suer has permissions)
MCP receive cvw-object-delete-result

Overrides:

confirmDelete in class CVWObject

---

objectCopy

public void objectCopy(java.lang.String copyType)

Copy or create Shortcut of this document. User selected Copy or Shortcut from the object menu.

Overrides:

objectCopy in class CVWObject

---

doDocFunction

public boolean doDocFunction(java.lang.String funct)

Processes a function performed on this CVWDocument

---

open

public void open()

Processes a open for view for this document from the CVW server.
MCP receive cvw-object-window

---

export

public void export()

Processes an export for this document from the CVW server.
MCP receive cvw-object-export

---

checkIn

public void checkIn(java.lang.String save)

Processes a checkin for this document from the CVW server.
MCP receive cvw-document-checkin

---

checkInError

public void checkInError(java.lang.String errMsg)

Processes a checkin error for this document from the CVW server.
MCP receive cvw-document-checkin

---

checkOut

public void checkOut()

---

checkOutError

public void checkOutError(java.lang.String errMsg)

Processes a checkout error for this document from the CVW server.
MCP receive cvw-document-checkout

---

isCheckedOut

public boolean isCheckedOut()

Returns if this document is currently checked out/has been opened for editing

---

setCheckOut

public void setCheckOut(boolean checkout_value)

Sets the checked out state of this document

---

paramString

public java.lang.String paramString()

Returns a string representing the state of this component.

Overrides:

paramString in class CVWObject

---

Overview  Package   Class  Use  Deprecated  Index
Home >> All >> org >> mitre >> [ cvw overview ]	PREV CLASS  NEXT CLASS
SUMMARY:  JAVADOC |  SOURCE |  DOWNLOAD | NESTED | FIELD | CONSTR | METHOD	DETAIL: FIELD | CONSTR | METHOD

---