com.esri.arcgis.carto
Class MapDocument

java.lang.Object
  extended by com.esri.arcgis.carto.MapDocument
All Implemented Interfaces:
IDocumentInfo, IDocumentInfo2, IDocumentPreview, IMapDocument, com.esri.arcgis.interop.RemoteObjRef, IDocumentVersion, java.io.Serializable

public class MapDocument
extends java.lang.Object
implements com.esri.arcgis.interop.RemoteObjRef, IMapDocument, IDocumentVersion, IDocumentInfo, IDocumentInfo2, IDocumentPreview

COM Class 'MapDocument'. Generated 3/19/2015 1:20:41 PM from 'C:\ArcGIS\COM\esriCarto.olb'

Description 'The MapDocument coclass is used to read and write map document files.' Generator Options: PromptForTypeLibraries = False ClashPrefix = esri_ LowerCaseMemberNames = True IDispatchOnly = False RetryOnReject = False AwtForOcxs = True ArraysAsObjects = False DontRenameSameMethods = False ImplementConflictingInterfaces = True ReuseMethods = True RenameConflictingInterfaceMethods = True GenBeanInfo = True GenerateJavadoc =

See Also:
Serialized Form

Field Summary
 
Fields inherited from interface com.esri.arcgis.carto.IMapDocument
IID, IID5366451c_a001_4179_b8cb_e8f014628a44, xxDummy
 
Fields inherited from interface com.esri.arcgis.system.IDocumentVersion
IID, IIDecc43c55_0148_4ec1_bf87_b9a183c5dc98, xxDummy
 
Fields inherited from interface com.esri.arcgis.carto.IDocumentInfo
IID, IIDd3e5c54e_2a84_11d4_9ff2_00c04f6bc78e, xxDummy
 
Fields inherited from interface com.esri.arcgis.carto.IDocumentInfo2
IID, IIDd3e5c54f_2a84_11d4_9ff2_00c04f6bc78e, xxDummy
 
Fields inherited from interface com.esri.arcgis.carto.IDocumentPreview
IID, IIDefe86eff_4c92_47b8_af1b_2d7ded932e24, xxDummy
 
Constructor Summary
MapDocument()
          Constructs a MapDocument using ArcGIS Engine.
MapDocument(java.lang.Object obj)
          Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
MapDocument theMapDocument = (MapDocument) obj;
 
Method Summary
 void close()
          Close the map document.
 void createPreview()
          Creates a thumbnail preview of the document.
 void deletePreview()
          Deletes the thumbnail preview of the document.
 boolean equals(java.lang.Object o)
          Compare this object with another
 void esri_new(java.lang.String sDocument)
          Creates and opens a new map document in preparation for the contents to be retrieve or updated.
 IActiveView getActiveView()
          The ActiveView of the map document.
 java.lang.String getAuthor()
          The author of the document.
 java.lang.String getCategory()
          The category of the document.
