wt.vc.config
Class IteratedFolderedConfigSpec

java.lang.Object
  wt.vc.config.IteratedFolderedConfigSpec

All Implemented Interfaces:

ConfigSpec, Externalizable, NetFactor, ObjectMappable, Serializable

public class IteratedFolderedConfigSpec

extends Object

implements ConfigSpec, ObjectMappable, Externalizable

The IteratedFolderedConfigSpec can be used to filter IteratedFoldered elements based on folder location. Only those elements in the particular folder or sub-folder will be returned by this ConfigSpec.

Use the newIteratedFolderedConfigSpec static factory method(s), not the IteratedFolderedConfigSpec constructor, to construct instances of this class. Instances must be constructed using the static factory(s), in order to ensure proper initialization of the instance.

Supported API: true

Extendable: false

See Also:

IteratedFoldered, Serialized Form

Field Summary

private static String	CLASSNAME
static long	EXTERNALIZATION_VERSION_UID
static String	FOLDER Label for the attribute; The folder elements must be in, either directly or as a consequence of being in a sub-folder.
private static String	FOLDER_ROLE
private ObjectReference	folderRef
private static Class	IT_FOLDER_MEMBER_LINK
private static Class	IT_SHORTCUT_LINK
private static String	MEMBER_ROLE_VID
protected static long	OLD_FORMAT_VERSION_UID
private static String	REFERENCING_FOLDER_ROLE
private static String	RESOURCE
(package private) static long	serialVersionUID
private static String	TARGET_ROLE_VID
private static String	VERSION_IDENTIFIER

Constructor Summary

IteratedFolderedConfigSpec()

Method Summary

QuerySpec	appendSearchCriteria(QuerySpec querySpec) Appends a "folder = getFolder() OR folder = subFolder OR ..." to the QuerySpec.
private QueryResult	getAllSubFolders(Folder folder)
ClassInfo	getClassInfo() Returns the ClassInfo object for this class.
String	getConceptualClassname() Deprecated.
Folder	getFolder() Gets the value of the attribute: FOLDER.
private long[]	getSubFolderOIDs()
protected void	initialize(Folder folder) Supports initialization, following construction of an instance.
static IteratedFolderedConfigSpec	newIteratedFolderedConfigSpec(Folder folder) Supported API: false
QueryResult	process(QueryResult results) Returns a clone of the results.
void	readExternal(ObjectInput input) Reads the non-transient fields of this class from an external source.
void	readExternal(PersistentRetrieveIfc input) Used by Persistent Data Service to populate the persistent attributes of this class from a persistent store.
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(IteratedFolderedConfigSpec thisObject, ObjectInput input, long readSerialVersionUID, boolean passThrough, boolean superDone) Reads the non-transient fields of this class from an external source.
void	setFolder(Folder a_Folder) Sets the value of the attribute: FOLDER.
String	toString() Returns the conceptual (modeled) name for the class.
void	writeExternal(ObjectOutput output) Writes the non-transient fields of this class to an external source.
void	writeExternal(PersistentStoreIfc output) Used by Persistent Data Service to obtain the values of the persistent attributes of this class, so they can be written to a persistent store.

Methods inherited from class java.lang.Object

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

Field Detail

RESOURCE

private static final String RESOURCE

See Also:

Constant Field Values

CLASSNAME

private static final String CLASSNAME

FOLDER

public static final String FOLDER

Label for the attribute; The folder elements must be in, either directly or as a consequence of being in a sub-folder.

Supported API: false

See Also:

Constant Field Values

folderRef

private ObjectReference folderRef

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

IT_FOLDER_MEMBER_LINK

private static final Class IT_FOLDER_MEMBER_LINK

IT_SHORTCUT_LINK

private static final Class IT_SHORTCUT_LINK

FOLDER_ROLE

private static final String FOLDER_ROLE

See Also:

Constant Field Values

REFERENCING_FOLDER_ROLE

private static final String REFERENCING_FOLDER_ROLE

See Also:

Constant Field Values

MEMBER_ROLE_VID

private static final String MEMBER_ROLE_VID

See Also:

Constant Field Values

TARGET_ROLE_VID

private static final String TARGET_ROLE_VID

See Also:

Constant Field Values

VERSION_IDENTIFIER

private static final String VERSION_IDENTIFIER

See Also:

Constant Field Values

Constructor Detail

IteratedFolderedConfigSpec

public IteratedFolderedConfigSpec()

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(IteratedFolderedConfigSpec 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

writeExternal

public void writeExternal(PersistentStoreIfc output)
                   throws SQLException,
                          DatastoreException

Used by Persistent Data Service to obtain the values of the persistent attributes of this class, so they can be written to a persistent store.

(Not intended for general use.)

Supported API: false

Specified by:

writeExternal in interface ObjectMappable

Parameters:

output -

Throws:

SQLException

DatastoreException

readExternal

public void readExternal(PersistentRetrieveIfc input)
                  throws SQLException,
                         DatastoreException

Used by Persistent Data Service to populate the persistent attributes of this class from a persistent store.

(Not intended for general use.)

Supported API: false

Specified by:

readExternal in interface ObjectMappable

Parameters:

input -

Throws:

SQLException

DatastoreException

getConceptualClassname

public String getConceptualClassname()

Deprecated.

Returns the conceptual (modeled) name for the class.

Supported API: false

Specified by:

getConceptualClassname in interface NetFactor

Returns:

String

toString

public String toString()

Returns the conceptual (modeled) name for the class.

Supported API: false

Returns:

String

getClassInfo

public ClassInfo getClassInfo()
                       throws WTIntrospectionException

Returns the ClassInfo object for this class.

Supported API: false

Specified by:

getClassInfo in interface NetFactor

Returns:

ClassInfo

Throws:

WTIntrospectionException

getFolder

public Folder getFolder()
                 throws ObjectNoLongerExistsException

Gets the value of the attribute: FOLDER. The folder elements must be in, either directly or as a consequence of being in a sub-folder.

Supported API: false

Returns:

Folder

Throws:

ObjectNoLongerExistsException

setFolder

public void setFolder(Folder a_Folder)
               throws WTPropertyVetoException

Sets the value of the attribute: FOLDER. The folder elements must be in, either directly or as a consequence of being in a sub-folder.

Supported API: false

Parameters:

a_Folder -

Throws:

WTPropertyVetoException

appendSearchCriteria

public QuerySpec appendSearchCriteria(QuerySpec querySpec)
                               throws WTException,
                                      QueryException

Appends a "folder = getFolder() OR folder = subFolder OR ..." 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 a clone of the results. No processing is done: it is expected that the results have already been pre-filtered by the search.

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. Note that after enumerating through the elements of this QueryResult, it should be reset.

Returns:

QueryResult

Throws:

WTException

See Also:

QueryResult, Iterated

newIteratedFolderedConfigSpec

public static IteratedFolderedConfigSpec newIteratedFolderedConfigSpec(Folder folder)
                                                                throws WTPropertyVetoException

Supported API: false

Parameters:

folder -

Returns:

IteratedFolderedConfigSpec

Throws:

WTPropertyVetoException

initialize

protected void initialize(Folder folder)
                   throws WTPropertyVetoException

Supports initialization, following construction of an instance. Invoked by "new" factory having the same signature.

Supported API: false

Parameters:

folder -

Throws:

WTPropertyVetoException

getSubFolderOIDs

private long[] getSubFolderOIDs()
                         throws WTException

Throws:

WTException

getAllSubFolders

private QueryResult getAllSubFolders(Folder folder)
                              throws WTException

Throws:

WTException