TLcdOWSOperation (LuciadLightspeed API documentation)

java.lang.Object
- com.luciad.datamodel.TLcdDataObject
- - com.luciad.ogc.ows.model.TLcdOWSOperation

All Implemented Interfaces:

ILcdDataObject, ILcdCloneable, ILcdDeepCloneable, Cloneable
```
public class TLcdOWSOperation
extends TLcdDataObject
```
This class contains metadata about an operation supported by an OpenGIS Web Service (OWS).

Field Summary

Fields
Modifier and Type	Field and Description
`static TLcdDataProperty`	`CONSTRAINT_PROPERTY` Data property that maps to the `Constraint` element.
`static TLcdDataProperty`	`DCP_PROPERTY` Data property that maps to the `DCP` element.
`static TLcdDataProperty`	`METADATA_PROPERTY` Data property that maps to the `Metadata` element.
`static TLcdDataProperty`	`NAME_PROPERTY` Data property that maps to the `name` attribute.
`static TLcdDataProperty`	`PARAMETER_PROPERTY` Data property that maps to the `Parameter` element.

Constructor Summary

Constructors
Constructor and Description
`TLcdOWSOperation()` Creates a new `TLcdOWSOperation` instance.
`TLcdOWSOperation(String aName)` Creates a new `TLcdOWSOperation` instance with the given operation name.
`TLcdOWSOperation(TLcdDataType aType)` Creates a new `TLcdOWSOperation` instance with the given data type.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addConstraint(TLcdOWSDomain aConstraint)` Adds a constraint to this operation.
`void`	`addDCP(TLcdOWSDCP aDCP)` Adds a Distributed Computing Platform (DCP) supported for this operation.
`void`	`addMetadata(TLcdOWSMetadata aMetadata)` Adds a metadata object to this operation.
`void`	`addParameter(TLcdOWSDomain aParameter)` Adds a parameter to this operation.
`List<TLcdOWSDomain>`	`getConstraint()` Returns the value of the property that maps to the `Constraint` element.
`TLcdOWSDomain`	`getConstraint(int aIndex)` Returns the constraint at the given index.
`int`	`getConstraintCount()` Returns the number of constraints.
`List<TLcdOWSDCP>`	`getDCP()` Returns the value of the property that maps to the `DCP` element.
`TLcdOWSDCP`	`getDCP(int aIndex)` Returns the Distributed Computing Platform (DCP) at the given index.
`int`	`getDCPCount()` Returns the number of Distributed Computing Platforms for this operation.
`List<TLcdOWSMetadata>`	`getMetadata()` Returns the value of the property that maps to the `Metadata` element.
`TLcdOWSMetadata`	`getMetadata(int aIndex)` Returns the metadata at the given index.
`int`	`getMetadataCount()` Returns the number of metadata objects for this operation.
`String`	`getName()` Returns the value of the property that maps to the `name` attribute.
`List<TLcdOWSDomain>`	`getParameter()` Returns the value of the property that maps to the `Parameter` element.
`TLcdOWSDomain`	`getParameter(int aIndex)` Returns the parameter at the given index.
`int`	`getParameterCount()` Returns the number of parameters.
`void`	`removeConstraint(int aIndex)` Removes the constraint at the given index.
`void`	`removeDCP(int aIndex)` Removes the Distributed Computing Platform (DCP) at the given index.
`void`	`removeMetadata(int aIndex)` Removes the metadata at the given index.
`void`	`removeParameter(int aIndex)` Removes the parameter at the given index.
`void`	`setName(String aValue)` Sets the value of the property that maps to the `name` attribute.

Methods inherited from class com.luciad.datamodel.TLcdDataObject
clone, clone, getDataType, getValue, getValue, hasValue, hasValue, setValue, setValue, toString

Methods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Field Detail
  - NAME_PROPERTY
```
public static final TLcdDataProperty NAME_PROPERTY
```
    Data property that maps to the name attribute. The possible values for this property are instances of String.
  - DCP_PROPERTY
```
public static final TLcdDataProperty DCP_PROPERTY
```
    Data property that maps to the DCP element. The possible values for this property are instances of List<TLcdOWSDCP>.
  - PARAMETER_PROPERTY
```
public static final TLcdDataProperty PARAMETER_PROPERTY
```
    Data property that maps to the Parameter element. The possible values for this property are instances of List<TLcdOWSDomain>.
  - CONSTRAINT_PROPERTY
```
public static final TLcdDataProperty CONSTRAINT_PROPERTY
```
    Data property that maps to the Constraint element. The possible values for this property are instances of List<TLcdOWSDomain>.
  - METADATA_PROPERTY
```
public static final TLcdDataProperty METADATA_PROPERTY
```
    Data property that maps to the Metadata element. The possible values for this property are instances of List<TLcdOWSMetadata>.
- Constructor Detail
  - TLcdOWSOperation
```
public TLcdOWSOperation(String aName)
```
    Creates a new TLcdOWSOperation instance with the given operation name.
    
    Parameters:
    
    aName - the operation name
  - TLcdOWSOperation
```
public TLcdOWSOperation()
```
    Creates a new TLcdOWSOperation instance. No name will be set.
  - TLcdOWSOperation
```
public TLcdOWSOperation(TLcdDataType aType)
```
    Creates a new TLcdOWSOperation instance with the given data type. No name will be set.
    
    Parameters:
    
    aType - The data type.
- Method Detail
  - addDCP
```
public void addDCP(TLcdOWSDCP aDCP)
```
    Adds a Distributed Computing Platform (DCP) supported for this operation.
    
    Parameters:
    
    aDCP - the DCP to be added
  - getDCPCount
```
public int getDCPCount()
```
    Returns the number of Distributed Computing Platforms for this operation.
    
    Returns:
    
    the number of Distributed Computing Platforms for this operation.
  - removeDCP
```
public void removeDCP(int aIndex)
```
    Removes the Distributed Computing Platform (DCP) at the given index.
    
    Parameters:
    
    aIndex - the index of the DCP to be removed
  - getDCP
```
public TLcdOWSDCP getDCP(int aIndex)
```
    Returns the Distributed Computing Platform (DCP) at the given index.
    
    Parameters:
    
    aIndex - the index of the DCP to be retrieved.
    
    Returns:
    
    the DCP at the given index.
  - addParameter
```
public void addParameter(TLcdOWSDomain aParameter)
```
    Adds a parameter to this operation.
    The parameter list is an optional unordered list of parameter domains that each apply to this operation which this server implements.
    
    Parameters:
    
    aParameter - the parameter to be added.
  - getParameterCount
```
public int getParameterCount()
```
    Returns the number of parameters.
    
    Returns:
    
    the number of parameters.
  - removeParameter
```
public void removeParameter(int aIndex)
```
    Removes the parameter at the given index.
    
    Parameters:
    
    aIndex - the index of the parameter to be removed
  - getParameter
```
public TLcdOWSDomain getParameter(int aIndex)
```
    Returns the parameter at the given index.
    
    Parameters:
    
    aIndex - the index of the parameter to be retrieved
    
    Returns:
    
    the parameter at the given position.
  - addConstraint
```
public void addConstraint(TLcdOWSDomain aConstraint)
```
    Adds a constraint to this operation.
    The constraint list is an optional unordered list of valid domain constraints on non-parameter quantities that each apply to this operation.
    
    Parameters:
    
    aConstraint - the constraint to be added.
  - getConstraintCount
```
public int getConstraintCount()
```
    Returns the number of constraints.
    
    Returns:
    
    the number of constraints.
  - removeConstraint
```
public void removeConstraint(int aIndex)
```
    Removes the constraint at the given index.
    
    Parameters:
    
    aIndex - the index of the constraint to be removed
  - getConstraint
```
public TLcdOWSDomain getConstraint(int aIndex)
```
    Returns the constraint at the given index.
    The constraint list is an optional unordered list of valid domain constraints on non-parameter quantities that each apply to this operation.
    
    Parameters:
    
    aIndex - the index of the constraint to be retrieved
    
    Returns:
    
    the constraint at the given index.
  - addMetadata
```
public void addMetadata(TLcdOWSMetadata aMetadata)
```
    Adds a metadata object to this operation.
    
    Parameters:
    
    aMetadata - the metadata to be added.
  - getMetadataCount
```
public int getMetadataCount()
```
    Returns the number of metadata objects for this operation.
    
    Returns:
    
    the number of metadata objects for this operation.
  - removeMetadata
```
public void removeMetadata(int aIndex)
```
    Removes the metadata at the given index.
    
    Parameters:
    
    aIndex - the index of the metadata to be removed
  - getMetadata
```
public TLcdOWSMetadata getMetadata(int aIndex)
```
    Returns the metadata at the given index.
    
    Parameters:
    
    aIndex - the index of the metadata to be retrieved
    
    Returns:
    
    the metadata at the given index.
  - getName
```
public String getName()
```
    Returns the value of the property that maps to the name attribute.
    Name or identifier of this operation (request) (for example, GetCapabilities). The list of required and optional operations implemented shall be specified in the Implementation Specification for this service.
    
    Returns:
    
    the value of the NAME_PROPERTY property.
  - setName
```
public void setName(String aValue)
```
    Sets the value of the property that maps to the name attribute.
    Name or identifier of this operation (request) (for example, GetCapabilities). The list of required and optional operations implemented shall be specified in the Implementation Specification for this service.
    
    Parameters:
    
    aValue - the value to set for the NAME_PROPERTY property.
  - getDCP
```
public List<TLcdOWSDCP> getDCP()
```
    Returns the value of the property that maps to the DCP element.
    Information for one distributed Computing Platform (DCP) supported for this operation. At present, only the HTTP DCP is defined, so this element only includes the HTTP element.
    
    Returns:
    
    the value of the DCP_PROPERTY property.
  - getParameter
```
public List<TLcdOWSDomain> getParameter()
```
    Returns the value of the property that maps to the Parameter element.
    Optional unordered list of parameter domains that each apply to this operation which this server implements. If one of these Parameter elements has the same "name" attribute as a Parameter element in the OperationsMetadata element, this Parameter element shall override the other one for this operation. The list of required and optional parameter domain limitations for this operation shall be specified in the Implementation Specification for this service.
    
    Returns:
    
    the value of the PARAMETER_PROPERTY property.
  - getConstraint
```
public List<TLcdOWSDomain> getConstraint()
```
    Returns the value of the property that maps to the Constraint element.
    Optional unordered list of valid domain constraints on non-parameter quantities that each apply to this operation. If one of these Constraint elements has the same "name" attribute as a Constraint element in the OperationsMetadata element, this Constraint element shall override the other one for this operation. The list of required and optional constraints for this operation shall be specified in the Implementation Specification for this service.
    
    Returns:
    
    the value of the CONSTRAINT_PROPERTY property.
  - getMetadata
```
public List<TLcdOWSMetadata> getMetadata()
```
    Returns the value of the property that maps to the Metadata element.
    
    Returns:
    
    the value of the METADATA_PROPERTY property.

LuciadLightspeedClass TLcdOWSOperation

Field Summary

Constructor Summary

Method Summary

Methods inherited from class com.luciad.datamodel.TLcdDataObject

Methods inherited from class java.lang.Object

Field Detail

NAME_PROPERTY

DCP_PROPERTY

PARAMETER_PROPERTY

CONSTRAINT_PROPERTY

METADATA_PROPERTY

Constructor Detail

TLcdOWSOperation

TLcdOWSOperation

TLcdOWSOperation

Method Detail

addDCP

getDCPCount

removeDCP

getDCP

addParameter

getParameterCount

removeParameter

getParameter

addConstraint

getConstraintCount

removeConstraint

getConstraint

addMetadata

getMetadataCount

removeMetadata

getMetadata

getName

setName

getDCP

getParameter

getConstraint

getMetadata