static java.lang.String getClsid()
          getClsid.
 java.lang.String getComments()
          Comments for the document.
 java.lang.String getCredits()
          The credits of the document.
 java.lang.Object getDateExported()
          Date the document was last exported.
 java.lang.Object getDatePrinted()
          Date the document was last printed.
 java.lang.Object getDateSaved()
          Date the document was last saved.
 java.lang.String getDocumentFilename()
          The map document filename that the MapDocument coclass is linked to.
 java.lang.String getDocumentTitle()
          The title of the document.
 int getDocumentType()
          The type of map document currently loaded in the object.
 int getDocumentVersion()
          Indicates if the version of the map document is compatible with the current version of software.
 java.lang.String getFolder()
          The folder of the document.
 java.lang.String getHyperlinkBase()
          The hyperlink base of the document.
 com.esri.arcgis.interop.Dispatch getJintegraDispatch()
          Deprecated. Internal use only.
 java.lang.String getKeywords()
          The keywords for the document.
 ILayer getLayer(int mapIndex, int layerIndex)
          The Layer object at the specified index for the specified map.
 IMap getMap(int mapIndex)
          The Map object at the specified index.
 int getMapCount()
          The number of Map objects contained within the map document.
 java.lang.String getName()
          The name of the document.
 IPageLayout getPageLayout()
          The PageLayout object.
 java.lang.String getPath()
          The path of the document.
 IPrinter getPrinter()
          The printer object.
 java.lang.String getSubject()
          The subject of the document.
 IPicture getThumbnail()
          The thumbnail stored in the map document.
 void getVersionInfo(boolean[] versionInfoMissing, int[] lMajor, int[] lMinor, int[] lRevision, int[] lBuild)
          Retrieve the detailed version information of the map document.
 int hashCode()
          the hashcode for this object
 boolean isHasPreviewSaved()
          Indicates the presence of a thumbnail preview in the document.
 boolean isHasPreviewToSave()
          Indicates the presence of a thumbnail preview to be saved with the document.
 boolean isMapDocument(java.lang.String sDocument)
          Indicates if the map document is a valid map document.
 boolean isPasswordProtected(java.lang.String sDocument)
          Indicates if the map document is protected by a passsword.
 boolean isPresent(java.lang.String sDocument)
          Indicates if the map document is present.
 boolean isReadOnly(java.lang.String sDocument)
          Indicates if the map document is read only.
 boolean isRelativePaths()
          Indicates if relative path is used when the document is saved.
 boolean isRestricted(java.lang.String sDocument)
          Indicates if the use of the map document is restricted to certain applications.
 boolean isSavePreview()
          Indicates if a preview of the document is saved when the document is saved.
 boolean isUsesRelativePaths()
          Indicates if the data in the map document is referenced using relative paths.
 void open(java.lang.String sDocument, java.lang.String bsPassword)
          Open the map document in preparation for the contents to be retrieve or updated.
 void release()
          Release a MapDocument.
 void replaceContents(IMxdContents pObject)
          Replace the contents of the map document.
 void save(boolean bUseRelativePaths, boolean bCreateThumnbail)
          Save the contents of the map document to the bound file.
 void saveAs(java.lang.String sDocument, boolean bUseRelativePaths, boolean bCreateThumnbail)
          Save the contents of the map document to the specified file name.
 void setActiveView(IActiveView pActiveView)
          Set the ActiveView content of the map document.
 void setAuthor(java.lang.String author)
          The author of the document.
 void setCategory(java.lang.String category)
          The category of the document.
 void setComments(java.lang.String comments)
          Comments for the document.
 void setCredits(java.lang.String credits)
          The credits of the document.
 void setDocumentTitle(java.lang.String title)
          The title of the document.
 void setDocumentVersion(int docVersion)
          The version of the document to save.
 void setHyperlinkBase(java.lang.String path)
          The hyperlink base of the document.
 void setKeywords(java.lang.String keywords)
          The keywords for the document.
 void setRelativePaths(boolean useRelativePaths)
          Indicates if relative path is used when the document is saved.
 void setSavePreview(boolean savePreview)
          Indicates if a preview of the document is saved when the document is saved.
 void setSubject(java.lang.String subject)
          The subject of the document.
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

MapDocument

public MapDocument()
            throws java.io.IOException,
                   java.net.UnknownHostException
Constructs a MapDocument using ArcGIS Engine.

Throws:
java.io.IOException - if there are interop problems
java.net.UnknownHostException - if there are interop problems

MapDocument

public MapDocument(java.lang.Object obj)
            throws java.io.IOException
Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
MapDocument theMapDocument = (MapDocument) obj;

Construct a MapDocument using a reference to such an object returned from ArcGIS Engine or Server. This is semantically equivalent to casting obj to MapDocument.

Parameters:
obj - an object returned from ArcGIS Engine or Server
Throws:
java.io.IOException - if there are interop problems
Method Detail

getClsid

public static java.lang.String getClsid()
getClsid.


equals

public boolean equals(java.lang.Object o)
Compare this object with another

Overrides:
equals in class java.lang.Object

hashCode

public int hashCode()
the hashcode for this object

Overrides:
hashCode in class java.lang.Object

