oracle.apps.fnd.applxdf.xdfapi
Class Sequence

java.lang.Object
  oracle.apps.fnd.applxdf.xdfapi.XdfObject
      oracle.apps.fnd.applxdf.xdfapi.Sequence

public class Sequence
extends XdfObject

Sequence - A subtype of XdfObject, reprents a sequence object in XDF file.

Author:

nnaser <nishan.naser@oracle.com>

Field Summary

Fields inherited from class oracle.apps.fnd.applxdf.xdfapi.XdfObject

ctx, DEBUG, mBaseObjType, mName, mPersistenceFormat, mSchemaName, mUsrPros, mXmlDoc, mXPath, mXPathExpr

Constructor Summary

Sequence(oracle.xml.parser.v2.XMLElement xmlDocRoot)
Create a sequence object with given xdf document.

Sequence(oracle.xml.parser.v2.XMLElement xmlDocRoot, boolean persistenceFormat)
Create a sequence object with given xdf document and persistence Format.

Method Summary

java.lang.String	getCacheFlag() Gets the CACHE flag.
int	getCacheSize() Retrieves the cache size for this sequence.
java.lang.String	getCycleFlag() Gets the CYCLE flag.
int	getIncrementBy() Retrieves the increment value for this sequence.
int	getMaxValue() Retrieves the maximum value for this sequence.
int	getMinValue() Retrieves the minimum value for this sequence.
java.lang.String	getOrderFlag() Gets the ORDER flag.
int	getStartWith() Retrieves the start with value for this sequence.
java.lang.String	getType() Gets the object type (implements the abstract in the super class).
UserDefinedProperties	getUserProperties() Get the User Defined Properties in this table.

Methods inherited from class oracle.apps.fnd.applxdf.xdfapi.XdfObject

getName, getPersistenceFormat, getSchemaName, getXmlDoc

Methods inherited from class java.lang.Object

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

Constructor Detail

Sequence

public Sequence(oracle.xml.parser.v2.XMLElement xmlDocRoot)

Create a sequence object with given xdf document.

Parameters:

xmlDocRoot -

Sequence

public Sequence(oracle.xml.parser.v2.XMLElement xmlDocRoot,
                boolean persistenceFormat)

Create a sequence object with given xdf document and persistence Format.

Parameters:

xmlDocRoot -

Method Detail

getType

public java.lang.String getType()

Gets the object type (implements the abstract in the super class).

Specified by:

getType in class XdfObject

Returns:

String - Object Type

getStartWith

public int getStartWith()

Retrieves the start with value for this sequence.

Returns:

int - START_WITH value

getIncrementBy

public int getIncrementBy()

Retrieves the increment value for this sequence.

Returns:

int - INCREMENT value

getMinValue

public int getMinValue()

Retrieves the minimum value for this sequence.

Returns:

int - MINVALUE value

getMaxValue

public int getMaxValue()

Retrieves the maximum value for this sequence.

Returns:

int - MAXVALUE value

getCycleFlag

public java.lang.String getCycleFlag()

Gets the CYCLE flag.

Returns:

'Y' if this sequence should cycle back to the beginning when the last permissible value is reached.

getCacheFlag

public java.lang.String getCacheFlag()

Gets the CACHE flag.

Returns:

'Y' if the sequence is cached.

getCacheSize

public int getCacheSize()

Retrieves the cache size for this sequence. Only valid when getCacheFlag() returns 'Y'.

Returns:

int - CACHE size specified

getOrderFlag

public java.lang.String getOrderFlag()

Gets the ORDER flag.

Returns:

'Y' if this sequence must generate values in order.

getUserProperties

public UserDefinedProperties getUserProperties()

Get the User Defined Properties in this table.

Returns:

String