wt.part
Class StandardPartDocService

java.lang.Object
  wt.services.StandardManager
      wt.part.StandardPartDocService

All Implemented Interfaces:

Manager, NetFactor, PartDocService, Serializable

public class StandardPartDocService

extends StandardManager

implements PartDocService, Serializable

Use the newStandardPartDocService static factory method(s), not the StandardPartDocService 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: false

Extendable: false

See Also:

Serialized Form

Nested Class Summary

private static class

StandardPartDocService.LatestReleasedConfigSpec

Field Summary

private static String	CLASSNAME
private static LatestConfigSpec	LATEST_CONFIG_SPEC
private static StandardPartDocService.LatestReleasedConfigSpec	LATEST_RELEASED_CONFIG_SPEC
private static String	RESOURCE
private static Hashtable	validStateHash

Fields inherited from class wt.services.StandardManager

Fields inherited from interface wt.services.Manager

MANAGER_SERVICE, STARTUP_AUTOMATIC, STARTUP_MANUAL, STATUS_EMERGENCY_SHUTDOWN, STATUS_EMERGENCY_SHUTTING_DOWN, STATUS_SHUTDOWN, STATUS_SHUTDOWN_ERRORS, STATUS_SHUTDOWN_FAILURE, STATUS_SHUTTING_DOWN, STATUS_STARTED, STATUS_STARTED_ERRORS, STATUS_STARTING_UP, STATUS_STARTUP_FAILURE

Constructor Summary

StandardPartDocService()

Method Summary

WTPart	createPartDocRelation(WTPart part, WTDocument doc) Supported API: false
WTPart	deletePartDocRelation(WTPart part, WTDocument doc) Supported API: false
protected QueryResult	filterReferenceDocuments(QueryResult referenceDocuments, boolean isRow)
QueryResult	findEligibleDocuments(QuerySpec docSpec) Supported API: false
WTKeyedMap	getAssociatedDocuments(WTCollection parts) Takes a collection of WTParts and returns a map where the keyset is a collection of the parts passed into the method.
QueryResult	getAssociatedDocuments(WTPart part) Supported API: false
QueryResult	getAssociatedParts(WTDocument doc) Supported API: false
QueryResult	getAssociatedUpdateableDocuments(WTPart part) Supported API: false
String	getConceptualClassname() Deprecated.
protected QueryResult	getLatestReferenceDocuments(QueryResult masters)
protected QueryResult	getLatestReferenceDocuments(WTPart part)
WTKeyedMap	getLatestReleasedDocument(WTCollection masterCollection) Given a collection of WTDocumentMasters (can be colleciton of Persistables, QueryKeys or WTReferences) this method finds the latest released iteration.
protected WTKeyedMap	intGetAssociatedDocuments(WTCollection parts, boolean includeEPMDocuments)
protected QueryResult	intGetAssociatedDocuments(WTPart part, boolean includeEPMDocuments)
protected QueryResult	intGetAssociations(WTPart part, WTDocument doc)
static StandardPartDocService	newStandardPartDocService() Default factory for the class.

Methods inherited from class wt.services.StandardManager

emergencyShutdown, emergencyShutdownComplete, emergencyShuttingDown, getClassInfo, getManagerService, getManagerStatus, getName, getStartupType, init, initialize, initialize, isStarted, newStandardManager, newStandardManager, performEmergencyShutdownProcess, performShutdownProcess, performStartupProcess, registerEvents, setManagerService, shutdown, shutdownFailure, shutdownSuccess, shuttingDown, started, startedErrors, startingUp, startup, startupFailure, toString

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

LATEST_RELEASED_CONFIG_SPEC

private static final StandardPartDocService.LatestReleasedConfigSpec LATEST_RELEASED_CONFIG_SPEC

LATEST_CONFIG_SPEC

private static final LatestConfigSpec LATEST_CONFIG_SPEC

validStateHash

private static Hashtable validStateHash

Constructor Detail

StandardPartDocService

public StandardPartDocService()

Method Detail

getConceptualClassname

public String getConceptualClassname()

Deprecated.

Returns the conceptual (modeled) name for the class.

Supported API: false

Specified by:

