TLcdOWSOperationsMetadata (LuciadLightspeed API documentation)

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

All Implemented Interfaces:

ILcdDataObject, ILcdCloneable, ILcdDeepCloneable, Cloneable

Direct Known Subclasses:

TLcdWCSOperationsMetadata
```
public class TLcdOWSOperationsMetadata
extends TLcdDataObject
```
This class represents the operations metadata of 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`	`EXTENDED_CAPABILITIES_PROPERTY` Data property that maps to the `ExtendedCapabilities` element.
`static TLcdDataProperty`	`OPERATION_PROPERTY` Data property that maps to the `Operation` element.
`static TLcdDataProperty`	`PARAMETER_PROPERTY` Data property that maps to the `Parameter` element.

Constructor Summary

Constructors
Constructor and Description
`TLcdOWSOperationsMetadata()` Creates a new `TLcdOWSOperationsMetadata` instance.
`TLcdOWSOperationsMetadata(TLcdDataType aType)` Creates a new `TLcdOWSOperationsMetadata` 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.
`void`	`addOperation(TLcdOWSOperation aOperation)` Adds an operation.
`void`	`addParameter(TLcdOWSDomain aParameter)` Adds a parameter.
`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.
`TLcdOWSDomain`	`getConstraintByName(String aName)` Returns a constraint associated to the given name or `null` if no constraint can be found with that name.
`int`	`getConstraintCount()` Returns the number of constraints.
`Object`	`getExtendedCapabilities()` Returns the value of the property that maps to the `ExtendedCapabilities` element.
`List<TLcdOWSOperation>`	`getOperation()` Returns the value of the property that maps to the `Operation` element.
`TLcdOWSOperation`	`getOperation(int aIndex)` Returns the operation at the given index.
`TLcdOWSOperation`	`getOperationByName(String aName)` Returns an operation associated to the given name or `null` if no operation can be found with that name.
`int`	`getOperationCount()` Returns the number of operations.
`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.
`TLcdOWSDomain`	`getParameterByName(String aName)` Returns a parameter associated to the given name or `null` if no parameter can be found with that name.
`int`	`getParameterCount()` Returns the number of parameters.
`void`	`removeConstraint(int aIndex)` Removes the constraint at the given index.
`void`	`removeOperation(int aIndex)` Removes the operation at the given index.
`void`	`removeParameter(int aIndex)` Removes the parameter at the given index.
`void`	`setExtendedCapabilities(Object aValue)` Sets the value of the property that maps to the `ExtendedCapabilities` element.

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
  - OPERATION_PROPERTY
```
public static final TLcdDataProperty OPERATION_PROPERTY
```
    Data property that maps to the Operation element. The possible values for this property are instances of List<TLcdOWSOperation>.
  - 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>.
  - EXTENDED_CAPABILITIES_PROPERTY
```
public static final TLcdDataProperty EXTENDED_CAPABILITIES_PROPERTY
```
    Data property that maps to the ExtendedCapabilities element. The possible values for this property are instances of Object.
- Constructor Detail
  - TLcdOWSOperationsMetadata
```
public TLcdOWSOperationsMetadata()
```
    Creates a new TLcdOWSOperationsMetadata instance.
  - TLcdOWSOperationsMetadata
```
public TLcdOWSOperationsMetadata(TLcdDataType aType)
```
    Creates a new TLcdOWSOperationsMetadata instance with the given data type.
    
    Parameters:
    
    aType - The data type.
- Method Detail
  - addOperation
```
public void addOperation(TLcdOWSOperation aOperation)
```
    Adds an operation.
    
    Parameters:
    
    aOperation - the operation to be added
  - getOperationCount
```
public int getOperationCount()
```
    Returns the number of operations.
    
    Returns:
    
    the number of operations.
  - removeOperation
```
public void removeOperation(int aIndex)
```
    Removes the operation at the given index.
    
    Parameters:
    
    aIndex - the index of operation to be removed
  - getOperation
```
public TLcdOWSOperation getOperation(int aIndex)
```
    Returns the operation at the given index.
    
    Parameters:
    
    aIndex - the index of the operation to be retrieved
    
    Returns:
    
    the operation at the given index
  - addParameter
```
public void addParameter(TLcdOWSDomain aParameter)
```
    Adds a parameter.
    The parameter list is an optional unordered list of parameter valid domains that each apply to one or more operations which this server interface 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.
    The parameter list is an optional unordered list of parameter valid domains that each apply to one or more operations which this server interface implements.
    
    Parameters:
    
    aIndex - the index of the parameter to be retrieved
    
    Returns:
    
    the parameter at the given index.
  - addConstraint
```
public void addConstraint(TLcdOWSDomain aConstraint)
```
    Adds a constraint.
    The constraint list is an optional unordered list of valid domain constraints on non-parameter quantities that each apply to this server.
    
    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 server.
    
    Parameters:
    
    aIndex - the index of the constraint to be retrieved
    
    Returns:
    
    the constraint at the given index.
  - getOperationByName
```
public TLcdOWSOperation getOperationByName(String aName)
```
    Returns an operation associated to the given name or null if no operation can be found with that name.
    
    Parameters:
    
    aName - the name of an operation
    
    Returns:
    
    the operation associated to the given name or null if no operation can be found with that name.
  - getConstraintByName
```
public TLcdOWSDomain getConstraintByName(String aName)
```
    Returns a constraint associated to the given name or null if no constraint can be found with that name.
    
    Parameters:
    
    aName - the name of a constraint
    
    Returns:
    
    the constraint associated to the given name or null if no constraint can be found with that name.
    
    Since:
    
    2017.0
  - getParameterByName
```
public TLcdOWSDomain getParameterByName(String aName)
```
    Returns a parameter associated to the given name or null if no parameter can be found with that name.
    
    Parameters:
    
    aName - the name of a parameter
    
    Returns:
    
    the parameter associated to the given name or null if no parameter can be found with that name.
    
    Since:
    
    2017.0
  - getOperation
```
public List<TLcdOWSOperation> getOperation()
```
    Returns the value of the property that maps to the Operation element.
    Metadata for one operation that this server implements.
    
    Returns:
    
    the value of the OPERATION_PROPERTY property.
  - getParameter
```
public List<TLcdOWSDomain> getParameter()
```
    Returns the value of the property that maps to the Parameter element.
    Optional unordered list of parameter valid domains that each apply to one or more operations which this server interface implements. The list of required and optional parameter domain limitations 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 server. The list of required and optional constraints shall be specified in the Implementation Specification for this service.
    
    Returns:
    
    the value of the CONSTRAINT_PROPERTY property.
  - getExtendedCapabilities
```
public Object getExtendedCapabilities()
```
    Returns the value of the property that maps to the ExtendedCapabilities element.
    Individual software vendors and servers can use this element to provide metadata about any additional server abilities.
    
    Returns:
    
    the value of the EXTENDED_CAPABILITIES_PROPERTY property.
  - setExtendedCapabilities
```
public void setExtendedCapabilities(Object aValue)
```
    Sets the value of the property that maps to the ExtendedCapabilities element.
    Individual software vendors and servers can use this element to provide metadata about any additional server abilities.
    
    Parameters:
    
    aValue - the value to set for the EXTENDED_CAPABILITIES_PROPERTY property.

LuciadLightspeedClass TLcdOWSOperationsMetadata

Field Summary

Constructor Summary

Method Summary

Methods inherited from class com.luciad.datamodel.TLcdDataObject

Methods inherited from class java.lang.Object

Field Detail

OPERATION_PROPERTY

PARAMETER_PROPERTY

CONSTRAINT_PROPERTY

EXTENDED_CAPABILITIES_PROPERTY

Constructor Detail

TLcdOWSOperationsMetadata

TLcdOWSOperationsMetadata

Method Detail

addOperation

getOperationCount

removeOperation

getOperation

addParameter

getParameterCount

removeParameter

getParameter

addConstraint

getConstraintCount

removeConstraint

getConstraint

getOperationByName

getConstraintByName

getParameterByName

getOperation

getParameter

getConstraint

getExtendedCapabilities

setExtendedCapabilities