oracle.ifs.common

Class FolderIndexDeferredUpdate

java.lang.Object

oracle.ifs.common.FolderIndexDeferredUpdate

All Implemented Interfaces:

Serializable

public final class FolderIndexDeferredUpdate
extends Object
implements Serializable

A FolderIndexDeferredUpdate contains information used to update the main FolderIndex or a partition asynchronously by an agent or handler.

Version:

2.0

Author:

Dave Long

See Also:

Serialized Form

(Unpublished)

Field Summary

Fields

Modifier and Type	Field and Description
protected long	m_Id The id of the deferred update entry
protected long	m_LeftId The left id (parent folder)
protected int	m_Level The map level.
protected int	m_OperationType The operation type.
protected String	m_PartitionTableName The name of the partition table, or null if for the main FolderIndex.
protected long	m_RightId The right id (child folder)
protected long	m_TargetId The target id (folder that is destination of a Move)
static int	OPERATION_TYPE_ADD_TO_FOLDER The operation type for adding a folder to a folder, for creating a folder index deferred update entry.
static int	OPERATION_TYPE_CREATE_AND_ADD_TO_FOLDER The operation type for adding a folder to a folder after creating the Folder, for creating a folder index deferred update entry.
static int	OPERATION_TYPE_FREE_FOLDER The operation type for freeing a folder, for creating a folder index deferred update entry.
static int	OPERATION_TYPE_MOVE_FOLDER The operation type for moving a folder from one parent to another, for creating a folder index deferred update entry.
static int	OPERATION_TYPE_NEW_FOLDER The operation type for a new folder, for creating a folder index deferred update entry.
static int	OPERATION_TYPE_NO_OPERATION The operation type for a no-op.
static int	OPERATION_TYPE_PROMOTE_FOLDER The operation type for promoting a folder, for creating a folder index deferred update entry.
static int	OPERATION_TYPE_REMOVE_FROM_FOLDER The operation type for removing a folder from a folder, for creating a folder index deferred update entry.

Constructor Summary

Constructors

Constructor and Description
FolderIndexDeferredUpdate(long id, int opType, long leftId, long rightId, int level) Constructs a FolderIndexDeferredUpdate.
FolderIndexDeferredUpdate(String partTable, int opType, long leftId, long rightId) Constructs a FolderIndexDeferredUpdate.
FolderIndexDeferredUpdate(String partTable, int opType, long leftId, long rightId, long targetId) Constructs a FolderIndexDeferredUpdate.

Method Summary

Modifier and Type	Method and Description
long	getId() Gets the id of the entry
long	getLeftId() Gets the left ID for the entry
int	getLevel() Gets the map level for the entry
int	getOperationType() Gets the operation type for the entry
String	getPartitionTableName() Gets the name of the partition table, or null if for the main FolderIndex.
long	getRightId() Gets the right ID for the entry
long	getTargetId() Gets the target ID for the entry

Methods inherited from class java.lang.Object

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

Field Detail

OPERATION_TYPE_NO_OPERATION

public static final int OPERATION_TYPE_NO_OPERATION

The operation type for a no-op.

Current value is 0.

See Also:

Constant Field Values

(Unpublished)

OPERATION_TYPE_NEW_FOLDER

public static final int OPERATION_TYPE_NEW_FOLDER

The operation type for a new folder, for creating a folder index deferred update entry.

Current value is 1.

See Also:

Constant Field Values

(Unpublished)

OPERATION_TYPE_FREE_FOLDER

public static final int OPERATION_TYPE_FREE_FOLDER

The operation type for freeing a folder, for creating a folder index deferred update entry.

Current value is 2.

See Also:

Constant Field Values

(Unpublished)

OPERATION_TYPE_ADD_TO_FOLDER

public static final int OPERATION_TYPE_ADD_TO_FOLDER

The operation type for adding a folder to a folder, for creating a folder index deferred update entry.

Current value is 3.

See Also:

Constant Field Values

(Unpublished)

OPERATION_TYPE_REMOVE_FROM_FOLDER

