nl.b3p.xml.wfs.v100.transaction

Class LockFeatureType

java.lang.Object

nl.b3p.xml.wfs.v100.transaction.LockFeatureType

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

LockFeature

public class LockFeatureType
extends Object
implements Serializable

This type defines the LockFeature operation. The LockFeature element contains one or more Lock elements that define which features of a particular type should be locked. A lock identifier (lockId) is returned to the client application which can be used by subsequent operations to reference the locked features.

Version:

$Revision$ $Date$

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
LockFeatureType()

Method Summary

Modifier and Type	Method and Description
void	addLock(int index, Lock vLock) Method addLock
void	addLock(Lock vLock) Method addLock
void	clearLock() Method clearLock
void	deleteExpiry() Method deleteExpiry
Enumeration	enumerateLock() Method enumerateLock
int	getExpiry() Returns the value of field 'expiry'.
Lock[]	getLock() Method getLock
Lock	getLock(int index) Method getLock
AllSomeType	getLockAction() Returns the value of field 'lockAction'.
int	getLockCount() Method getLockCount
String	getService() Returns the value of field 'service'.
String	getVersion() Returns the value of field 'version'.
boolean	hasExpiry() Method hasExpiry
boolean	isValid() Method isValid
void	marshal(ContentHandler handler) Method marshal
void	marshal(Writer out) Method marshal
boolean	removeLock(Lock vLock) Method removeLock
void	setExpiry(int expiry) Sets the value of field 'expiry'.
void	setLock(int index, Lock vLock) Method setLock
void	setLock(Lock[] lockArray) Method setLock
void	setLockAction(AllSomeType lockAction) Sets the value of field 'lockAction'.
void	setService(String service) Sets the value of field 'service'.
void	setVersion(String version) Sets the value of field 'version'.
static LockFeatureType	unmarshal(Reader reader) Method unmarshal
void	validate() Method validate

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

LockFeatureType

public LockFeatureType()

Method Detail

addLock

public void addLock(Lock vLock)
             throws IndexOutOfBoundsException

Method addLock

Parameters:

vLock -

Throws:

IndexOutOfBoundsException

addLock

public void addLock(int index,
                    Lock vLock)
             throws IndexOutOfBoundsException

Method addLock

Parameters:

index -

vLock -

Throws:

IndexOutOfBoundsException

clearLock

public void clearLock()

Method clearLock

deleteExpiry

public void deleteExpiry()

Method deleteExpiry

enumerateLock

public Enumeration enumerateLock()

Method enumerateLock

Returns:

Enumeration

getExpiry

public int getExpiry()

Returns the value of field 'expiry'.

Returns:

int

getLock

public Lock getLock(int index)
             throws IndexOutOfBoundsException

Method getLock

Parameters:

index -

Returns:

Lock

Throws:

IndexOutOfBoundsException

getLock

public Lock[] getLock()

Method getLock

Returns:

Lock

getLockAction

public AllSomeType getLockAction()

Returns the value of field 'lockAction'. The field 'lockAction' has the following description: The lockAction attribute is used to indicate what a Web Feature Service should do when it encounters a feature instance that has already been locked by another client application. Valid values are ALL or SOME. ALL means that the Web Feature Service must acquire locks on all the requested feature instances. If it cannot acquire those locks then the request should fail. In this instance, all locks acquired by the operation should be released. SOME means that the Web Feature Service should lock as many of the requested features as it can.

Returns:

AllSomeType

getLockCount

public int getLockCount()

Method getLockCount

Returns:

int

getService

public String getService()

Returns the value of field 'service'.

Returns:

String

getVersion

public String getVersion()

Returns the value of field 'version'.

Returns:

String

hasExpiry

public boolean hasExpiry()

Method hasExpiry

Returns:

boolean

isValid

public boolean isValid()

Method isValid

Returns:

boolean

marshal

public void marshal(Writer out)
             throws org.exolab.castor.xml.MarshalException,
                    org.exolab.castor.xml.ValidationException

Method marshal

Parameters:

out -

Throws:

org.exolab.castor.xml.MarshalException

org.exolab.castor.xml.ValidationException

marshal

public void marshal(ContentHandler handler)
             throws IOException,
                    org.exolab.castor.xml.MarshalException,
                    org.exolab.castor.xml.ValidationException

Method marshal

Parameters:

handler -

Throws:

IOException

org.exolab.castor.xml.MarshalException

org.exolab.castor.xml.ValidationException

removeLock

public boolean removeLock(Lock vLock)

Method removeLock

Parameters:

vLock -

Returns:

boolean

setExpiry

public void setExpiry(int expiry)

Sets the value of field 'expiry'.

Parameters:

expiry - the value of field 'expiry'.

setLock

public void setLock(int index,
                    Lock vLock)
             throws IndexOutOfBoundsException

Method setLock

Parameters:

index -

vLock -

Throws:

IndexOutOfBoundsException

setLock

public void setLock(Lock[] lockArray)

Method setLock

Parameters:

lockArray -

setLockAction

public void setLockAction(AllSomeType lockAction)

Sets the value of field 'lockAction'. The field 'lockAction' has the following description: The lockAction attribute is used to indicate what a Web Feature Service should do when it encounters a feature instance that has already been locked by another client application. Valid values are ALL or SOME. ALL means that the Web Feature Service must acquire locks on all the requested feature instances. If it cannot acquire those locks then the request should fail. In this instance, all locks acquired by the operation should be released. SOME means that the Web Feature Service should lock as many of the requested features as it can.

Parameters:

lockAction - the value of field 'lockAction'.

setService

public void setService(String service)

Sets the value of field 'service'.

Parameters:

service - the value of field 'service'.

setVersion

public void setVersion(String version)

Sets the value of field 'version'.

Parameters:

version - the value of field 'version'.

unmarshal

public static LockFeatureType unmarshal(Reader reader)
                                 throws org.exolab.castor.xml.MarshalException,
                                        org.exolab.castor.xml.ValidationException

Method unmarshal

Parameters:

reader -

Returns:

LockFeatureType

Throws:

org.exolab.castor.xml.MarshalException

org.exolab.castor.xml.ValidationException

validate

public void validate()
              throws org.exolab.castor.xml.ValidationException

Method validate

Throws:

org.exolab.castor.xml.ValidationException