getJintegraDispatch

public com.esri.arcgis.interop.Dispatch getJintegraDispatch()
Deprecated. Internal use only.

Specified by:
getJintegraDispatch in interface com.esri.arcgis.interop.RemoteObjRef

release

public void release()
Release a MapDocument.

Specified by:
release in interface com.esri.arcgis.interop.RemoteObjRef

isMapDocument

public boolean isMapDocument(java.lang.String sDocument)
                      throws java.io.IOException,
                             AutomationException
Indicates if the map document is a valid map document.

Specified by:
isMapDocument in interface IMapDocument
Parameters:
sDocument - The sDocument (in)
Returns:
The isMapDocument
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isPresent

public boolean isPresent(java.lang.String sDocument)
                  throws java.io.IOException,
                         AutomationException
Indicates if the map document is present.

Specified by:
isPresent in interface IMapDocument
Parameters:
sDocument - The sDocument (in)
Returns:
The isPresent
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isReadOnly

public boolean isReadOnly(java.lang.String sDocument)
                   throws java.io.IOException,
                          AutomationException
Indicates if the map document is read only.

Specified by:
isReadOnly in interface IMapDocument
Parameters:
sDocument - The sDocument (in)
Returns:
The isReadOnly
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isRestricted

public boolean isRestricted(java.lang.String sDocument)
                     throws java.io.IOException,
                            AutomationException
Indicates if the use of the map document is restricted to certain applications.

Specified by:
isRestricted in interface IMapDocument
Parameters:
sDocument - The sDocument (in)
Returns:
The isRestricted
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isPasswordProtected

public boolean isPasswordProtected(java.lang.String sDocument)
                            throws java.io.IOException,
                                   AutomationException
Indicates if the map document is protected by a passsword.

Specified by:
isPasswordProtected in interface IMapDocument
Parameters:
sDocument - The sDocument (in)
Returns:
The isPasswordProtected
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

esri_new

public void esri_new(java.lang.String sDocument)
              throws java.io.IOException,
                     AutomationException
Creates and opens a new map document in preparation for the contents to be retrieve or updated.