getConceptualClassname in interface NetFactor

Overrides:

getConceptualClassname in class StandardManager

Returns:

String

newStandardPartDocService

public static StandardPartDocService newStandardPartDocService()
                                                        throws WTException

Default factory for the class.

Supported API: false

Returns:

StandardPartDocService

Throws:

WTException

createPartDocRelation

public WTPart createPartDocRelation(WTPart part,
                                    WTDocument doc)
                             throws WTException

Supported API: false

Specified by:

createPartDocRelation in interface PartDocService

Parameters:

part -

doc -

Returns:

WTPart

Throws:

WTException

deletePartDocRelation

public WTPart deletePartDocRelation(WTPart part,
                                    WTDocument doc)
                             throws WTException

Supported API: false

Specified by:

deletePartDocRelation in interface PartDocService

Parameters:

part -

doc -

Returns:

WTPart

Throws:

WTException

getAssociatedDocuments

public QueryResult getAssociatedDocuments(WTPart part)
                                   throws WTException

Supported API: false

Specified by:

getAssociatedDocuments in interface PartDocService

Parameters:

part -

Returns:

QueryResult

Throws:

WTException

getAssociatedDocuments

public WTKeyedMap getAssociatedDocuments(WTCollection parts)
                                  throws WTException

Takes a collection of WTParts and returns a map where the keyset is a collection of the parts passed into the method. The values in the map are WTCollections that contain either IteratedDescribeLink or DocumentVersion objects. If a part passed in does not have any associated documents, it will not be in the returned map.

Supported API: false

Specified by:

getAssociatedDocuments in interface PartDocService

Parameters:

parts -

Returns:

WTKeyedMap

Throws:

WTException

getAssociatedUpdateableDocuments

public QueryResult getAssociatedUpdateableDocuments(WTPart part)
                                             throws WTException

Supported API: false

Specified by:

getAssociatedUpdateableDocuments in interface PartDocService

Parameters:

part -

Returns:

QueryResult

Throws:

WTException

getAssociatedParts

public QueryResult getAssociatedParts(WTDocument doc)
                               throws WTException

Supported API: false

Specified by:

getAssociatedParts in interface PartDocService

Parameters:

doc -

Returns:

QueryResult

Throws:

WTException

findEligibleDocuments

public QueryResult findEligibleDocuments(QuerySpec docSpec)
                                  throws WTException

Supported API: false

Specified by:

findEligibleDocuments in interface PartDocService

Parameters:

docSpec -

Returns:

QueryResult

Throws:

WTException

getLatestReleasedDocument

public WTKeyedMap getLatestReleasedDocument(WTCollection masterCollection)
                                     throws WTException

Given a collection of WTDocumentMasters (can be colleciton of Persistables, QueryKeys or WTReferences) this method finds the latest released iteration. If there is no released iteration, the latest is used. The map returned has the input collection objects as keys and the appropriate iterations as the values. Note: if an eligible iteration cannot be found for a master, that master/iteration pair will not be returned in the map.

Supported API: false

Specified by:

getLatestReleasedDocument in interface PartDocService

Parameters:

masterCollection -

Returns:

WTKeyedMap

Throws:

WTException

getLatestReferenceDocuments

protected QueryResult getLatestReferenceDocuments(WTPart part)
                                           throws WTException

Throws:

WTException

getLatestReferenceDocuments

protected QueryResult getLatestReferenceDocuments(QueryResult masters)
                                           throws WTException

Throws:

WTException

filterReferenceDocuments

protected QueryResult filterReferenceDocuments(QueryResult referenceDocuments,
                                               boolean isRow)
                                        throws WTException

Throws:

WTException

intGetAssociatedDocuments

protected QueryResult intGetAssociatedDocuments(WTPart part,
                                                boolean includeEPMDocuments)
                                         throws WTException

Throws:

WTException

intGetAssociatedDocuments

protected WTKeyedMap intGetAssociatedDocuments(WTCollection parts,
                                               boolean includeEPMDocuments)
                                        throws WTException

Throws:

WTException

intGetAssociations

protected QueryResult intGetAssociations(WTPart part,
                                         WTDocument doc)
                                  throws WTException

Throws:

WTException