Overview | Package | Class | Tree | Deprecated | Index | Help
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD

## oracle.ifs.fdk
Class LockManager

All Superinterfaces:
  java.rmi.Remote

All Known Subinterfaces:
  ExtendedLockManager

All Known Implementing Classes:
  CoreExtendedLockManager, CoreLockManager, ExtendedLockManagerImpl, LockManagerImpl

    public interface class LockManager

extends java.rmi.Remote

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

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

  Description copied from interface: `LockManager`
  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

    void releaseManualLocks(long[] ids)
                            throws FdkException

  Description copied from interface: `LockManager`
  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

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

  Description copied from interface: `LockManager`
  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_FINALIZED
    - FdkConstants.LOCKTYPE_MANUAL
    - FdkConstants.LOCKTYPE_WORKFLOW
    - FdkConstants.LOCKTYPE_RECORD
    - FdkConstants.LOCKTYPE_HASRECORD
    - FdkConstants.LOCKTYPE_FREEZE
    - FdkConstants.LOCKTYPE_LIFECYCLE
    - FdkConstants.LOCKTYPE_RETENTION
    - FdkConstants.LOCKTYPE_NAMEDFREEZE
    - FdkConstants.LOCKTYPE_CUSTOM
    `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

Overview | Package | Class | Tree | Deprecated | Index | Help
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD