com.esri.arcgis.carto
Class DocumentInfo

java.lang.Object
  com.esri.arcgis.carto.DocumentInfo

All Implemented Interfaces:

IDocumentInfo, IDocumentInfo2, IDocumentInfo3, com.esri.arcgis.interop.RemoteObjRef, java.io.Serializable

public class DocumentInfo
extends java.lang.Object
implements com.esri.arcgis.interop.RemoteObjRef, IDocumentInfo, IDocumentInfo2, IDocumentInfo3

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

Description 'The DocumentInfo coclass is used to read and write map document properties.' 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.IDocumentInfo

IID, IIDd3e5c54e_2a84_11d4_9ff2_00c04f6bc78e, xxDummy

Fields inherited from interface com.esri.arcgis.carto.IDocumentInfo3

IID, IID8bcb734e_6d92_4c17_beb3_9b0e7cf3724e, xxDummy

Fields inherited from interface com.esri.arcgis.carto.IDocumentInfo2

IIDd3e5c54f_2a84_11d4_9ff2_00c04f6bc78e

Constructor Summary

DocumentInfo()
Constructs a DocumentInfo using ArcGIS Engine.

DocumentInfo(java.lang.Object obj)
Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
DocumentInfo theDocumentInfo = (DocumentInfo) obj;

Method Summary

boolean	equals(java.lang.Object o) Compare this object with another
java.lang.String	getAccessConstraints() The access constraints of document info.
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	getDocumentTitle() The title of the document.
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.
java.lang.String	getName() The name of the document.
java.lang.String	getPath() The path of the document.
java.lang.String	getSubject() The subject of the document.
IPicture	getThumbnail() The thumbnail of document info.
int	hashCode() the hashcode for this object
boolean	isRelativePaths() Indicates if relative path is used when the document is saved.
boolean	isSavePreview() Indicates if a preview of the document is saved when the document is saved.
void	release() Release a DocumentInfo.
void	setAccessConstraints(java.lang.String pConstraints) The access constraints of document info.
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	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.
void	setThumbnail(IPicture ppThumbnail) The thumbnail of document info.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

DocumentInfo

public DocumentInfo()
             throws java.io.IOException,
                    java.net.UnknownHostException

Constructs a DocumentInfo using ArcGIS Engine.

Throws:

java.io.IOException - if there are interop problems

java.net.UnknownHostException - if there are interop problems

DocumentInfo

public DocumentInfo(java.lang.Object obj)
             throws java.io.IOException

Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
DocumentInfo theDocumentInfo = (DocumentInfo) obj;

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

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 DocumentInfo.

Specified by:

release in interface com.esri.arcgis.interop.RemoteObjRef

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.

getAccessConstraints

public java.lang.String getAccessConstraints()
                                      throws java.io.IOException,
                                             AutomationException

The access constraints of document info.

Specified by:

getAccessConstraints in interface IDocumentInfo3

Returns:

The pConstraints

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setAccessConstraints

public void setAccessConstraints(java.lang.String pConstraints)
                          throws java.io.IOException,
                                 AutomationException

The access constraints of document info.

Specified by:

setAccessConstraints in interface IDocumentInfo3

Parameters:

pConstraints - The pConstraints (in)

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 of document info.

Specified by:

getThumbnail in interface IDocumentInfo3

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.

setThumbnail

public void setThumbnail(IPicture ppThumbnail)
                  throws java.io.IOException,
                         AutomationException

The thumbnail of document info.

Specified by:

setThumbnail in interface IDocumentInfo3

Parameters:

ppThumbnail - A reference to a com.esri.arcgis.support.ms.stdole.IPicture (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.