Overview  Package   Class  Tree  Deprecated  Index  Help 
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD

com.esri.arcgis.schematic
Class SchematicFolder

java.lang.Object
  extended by com.esri.arcgis.schematic.SchematicFolder
All Implemented Interfaces:
IDataset, IMetadata, IMetadataEdit, ISchemaLock, com.esri.arcgis.interop.RemoteObjRef, ISchematicDiagramContainer, ISchematicFolder, ISchematicFolderContainer, java.io.Serializable
public class SchematicFolder
extends java.lang.Object
implements com.esri.arcgis.interop.RemoteObjRef, IDataset, IMetadata, IMetadataEdit, ISchemaLock, ISchematicFolder, ISchematicFolderContainer, ISchematicDiagramContainer

COM Class 'SchematicFolder'. Generated 3/19/2015 1:20:46 PM from 'C:\ArcGIS\COM\esriSchematic.olb'

Description 'A schematic folder object.' 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.geodatabase.IDataset
IID, IID2d04c042_7766_11d0_b77d_00805f7ced21, xxDummy
 
Fields inherited from interface com.esri.arcgis.geodatabase.IMetadata
IID, IID5de04a82_24e4_11d3_a641_0008c7d3ae50, xxDummy
 
Fields inherited from interface com.esri.arcgis.geodatabase.IMetadataEdit
IID, IID97fdb978_62a4_49c5_8252_b07837b33ee9, xxDummy
 
Fields inherited from interface com.esri.arcgis.geodatabase.ISchemaLock
IID, IIDdca648e5_0fbb_11d3_80a5_00c04f686238, xxDummy
 
Fields inherited from interface com.esri.arcgis.schematic.ISchematicFolder
IID, IIDf9037aed_ba15_40f8_b6ef_cbd3acae8cdb, xxDummy
 
Fields inherited from interface com.esri.arcgis.schematic.ISchematicFolderContainer
IID, IID41fd8da6_930d_49b8_91bb_1217ee77c6c2, xxDummy
 
Fields inherited from interface com.esri.arcgis.schematic.ISchematicDiagramContainer
IID, IID441ed561_78df_4bdf_821d_6e72fc82742b, xxDummy
 
Constructor Summary
SchematicFolder(java.lang.Object obj)
          Construct a SchematicFolder using a reference to such an object returned from ArcGIS Engine or Server.
 
Method Summary
 boolean canCopy()
          True if this dataset can be copied.
 boolean canDelete()
          True if this dataset can be deleted.
 boolean canRename()
          True if this dataset can be renamed.
 void changeSchemaLock(int schemaLock)
          Changes a schema lock.
 IDataset copy(java.lang.String copyName, IWorkspace copyWorkspace)
          Copies this dataset to a new dataset with the specified name.
 ISchematicFolder createSchematicFolder(java.lang.String name)
          Creates a new schematic subfolder in the schematic folder.
 void delete()
          Deletes this dataset.
 boolean equals(java.lang.Object o)
          Compare this object with another
 java.lang.String getBrowseName()
          The browse name of the dataset.
 java.lang.String getCategory()
          The category of the dataset.
 void getCurrentSchemaLocks(IEnumSchemaLockInfo[] schemaLockInfo)
          The list of current locks.
 ISchematicFolderContainer getFolderContainer()
          Parent container of the schematic folder.
 int getFolderContainerID()
          ID of the parent container of the schematic folder.
 IName getFullName()
          The associated name object.
 int getID()
          ID of the schematic folder.
 com.esri.arcgis.interop.Dispatch getJintegraDispatch()
          Deprecated. Internal use only.
 IPropertySet getMetadata()
          The PropertySet containing metadata.
 java.lang.String getName()
          The name of the Dataset.
 IPropertySet getPropertySet()
          The set of properties for the dataset.
 ISchematicDataset getSchematicDataset()
          Schematic dataset related to the schematic folder.
 ISchematicDiagram getSchematicDiagramByID(ISchematicDiagramClass schematicDiagramClass, int iD)
          Schematic diagram referenced by the specified ID.
 ISchematicDiagram getSchematicDiagramByName(ISchematicDiagramClass schematicDiagramClass, java.lang.String name)
          Schematic diagram referenced by the specified Name.
 IEnumSchematicDiagram getSchematicDiagrams()
          Schematic diagrams enumeration within the schematic dataset or schematic folder container.
 ISchematicFolder getSchematicFolderByID(int iD)
          Schematic folder referenced by the specified ID.
 ISchematicFolder getSchematicFolderByName(java.lang.String name)
          Schematic folder referenced by the specified Name.
 IEnumSchematicFolder getSchematicFolders()
          Schematic folders enumeration within the schematic dataset or the schematic folder container.
 IEnumDataset getSubsets()
          Datasets contained within this dataset.
 int getType()
          The type of the Dataset.
 IWorkspace getWorkspace()
          The workspace containing this dataset.
 int hashCode()
          the hashcode for this object
 boolean isCanEditMetadata()
          Indicates if metadata can be edited.
 void release()
          Release a SchematicFolder.
 void rename(java.lang.String name)
          Renames this Dataset.
 void setBrowseName(java.lang.String name)
          The browse name of the dataset.
 void setFolderContainerByRef(ISchematicFolderContainer schematicFolderContainer)
          Parent container of the schematic folder.
 void setMetadata(IPropertySet propertySet)
          The PropertySet containing metadata.
 void synchronize(int action, int interval)
          Updates metadata with the current properties; may create metadata if it doesn't already exist.
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

