nl.b3p.xml.wfs.v110

Class TransactionType

java.lang.Object

nl.b3p.xml.wfs.v110.BaseRequestType

nl.b3p.xml.wfs.v110.TransactionType

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

Transaction

public class TransactionType
extends BaseRequestType
implements Serializable

The TransactionType defines the Transaction operation. A Transaction element contains one or more Insert, Update Delete and Native elements that allow a client application to create, modify or remove feature instances from the feature repository that a Web Feature Service controls.

Version:

$Revision$ $Date$

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
TransactionType()

Method Summary

Modifier and Type	Method and Description
void	addTransactionTypeChoice(int index, TransactionTypeChoice vTransactionTypeChoice) Method addTransactionTypeChoice
void	addTransactionTypeChoice(TransactionTypeChoice vTransactionTypeChoice) Method addTransactionTypeChoice
void	clearTransactionTypeChoice() Method clearTransactionTypeChoice
Enumeration	enumerateTransactionTypeChoice() Method enumerateTransactionTypeChoice
String	getLockId() Returns the value of field 'lockId'.
AllSomeType	getReleaseAction() Returns the value of field 'releaseAction'.
TransactionTypeChoice[]	getTransactionTypeChoice() Method getTransactionTypeChoice
TransactionTypeChoice	getTransactionTypeChoice(int index) Method getTransactionTypeChoice
int	getTransactionTypeChoiceCount() Method getTransactionTypeChoiceCount
boolean	isValid() Method isValid
void	marshal(ContentHandler handler) Method marshal
void	marshal(Writer out) Method marshal
boolean	removeTransactionTypeChoice(TransactionTypeChoice vTransactionTypeChoice) Method removeTransactionTypeChoice
void	setLockId(String lockId) Sets the value of field 'lockId'.
void	setReleaseAction(AllSomeType releaseAction) Sets the value of field 'releaseAction'.
void	setTransactionTypeChoice(int index, TransactionTypeChoice vTransactionTypeChoice) Method setTransactionTypeChoice
void	setTransactionTypeChoice(TransactionTypeChoice[] transactionTypeChoiceArray) Method setTransactionTypeChoice
static BaseRequestType	unmarshal(Reader reader) Method unmarshal
void	validate() Method validate

Methods inherited from class nl.b3p.xml.wfs.v110.BaseRequestType

getHandle, getService, getVersion, setHandle, setService, setVersion

Methods inherited from class java.lang.Object

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

Constructor Detail

TransactionType

public TransactionType()

Method Detail

addTransactionTypeChoice

public void addTransactionTypeChoice(TransactionTypeChoice vTransactionTypeChoice)
                              throws IndexOutOfBoundsException

Method addTransactionTypeChoice

Parameters:

vTransactionTypeChoice -

Throws:

IndexOutOfBoundsException

addTransactionTypeChoice

public void addTransactionTypeChoice(int index,
                                     TransactionTypeChoice vTransactionTypeChoice)
                              throws IndexOutOfBoundsException

Method addTransactionTypeChoice

Parameters:

index -

vTransactionTypeChoice -

Throws:

IndexOutOfBoundsException

clearTransactionTypeChoice

public void clearTransactionTypeChoice()

Method clearTransactionTypeChoice

enumerateTransactionTypeChoice

public Enumeration enumerateTransactionTypeChoice()

Method enumerateTransactionTypeChoice

Returns:

Enumeration

getLockId

public String getLockId()

Returns the value of field 'lockId'. The field 'lockId' has the following description: In order for a client application to operate upon locked feature instances, the Transaction request must include the LockId element. The content of this element must be the lock identifier the client application obtained from a previous GetFeatureWithLock or LockFeature operation. If the correct lock identifier is specified the Web Feature Service knows that the client application may operate upon the locked feature instances. No LockId element needs to be specified to operate upon unlocked features.

Returns:

String

getReleaseAction

public AllSomeType getReleaseAction()

