|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object com.esri.arcgis.geoprocessing.GPFunctionName
public class GPFunctionName
Geoprocessing Function Name object.
Constructor Summary | |
---|---|
GPFunctionName()
Constructs a GPFunctionName using ArcGIS Engine. |
|
GPFunctionName(Object obj)
Deprecated. As of ArcGIS 9.2, replaced by normal Java casts. GPFunctionName theGPFunctionName = (GPFunctionName) obj; |
Method Summary | |
---|---|
void |
deserialize(IXMLSerializeData data)
Deserializes an object from XML. |
boolean |
equals(Object o)
Compare this object with another |
String |
getCategory()
The category of the GPName object. |
void |
getClassID(GUID[] pClassID)
getClassID |
static String |
getClsid()
getClsid. |
String |
getDescription()
The description of the GPName object. |
String |
getDisplayName()
The descriptive display name of the GPName object. |
Object |
getFactory()
The factory object of the GPName object. |
int |
getHelpContext()
The context identifier of the topic within the help file for this function associated with this name object. |
String |
getHelpFile()
Name of the (CHM) file containing help information for this function associated with this name object. |
int |
getMinimumProduct()
The minimum product required to use the function associated with this name object. |
String |
getName()
The name of the GPName object. |
String |
getNameString()
The name string of the object. |
int |
getRequiredExtension()
The extension, if any, required to use the function associated with this name object. |
void |
getSizeMax(_ULARGE_INTEGER[] pcbSize)
getSizeMax |
int |
hashCode()
the hashcode for this object |
void |
isDirty()
isDirty |
void |
load(IStream pstm)
load |
Object |
open()
Opens the object referred to by this name. |
void |
readExternal(ObjectInput in)
|
void |
save(IStream pstm,
int fClearDirty)
save |
void |
serialize(IXMLSerializeData data)
Serializes an object to XML. |
void |
setCategory(String path)
The category of the GPName object. |
void |
setDescription(String description)
The description of the GPName object. |
void |
setDisplayName(String name)
The descriptive display name of the GPName object. |
void |
setFactoryByRef(Object factory)
The factory object of the GPName object. |
void |
setHelpContext(int context)
The context identifier of the topic within the help file for this function associated with this name object. |
void |
setHelpFile(String file)
Name of the (CHM) file containing help information for this function associated with this name object. |
void |
setMinimumProduct(int product)
The minimum product required to use the function associated with this name object. |
void |
setName(String name)
The name of the GPName object. |
void |
setNameString(String nameString)
The name string of the object. |
void |
setRequiredExtension(int extension)
The extension, if any, required to use the function associated with this name object. |
void |
writeExternal(ObjectOutput out)
|
Methods inherited from class java.lang.Object |
---|
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait |
Methods inherited from interface com.esri.arcgis.interop.RemoteObjRef |
---|
getJintegraDispatch, release |
Constructor Detail |
---|
public GPFunctionName() throws IOException, UnknownHostException
IOException
- if there are interop problems
UnknownHostException
- if there are interop problemspublic GPFunctionName(Object obj) throws IOException
GPFunctionName theGPFunctionName = (GPFunctionName) obj;
obj
to GPFunctionName
.
obj
- an object returned from ArcGIS Engine or Server
IOException
- if there are interop problemsMethod Detail |
---|
public static String getClsid()
public boolean equals(Object o)
equals
in class Object
public int hashCode()
hashCode
in class Object
public void setNameString(String nameString) throws IOException, AutomationException
The NameString property is reserved for future use. When implemented, it will return a string representation of the locational component of the name object that may be persisted by applications.
setNameString
in interface IName
nameString
- The nameString (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public String getNameString() throws IOException, AutomationException
The NameString property is reserved for future use. When implemented, it will return a string representation of the locational component of the name object that may be persisted by applications.
getNameString
in interface IName
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public Object open() throws IOException, AutomationException
The Open method lets you instantiate the actual object given the name object.
Note: Opening a feature class that participates in a topology or geometric network will also open all other feature classes participating in the topology or geometric network in memory.
IName pName = pFeatureClassName;
pFeatureClass = new IFeatureClassProxy(pName.open());
open
in interface IName
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public String getName() throws IOException, AutomationException
getName
in interface IGPName
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void setName(String name) throws IOException, AutomationException
setName
in interface IGPName
name
- The name (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public String getDisplayName() throws IOException, AutomationException
getDisplayName
in interface IGPName
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void setDisplayName(String name) throws IOException, AutomationException
setDisplayName
in interface IGPName
name
- The name (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public String getDescription() throws IOException, AutomationException
getDescription
in interface IGPName
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void setDescription(String description) throws IOException, AutomationException
setDescription
in interface IGPName
description
- The description (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public String getCategory() throws IOException, AutomationException
getCategory
in interface IGPName
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void setCategory(String path) throws IOException, AutomationException
setCategory
in interface IGPName
path
- The path (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public Object getFactory() throws IOException, AutomationException
getFactory
in interface IGPName
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void setFactoryByRef(Object factory) throws IOException, AutomationException
setFactoryByRef
in interface IGPName
factory
- A reference to another Object (IUnknown) (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public int getMinimumProduct() throws IOException, AutomationException
getMinimumProduct
in interface IGPFunctionName
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void setMinimumProduct(int product) throws IOException, AutomationException
setMinimumProduct
in interface IGPFunctionName
product
- A com.esri.arcgis.system.esriProductCode constant (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public int getRequiredExtension() throws IOException, AutomationException
getRequiredExtension
in interface IGPFunctionName
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void setRequiredExtension(int extension) throws IOException, AutomationException
setRequiredExtension
in interface IGPFunctionName
extension
- A com.esri.arcgis.system.esriLicenseExtensionCode constant (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public String getHelpFile() throws IOException, AutomationException
getHelpFile
in interface IGPFunctionName
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void setHelpFile(String file) throws IOException, AutomationException
setHelpFile
in interface IGPFunctionName
file
- The file (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public int getHelpContext() throws IOException, AutomationException
getHelpContext
in interface IGPFunctionName
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void setHelpContext(int context) throws IOException, AutomationException
setHelpContext
in interface IGPFunctionName
context
- The context (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void isDirty() throws IOException, AutomationException
IPersistStream is a Microsoft interface. Please refer to MSDN for information about this interface.
isDirty
in interface IPersistStream
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void load(IStream pstm) throws IOException, AutomationException
IPersistStream is a Microsoft interface. Please refer to MSDN for information about this interface.
load
in interface IPersistStream
pstm
- A reference to a com.esri.arcgis.system.IStream (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void save(IStream pstm, int fClearDirty) throws IOException, AutomationException
IPersistStream is a Microsoft interface. Please refer to MSDN for information about this interface.
save
in interface IPersistStream
pstm
- A reference to a com.esri.arcgis.system.IStream (in)fClearDirty
- The fClearDirty (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void getSizeMax(_ULARGE_INTEGER[] pcbSize) throws IOException, AutomationException
IPersistStream is a Microsoft interface. Please refer to MSDN for information about this interface.
getSizeMax
in interface IPersistStream
pcbSize
- A Structure: com.esri.arcgis.system._ULARGE_INTEGER (out: use single element array)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void getClassID(GUID[] pClassID) throws IOException, AutomationException
IPersist is a Microsoft interface. Please refer to MSDN for information about this interface.
getClassID
in interface IPersist
pClassID
- A Structure: com.esri.arcgis.support.ms.stdole.GUID (out: use single element array)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void serialize(IXMLSerializeData data) throws IOException, AutomationException
serialize
in interface IXMLSerialize
data
- A reference to a com.esri.arcgis.system.IXMLSerializeData (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void deserialize(IXMLSerializeData data) throws IOException, AutomationException
deserialize
in interface IXMLSerialize
data
- A reference to a com.esri.arcgis.system.IXMLSerializeData (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void writeExternal(ObjectOutput out) throws IOException
writeExternal
in interface Externalizable
IOException
public void readExternal(ObjectInput in) throws IOException, ClassNotFoundException
readExternal
in interface Externalizable
IOException
ClassNotFoundException
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |