wt.vc.wip
Class WorkInProgressHelper

java.lang.Object
  wt.vc.wip.WorkInProgressHelper

All Implemented Interfaces:

Externalizable, Serializable

public final class WorkInProgressHelper
extends Object
implements Externalizable

Provides the Work In Progress (WIP) service's Application Programming Interface (API). This API includes static methods to checkin, checkout, undo checkout, find the predecessor and successor(s) of an iteration, find the original checked out copy of a working copy, find the working copy of an original checked out copy, get cookie information, and get search conditions to aid in a query. These methods can be categorized as locally and remotely invokeable. The local methods are getters of information, typically from cookies, that are held in the client or server. The remote methods serve as wrappers to services that promote server-side functionality to clients.

Note that the methods in this helper do not consider/handle "sandbox" checkouts, but rather are specific to work-in-progress checkouts. The lone exception to this is getState() which can return WorkInProgressState.CHECKED_OUT_TO_SANDBOX.

Supported API: true

Extendable: false

See Also:

Workable, WorkInProgressService, Serialized Form

Field Summary

static WorkInProgressService

service Supported API: true

Method Summary

static WTCollection	getCheckedOut(WTCollection objects) Given a collection of objects, returns a collection containing only those objects that are checked out.
protected static WTCollection	getCheckedOut(WTCollection objects, WTPrincipal worker) Given a collection of objects, returns a collection containing only those objects that are checked out.
static SearchCondition	getSearchCondition_CI(Class target) Determines a search condition (containing a Checked In clause) to be appended on a query.
static SearchCondition	getSearchCondition_CO(Class target) Determines a search condition (containing a Checked Out clause) to be appended on a query.
static SearchCondition	getSearchCondition_WRK(Class target) Determines a search condition (containing a Working clause) to be appended on a query.
static SearchCondition	getSearchCondition(Class target, boolean checkedOut) Deprecated.
static WorkInProgressState	getState(Workable object) Gets the work-in-progress state of the object.
static boolean	isCheckedOut(Workable object) Tests if the workable object is checked out.
static boolean	isCheckedOut(Workable object, WTPrincipal worker) Tests if the workable object is checked out by the principal.
static boolean	isWorkingCopy(Workable object) Tests if the workable object is a working copy.

Methods inherited from class java.lang.Object

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

Field Detail

service

public static final WorkInProgressService service

Supported API: true

Method Detail

getState

public static WorkInProgressState getState(Workable object)
                                    throws WorkInProgressException

Gets the work-in-progress state of the object. The object could be either checked in, checked out, or in work.

Supported API: true

Parameters:

object -

Returns:

WorkInProgressState

Throws:

WorkInProgressException

isCheckedOut

public static boolean isCheckedOut(Workable object)
                            throws WTException

Tests if the workable object is checked out. True is returned if the object is either the original [checked out] copy, or the working copy of the original. Otherwise, false is returned.

Supported API: true

Parameters:

object -

Returns:

boolean

Throws:

WTException

isCheckedOut

public static boolean isCheckedOut(Workable object,
                                   WTPrincipal worker)
                            throws WTException

Tests if the workable object is checked out by the principal. True is returned if the object is either the original [checked out] copy and its locker is the given principal, or the working copy of the original and its owner is the given principal. Otherwise, false is returned.

Supported API: true

Parameters:

object -

worker -

Returns:

boolean

Throws:

WTException

getCheckedOut

protected static WTCollection getCheckedOut(WTCollection objects,
                                            WTPrincipal worker)
                                     throws WTException

Given a collection of objects, returns a collection containing only those objects that are checked out.

Supported API: true

Parameters:

objects -

worker -

Returns:

WTCollection

Throws:

WTException

getCheckedOut

public static WTCollection getCheckedOut(WTCollection objects)
                                  throws WTException

Given a collection of objects, returns a collection containing only those objects that are checked out.

Supported API: true

Parameters:

objects -

Returns:

WTCollection

Throws:

WTException

isWorkingCopy

public static boolean isWorkingCopy(Workable object)

Tests if the workable object is a working copy.

Supported API: true

Parameters:

object -

Returns:

boolean

getSearchCondition

public static SearchCondition getSearchCondition(Class target,
                                                 boolean checkedOut)
                                          throws WorkInProgressException,
                                                 QueryException

Deprecated.

Determines a search condition to be appended on a query.

Supported API: true

Parameters:

target -

checkedOut -

Returns:

SearchCondition

Throws:

WorkInProgressException

QueryException

getSearchCondition_WRK

public static SearchCondition getSearchCondition_WRK(Class target)
                                              throws WorkInProgressException,
                                                     QueryException

Determines a search condition (containing a Working clause) to be appended on a query.

Supported API: true

Parameters:

target -

Returns:

SearchCondition

Throws:

WorkInProgressException

QueryException

getSearchCondition_CO

public static SearchCondition getSearchCondition_CO(Class target)
                                             throws WorkInProgressException,
                                                    QueryException

Determines a search condition (containing a Checked Out clause) to be appended on a query.

Supported API: true

Parameters:

target -

Returns:

SearchCondition

Throws:

WorkInProgressException

QueryException

getSearchCondition_CI

public static SearchCondition getSearchCondition_CI(Class target)
                                             throws WorkInProgressException,
                                                    QueryException

Determines a search condition (containing a Checked In clause) to be appended on a query.

Supported API: true

Parameters:

target -

Returns:

SearchCondition

Throws:

WorkInProgressException

QueryException