public class

LayerServiceInfo

extends Object
implements Serializable
java.lang.Object
   ↳ com.esri.core.ags.LayerServiceInfo

Summary

Public Methods
boolean equals(Object obj)
static LayerServiceInfo fromJson(JsonParser parser, LayerServiceInfo layer)
Reads in a json representation of server default parameters
static LayerServiceInfo fromJson(JsonParser parser)
Reads in a json representation of server default parameters
LayerServiceCapabilities getCapabilities()
Returns the layer capabilities.
String getCopyrightText()
Gets layer copyright text.
double getDefaultZ()
Gets default Z.
String getDefinitionExpression()
Gets the definition expression.
String getDescription()
Gets layer description.
String getDisplayField()
Gets display field name.
DrawingInfo getDrawingInfo()
Returns the DrawingInfo.
EditFieldsInfo getEditFieldsInfo()
double getEffectiveMaxScale()
Gets layer's effective maximum scale, which represents the maximum scale at which the layer is visible.
double getEffectiveMinScale()
Gets layer's effective minimum scale, which represents the minimum scale at which the layer is visible.
MapGeometry getExtent()
Gets layer extent.
Field getField(String fieldName)
Gets the field by its name.
Field[] getFields()
Gets the fields of the FeatureSet.
Geometry.Type getGeometryType()
Gets geometry type.
String getGlobalIdField()
Gets the global id field.
int getId()
Gets layer id.
int getMaxRecordCount()
Returns the maximum record count set on the service, which controls the number of features that may be returned from a query.
double getMaxScale()
Gets layer maximum scale.
double getMinScale()
Gets layer minimum scale.
String getName()
Get layer name.
String getObjectIdField()
Gets name of object id field.
OwnershipBasedAccessControlForFeatures getOwnershipBasedAccessControlForFeatures()
int getParentLayerId()
Gets parent layer id.
List<LayerRelationship> getRelationShips()
Return a list of Relationships.
Renderer getRenderer()
Gets the renderer.
String getServiceDescription()
Gets the service description.
List<Integer> getSubLayerIds()
Gets the list of sublayer ids.
FeatureType getSubType(String subtype)
Gets feature subtype by name
FeatureType[] getSubTypes()
Gets an array of subtypes.
String getSupportedQueryFormats()
Returns the supported query formats
List<FeatureTemplate> getTemplates()
An array of feature templates defined in the Feature Service layer.
TimeInfo getTimeInfo()
String getType()
Returns the layer type.
String getTypeIdField()
Returns the name of field identifies feature type.
String getURL()
Returns layer URL.
String getVersion()
Returns the version name of the layer service
boolean hasM()
Returns true if layer has M.
boolean hasZ()
Returns true if layer has Z.
int hashCode()
boolean isAllowGeometryUpdates()
Returns true if the geometry of the features in the layer can be edited, false otherwise.
boolean isDataVersioned()
Is data versioned.
boolean isDefaultVisibility()
boolean isDefaultZEnabled()
Returns true if default Z is enabled.
boolean isHasAttachments()
Returns true if layer has attachments.
boolean isSupportsAdvancedQueries()
When true, the layer supports orderByFields in a query operation.
boolean isSupportsRollbackOnFailureParameter()
boolean isSupportsStatistics()
When true, the layer supports statistical functions in query operations.
void setCapabilities(String capabilitiesOverride)
Sets the layer capabilities.
void setDefinitionExpression(String definitionExpression)
Set the definition expression.
void setDrawingInfo(DrawingInfo drawingInfo)
Sets the DrawingInfo.
void setEditFieldInfo(EditFieldsInfo editFieldInfo)
void setExtent(MapGeometry extent)
Set layer extent.
void setMaxScale(double maxScale)
Sets the maximum scale.
void setMinScale(double minScale)
Sets the minimum scale.
void setOwnershipBasedAccessControlForFeatures(OwnershipBasedAccessControlForFeatures ownershipBasedAccessControlForFeatures)
void setRenderer(Renderer renderer)
Sets the Renderer.
void setSubTypes(FeatureType[] subTypes)
Sets subtypes.
void setTemplates(List<FeatureTemplate> templates)
Set the feature templates.
void setType(String type)
Sets the layer type.
void setURL(String uRL)
Sets the URL
String toString()
[Expand]
Inherited Methods
From class java.lang.Object

