wt.vc.config
Interface InUseDelegate

All Known Implementing Classes:

CabinetBasedInUseDelegate, IteratedInUseDelegate, LockableInUseDelegate, OwnableInUseDelegate, SessionEditedIterationInUseDelegate, WorkableInUseDelegate

public interface InUseDelegate

The InUseDelegate can be used to determine if a given iteration is undergoing change. Typically, a user is not interested in other people's work-in-progress. This delegate can be used by ConfigSpecs to filter out such iterations.

Supported API: true

Extendable: false

Method Summary

boolean	iterationIsInUse(Iterated iterationToCheck) Returns true if the given iteration is undergoing change by any individual.
boolean	iterationIsInUseByPrincipal(Iterated iterationToCheck, WTPrincipal principal) Returns true if the given iteration is undergoing change by the specified individual.

Method Detail

iterationIsInUse

public boolean iterationIsInUse(Iterated iterationToCheck)
                         throws WTException

Returns true if the given iteration is undergoing change by any individual.

Supported API: true

Parameters:

iterationToCheck -

Returns:

boolean

Throws:

WTException

iterationIsInUseByPrincipal

public boolean iterationIsInUseByPrincipal(Iterated iterationToCheck,
                                           WTPrincipal principal)
                                    throws WTException

Returns true if the given iteration is undergoing change by the specified individual. A null principal value is defaulted to the current principal.

Supported API: true

Parameters:

iterationToCheck -

principal -

Returns:

boolean

Throws:

WTException