Class AGSServerObjectNameClass

Namespace
ESRI.ArcGIS.GISClient
Assembly
ESRI.Server.GISClient.dll
[ClassInterface(ClassInterfaceType.None)]
[Guid("6C22971C-D450-4B4D-9422-EE96A40FACC5")]
public class AGSServerObjectNameClass : AGSServerObjectName, IAGSServerObjectName3, IAGSServerObjectName2, IAGSServerObjectName, IName, IMetadata, IMetadataEdit, IPersistStream, IPersist
Inheritance
AGSServerObjectNameClass
Implements
Inherited Members

Constructors

AGSServerObjectNameClass()

public AGSServerObjectNameClass()

Explicit Interface Implementations

AGSServerConnectionName

The connection name object for this server object.

virtual IAGSServerConnectionName AGSServerConnectionName { get; set; }

Returns

IAGSServerConnectionName

Remarks

<P>The name object for an <STRONG>AGSServerConnection. </STRONG>The <STRONG>AGSServerConnectionName </STRONG>for an AGSServerConnection can be persisted, for example, in a map document. An application can call the <STRONG><A href="JavaScript:Jump('esriSystem/IName_Open.htm')">Open</A> </STRONG>method on the <STRONG>AGSServerConnectionName</STRONG> after loading it from persistent storage in order to connect to and get an object reference to the GIS server or web service catalog.</P>

CanEditMetadata

Indicates if metadata can be edited.

virtual bool CanEditMetadata { get; }

Returns

bool

Remarks

This property is available to those objects that support metadata.

Capabilities

The web capabilities of the service.

virtual string Capabilities { get; set; }

Returns

string

Description

The name of the service.

virtual string Description { get; set; }

Returns

string

GetClassID(out Guid)

virtual void GetClassID(out Guid pClassID)

Parameters

pClassID Guid

GetSizeMax(out _ULARGE_INTEGER)

virtual void GetSizeMax(out _ULARGE_INTEGER pcbSize)

Parameters

pcbSize _ULARGE_INTEGER

IAGSServerObjectName2_AGSServerConnectionName

virtual IAGSServerConnectionName IAGSServerObjectName2_AGSServerConnectionName { get; set; }

Returns

IAGSServerConnectionName

IAGSServerObjectName2_Name

virtual string IAGSServerObjectName2_Name { get; set; }

Returns

string

IAGSServerObjectName2_Type

virtual string IAGSServerObjectName2_Type { get; set; }

Returns

string

IAGSServerObjectName2_URL

virtual string IAGSServerObjectName2_URL { get; set; }

Returns

string

IAGSServerObjectName3_AGSServerConnectionName

virtual IAGSServerConnectionName IAGSServerObjectName3_AGSServerConnectionName { get; set; }

Returns

IAGSServerConnectionName

IAGSServerObjectName3_Capabilities

virtual string IAGSServerObjectName3_Capabilities { get; set; }

Returns

string

IAGSServerObjectName3_Name

virtual string IAGSServerObjectName3_Name { get; set; }

Returns

string

IAGSServerObjectName3_NameString2

virtual string IAGSServerObjectName3_NameString2 { get; set; }

Returns

string

IAGSServerObjectName3_ParentType

virtual string IAGSServerObjectName3_ParentType { get; set; }

Returns

string

IAGSServerObjectName3_Type

virtual string IAGSServerObjectName3_Type { get; set; }

Returns

string

IAGSServerObjectName3_URL

virtual string IAGSServerObjectName3_URL { get; set; }

Returns

string

IsDirty()

virtual void IsDirty()

Load(IStream)

virtual void Load(IStream pstm)

Parameters

pstm IStream

Metadata

The PropertySet containing metadata.

virtual IPropertySet Metadata { get; set; }

Returns

IPropertySet

Remarks

The variable to hold the data must be of IPropertySet data type.

The metadata property is frequently used to save, or update, changes to metadata documents that have taken place through methods available on the IPropertySet, IXmlPropertySet, and/or IXmlPropertySet2 interfaces.

Name

Name of the server object.

virtual string Name { get; set; }

Returns

string

Remarks

Required if the MapServer object is obtained via a LAN AGSServerConnection.

NameString

The name string of the object.

virtual string NameString { get; set; }

Returns

string

Remarks

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.

NameString2

The name string for the server object name.

virtual string NameString2 { get; set; }

Returns

string

Open()

Opens the object referred to by this name.

virtual object Open()

Returns

object

Remarks

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.

ParentType

The type of server object this server object extension is associated with.

virtual string ParentType { get; set; }

Returns

string

Save(IStream, int)

virtual void Save(IStream pstm, int fClearDirty)

Parameters

pstm IStream
fClearDirty int

Synchronize(esriMetadataSyncAction, int)

Updates metadata with the current properties; may create metadata if it doesn't already exist.

virtual void Synchronize(esriMetadataSyncAction action, int interval)

Parameters

action esriMetadataSyncAction
interval int

Remarks

The following actions will result in synchronization given each of the listed conditions:

Action Metadata status Esri/Sync element Interval parameter
esriMSAAccessed Doesn't matter Must not be FALSE Must be less than actual interval
esriMSAAlways Doesn't matter Doesn't matter Doesn't matter
esriMSACreated Must not exist Must not be FALSE Must be less than actual interval
esriMSANotCreated Must exist Must not be FALSE Must be less than actual interval
esriMSAOverwrite Doesn't matter Doesn't matter Doesn't matter

The difference between esriMSAAlways and esriMSAOverwrite lies in which elements are synchronized. esriMSAAlways will honor the removal or value change of an element's Sync attribute (to disable synchronization), whereas using esriMSAOverwrite is equivalent to setting the IXmlPropertySet2.OverwriteSyncAttribute to true for the metadata's property set, meaning that even elements without a Sync attribute of TRUE will be synchronized.

Type

Type of the server object (MapServer or GeocodeServer).

virtual string Type { get; set; }

Returns

string

URL

Server object URL (if connection type is internet).

virtual string URL { get; set; }

Returns

string

Remarks

Required if the MapServer object is obtained via an internet AGSServerConnection to a web service catalog.