Specified by:
esri_new in interface IMapDocument
Parameters:
sDocument - The sDocument (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

open

public void open(java.lang.String sDocument,
                 java.lang.String bsPassword)
          throws java.io.IOException,
                 AutomationException
Open the map document in preparation for the contents to be retrieve or updated.

Specified by:
open in interface IMapDocument
Parameters:
sDocument - The sDocument (in)
bsPassword - The bsPassword (in, optional, pass if not required)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getDocumentFilename

public java.lang.String getDocumentFilename()
                                     throws java.io.IOException,
                                            AutomationException
The map document filename that the MapDocument coclass is linked to.

Specified by:
getDocumentFilename in interface IMapDocument
Returns:
The sDocument
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getDocumentType

public int getDocumentType()
                    throws java.io.IOException,
                           AutomationException
The type of map document currently loaded in the object.

Specified by:
getDocumentType in interface IMapDocument
Returns:
A com.esri.arcgis.carto.esriMapDocumentType constant
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isUsesRelativePaths

public boolean isUsesRelativePaths()
                            throws java.io.IOException,
                                   AutomationException
Indicates if the data in the map document is referenced using relative paths.

Specified by:
isUsesRelativePaths in interface IMapDocument
Returns:
The bUsesRelativePaths
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getDocumentVersion

public int getDocumentVersion()
                       throws java.io.IOException,
                              AutomationException
Indicates if the version of the map document is compatible with the current version of software.

Specified by:
getDocumentVersion in interface IMapDocument
Specified by:
getDocumentVersion in interface IDocumentVersion
Returns:
A com.esri.arcgis.carto.esriMapDocumentVersionInfo constant
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getPageLayout

public IPageLayout getPageLayout()
                          throws java.io.IOException,
                                 AutomationException
The PageLayout object.

Specified by:
getPageLayout in interface IMapDocument
Returns:
A reference to a com.esri.arcgis.carto.IPageLayout
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getActiveView

public IActiveView getActiveView()
                          throws java.io.IOException,
                                 AutomationException
The ActiveView of the map document.

Specified by:
getActiveView in interface IMapDocument
Returns:
A reference to a com.esri.arcgis.carto.IActiveView
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getMapCount

public int getMapCount()
                throws java.io.IOException,
                       AutomationException
The number of Map objects contained within the map document.

Specified by:
getMapCount in interface IMapDocument
Returns:
The mapCount
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getMap

public IMap getMap(int mapIndex)
            throws java.io.IOException,
                   AutomationException
The Map object at the specified index.

Specified by:
getMap in interface IMapDocument
Parameters:
mapIndex - The mapIndex (in)
Returns:
A reference to a com.esri.arcgis.carto.IMap
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getLayer

public ILayer getLayer(int mapIndex,
                       int layerIndex)
                throws java.io.IOException,
                       AutomationException
The Layer object at the specified index for the specified map.

Specified by:
getLayer in interface IMapDocument
Parameters:
mapIndex - The mapIndex (in)
layerIndex - The layerIndex (in)
Returns:
A reference to a com.esri.arcgis.carto.ILayer
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getPrinter

public IPrinter getPrinter()
                    throws java.io.IOException,
                           AutomationException
The printer object. If no printer object is stored in the map document this returns NULL.

Specified by:
getPrinter in interface IMapDocument
Returns:
A reference to a com.esri.arcgis.output.IPrinter
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getThumbnail

public IPicture getThumbnail()
                      throws java.io.IOException,
                             AutomationException
The thumbnail stored in the map document. If this is empty E_FAIL is returned.

Specified by:
getThumbnail in interface IMapDocument
Returns:
A reference to a com.esri.arcgis.support.ms.stdole.IPicture
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

close

public void close()
           throws java.io.IOException,
                  AutomationException
Close the map document.

Specified by:
close in interface IMapDocument
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getVersionInfo

public void getVersionInfo(boolean[] versionInfoMissing,
                           int[] lMajor,
                           int[] lMinor,
                           int[] lRevision,
                           int[] lBuild)
                    throws java.io.IOException,
                           AutomationException
Retrieve the detailed version information of the map document.

Specified by:
getVersionInfo in interface IMapDocument
Parameters:
versionInfoMissing - The versionInfoMissing (in/out: use single element array)
lMajor - The lMajor (in/out: use single element array)
lMinor - The lMinor (in/out: use single element array)
lRevision - The lRevision (in/out: use single element array)
lBuild - The lBuild (in/out: use single element array)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

replaceContents

public void replaceContents(IMxdContents pObject)
                     throws java.io.IOException,
                            AutomationException
Replace the contents of the map document.

Specified by:
replaceContents in interface IMapDocument
Parameters:
pObject - A reference to a com.esri.arcgis.carto.IMxdContents (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setActiveView

public void setActiveView(IActiveView pActiveView)
                   throws java.io.IOException,
                          AutomationException
Set the ActiveView content of the map document.

Specified by:
setActiveView in interface IMapDocument
Parameters:
pActiveView - A reference to a com.esri.arcgis.carto.IActiveView (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

save

public void save(boolean bUseRelativePaths,
                 boolean bCreateThumnbail)
          throws java.io.IOException,
                 AutomationException
Save the contents of the map document to the bound file.

Specified by:
save in interface IMapDocument
Parameters:
bUseRelativePaths - The bUseRelativePaths (in, optional, pass true if not required)
bCreateThumnbail - The bCreateThumnbail (in, optional, pass true if not required)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

saveAs

public void saveAs(java.lang.String sDocument,
                   boolean bUseRelativePaths,
                   boolean bCreateThumnbail)
            throws java.io.IOException,
                   AutomationException
Save the contents of the map document to the specified file name.

Specified by:
saveAs in interface IMapDocument
Parameters:
sDocument - The sDocument (in)
bUseRelativePaths - The bUseRelativePaths (in, optional, pass true if not required)
bCreateThumnbail - The bCreateThumnbail (in, optional, pass true if not required)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setDocumentVersion

public void setDocumentVersion(int docVersion)
                        throws java.io.IOException,
                               AutomationException
The version of the document to save.

Specified by:
setDocumentVersion in interface IDocumentVersion
Parameters:
docVersion - A com.esri.arcgis.system.esriArcGISVersion constant (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getDocumentTitle

public java.lang.String getDocumentTitle()
                                  throws java.io.IOException,
                                         AutomationException
The title of the document.

Specified by:
getDocumentTitle in interface IDocumentInfo
Specified by:
getDocumentTitle in interface IDocumentInfo2
Returns:
The title
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setDocumentTitle

public void setDocumentTitle(java.lang.String title)
                      throws java.io.IOException,
                             AutomationException
The title of the document.

Specified by:
setDocumentTitle in interface IDocumentInfo
Specified by:
setDocumentTitle in interface IDocumentInfo2
Parameters:
title - The title (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getSubject

public java.lang.String getSubject()
                            throws java.io.IOException,
                                   AutomationException
The subject of the document.

Specified by:
getSubject in interface IDocumentInfo
Specified by:
getSubject in interface IDocumentInfo2
Returns:
The subject
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setSubject

public void setSubject(java.lang.String subject)
                throws java.io.IOException,
                       AutomationException
The subject of the document.

Specified by:
setSubject in interface IDocumentInfo
Specified by:
setSubject in interface IDocumentInfo2
Parameters:
subject - The subject (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getAuthor

public java.lang.String getAuthor()
                           throws java.io.IOException,
                                  AutomationException
The author of the document.

Specified by:
getAuthor in interface IDocumentInfo
Specified by:
getAuthor in interface IDocumentInfo2
Returns:
The author
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setAuthor

public void setAuthor(java.lang.String author)
               throws java.io.IOException,
                      AutomationException
The author of the document.

Specified by:
setAuthor in interface IDocumentInfo
Specified by:
setAuthor in interface IDocumentInfo2
Parameters:
author - The author (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getCategory

public java.lang.String getCategory()
                             throws java.io.IOException,
                                    AutomationException
The category of the document.

Specified by:
getCategory in interface IDocumentInfo
Specified by:
getCategory in interface IDocumentInfo2
Returns:
The category
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setCategory

public void setCategory(java.lang.String category)
                 throws java.io.IOException,
                        AutomationException
The category of the document.

Specified by:
setCategory in interface IDocumentInfo
Specified by:
setCategory in interface IDocumentInfo2
Parameters:
category - The category (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getComments

public java.lang.String getComments()
                             throws java.io.IOException,
                                    AutomationException
Comments for the document.

Specified by:
getComments in interface IDocumentInfo
Specified by:
getComments in interface IDocumentInfo2
Returns:
The comments
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setComments

public void setComments(java.lang.String comments)
                 throws java.io.IOException,
                        AutomationException
Comments for the document.

Specified by:
setComments in interface IDocumentInfo
Specified by:
setComments in interface IDocumentInfo2
Parameters:
comments - The comments (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getKeywords

public java.lang.String getKeywords()
                             throws java.io.IOException,
                                    AutomationException
The keywords for the document.

Specified by:
getKeywords in interface IDocumentInfo
Specified by:
getKeywords in interface IDocumentInfo2
Returns:
The keywords
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setKeywords

public void setKeywords(java.lang.String keywords)
                 throws java.io.IOException,
                        AutomationException
The keywords for the document.

Specified by:
setKeywords in interface IDocumentInfo
Specified by:
setKeywords in interface IDocumentInfo2
Parameters:
keywords - The keywords (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getHyperlinkBase

public java.lang.String getHyperlinkBase()
                                  throws java.io.IOException,
                                         AutomationException
The hyperlink base of the document.

Specified by:
getHyperlinkBase in interface IDocumentInfo
Specified by:
getHyperlinkBase in interface IDocumentInfo2
Returns:
The path
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setHyperlinkBase

public void setHyperlinkBase(java.lang.String path)
                      throws java.io.IOException,
                             AutomationException
The hyperlink base of the document.

Specified by:
setHyperlinkBase in interface IDocumentInfo
Specified by:
setHyperlinkBase in interface IDocumentInfo2
Parameters:
path - The path (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isSavePreview

public boolean isSavePreview()
                      throws java.io.IOException,
                             AutomationException
Indicates if a preview of the document is saved when the document is saved.

Specified by:
isSavePreview in interface IDocumentInfo
Specified by:
isSavePreview in interface IDocumentInfo2
Returns:
The savePreview
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setSavePreview

public void setSavePreview(boolean savePreview)
                    throws java.io.IOException,
                           AutomationException
Indicates if a preview of the document is saved when the document is saved.

Specified by:
setSavePreview in interface IDocumentInfo
Specified by:
setSavePreview in interface IDocumentInfo2
Parameters:
savePreview - The savePreview (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getCredits

public java.lang.String getCredits()
                            throws java.io.IOException,
                                   AutomationException
The credits of the document.

Specified by:
getCredits in interface IDocumentInfo2
Returns:
The credits
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setCredits

public void setCredits(java.lang.String credits)
                throws java.io.IOException,
                       AutomationException
The credits of the document.

Specified by:
setCredits in interface IDocumentInfo2
Parameters:
credits - The credits (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isRelativePaths

public boolean isRelativePaths()
                        throws java.io.IOException,
                               AutomationException
Indicates if relative path is used when the document is saved.

Specified by:
isRelativePaths in interface IDocumentInfo2
Returns:
The useRelativePaths
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setRelativePaths

public void setRelativePaths(boolean useRelativePaths)
                      throws java.io.IOException,
                             AutomationException
Indicates if relative path is used when the document is saved.

Specified by:
setRelativePaths in interface IDocumentInfo2
Parameters:
useRelativePaths - The useRelativePaths (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getName

public java.lang.String getName()
                         throws java.io.IOException,
                                AutomationException
The name of the document.

Specified by:
getName in interface IDocumentInfo2
Returns:
The name
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getPath

public java.lang.String getPath()
                         throws java.io.IOException,
                                AutomationException
The path of the document.

Specified by:
getPath in interface IDocumentInfo2
Returns:
The path
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getFolder

public java.lang.String getFolder()
                           throws java.io.IOException,
                                  AutomationException
The folder of the document.

Specified by:
getFolder in interface IDocumentInfo2
Returns:
The folder
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getDateSaved

public java.lang.Object getDateSaved()
                              throws java.io.IOException,
                                     AutomationException
Date the document was last saved.

Specified by:
getDateSaved in interface IDocumentInfo2
Returns:
A Variant
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getDatePrinted

public java.lang.Object getDatePrinted()
                                throws java.io.IOException,
                                       AutomationException
Date the document was last printed.

Specified by:
getDatePrinted in interface IDocumentInfo2
Returns:
A Variant
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getDateExported

public java.lang.Object getDateExported()
                                 throws java.io.IOException,
                                        AutomationException
Date the document was last exported.

Specified by:
getDateExported in interface IDocumentInfo2
Returns:
A Variant
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

createPreview

public void createPreview()
                   throws java.io.IOException,
                          AutomationException
Creates a thumbnail preview of the document.

Specified by:
createPreview in interface IDocumentPreview
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

deletePreview

public void deletePreview()
                   throws java.io.IOException,
                          AutomationException
Deletes the thumbnail preview of the document.

Specified by:
deletePreview in interface IDocumentPreview
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isHasPreviewSaved

public boolean isHasPreviewSaved()
                          throws java.io.IOException,
                                 AutomationException
Indicates the presence of a thumbnail preview in the document.

Specified by:
isHasPreviewSaved in interface IDocumentPreview
Returns:
The hasPreviewSaved
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isHasPreviewToSave

public boolean isHasPreviewToSave()
                           throws java.io.IOException,
                                  AutomationException
Indicates the presence of a thumbnail preview to be saved with the document.

Specified by:
isHasPreviewToSave in interface IDocumentPreview
Returns:
The hasPreviewToSave
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.