SchematicFolder

public SchematicFolder(java.lang.Object obj)
                throws java.io.IOException
Construct a SchematicFolder using a reference to such an object returned from ArcGIS Engine or Server. This is semantically equivalent to casting obj to SchematicFolder.
Casting to this class from the return value of a method will not work, as this class represents an abstract class in ArcObjects.
*
SchematicFolder o = (SchematicFolder)obj; // will not work

SchematicFolder o = new SchematicFolder(obj); // Use this constructor instead
* @param obj an object returned from ArcGIS Engine or Server

Throws:
java.io.IOException - if there are interop problems SchematicFolder theSchematicFolder = (SchematicFolder) obj;
Method Detail

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

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

getName

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

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

getFullName

public IName getFullName()
                  throws java.io.IOException,
                         AutomationException
The associated name object.

Specified by:
getFullName in interface IDataset
Returns:
A reference to a com.esri.arcgis.system.IName
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getBrowseName

public java.lang.String getBrowseName()
                               throws java.io.IOException,
                                      AutomationException
The browse name of the dataset.

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

setBrowseName

public void setBrowseName(java.lang.String name)
                   throws java.io.IOException,
                          AutomationException
The browse name of the dataset.

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

getType

public int getType()
            throws java.io.IOException,
                   AutomationException
The type of the Dataset.

Specified by:
getType in interface IDataset
Returns:
A com.esri.arcgis.geodatabase.esriDatasetType constant
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 dataset.

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

getSubsets

public IEnumDataset getSubsets()
                        throws java.io.IOException,
                               AutomationException
Datasets contained within this dataset.

Specified by:
getSubsets in interface IDataset
Returns:
A reference to a com.esri.arcgis.geodatabase.IEnumDataset
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getWorkspace

public IWorkspace getWorkspace()
                        throws java.io.IOException,
                               AutomationException
The workspace containing this dataset.

Specified by:
getWorkspace in interface IDataset
Returns:
A reference to a com.esri.arcgis.geodatabase.IWorkspace
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getPropertySet

public IPropertySet getPropertySet()
                            throws java.io.IOException,
                                   AutomationException
The set of properties for the dataset.

Specified by:
getPropertySet in interface IDataset
Returns:
A reference to a com.esri.arcgis.system.IPropertySet
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

canCopy

public boolean canCopy()
                throws java.io.IOException,
                       AutomationException
True if this dataset can be copied.

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

copy

public IDataset copy(java.lang.String copyName,
                     IWorkspace copyWorkspace)
              throws java.io.IOException,
                     AutomationException
Copies this dataset to a new dataset with the specified name.

Specified by:
copy in interface IDataset
Parameters:
copyName - The copyName (in)
copyWorkspace - A reference to a com.esri.arcgis.geodatabase.IWorkspace (in)
Returns:
A reference to a com.esri.arcgis.geodatabase.IDataset
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

canDelete

public boolean canDelete()
                  throws java.io.IOException,
                         AutomationException
True if this dataset can be deleted.

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

delete

public void delete()
            throws java.io.IOException,
                   AutomationException
Deletes this dataset.

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

canRename

public boolean canRename()
                  throws java.io.IOException,
                         AutomationException
True if this dataset can be renamed.

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

rename

public void rename(java.lang.String name)
            throws java.io.IOException,
                   AutomationException
Renames this Dataset.

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

getMetadata

public IPropertySet getMetadata()
                         throws java.io.IOException,
                                AutomationException
The PropertySet containing metadata.

Specified by:
getMetadata in interface IMetadata
Returns:
A reference to a com.esri.arcgis.system.IPropertySet
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setMetadata

public void setMetadata(IPropertySet propertySet)
                 throws java.io.IOException,
                        AutomationException
The PropertySet containing metadata.