Public Methods

public boolean equals (Object obj)

Parameters
obj Object
Returns
boolean

public static LayerServiceInfo fromJson (JsonParser parser, LayerServiceInfo layer)

Reads in a json representation of server default parameters

Parameters
parser JsonParser: The parser for the json object
layer LayerServiceInfo
Returns
LayerServiceInfo the decoded object from JSON representation.
Throws
Exception
Exception

public static LayerServiceInfo fromJson (JsonParser parser)

Reads in a json representation of server default parameters

Parameters
parser JsonParser: The parser for the json object
Returns
LayerServiceInfo the decoded object from JSON representation.
Throws
Exception
Exception

public LayerServiceCapabilities getCapabilities ()

Returns the layer capabilities.

Returns
LayerServiceCapabilities layer capabilities

public String getCopyrightText ()

Gets layer copyright text.

Returns
String layer copyright text

public double getDefaultZ ()

Gets default Z.

Returns
double default Z

public String getDefinitionExpression ()

Gets the definition expression.

Returns
String the definition expression

public String getDescription ()

Gets layer description.

Returns
String layer description

public String getDisplayField ()

Gets display field name.

Returns
String display field name

public DrawingInfo getDrawingInfo ()

Returns the DrawingInfo.

Returns
DrawingInfo the DrawingInfo

public EditFieldsInfo getEditFieldsInfo ()

Returns
EditFieldsInfo the editFieldInfo

public double getEffectiveMaxScale ()

Gets layer's effective maximum scale, which represents the maximum scale at which the layer is visible. Effective maximum scale is calculated based on the maxScale value of the current layer and its ancestors.

Returns
double effective maximum scale

public double getEffectiveMinScale ()

Gets layer's effective minimum scale, which represents the minimum scale at which the layer is visible. Effective minimum scale is calculated based on the minScale value of the current layer and its ancestors.

Returns
double effective minimum scale

public MapGeometry getExtent ()

Gets layer extent.

Returns
MapGeometry layer extent

public Field getField (String fieldName)

Gets the field by its name.

Returns
Field the field

public Field[] getFields ()

Gets the fields of the FeatureSet.

Returns
Field[] Returns the fields.

public Geometry.Type getGeometryType ()

Gets geometry type.

Returns
Geometry.Type geometry type

public String getGlobalIdField ()

Gets the global id field.

Returns
String global id field

public int getId ()

Gets layer id.

Returns
int layer id

public int getMaxRecordCount ()

Returns the maximum record count set on the service, which controls the number of features that may be returned from a query.

Returns
int maxRecordCount The maximum number of features that can be returned in a query

public double getMaxScale ()

Gets layer maximum scale.

Returns
double maximum scale

public double getMinScale ()

Gets layer minimum scale.

Returns
double minimum scale

public String getName ()

Get layer name.

Returns
String layer name

public String getObjectIdField ()

Gets name of object id field.

Returns
String name of object id field

public OwnershipBasedAccessControlForFeatures getOwnershipBasedAccessControlForFeatures ()

Returns
OwnershipBasedAccessControlForFeatures the ownershipBasedAccessControlForFeatures

public int getParentLayerId ()

Gets parent layer id.

Returns
int parent layer id

public List<LayerRelationship> getRelationShips ()

Return a list of Relationships.

Returns
List<LayerRelationship> list of Relationship

public Renderer getRenderer ()

Gets the renderer.

Returns
Renderer the renderer

