wt.vc.config
Class MultipleLatestConfigSpec

java.lang.Object
  wt.vc.config.MultipleLatestConfigSpec

All Implemented Interfaces:

ConfigSpec, Externalizable, Serializable

public final class MultipleLatestConfigSpec

extends Object

implements ConfigSpec, Externalizable

Returns all latest iterations for a master except those latest iterations not owned by the current principal (either checked-out to another user or stored in a personal cabinet). This ConfigSpec is similar to the LatestConfigSpec, but returns potentially many iterations per master, whereas the LatestConfigSpec returns only one.

Supported API: true

Extendable: false

See Also:

Iterated, Serialized Form

Field Summary

private boolean	checkedOutFiltered
private static String	CLASSNAME
private static String	CLOSE_PAREN
static long	EXTERNALIZATION_VERSION_UID
protected static long	OLD_FORMAT_VERSION_UID
private static String	RESOURCE
(package private) static long	serialVersionUID

Constructor Summary

MultipleLatestConfigSpec()


Supported API: false

MultipleLatestConfigSpec(boolean checkedOutFiltered)


Supported API: false

Method Summary

QuerySpec	appendSearchCriteria(QuerySpec querySpec) Appends a "latest == true" condition to the QuerySpec.
boolean	isCheckedOutFiltered() Gets the value of the attribute: checkedOutFiltered.
QueryResult	process(QueryResult results) Returns all latest iterations either owned by the current principal (including via a checkout) or stored in a shared cabinet.
void	readExternal(ObjectInput input) Reads the non-transient fields of this class from an external source.
private boolean	readOldVersion(ObjectInput input, long readSerialVersionUID, boolean passThrough, boolean superDone) Reads the non-transient fields of this class from an external source, which is not the current version.
protected boolean	readVersion(MultipleLatestConfigSpec thisObject, ObjectInput input, long readSerialVersionUID, boolean passThrough, boolean superDone) Reads the non-transient fields of this class from an external source.
void	setCheckedOutFiltered(boolean a_CheckedOutFiltered) Sets the value of the attribute: checkedOutFiltered.
void	writeExternal(ObjectOutput output) Writes the non-transient fields of this class to an external source.

Methods inherited from class java.lang.Object

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

Field Detail

RESOURCE

private static final String RESOURCE

See Also:

Constant Field Values

CLASSNAME

private static final String CLASSNAME

checkedOutFiltered

private boolean checkedOutFiltered

serialVersionUID

static final long serialVersionUID

See Also:

Constant Field Values

EXTERNALIZATION_VERSION_UID

public static final long EXTERNALIZATION_VERSION_UID

See Also:

Constant Field Values

OLD_FORMAT_VERSION_UID

protected static final long OLD_FORMAT_VERSION_UID

See Also:

Constant Field Values

CLOSE_PAREN

private static final String CLOSE_PAREN

Constructor Detail

MultipleLatestConfigSpec

public MultipleLatestConfigSpec()

Supported API: false

MultipleLatestConfigSpec

public MultipleLatestConfigSpec(boolean checkedOutFiltered)

Supported API: false

Parameters:

checkedOutFiltered -

Method Detail

writeExternal

public void writeExternal(ObjectOutput output)
                   throws IOException

Writes the non-transient fields of this class to an external source.

Supported API: false

Specified by:

writeExternal in interface Externalizable

Parameters:

output -

Throws:

IOException

readExternal

public void readExternal(ObjectInput input)
                  throws IOException,
                         ClassNotFoundException

Reads the non-transient fields of this class from an external source.

Supported API: false

Specified by:

readExternal in interface Externalizable

Parameters:

input -

Throws:

IOException

ClassNotFoundException

readVersion

protected boolean readVersion(MultipleLatestConfigSpec thisObject,
                              ObjectInput input,
                              long readSerialVersionUID,
                              boolean passThrough,
                              boolean superDone)
                       throws IOException,
                              ClassNotFoundException

Reads the non-transient fields of this class from an external source.

Supported API: false

Parameters:

thisObject -

input -

readSerialVersionUID -

passThrough -

superDone -

Returns:

boolean

Throws:

IOException

ClassNotFoundException

readOldVersion

private boolean readOldVersion(ObjectInput input,
                               long readSerialVersionUID,
                               boolean passThrough,
                               boolean superDone)
                        throws IOException,
                               ClassNotFoundException

Reads the non-transient fields of this class from an external source, which is not the current version.

Parameters:

input -

readSerialVersionUID -

passThrough -

superDone -

Returns:

boolean

Throws:

IOException

ClassNotFoundException

isCheckedOutFiltered

public boolean isCheckedOutFiltered()

Gets the value of the attribute: checkedOutFiltered.

Supported API: false

Returns:

boolean

setCheckedOutFiltered

public void setCheckedOutFiltered(boolean a_CheckedOutFiltered)

Sets the value of the attribute: checkedOutFiltered.

Supported API: false

Parameters:

a_CheckedOutFiltered -

appendSearchCriteria

public QuerySpec appendSearchCriteria(QuerySpec querySpec)
                               throws WTException,
                                      QueryException

Appends a "latest == true" condition to the QuerySpec.

Supported API: true

Specified by:

appendSearchCriteria in interface ConfigSpec

Parameters:

querySpec - A QuerySpec with a target class that is Iterated.

Returns:

QuerySpec

Throws:

WTException

QueryException

See Also:

QuerySpec, SearchCondition

process

public QueryResult process(QueryResult results)
                    throws WTException

Returns all latest iterations either owned by the current principal (including via a checkout) or stored in a shared cabinet.

Supported API: true

Specified by:

process in interface ConfigSpec

Parameters:

results - QueryResult of iterations to filter. Assumed to be the result of a query that included the additional search conditions applied by appendSearchCriteria.

Returns:

QueryResult

Throws:

WTException

See Also:

Versioned, wt.vc.