Specified by:
setMetadata in interface IMetadata
Parameters:
propertySet - A reference to a com.esri.arcgis.system.IPropertySet (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

synchronize

public void synchronize(int action,
                        int interval)
                 throws java.io.IOException,
                        AutomationException
Updates metadata with the current properties; may create metadata if it doesn't already exist.

Specified by:
synchronize in interface IMetadata
Parameters:
action - A com.esri.arcgis.geodatabase.esriMetadataSyncAction constant (in)
interval - The interval (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isCanEditMetadata

public boolean isCanEditMetadata()
                          throws java.io.IOException,
                                 AutomationException
Indicates if metadata can be edited.

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

changeSchemaLock

public void changeSchemaLock(int schemaLock)
                      throws java.io.IOException,
                             AutomationException
Changes a schema lock.

Specified by:
changeSchemaLock in interface ISchemaLock
Parameters:
schemaLock - A com.esri.arcgis.geodatabase.esriSchemaLock constant (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getCurrentSchemaLocks

public void getCurrentSchemaLocks(IEnumSchemaLockInfo[] schemaLockInfo)
                           throws java.io.IOException,
                                  AutomationException
The list of current locks.

Specified by:
getCurrentSchemaLocks in interface ISchemaLock
Parameters:
schemaLockInfo - A reference to a com.esri.arcgis.geodatabase.IEnumSchemaLockInfo (out: use single element array)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getSchematicDataset

public ISchematicDataset getSchematicDataset()
                                      throws java.io.IOException,
                                             AutomationException
Schematic dataset related to the schematic folder.

Specified by:
getSchematicDataset in interface ISchematicFolder
Returns:
A reference to a com.esri.arcgis.schematic.ISchematicDataset
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getID

public int getID()
          throws java.io.IOException,
                 AutomationException
ID of the schematic folder.

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

getFolderContainerID

public int getFolderContainerID()
                         throws java.io.IOException,
                                AutomationException
ID of the parent container of the schematic folder. That is, ID of the schematic dataset or ID of the parent folder that contains this schematic folder.

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

getFolderContainer

public ISchematicFolderContainer getFolderContainer()
                                             throws java.io.IOException,
                                                    AutomationException
Parent container of the schematic folder.

Specified by:
getFolderContainer in interface ISchematicFolder
Returns:
A reference to a com.esri.arcgis.schematic.ISchematicFolderContainer
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setFolderContainerByRef

public void setFolderContainerByRef(ISchematicFolderContainer schematicFolderContainer)
                             throws java.io.IOException,
                                    AutomationException
Parent container of the schematic folder.

Specified by:
setFolderContainerByRef in interface ISchematicFolder
Parameters:
schematicFolderContainer - A reference to a com.esri.arcgis.schematic.ISchematicFolderContainer (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

createSchematicFolder

public ISchematicFolder createSchematicFolder(java.lang.String name)
                                       throws java.io.IOException,
                                              AutomationException
Creates a new schematic subfolder in the schematic folder.

Specified by:
createSchematicFolder in interface ISchematicFolder
Parameters:
name - The name (in)
Returns:
A reference to a com.esri.arcgis.schematic.ISchematicFolder
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getSchematicFolders

public IEnumSchematicFolder getSchematicFolders()
                                         throws java.io.IOException,
                                                AutomationException
Schematic folders enumeration within the schematic dataset or the schematic folder container.

Specified by:
getSchematicFolders in interface ISchematicFolderContainer
Returns:
A reference to a com.esri.arcgis.schematic.IEnumSchematicFolder
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getSchematicFolderByID

public ISchematicFolder getSchematicFolderByID(int iD)
                                        throws java.io.IOException,
                                               AutomationException
Schematic folder referenced by the specified ID.

Specified by:
getSchematicFolderByID in interface ISchematicFolderContainer
Parameters:
iD - The iD (in)
Returns:
A reference to a com.esri.arcgis.schematic.ISchematicFolder
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getSchematicFolderByName

public ISchematicFolder getSchematicFolderByName(java.lang.String name)
                                          throws java.io.IOException,
                                                 AutomationException
Schematic folder referenced by the specified Name.

Specified by:
getSchematicFolderByName in interface ISchematicFolderContainer
Parameters:
name - The name (in)
Returns:
A reference to a com.esri.arcgis.schematic.ISchematicFolder
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getSchematicDiagrams

public IEnumSchematicDiagram getSchematicDiagrams()
                                           throws java.io.IOException,
                                                  AutomationException
Schematic diagrams enumeration within the schematic dataset or schematic folder container.

Specified by:
getSchematicDiagrams in interface ISchematicDiagramContainer
Returns:
A reference to a com.esri.arcgis.schematic.IEnumSchematicDiagram
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getSchematicDiagramByID

public ISchematicDiagram getSchematicDiagramByID(ISchematicDiagramClass schematicDiagramClass,
                                                 int iD)
                                          throws java.io.IOException,
                                                 AutomationException
Schematic diagram referenced by the specified ID.

Specified by:
getSchematicDiagramByID in interface ISchematicDiagramContainer
Parameters:
schematicDiagramClass - A reference to a com.esri.arcgis.schematic.ISchematicDiagramClass (in)
iD - The iD (in)
Returns:
A reference to a com.esri.arcgis.schematic.ISchematicDiagram
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getSchematicDiagramByName

public ISchematicDiagram getSchematicDiagramByName(ISchematicDiagramClass schematicDiagramClass,
                                                   java.lang.String name)
                                            throws java.io.IOException,
                                                   AutomationException
Schematic diagram referenced by the specified Name.

Specified by:
getSchematicDiagramByName in interface ISchematicDiagramContainer
Parameters:
schematicDiagramClass - A reference to a com.esri.arcgis.schematic.ISchematicDiagramClass (in)
name - The name (in)
Returns:
A reference to a com.esri.arcgis.schematic.ISchematicDiagram
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
Overview  Package   Class  Tree  Deprecated  Index  Help 
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD