oracle.ifs.fdk
Interface LockManager

public interface LockManager

A facade interface for managing locks.

Method Summary

Item[]	acquireManualLocks(long[] ids, NamedValueSet[] attributes) Acquires manual locks on the given Items.
Item[]	listLockedDocuments(int[] locks, NamedValue[] options, AttributeRequest[] attributes) Returns a list of Documents locked by a user.
void	releaseManualLocks(long[] ids) Releases manual locks on the given Items.

Method Detail

acquireManualLocks

public Item[] acquireManualLocks(long[] ids,
                                 NamedValueSet[] attributes)
                          throws FdkException

Acquires manual locks on the given Items.

Parameters:

ids - the IDs of the Items to lock.

attributes - optional attributes.

Returns:

Item[] the LockEntry items that was created as an array in the order of the requested ID's

Throws:

FdkException - if the operation fails.

releaseManualLocks

public void releaseManualLocks(long[] ids)
                        throws FdkException

Releases manual locks on the given Items. Does not affect other locks.

Parameters:

ids - the IDs of the Items to unlock.

Throws:

FdkException - if the operation fails.

listLockedDocuments

public Item[] listLockedDocuments(int[] locks,
                                  NamedValue[] options,
                                  AttributeRequest[] attributes)
                           throws FdkException

Returns a list of Documents locked by a user. This can be used to query various user related locks. Example - To get the list of documents checked out by a user query for the documents on which the user has a checkout lock.

Parameters:

locks - The types of locks to search for. Valid values are

• FdkConstants.LOCKTYPE_CHECKOUT
• FdkConstants.LOCKTYPE_FAMILYHASRECORD
• FdkConstants.LOCKTYPE_FINALIZED
• FdkConstants.LOCKTYPE_MANUAL
• FdkConstants.LOCKTYPE_RECORD
• FdkConstants.LOCKTYPE_WORKFLOW

options - Optional restrictions/sort options. Valid Attributes:

• notation: {Attribute name, Attribute type}
• {Attributes.CREATED_BY, Long}
• {Options.RESOLVE_OBJECTS, Boolean}
• {Options.START_DATE, Date}
• {Options.END_DATE, Date}
• {Options.PRIMARY_SORT_ATTRIBUTE, String}
• {Options.PRIMARY_SORT_DIRECTION, Boolean}
• {Options.SECONDARY_SORT_ATTRIBUTE, String}
• {Options.SECONDARY_SORT_DIRECTION, Boolean}

Some of the supported attributes for sorting are

• ID
• OWNER
• START_DATE
• END_DATE

Any valid attribute on the LockEntry may be specified for sorting. If an attribute name is specified with no direction, ascending is the default. Attribute names must be valid attributes in Attributes

attributes - Attributes to be populated on the returned LOCK items

Returns:

The list of documents

Throws:

FdkException - If the operation fails