Package com.ptc.wvs.server.schedule

Class ScheduleJobs

java.lang.Object

com.ptc.wvs.server.schedule.ScheduleJobs

public class ScheduleJobs
extends Object

Class containing methods available to those writing customized queries for Scheduled Jobs.

Supported API: true

Extendable: false

Method Summary

Modifier and Type	Method	Description
static WTContainerRef	getCurrentContainer()	Returns the WTContainerRef of the Scheduled Job's context.
static WTList	getRepresentables(Class<?> _class, boolean _onlyLatest, boolean _onlyWithNoRep)	Returns list of objects of a specified class.
static boolean	isNewObject(Persistable _p)	Returns flag indicating if a specified object is a "new" object.
static WTList	removeInWork(WTList _originalList)	Examines a WTList and returns a new WTList with objects "In Work" removed.
static WTList	removeInWork(QueryResult _qr)	Examines a QueryResult and returns a new WTList with objects "In Work" removed.

Methods inherited from class java.lang.Object

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

Method Details

getCurrentContainer

public static WTContainerRef getCurrentContainer()

Returns the WTContainerRef of the Scheduled Job's context. NOTE: This method can be used by other classes that perform queries on behalf of Scheduled Jobs. Supported API: true

Returns:

WTContainerRef

getRepresentables

public static WTList getRepresentables(Class<?> _class,
 boolean _onlyLatest,
 boolean _onlyWithNoRep)

Returns list of objects of a specified class. Caller can request only latest iteration of the object and only objects that do not currently have a Representation. Supported API: true

Parameters:

_class - Class of interest.

_onlyLatest - Flag indicating if only the latest iteration of the object should be returned.

_onlyWithNoRep - Flag indicating if only objects without a Representation should be returned.

Returns:

WTList of Objects. Can be an empty list.

removeInWork

public static WTList removeInWork(WTList _originalList)

Examines a WTList and returns a new WTList with objects "In Work" removed. Supported API: true

Parameters:

_qr - WTList of Objects to consider.

Returns:

New WTList with "In Work" objects removed. Can be an empty WTList.

removeInWork

public static WTList removeInWork(QueryResult _qr)

Examines a QueryResult and returns a new WTList with objects "In Work" removed. Supported API: true

Parameters:

_qr - QueryResult of Objects to consider.

Returns:

New WTList with "In Work" objects removed. Can be an empty WTList.

isNewObject

public static boolean isNewObject(Persistable _p)

Returns flag indicating if a specified object is a "new" object. A "new" object is in a workspace but has not yet been checked in. Supported API: true

Parameters:

_p - Persistable of interest.

Returns:

true if the specified object is "new."