Returns the value of field 'releaseAction'. The field 'releaseAction' has the following description: The releaseAction attribute is used to control how a Web Feature service releases locks on feature instances after a Transaction request has been processed. Valid values are ALL or SOME. A value of ALL means that the Web Feature Service should release the locks of all feature instances locked with the specified lockId regardless or whether or not the features were actually modified. A value of SOME means that the Web Feature Service will only release the locks held on feature instances that were actually operated upon by the transaction. The lockId that the client application obtained shall remain valid and the other, unmodified, feature instances shall remain locked. If the expiry attribute was specified in the original operation that locked the feature instances, then the expiry counter will be reset to give the client application that same amount of time to post subsequent transactions against the locked features.

Returns:

AllSomeType

getTransactionTypeChoice

public TransactionTypeChoice getTransactionTypeChoice(int index)
                                               throws IndexOutOfBoundsException

Method getTransactionTypeChoice

Parameters:

index -

Returns:

TransactionTypeChoice

Throws:

IndexOutOfBoundsException

getTransactionTypeChoice

public TransactionTypeChoice[] getTransactionTypeChoice()

Method getTransactionTypeChoice

Returns:

TransactionTypeChoice

getTransactionTypeChoiceCount

public int getTransactionTypeChoiceCount()

Method getTransactionTypeChoiceCount

Returns:

int

isValid

public boolean isValid()

Method isValid

Overrides:

isValid in class BaseRequestType

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

removeTransactionTypeChoice

public boolean removeTransactionTypeChoice(TransactionTypeChoice vTransactionTypeChoice)

Method removeTransactionTypeChoice

Parameters:

vTransactionTypeChoice -

Returns:

boolean

setLockId

public void setLockId(String lockId)

Sets the value of field 'lockId'. The field 'lockId' has the following description: In order for a client application to operate upon locked feature instances, the Transaction request must include the LockId element. The content of this element must be the lock identifier the client application obtained from a previous GetFeatureWithLock or LockFeature operation. If the correct lock identifier is specified the Web Feature Service knows that the client application may operate upon the locked feature instances. No LockId element needs to be specified to operate upon unlocked features.

Parameters:

lockId - the value of field 'lockId'.

setReleaseAction

public void setReleaseAction(AllSomeType releaseAction)

Sets the value of field 'releaseAction'. The field 'releaseAction' has the following description: The releaseAction attribute is used to control how a Web Feature service releases locks on feature instances after a Transaction request has been processed. Valid values are ALL or SOME. A value of ALL means that the Web Feature Service should release the locks of all feature instances locked with the specified lockId regardless or whether or not the features were actually modified. A value of SOME means that the Web Feature Service will only release the locks held on feature instances that were actually operated upon by the transaction. The lockId that the client application obtained shall remain valid and the other, unmodified, feature instances shall remain locked. If the expiry attribute was specified in the original operation that locked the feature instances, then the expiry counter will be reset to give the client application that same amount of time to post subsequent transactions against the locked features.

Parameters:

releaseAction - the value of field 'releaseAction'.

setTransactionTypeChoice

public void setTransactionTypeChoice(int index,
                                     TransactionTypeChoice vTransactionTypeChoice)
                              throws IndexOutOfBoundsException

Method setTransactionTypeChoice

Parameters:

index -

vTransactionTypeChoice -

Throws:

IndexOutOfBoundsException

setTransactionTypeChoice

public void setTransactionTypeChoice(TransactionTypeChoice[] transactionTypeChoiceArray)

Method setTransactionTypeChoice

Parameters:

transactionTypeChoiceArray -

unmarshal

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

Method unmarshal

Parameters:

reader -

Returns:

BaseRequestType

Throws:

org.exolab.castor.xml.MarshalException

org.exolab.castor.xml.ValidationException

validate

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

Method validate

Overrides:

validate in class BaseRequestType

Throws:

org.exolab.castor.xml.ValidationException