public static final int OPERATION_TYPE_REMOVE_FROM_FOLDER

The operation type for removing a folder from a folder, for creating a folder index deferred update entry.

Current value is 4.

See Also:

Constant Field Values

(Unpublished)

OPERATION_TYPE_PROMOTE_FOLDER

public static final int OPERATION_TYPE_PROMOTE_FOLDER

The operation type for promoting a folder, for creating a folder index deferred update entry.

Current value is 5.

See Also:

Constant Field Values

(Unpublished)

OPERATION_TYPE_CREATE_AND_ADD_TO_FOLDER

public static final int OPERATION_TYPE_CREATE_AND_ADD_TO_FOLDER

The operation type for adding a folder to a folder after creating the Folder, for creating a folder index deferred update entry.

Current value is 6.

See Also:

Constant Field Values

(Unpublished)

OPERATION_TYPE_MOVE_FOLDER

public static final int OPERATION_TYPE_MOVE_FOLDER

The operation type for moving a folder from one parent to another, for creating a folder index deferred update entry.

Current value is 7.

See Also:

Constant Field Values

(Unpublished)

m_PartitionTableName

protected String m_PartitionTableName

The name of the partition table, or null if for the main FolderIndex.

(Unpublished)

m_Id

protected long m_Id

The id of the deferred update entry

(Unpublished)

m_OperationType

protected int m_OperationType

The operation type.

(Unpublished)

m_LeftId

protected long m_LeftId

The left id (parent folder)

(Unpublished)

m_RightId

protected long m_RightId

The right id (child folder)

(Unpublished)

m_TargetId

protected long m_TargetId

The target id (folder that is destination of a Move)

(Unpublished)

m_Level

protected int m_Level

The map level.

(Unpublished)

Constructor Detail

FolderIndexDeferredUpdate

public FolderIndexDeferredUpdate(long id,
                                 int opType,
                                 long leftId,
                                 long rightId,
                                 int level)

Constructs a FolderIndexDeferredUpdate.

This variant is used when reading FolderIndexDeferredUpdate entries from the Database.

Parameters:

id - the id of the entry inthe folder index update table

opType - the operation type

leftId - the ID of the parent folder

rightId - the ID of the child folder

level - the folder index map level

(Unpublished)

FolderIndexDeferredUpdate

public FolderIndexDeferredUpdate(String partTable,
                                 int opType,
                                 long leftId,
                                 long rightId)

Constructs a FolderIndexDeferredUpdate.

This variant is used in the partition handler, which uses this structure to equest the FolderIndexService to apply updates to a FolderIndex partition.

Parameters:

partTable - the partition table name

opType - the operation type

leftId - the ID of the parent folder

rightId - the ID of the child folder

(Unpublished)

FolderIndexDeferredUpdate

public FolderIndexDeferredUpdate(String partTable,
                                 int opType,
                                 long leftId,
                                 long rightId,
                                 long targetId)

Constructs a FolderIndexDeferredUpdate.

This variant is used in the partition handler, which uses this structure to equest the FolderIndexService to apply updates to a FolderIndex partition.

Parameters:

partTable - the partition table name

opType - the operation type

leftId - the ID of the parent folder

rightId - the ID of the child folder

targetId - the ID of the target folder (for Move only)

(Unpublished)

Method Detail

getPartitionTableName

public final String getPartitionTableName()

Gets the name of the partition table, or null if for the main FolderIndex.

Returns:

the partition table name, or null for the main FolderIndex

(Published)

getId

public final long getId()

Gets the id of the entry

Returns:

the id

(Published)

getOperationType

public final int getOperationType()

Gets the operation type for the entry

Returns:

the class id

(Published)

getLeftId

public final long getLeftId()

Gets the left ID for the entry

Returns:

the left ID

(Published)

getRightId

public final long getRightId()

Gets the right ID for the entry

Returns:

the right id

(Published)

getTargetId

public final long getTargetId()

Gets the target ID for the entry

Returns:

the right id

(Published)

getLevel

public final int getLevel()

Gets the map level for the entry

Returns:

the map level

(Published)