public String getServiceDescription ()

Gets the service description.

Returns
String the service description

public List<Integer> getSubLayerIds ()

Gets the list of sublayer ids.

Returns
List<Integer> list of sublayer ids

public FeatureType getSubType (String subtype)

Gets feature subtype by name

Parameters
subtype String: subtype name
Returns
FeatureType the FeatureType corresponding to the input String

public FeatureType[] getSubTypes ()

Gets an array of subtypes.

Returns
FeatureType[] array of subtypes

public String getSupportedQueryFormats ()

Returns the supported query formats

Returns
String supportedQueryFormats the supported query formats

public List<FeatureTemplate> getTemplates ()

An array of feature templates defined in the Feature Service layer. Only applicable for ArcGIS Server Feature Service layers.

Returns
List<FeatureTemplate> array of feature templates

public TimeInfo getTimeInfo ()

Returns
TimeInfo the timeInfo

public String getType ()

Returns the layer type.

Returns
String layer type

public String getTypeIdField ()

Returns the name of field identifies feature type.

Returns
String name of field

public String getURL ()

Returns layer URL.

Returns
String layer URL

public String getVersion ()

Returns the version name of the layer service

Returns
String the version of the layer service

public boolean hasM ()

Returns true if layer has M.

Returns
boolean true if layer has M

public boolean hasZ ()

Returns true if layer has Z.

Returns
boolean true if layer has Z

public int hashCode ()

Returns
int

public boolean isAllowGeometryUpdates ()

Returns true if the geometry of the features in the layer can be edited, false otherwise. In ArcGIS Server version 10.1, this option can be configured when publishing the service. For earlier versions, this is always true.

Returns
boolean is geometry updates allowed

public boolean isDataVersioned ()

Is data versioned.

Returns
boolean is data versioned

public boolean isDefaultVisibility ()

Returns
boolean

public boolean isDefaultZEnabled ()

Returns true if default Z is enabled.

Returns
boolean true if default Z is enabled.

public boolean isHasAttachments ()

Returns true if layer has attachments.

Returns
boolean if layer has attachments

public boolean isSupportsAdvancedQueries ()

When true, the layer supports orderByFields in a query operation.

Returns
boolean is orderByFields query supported

public boolean isSupportsRollbackOnFailureParameter ()

Returns
boolean

public boolean isSupportsStatistics ()

When true, the layer supports statistical functions in query operations.

Returns
boolean is statistical functions supported

public void setCapabilities (String capabilitiesOverride)

Sets the layer capabilities.

Parameters
capabilitiesOverride String: layer capabilities

public void setDefinitionExpression (String definitionExpression)

Set the definition expression.

public void setDrawingInfo (DrawingInfo drawingInfo)

Sets the DrawingInfo.

public void setEditFieldInfo (EditFieldsInfo editFieldInfo)

Parameters
editFieldInfo EditFieldsInfo: the editFieldInfo to set

public void setExtent (MapGeometry extent)

Set layer extent.

Parameters
extent MapGeometry: layer extent

public void setMaxScale (double maxScale)

Sets the maximum scale.

public void setMinScale (double minScale)

Sets the minimum scale.

public void setOwnershipBasedAccessControlForFeatures (OwnershipBasedAccessControlForFeatures ownershipBasedAccessControlForFeatures)

Parameters
ownershipBasedAccessControlForFeatures OwnershipBasedAccessControlForFeatures: the ownershipBasedAccessControlForFeatures to set

public void setRenderer (Renderer renderer)

Sets the Renderer.

public void setSubTypes (FeatureType[] subTypes)

Sets subtypes.

public void setTemplates (List<FeatureTemplate> templates)

Set the feature templates.

Parameters
templates List: the templates

public void setType (String type)

Sets the layer type.

Parameters
type String: layer type

public void setURL (String uRL)

Sets the URL

public String toString ()

Returns
String