wt.vc.config
Interface InUseDelegate

All Known Implementing Classes:

CabinetBasedInUseDelegate, IteratedInUseDelegate, LockableInUseDelegate, 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

QuerySpec	filterInUseByPrincipal(QuerySpec qs, WTPrincipal principal) Appends critera to prevent objects that are owned by someone other than the principal to be returned.
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

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

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

filterInUseByPrincipal

QuerySpec filterInUseByPrincipal(QuerySpec qs,
                                 WTPrincipal principal)
                                 throws WTException

Appends critera to prevent objects that are owned by someone other than the principal to be returned. A null principal value is defaulted to the current principal.

Supported API: true

Parameters:

qs - the query spec that is returned with additional criteria added

principal - the principal (null implies current principal) who should be using the iteration(s)

Throws:

WTException