Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD

wt.occurrence
Class StandardOccurrenceService

java.lang.Object
  extended bywt.services.StandardManager
      extended bywt.occurrence.StandardOccurrenceService
All Implemented Interfaces:
Manager, NetFactor, OccurrenceService, Serializable
public class StandardOccurrenceService
extends StandardManager
implements OccurrenceService, Serializable

This implementation of OccurrenceService implements the service API, send OccurrenceEvents and adds listeners in performStartupProcess().

Use the newStandardOccurrenceService static factory method(s), not the StandardOccurrenceService 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: true

See Also:
Serialized Form

Field Summary
private static String CLASSNAME
           
static String COPY_METHOD_CONTEXT_KEY
           
private static String MODIFY_OCCURRENCE_DATA_KEY
           
private static String OCCURRENCE_CACHE
           
private static String RESOURCE
           
private static String SAVE_OCCURRENCE_KEY
           
static String SKIP_OCCURRENCE_VALIDATION_KEY
           
private static boolean VERBOSE
           
 
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
StandardOccurrenceService()
           
 
Method Summary
 Vector addMissingUsesOccurrenceData(UsesOccurrence occurrence, Vector occurrenceData, Vector occurrenceDataToDelete)
          Deprecated.  
 WTKeyedMap addMissingUsesOccurrenceData(WTKeyedMap occDataMap, WTKeyedMap occDataToDeleteMap)
           
protected  void copyCombinedPathOccurrenceData(PathOccurrenceContext context)
          Deprecated.  
protected  void copyPathOccurrenceData(PathOccurrenceContext context)
          Deprecated.  
protected  Vector copyUsesOccurrenceData(UsesOccurrence occurrence)
          Deprecated.  
protected  void copyUsesOccurrences(OccurrenceableLink originalLink, OccurrenceableLink newLink)
          Deprecated.  
 CombinedPathOccurrenceData deleteCombinedPathOccurrenceData(CombinedPathOccurrenceData combinedPathOccurrenceData)
          This method should always be used to delete a CombinedPathOccurrenceData.
protected  void deleteOrphanedOccurrenceData(UsesOccurrence occurrence)
          Deletes UsesOccurrenceData objects that have been orphaned; this method should only be called internally when the given UsesOccurrence is about to be deleted and that UsesOccurrence isDataUnique(wt.occurrence.UsesOccurrence).
 PathOccurrenceData deletePathOccurrenceData(PathOccurrenceData pathOccurrenceData)
          This method should always be used to delete a PathOccurrenceData.
protected  CombinedPathOccurrenceData duplicate(CombinedPathOccurrenceData occData)
           
protected  Occurrence duplicate(Occurrence occ)
           
protected  OccurrenceData duplicate(OccurrenceData occData)
           
protected  PathOccurrence duplicate(PathOccurrence occ)
           
protected  PathOccurrenceData duplicate(PathOccurrenceData occData)
           
protected  UsesOccurrence duplicate(UsesOccurrence occ)
           
protected  UsesOccurrenceData duplicate(UsesOccurrenceData occData)
           
protected  void ensureEachLinkIsSeperateObject(Persistable[][][] usages)
          Makes sure each OccurrenceableLink in the usages array is a unique object.
 CombinedPathOccurrence getCombinedPathOccurrence(PathOccurrence parentOccurrence, PathParentableOccurrence childOccurrence)
          Returns a CombinedPathOccurrence with the given parent PathOccurrence and child PathParentableOccurrence.
 QueryResult getCombinedPathOccurrenceData(CombinedPathOccurrence occurrence, PathOccurrenceContext context, Class target)
          Returns an array of CombinedPathOccurrenceData objects of the given Class that are associated with the given CombinedPathOccurrence and PathOccurrenceContext.
 QueryResult getCombinedPathOccurrenceData(CombinedPathOccurrence occurrence, PathOccurrenceContext context, Vector targets)
          Returns an array of CombinedPathOccurrenceData objects of any of the Classes in the targets Vector associated with the given CombinedPathOccurrence and PathOccurrenceContext.
 QueryResult getCombinedPathOccurrenceData(PathOccurrenceContext context)
          Returns an array of CombinedPathOccurrenceData objects associated with the given PathOccurrenceContext.
 QueryResult getCombinedPathOccurrenceDataForDelete(CombinedPathOccurrence occurrence)
           
 QueryResult getCombinedPathOccurrences(PathOccurrenceMasterContext context)
          Returns a QueryResult of CombinedPathOccurrences having the given context.
 QueryResult getCombinedPathOccurrencesForChild(PathParentableOccurrence childPathOccurrence)
          Returns a QueryResult of CombinedPathOccurrences where the given PathOccurrence plays the 'child' role.
 QueryResult getCombinedPathOccurrencesForParent(PathOccurrence parentPathOccurrence)
          Returns a QueryResult of CombinedPathOccurrences where the given PathOccurrence plays the 'parent' role.
 String getConceptualClassname()
          Deprecated.  
protected  WTSet getNonUniqueDataSubSet(WTSet occs)
          Takes a WTSet of UsesOccurrence objects and returns a subset that are not unique in terms of the Occurrence#dataIdentifier.
 QueryResult getOccurrences(Vector occurrenceableLinks)
          Returns a QueryResult of arrays where each array has one of the given OccurrenceableLinks in position 0, an associated UsesOccurrence in position 1 and an associated PathOccurrence (that has no subPath) in position 2; the PathOccurrence could be null.
 QueryResult getOccurrences(Vector occurrenceableLinks, PathOccurrence subPathOccurrence)
          Returns a QueryResult of arrays where each array has one of the given OccurrenceableLink in position 0, an associated UsesOccurrence in position 1 and an associated PathOccurrence (having the given subPath) in position 2; the PathOccurrence could be null.
static long[] getOids(Vector v)
           
protected  OccurrenceableLink getPathDataPopulatedOccurrenceableLink(OccurrenceableLink link, PathOccurrenceContext context, Class target)
          Similar to getPathOccurrenceData(PathOccurrence,PathOccurrenceContext,java.lang.Class) except this method returns the updated OccurrenceableLink with the PathOccurrenceData and returns it.
 QueryResult getPathOccurrenceData(PathOccurrenceContext context)
          Returns an array of PathOccurrenceData objects associated with the given PathOccurrenceContext.
 QueryResult getPathOccurrenceData(PathOccurrence occurrence, PathOccurrenceContext context, Class target)
          Returns an array of PathOccurrenceData objects associated with the given PathOccurrence and PathOccurrenceContext.
 QueryResult getPathOccurrenceData(PathOccurrence occurrence, PathOccurrenceContext context, Vector targets)
          Returns an array of PathOccurrenceData objects associated with the given PathOccurrence and PathOccurrenceContext.
 QueryResult getPathOccurrenceDataForDelete(PathOccurrence occurrence)
           
 Persistable[][][] getPathOccurrenceDataPopulatedUsages(Persistable[][][] usages, PathOccurrenceContext occurrenceContext, Class occurrenceDataClass)
          Updates the PathOccurrences in the usages array by adding PathOccurrenceData of the specified type for the specified PathOccurrenceContext.
 Persistable[][][] getPathOccurrencePopulatedUsages(Persistable[][][] usages, List pathOccurrences)
          Updates the OccurrenceableLinks in the usages array by setting their usesOccurrenceVector with UsesOccurrences and setting PathOccurrences on the UsesOccurrences.
 QueryResult getPathOccurrences(PathOccurrenceMasterContext context)
          Returns a QueryResult of PathOccurrences having the given context.
 QueryResult getPathOccurrences(UsesOccurrence uses)
          Returns a QueryResult PathOccurrences related to the given UsesOccurrence.
 Vector getPopulatedOccurrenceableLinks(Vector occurrenceableLinks)
          Returns a Vector of OccurrenceableLinks with their usesOccurrenceVector populated with their UsesOccurrences; note that the UsesOccurrences also have their pathOccurrence populated.
 Vector getPopulatedOccurrenceableLinks(Vector occurrenceableLinks, PathOccurrence subPathOccurrence)
          Returns a Vector of OccurrenceableLinks with their usesOccurrenceVector populated with their UsesOccurrences; note that the UsesOccurrences also have their pathOccurrence populated.
 QueryResult getSuperPathOccurrences(PathOccurrence subPath)
           
protected  WTSet getUniqueDataSubSet(WTSet occs)
          Takes a WTSet of UsesOccurrence objects and returns a subset that is unique in terms of the Occurrence#dataIdentifier.
 QueryResult getUsesOccurrenceData(UsesOccurrence occurrence)
          Deprecated.  
 QueryResult getUsesOccurrenceData(UsesOccurrence occurrence, Vector classes)
          Returns an array of UsesOccurrenceData objects of the given classes and associated with the given UsesOccurrence object.
 WTKeyedMap getUsesOccurrenceData(WTCollection occs)
          Takes a WTCollection of UsesOccurrence objects and returns a WTKeyedMap where the keys are the UsesOccurrences passed in and the values are WTCollections of the UsesOccurrenceData that correspond to the keys.
 QueryResult getUsesOccurrences(OccurrenceableLink link)
          Returns a QueryResult of UsesOccurrence objects.
 QueryResult getUsesOccurrences(PathOccurrence path)
          Returns the UsesOccurrences associated with the given PathOccurrence.
 QueryResult getUsesOccurrences(UsesOccurrenceContext context)
          Returns a QueryResult of UsesOccurrence objects having the given context.
 QueryResult getUsesOccurrences(Vector occurrenceableLinks)
          Returns a QueryResult of arrays where each array has an OccurrenceableLink in position 0 and a UsesOccurrence in position 1.
 WTKeyedMap getUsesOccurrences(WTCollection links)
          Returns a WTKeyedMap where the keys are the input collection of OccurrenceableLinks and the values are WTCollections of the corresponding UsesOccurrence objects.
 QueryResult getUsesOccurrencesForDelete(OccurrenceableLink occurrenceableLink)
          Deprecated.  
protected  QueryResult getUsesOccurrencesForDelete(WTCollection occLinks)
           
protected  boolean isDataUnique(UsesOccurrence occurrence)
          Deprecated.  
protected  boolean isUniqueOrDeleted(UsesOccurrence occurrence)
           
private  Iterated iterateOccurrenceData(Iterated iteration)
          Create a new iteration for an existing occurrence data instance.
static StandardOccurrenceService newStandardOccurrenceService()
          Default factory for the class.
protected  void performStartupProcess()
          Provides several listeners.
protected  void processCleanupLinkEvent(KeyedEvent event)
          

Supported API: false
protected  void processCopyLinkEvent(KeyedEvent event)
          

Supported API: false
protected  void processNewIterationEvent(KeyedEvent event)
          

Supported API: false
protected  void processPreDeleteEvent(KeyedEvent event)
          

Supported API: false
protected  void processPreModifyEvent(KeyedEvent event)
          

Supported API: false
protected  void processPreStoreEvent(KeyedEvent event)
          

Supported API: false
protected  void propagateDeleteToCombinedPathOccurrenceData(CombinedPathOccurrence target)
           
protected  void propagateDeleteToCombinedPathOccurrenceData(CombinedPathOccurrence deleteTarget, CombinedPathOccurrenceDataLink deleteLink)
          Deprecated.  
protected  void propagateDeleteToCombinedPathOccurrenceData(PathOccurrenceContext target)
           
protected  void propagateDeleteToCombinedPathOccurrenceData(PathOccurrenceContext target, ContextCombinedPathOccurrenceData deleteLink)
          Deprecated.  
protected  void propagateDeleteToCombinedPathOccurrencesForChild(PathParentableOccurrence deleteTarget)
           
protected  void propagateDeleteToCombinedPathOccurrencesForParent(PathOccurrence deleteTarget)
           
protected  void propagateDeleteToPathOccurrenceData(PathOccurrence target)
           
protected  void propagateDeleteToPathOccurrenceData(PathOccurrenceContext target)
           
protected  void propagateDeleteToPathOccurrenceData(PathOccurrenceContext target, ContextPathOccurrenceData deleteLink)
          Deprecated.  
protected  void propagateDeleteToPathOccurrenceData(PathOccurrence deleteTarget, PathOccurrenceDataLink deleteLink)
          Deprecated.  
protected  void propagateDeleteToPathOccurrences(PathOccurrenceMasterContext deleteTarget)
           
protected  void propagateDeleteToPathOccurrences(UsesOccurrence deleteTarget)
           
protected  void propagateDeleteToSuperPathOccurrences(PathOccurrence deleteTarget)
           
protected  void propagateDeleteToUsesOccurrence(OccurrenceableLink deleteTarget, LinkUsesOccurrence deleteLink)
          Deprecated.  
protected  void propagateDeleteToUsesOccurrenceData(UsesOccurrence deleteTarget)
          Deprecated.  
protected  void propagateDeleteToUsesOccurrences(OccurrenceableLink deleteTarget)
          Deprecated.  
protected  void propagateDeleteToUsesOccurrences(WTCollection occLinks)
           
 void registerEvents(ManagerService managerService)
          Register events with the passed ManagerService.
 CombinedPathOccurrenceData saveCombinedPathOccurrenceData(CombinedPathOccurrenceData combinedPathOccurrenceData)
          This method should always be used to insert or store a CombinedPathOccurrenceData.
private  Iterated saveIteratedOccurrenceData(Iterated iteration)
          Save an iterated occurrence data instance.
 PathOccurrenceData savePathOccurrenceData(PathOccurrenceData pathOccurrenceData)
          This method should always be used to insert or store a .
 QueryResult saveUsesOccurrenceAndData(UsesOccurrence occurrence, Vector occurrenceData)
          Deprecated.  
 QueryResult saveUsesOccurrenceAndData(UsesOccurrence occurrence, Vector occurrenceData, Vector occurrenceDataToDelete)
          Deprecated.  
 WTCollection saveUsesOccurrenceAndData(WTKeyedMap occDataMap)
          This method should always be used to insert or store an Occurrence and/or OccurrenceData objects since they need special identifiers that must be obtained in a special way.
 WTCollection saveUsesOccurrenceAndData(WTKeyedMap occDataMap, WTKeyedMap occDataToDeleteMap)
          This method should always be used to insert or store an Occurrence and/or OccurrenceData objects since they need special identifiers that must be obtained in a special way.
 void setSkipValidation(boolean validationShouldBeSkipped)
          This API is intended for use by Windchill Visualization Services when calling either of the savePathOccurrenceAndData so that modification validation on the UsesOccurrence will not be done in the case where Visualization is only copying an occurrence from an EPM document to a part (it isn't really adding new information, only copying it).
protected  QueryResult simpleSaveUsesOccurrenceAndData(UsesOccurrence occurrence, Vector occurrenceData)
          Deprecated.  
protected  WTCollection simpleSaveUsesOccurrenceAndData(WTKeyedMap map)
          This method should always be used to insert or store an Occurrence and/or OccurrenceData objects since they need special identifiers that must be obtained in a special way.
protected  void validateCombinedPathOccurrenceCreation(CombinedPathOccurrence combinedPathOccurrence)
          Verify that the parent and child PathOccurrences have different PathOccurrenceMasterContext and that the parent is a terminal path.
protected  void validateOccurrenceableLinkModify(OccurrenceableLink modifiedLink)
          Deprecated.  
protected  void validateOccurrenceableLinkModify(WTCollection modifiedLinks)
          

Supported API: false
protected  void validateOccurrenceDataModifiability(OccurrenceData target, int operation)
          

Supported API: false
protected  void validateOccurrenceModifiability(Occurrence target, int operation)
          

Supported API: false
protected  void validatePathOccurrenceCreation(PathOccurrence pathOccurrence)
          Verify that the given PathOccurrence and its subPath have the same PathOccurrenceMasterContext and that the path must be a root in order to have a null subPath and that a non-null subPath cannot be a terminal path.
protected  void validateUsesOccurrenceCreation(UsesOccurrence usesOccurrence)
          

Supported API: false
protected  void verifySaveUsesOccurrenceAllowed(Occurrence occurrence)
           
 
Methods inherited from class wt.services.StandardManager
emergencyShutdown, emergencyShutdownComplete, emergencyShuttingDown, getClassInfo, getManagerService, getManagerStatus, getName, getStartupType, init, initialize, initialize, isStarted, newStandardManager, newStandardManager, performEmergencyShutdownProcess, performShutdownProcess, 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

SAVE_OCCURRENCE_KEY

private static final String SAVE_OCCURRENCE_KEY
See Also:
Constant Field Values

MODIFY_OCCURRENCE_DATA_KEY

private static final String MODIFY_OCCURRENCE_DATA_KEY
See Also:
Constant Field Values

SKIP_OCCURRENCE_VALIDATION_KEY

public static final String SKIP_OCCURRENCE_VALIDATION_KEY
See Also:
Constant Field Values

OCCURRENCE_CACHE

private static final String OCCURRENCE_CACHE
See Also:
Constant Field Values

VERBOSE

private static final boolean VERBOSE

COPY_METHOD_CONTEXT_KEY

public static final String COPY_METHOD_CONTEXT_KEY
See Also:
Constant Field Values
Constructor Detail

StandardOccurrenceService

public StandardOccurrenceService()
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

deleteOrphanedOccurrenceData

protected void deleteOrphanedOccurrenceData(UsesOccurrence occurrence)
                                     throws WTException
Deletes UsesOccurrenceData objects that have been orphaned; this method should only be called internally when the given UsesOccurrence is about to be deleted and that UsesOccurrence isDataUnique(wt.occurrence.UsesOccurrence).

Supported API: false

Parameters:
occurrence -
Throws:
WTException

performStartupProcess

protected void performStartupProcess()
                              throws ManagerException
Provides several listeners.

Supported API: false

Overrides:
performStartupProcess in class StandardManager
Throws:
ManagerException

validateCombinedPathOccurrenceCreation

protected void validateCombinedPathOccurrenceCreation(CombinedPathOccurrence combinedPathOccurrence)
                                               throws WTException,
                                                      OccurrenceException
Verify that the parent and child PathOccurrences have different PathOccurrenceMasterContext and that the parent is a terminal path.

Supported API: false

Parameters:
combinedPathOccurrence -
Throws:
WTException
OccurrenceException

validateOccurrenceableLinkModify

protected void validateOccurrenceableLinkModify(WTCollection modifiedLinks)
                                         throws WTException


Supported API: false

Parameters:
modifiedLinks -
Throws:
WTException

validateOccurrenceDataModifiability

protected void validateOccurrenceDataModifiability(OccurrenceData target,
                                                   int operation)
                                            throws WTException,
                                                   OccurrenceException


Supported API: false

Parameters:
target -
operation -
Throws:
WTException
OccurrenceException

validateOccurrenceModifiability

protected void validateOccurrenceModifiability(Occurrence target,
                                               int operation)
                                        throws WTException,
                                               OccurrenceException


Supported API: false

Parameters:
target -
operation -
Throws:
WTException
OccurrenceException

validatePathOccurrenceCreation

protected void validatePathOccurrenceCreation(PathOccurrence pathOccurrence)
                                       throws WTException,
                                              OccurrenceException
Verify that the given PathOccurrence and its subPath have the same PathOccurrenceMasterContext and that the path must be a root in order to have a null subPath and that a non-null subPath cannot be a terminal path.

Supported API: false

Parameters:
pathOccurrence -
Throws:
WTException
OccurrenceException

validateUsesOccurrenceCreation

protected void validateUsesOccurrenceCreation(UsesOccurrence usesOccurrence)
                                       throws WTException,
                                              OccurrenceException


Supported API: false

Parameters:
usesOccurrence -
Throws:
WTException
OccurrenceException

registerEvents

public void registerEvents(ManagerService managerService)
Register events with the passed ManagerService. The default method does nothing, subclasses should provide an overriding implementation.

Supported API: false

Specified by:
registerEvents in interface Manager
Overrides:
registerEvents in class StandardManager
Parameters:
managerService - the ManagerService with which to register events.

processCopyLinkEvent

protected void processCopyLinkEvent(KeyedEvent event)
                             throws WTException


Supported API: false

Parameters:
event -
Throws:
WTException

processCleanupLinkEvent

protected void processCleanupLinkEvent(KeyedEvent event)
                                throws WTException


Supported API: false

Parameters:
event -
Throws:
WTException

processNewIterationEvent

protected void processNewIterationEvent(KeyedEvent event)
                                 throws WTException


Supported API: false

Parameters:
event -
Throws:
WTException

processPreDeleteEvent

protected void processPreDeleteEvent(KeyedEvent event)
                              throws WTException


Supported API: false

Parameters:
event -
Throws:
WTException

processPreModifyEvent

protected void processPreModifyEvent(KeyedEvent event)
                              throws WTException


Supported API: false

Parameters:
event -
Throws:
WTException

processPreStoreEvent

protected void processPreStoreEvent(KeyedEvent event)
                             throws WTException


Supported API: false

Parameters:
event -
Throws:
WTException

newStandardOccurrenceService

public static StandardOccurrenceService newStandardOccurrenceService()
                                                              throws WTException
Default factory for the class.

Supported API: false

Returns:
StandardOccurrenceService
Throws:
WTException

deleteCombinedPathOccurrenceData

public CombinedPathOccurrenceData deleteCombinedPathOccurrenceData(CombinedPathOccurrenceData combinedPathOccurrenceData)
                                                            throws WTException
This method should always be used to delete a CombinedPathOccurrenceData.

Supported API: true

Specified by:
deleteCombinedPathOccurrenceData in interface OccurrenceService
Parameters:
combinedPathOccurrenceData -
Returns:
CombinedPathOccurrenceData
Throws:
WTException

deletePathOccurrenceData

public PathOccurrenceData deletePathOccurrenceData(PathOccurrenceData pathOccurrenceData)
                                            throws WTException
This method should always be used to delete a PathOccurrenceData.

Supported API: true

Specified by:
deletePathOccurrenceData in interface OccurrenceService
Parameters:
pathOccurrenceData -
Returns:
PathOccurrenceData
Throws:
WTException

getCombinedPathOccurrenceData

public QueryResult getCombinedPathOccurrenceData(CombinedPathOccurrence occurrence,
                                                 PathOccurrenceContext context,
                                                 Class target)
                                          throws WTException
Returns an array of CombinedPathOccurrenceData objects of the given Class that are associated with the given CombinedPathOccurrence and PathOccurrenceContext.

Supported API: true

Specified by:
getCombinedPathOccurrenceData in interface OccurrenceService
Parameters:
occurrence -
context -
target -
Returns:
QueryResult
Throws:
WTException

getCombinedPathOccurrenceData

public QueryResult getCombinedPathOccurrenceData(CombinedPathOccurrence occurrence,
                                                 PathOccurrenceContext context,
                                                 Vector targets)
                                          throws WTException
Returns an array of CombinedPathOccurrenceData objects of any of the Classes in the targets Vector associated with the given CombinedPathOccurrence and PathOccurrenceContext.

Supported API: true

Specified by:
getCombinedPathOccurrenceData in interface OccurrenceService
Parameters:
occurrence -
context -
targets -
Returns:
QueryResult
Throws:
WTException

getCombinedPathOccurrenceData

public QueryResult getCombinedPathOccurrenceData(PathOccurrenceContext context)
                                          throws WTException
Returns an array of CombinedPathOccurrenceData objects associated with the given PathOccurrenceContext.

Supported API: true

Specified by:
getCombinedPathOccurrenceData in interface OccurrenceService
Parameters:
context -
Returns:
QueryResult
Throws:
WTException

getCombinedPathOccurrence

public CombinedPathOccurrence getCombinedPathOccurrence(PathOccurrence parentOccurrence,
                                                        PathParentableOccurrence childOccurrence)
                                                 throws WTException
Returns a CombinedPathOccurrence with the given parent PathOccurrence and child PathParentableOccurrence.

Supported API: true

Specified by:
getCombinedPathOccurrence in interface OccurrenceService
Parameters:
parentOccurrence -
childOccurrence - This Vector of OccurrenceableLinks should be used to find the associated UsesOccurrence objects.
Returns:
CombinedPathOccurrence
Throws:
WTException

getCombinedPathOccurrences

public QueryResult getCombinedPathOccurrences(PathOccurrenceMasterContext context)
                                       throws WTException
Returns a QueryResult of CombinedPathOccurrences having the given context.

Supported API: true

Specified by:
getCombinedPathOccurrences in interface OccurrenceService
Parameters:
context - This Vector of OccurrenceableLinks should be used to find the associated UsesOccurrence objects.
Returns:
QueryResult
Throws:
WTException

getCombinedPathOccurrencesForChild

public QueryResult getCombinedPathOccurrencesForChild(PathParentableOccurrence childPathOccurrence)
                                               throws WTException
Returns a QueryResult of CombinedPathOccurrences where the given PathOccurrence plays the 'child' role.

Supported API: true

Specified by:
getCombinedPathOccurrencesForChild in interface OccurrenceService
Parameters:
childPathOccurrence - This Vector of OccurrenceableLinks should be used to find the associated UsesOccurrence objects.
Returns:
QueryResult
Throws:
WTException

getCombinedPathOccurrencesForParent

public QueryResult getCombinedPathOccurrencesForParent(PathOccurrence parentPathOccurrence)
                                                throws WTException
Returns a QueryResult of CombinedPathOccurrences where the given PathOccurrence plays the 'parent' role.

Supported API: true

Specified by:
getCombinedPathOccurrencesForParent in interface OccurrenceService
Parameters:
parentPathOccurrence - This Vector of OccurrenceableLinks should be used to find the associated UsesOccurrence objects.
Returns:
QueryResult
Throws:
WTException

getOccurrences

public QueryResult getOccurrences(Vector occurrenceableLinks)
                           throws WTException
Returns a QueryResult of arrays where each array has one of the given OccurrenceableLinks in position 0, an associated UsesOccurrence in position 1 and an associated PathOccurrence (that has no subPath) in position 2; the PathOccurrence could be null.

If there is no UsesOccurrence, then no QueryResult entry is returned.

Supported API: true

Specified by:
getOccurrences in interface OccurrenceService
Parameters:
occurrenceableLinks - This Vector of OccurrenceableLinks should be used to find the associated UsesOccurrence objects.
Returns:
QueryResult
Throws:
WTException

getOccurrences

public QueryResult getOccurrences(Vector occurrenceableLinks,
                                  PathOccurrence subPathOccurrence)
                           throws WTException
Returns a QueryResult of arrays where each array has one of the given OccurrenceableLink in position 0, an associated UsesOccurrence in position 1 and an associated PathOccurrence (having the given subPath) in position 2; the PathOccurrence could be null.

If there is no UsesOccurrence, then no QueryResult entry is returned.

Supported API: true

Specified by:
getOccurrences in interface OccurrenceService
Parameters:
occurrenceableLinks - This Vector of OccurrenceableLinks should be used to find the associated UsesOccurrence objects.
subPathOccurrence - This Vector of PathOccurrences should be used to find the associated PathOccurrence objects which play the superPath role. In other words we want to find the PathOccurrence objects that are one UsesOccurrence longer than the PathOccurrence objects contained in this Vector.
Returns:
QueryResult
Throws:
WTException

getPathOccurrenceData

public QueryResult getPathOccurrenceData(PathOccurrence occurrence,
                                         PathOccurrenceContext context,
                                         Class target)
                                  throws WTException
Returns an array of PathOccurrenceData objects associated with the given PathOccurrence and PathOccurrenceContext.

Supported API: true

Specified by:
getPathOccurrenceData in interface OccurrenceService
Parameters:
occurrence -
context -
target -
Returns:
QueryResult
Throws:
WTException

getPathOccurrenceData

public QueryResult getPathOccurrenceData(PathOccurrence occurrence,
                                         PathOccurrenceContext context,
                                         Vector targets)
                                  throws WTException
Returns an array of PathOccurrenceData objects associated with the given PathOccurrence and PathOccurrenceContext.

Supported API: true

Specified by:
getPathOccurrenceData in interface OccurrenceService
Parameters:
occurrence -
context -
targets -
Returns:
QueryResult
Throws:
WTException

getPathOccurrenceData

public QueryResult getPathOccurrenceData(PathOccurrenceContext context)
                                  throws WTException
Returns an array of PathOccurrenceData objects associated with the given PathOccurrenceContext.

Supported API: true

Specified by:
getPathOccurrenceData in interface OccurrenceService
Parameters:
context -
Returns:
QueryResult
Throws:
WTException

getPathOccurrencePopulatedUsages

public Persistable[][][] getPathOccurrencePopulatedUsages(Persistable[][][] usages,
                                                          List pathOccurrences)
                                                   throws WTException
Updates the OccurrenceableLinks in the usages array by setting their usesOccurrenceVector with UsesOccurrences and setting PathOccurrences on the UsesOccurrences.

Supported API: true

Specified by:
getPathOccurrencePopulatedUsages in interface OccurrenceService
Parameters:
usages - The three-dimensional array of Persistable returned from navigating many used-by objects at once.
pathOccurrences - List of path PathOccurrences that match the order of the first dimension of the usages array.
Returns:
The usages array passed in, with UsesOccurrences and PathOccurrences populated.
Throws:
WTException

getPathOccurrenceDataPopulatedUsages

public Persistable[][][] getPathOccurrenceDataPopulatedUsages(Persistable[][][] usages,
                                                              PathOccurrenceContext occurrenceContext,
                                                              Class occurrenceDataClass)
                                                       throws WTException
Updates the PathOccurrences in the usages array by adding PathOccurrenceData of the specified type for the specified PathOccurrenceContext.

Supported API: true

Specified by:
getPathOccurrenceDataPopulatedUsages in interface OccurrenceService
Parameters:
usages - The three-dimensional array of Persistable returned from navigating many used-by objects at once.
occurrenceContext - The context of the path occurrence data to add to the PathOccurrences.
occurrenceDataClass - The class PathOccurrenceData or one of its sub-types specifying the type of path occurrence data to fetch.
Returns:
The usages array passed in, with the path occurrence data added.
Throws:
WTException

getPathOccurrences

public QueryResult getPathOccurrences(UsesOccurrence uses)
                               throws WTException
Returns a QueryResult PathOccurrences related to the given UsesOccurrence.

Supported API: true

Specified by:
getPathOccurrences in interface OccurrenceService
Parameters:
uses - This Vector of PathOccurrences should be used to find the associated PathOccurrence objects which play the superPath role. In other words we want to find the PathOccurrence objects that are one UsesOccurrence longer than the PathOccurrence objects contained in this Vector.
Returns:
QueryResult
Throws:
WTException

getPathOccurrences

public QueryResult getPathOccurrences(PathOccurrenceMasterContext context)
                               throws WTException
Returns a QueryResult of PathOccurrences having the given context.

Supported API: true

Specified by:
getPathOccurrences in interface OccurrenceService
Parameters:
context - This Vector of PathOccurrences should be used to find the associated PathOccurrence objects which play the superPath role. In other words we want to find the PathOccurrence objects that are one UsesOccurrence longer than the PathOccurrence objects contained in this Vector.
Returns:
QueryResult
Throws:
WTException

getPopulatedOccurrenceableLinks

public Vector getPopulatedOccurrenceableLinks(Vector occurrenceableLinks,
                                              PathOccurrence subPathOccurrence)
                                       throws WTException
Returns a Vector of OccurrenceableLinks with their usesOccurrenceVector populated with their UsesOccurrences; note that the UsesOccurrences also have their pathOccurrence populated.

Supported API: true

Specified by:
getPopulatedOccurrenceableLinks in interface OccurrenceService
Parameters:
occurrenceableLinks - This Vector of OccurrenceableLinks should be used to find the associated UsesOccurrence objects.
subPathOccurrence - This Vector of PathOccurrences should be used to find the associated PathOccurrence objects which play the superPath role. In other words we want to find the PathOccurrence objects that are one UsesOccurrence longer than the PathOccurrence objects contained in this Vector.
Returns:
Vector
Throws:
WTException

getPopulatedOccurrenceableLinks

public Vector getPopulatedOccurrenceableLinks(Vector occurrenceableLinks)
                                       throws WTException
Returns a Vector of OccurrenceableLinks with their usesOccurrenceVector populated with their UsesOccurrences; note that the UsesOccurrences also have their pathOccurrence populated.

Supported API: true

Specified by:
getPopulatedOccurrenceableLinks in interface OccurrenceService
Parameters:
occurrenceableLinks - This Vector of OccurrenceableLinks should be used to find the associated UsesOccurrence objects.
Returns:
Vector
Throws:
WTException

getUsesOccurrences

public QueryResult getUsesOccurrences(PathOccurrence path)
                               throws OccurrenceException,
                                      WTException
Returns the UsesOccurrences associated with the given PathOccurrence.

Supported API: true

Specified by:
getUsesOccurrences in interface OccurrenceService
Parameters:
path -
Returns:
QueryResult
Throws:
OccurrenceException
WTException

getUsesOccurrenceData

public WTKeyedMap getUsesOccurrenceData(WTCollection occs)
                                 throws WTException
Takes a WTCollection of UsesOccurrence objects and returns a WTKeyedMap where the keys are the UsesOccurrences passed in and the values are WTCollections of the UsesOccurrenceData that correspond to the keys.

Supported API: true

Specified by:
getUsesOccurrenceData in interface OccurrenceService
Parameters:
occs -
Returns:
WTKeyedMap
Throws:
WTException

getUsesOccurrenceData

public QueryResult getUsesOccurrenceData(UsesOccurrence occurrence)
                                  throws WTException
Deprecated.  

Returns an array of UsesOccurrenceData objects associated with the given UsesOccurrence object.

Supported API: true

Specified by:
getUsesOccurrenceData in interface OccurrenceService
Parameters:
occurrence -
Returns:
QueryResult
Throws:
WTException

getUsesOccurrenceData

public QueryResult getUsesOccurrenceData(UsesOccurrence occurrence,
                                         Vector classes)
                                  throws WTException
Returns an array of UsesOccurrenceData objects of the given classes and associated with the given UsesOccurrence object.

Supported API: true

Specified by:
getUsesOccurrenceData in interface OccurrenceService
Parameters:
occurrence -
classes -
Returns:
QueryResult
Throws:
WTException

getUsesOccurrences

public QueryResult getUsesOccurrences(Vector occurrenceableLinks)
                               throws WTException
Returns a QueryResult of arrays where each array has an OccurrenceableLink in position 0 and a UsesOccurrence in position 1.

If there is no UsesOccurrence, then no QueryResult entry is returned.

Supported API: true

Specified by:
getUsesOccurrences in interface OccurrenceService
Parameters:
occurrenceableLinks -
Returns:
QueryResult
Throws:
WTException

getUsesOccurrences

public QueryResult getUsesOccurrences(OccurrenceableLink link)
                               throws WTException
Returns a QueryResult of UsesOccurrence objects.

Supported API: true

Specified by:
getUsesOccurrences in interface OccurrenceService
Parameters:
link -
Returns:
QueryResult
Throws:
WTException

getUsesOccurrences

public QueryResult getUsesOccurrences(UsesOccurrenceContext context)
                               throws WTException
Returns a QueryResult of UsesOccurrence objects having the given context.

Supported API: true

Specified by:
getUsesOccurrences in interface OccurrenceService
Parameters:
context -
Returns:
QueryResult
Throws:
WTException

getUsesOccurrences

public WTKeyedMap getUsesOccurrences(WTCollection links)
                              throws WTException
Returns a WTKeyedMap where the keys are the input collection of OccurrenceableLinks and the values are WTCollections of the corresponding UsesOccurrence objects.

Supported API: true

Specified by:
getUsesOccurrences in interface OccurrenceService
Parameters:
links -
Returns:
WTKeyedMap
Throws:
WTException

getUniqueDataSubSet

protected WTSet getUniqueDataSubSet(WTSet occs)
                             throws WTException
Takes a WTSet of UsesOccurrence objects and returns a subset that is unique in terms of the Occurrence#dataIdentifier.

Supported API: false

Parameters:
occs -
Returns:
WTSet
Throws:
WTException

getNonUniqueDataSubSet

protected WTSet getNonUniqueDataSubSet(WTSet occs)
                                throws WTException
Takes a WTSet of UsesOccurrence objects and returns a subset that are not unique in terms of the Occurrence#dataIdentifier.

Supported API: false

Parameters:
occs -
Returns:
WTSet
Throws:
WTException

saveCombinedPathOccurrenceData

public CombinedPathOccurrenceData saveCombinedPathOccurrenceData(CombinedPathOccurrenceData combinedPathOccurrenceData)
                                                          throws WTException
This method should always be used to insert or store a CombinedPathOccurrenceData.

Supported API: true

Specified by:
saveCombinedPathOccurrenceData in interface OccurrenceService
Parameters:
combinedPathOccurrenceData -
Returns:
CombinedPathOccurrenceData
Throws:
WTException

savePathOccurrenceData

public PathOccurrenceData savePathOccurrenceData(PathOccurrenceData pathOccurrenceData)
                                          throws WTException
This method should always be used to insert or store a .

Supported API: true

Specified by:
savePathOccurrenceData in interface OccurrenceService
Parameters:
pathOccurrenceData -
Returns:
PathOccurrenceData
Throws:
WTException

saveUsesOccurrenceAndData

public QueryResult saveUsesOccurrenceAndData(UsesOccurrence occurrence,
                                             Vector occurrenceData)
                                      throws WTException
Deprecated.  

This method should always be used to insert or store an Occurrence and/or OccurrenceData objects since they need special identifiers that must be obtained in a special way.

Returns a QueryResult of the Occurrence and the OccurrenceDatas that have been inserted or updated. Note that some other OccurrenceDatas may have been updated, too, but since the user of this method did not have them in their list they will not be returned.

If the Occurrence has a unique Occurrence#occurrenceDataIdentifier (no other Occurrence shares that occurrenceDataIdentifier), then save the OccurrenceData associated to the occurrence, but otherwise, copy the Occurrence to get one with a new dataIdentifier and copy all the associated OccurrenceData objects and then save the occurrenceData associated to the newly copied Occurrence.

Supported API: true

Specified by:
saveUsesOccurrenceAndData in interface OccurrenceService
Parameters:
occurrence -
occurrenceData -
Returns:
QueryResult
Throws:
WTException

saveUsesOccurrenceAndData

public QueryResult saveUsesOccurrenceAndData(UsesOccurrence occurrence,
                                             Vector occurrenceData,
                                             Vector occurrenceDataToDelete)
                                      throws WTException
Deprecated.  

This method should always be used to insert or store an Occurrence and/or OccurrenceData objects since they need special identifiers that must be obtained in a special way.

Returns a QueryResult of the Occurrence and the OccurrenceDatas that have been inserted or updated. Note that some other OccurrenceDatas may have been updated, too, but since the user of this method did not have them in their list they will not be returned.

If the Occurrence has a unique Occurrence#occurrenceDataIdentifier (no other Occurrence shares that occurrenceDataIdentifier), then save the OccurrenceData associated to the occurrence, but otherwise, copy the Occurrence to get one with a new dataIdentifier and copy all the associated OccurrenceData objects and then save the occurrenceData associated to the newly copied Occurrence.

Supported API: true

Specified by:
saveUsesOccurrenceAndData in interface OccurrenceService
Parameters:
occurrence -
occurrenceData -
occurrenceDataToDelete -
Returns:
QueryResult
Throws:
WTException

saveUsesOccurrenceAndData

public WTCollection saveUsesOccurrenceAndData(WTKeyedMap occDataMap)
                                       throws WTException
This method should always be used to insert or store an Occurrence and/or OccurrenceData objects since they need special identifiers that must be obtained in a special way.

Takes a WTKeyedMap where the keys are the UsesOccurrences and the values are a WTCollection of UsesOccurrenceData that correspond to the key.

Returns a WTCollection of the UsesOccurrence and the UsesOccurrenceDatas that have been inserted or updated. Note that some other UsesOccurrenceDatas may have been updated, too, but since the user of this method did not have them in their list they will not be returned.

If the Occurrence has a unique Occurrence#occurrenceDataIdentifier (no other Occurrence shares that occurrenceDataIdentifier), then save the OccurrenceData associated to the occurrence, but otherwise, copy the Occurrence to get one with a new dataIdentifier and copy all the associated OccurrenceData objects and then save the occurrenceData associated to the newly copied Occurrence.

Supported API: true

Specified by:
saveUsesOccurrenceAndData in interface OccurrenceService
Parameters:
occDataMap -
Returns:
WTCollection
Throws:
WTException

saveUsesOccurrenceAndData

public WTCollection saveUsesOccurrenceAndData(WTKeyedMap occDataMap,
                                              WTKeyedMap occDataToDeleteMap)
                                       throws WTException
This method should always be used to insert or store an Occurrence and/or OccurrenceData objects since they need special identifiers that must be obtained in a special way.

Takes two WTKeyedMaps where the keys are the UsesOccurrences and the values are a WTCollection of UsesOccurrenceData that correspond to the key. The second map identifies the UsesOccurrenceData to be deleted.

Returns a WTCollection of the UsesOccurrence and the UsesOccurrenceDatas that have been inserted or updated. Note that some other UsesOccurrenceDatas may have been updated, too, but since the user of this method did not have them in their list they will not be returned.

If the Occurrence has a unique Occurrence#occurrenceDataIdentifier (no other Occurrence shares that occurrenceDataIdentifier), then save the OccurrenceData associated to the occurrence, but otherwise, copy the Occurrence to get one with a new dataIdentifier and copy all the associated OccurrenceData objects and then save the occurrenceData associated to the newly copied Occurrence.

Supported API: true

Specified by:
saveUsesOccurrenceAndData in interface OccurrenceService
Parameters:
occDataMap -
occDataToDeleteMap -
Returns:
WTCollection
Throws:
WTException

setSkipValidation

public void setSkipValidation(boolean validationShouldBeSkipped)
                       throws WTException
This API is intended for use by Windchill Visualization Services when calling either of the savePathOccurrenceAndData so that modification validation on the UsesOccurrence will not be done in the case where Visualization is only copying an occurrence from an EPM document to a part (it isn't really adding new information, only copying it).

There should be one call to this method with an argument of true and a second with an argument of false; in between any number of calls to the save methods can be done.

Supported API: false

Specified by:
setSkipValidation in interface OccurrenceService
Parameters:
validationShouldBeSkipped -
Throws:
WTException

simpleSaveUsesOccurrenceAndData

protected WTCollection simpleSaveUsesOccurrenceAndData(WTKeyedMap map)
                                                throws WTException
This method should always be used to insert or store an Occurrence and/or OccurrenceData objects since they need special identifiers that must be obtained in a special way.

Takes a WTKeyedMap where the keys are the UsesOccurrences and the values are a WTCollection of UsesOccurrenceData that correspond to the key.

Returns a WTCollection of the UsesOccurrence and the UsesOccurrenceDatas that have been inserted or updated. Note that some other UsesOccurrenceDatas may have been updated, too, but since the user of this method did not have them in their list they will not be returned.

If the Occurrence has a unique Occurrence#occurrenceDataIdentifier (no other Occurrence shares that occurrenceDataIdentifier), then save the OccurrenceData associated to the occurrence, but otherwise, copy the Occurrence to get one with a new dataIdentifier and copy all the associated OccurrenceData objects and then save the occurrenceData associated to the newly copied Occurrence.

Supported API: false

Parameters:
map -
Returns:
WTCollection
Throws:
WTException

ensureEachLinkIsSeperateObject

protected void ensureEachLinkIsSeperateObject(Persistable[][][] usages)
Makes sure each OccurrenceableLink in the usages array is a unique object. This method is called before occurrence data is added to the links and is necessary because each link may need to be assigned a different usesOccurrenceVector containing different UsesOccurrences.

getPathDataPopulatedOccurrenceableLink

protected OccurrenceableLink getPathDataPopulatedOccurrenceableLink(OccurrenceableLink link,
                                                                    PathOccurrenceContext context,
                                                                    Class target)
                                                             throws WTException
Similar to getPathOccurrenceData(PathOccurrence,PathOccurrenceContext,java.lang.Class) except this method returns the updated OccurrenceableLink with the PathOccurrenceData and returns it.

Throws:
WTException

getOids

public static long[] getOids(Vector v)

duplicate

protected Occurrence duplicate(Occurrence occ)
                        throws WTException
Throws:
WTException

duplicate

protected UsesOccurrence duplicate(UsesOccurrence occ)
                            throws WTException
Throws:
WTException

duplicate

protected PathOccurrence duplicate(PathOccurrence occ)
                            throws WTException
Throws:
WTException

duplicate

protected OccurrenceData duplicate(OccurrenceData occData)
                            throws WTException
Throws:
WTException

duplicate

protected UsesOccurrenceData duplicate(UsesOccurrenceData occData)
                                throws WTException
Throws:
WTException

duplicate

protected PathOccurrenceData duplicate(PathOccurrenceData occData)
                                throws WTException
Throws:
WTException

duplicate

protected CombinedPathOccurrenceData duplicate(CombinedPathOccurrenceData occData)
                                        throws WTException
Throws:
WTException

verifySaveUsesOccurrenceAllowed

protected void verifySaveUsesOccurrenceAllowed(Occurrence occurrence)
                                        throws WTException
Throws:
WTException

propagateDeleteToUsesOccurrences

protected void propagateDeleteToUsesOccurrences(WTCollection occLinks)
                                         throws WTException
Throws:
WTException

propagateDeleteToPathOccurrenceData

protected void propagateDeleteToPathOccurrenceData(PathOccurrence target)
                                            throws WTException
Throws:
WTException

propagateDeleteToPathOccurrenceData

protected void propagateDeleteToPathOccurrenceData(PathOccurrenceContext target)
                                            throws WTException
Throws:
WTException

propagateDeleteToCombinedPathOccurrenceData

protected void propagateDeleteToCombinedPathOccurrenceData(PathOccurrenceContext target)
                                                    throws WTException
Throws:
WTException

propagateDeleteToCombinedPathOccurrenceData

protected void propagateDeleteToCombinedPathOccurrenceData(CombinedPathOccurrence target)
                                                    throws WTException
Throws:
WTException

propagateDeleteToCombinedPathOccurrencesForParent

protected void propagateDeleteToCombinedPathOccurrencesForParent(PathOccurrence deleteTarget)
                                                          throws WTException
Throws:
WTException

propagateDeleteToCombinedPathOccurrencesForChild

protected void propagateDeleteToCombinedPathOccurrencesForChild(PathParentableOccurrence deleteTarget)
                                                         throws WTException
Throws:
WTException

propagateDeleteToPathOccurrences

protected void propagateDeleteToPathOccurrences(UsesOccurrence deleteTarget)
                                         throws WTException
Throws:
WTException

propagateDeleteToPathOccurrences

protected void propagateDeleteToPathOccurrences(PathOccurrenceMasterContext deleteTarget)
                                         throws WTException
Throws:
WTException

propagateDeleteToSuperPathOccurrences

protected void propagateDeleteToSuperPathOccurrences(PathOccurrence deleteTarget)
                                              throws WTException
Throws:
WTException

isUniqueOrDeleted

protected boolean isUniqueOrDeleted(UsesOccurrence occurrence)
                             throws WTException
Throws:
WTException

addMissingUsesOccurrenceData

public WTKeyedMap addMissingUsesOccurrenceData(WTKeyedMap occDataMap,
                                               WTKeyedMap occDataToDeleteMap)
                                        throws WTException
Throws:
WTException

getPathOccurrenceDataForDelete

public QueryResult getPathOccurrenceDataForDelete(PathOccurrence occurrence)
                                           throws WTException
Throws:
WTException

getCombinedPathOccurrenceDataForDelete

public QueryResult getCombinedPathOccurrenceDataForDelete(CombinedPathOccurrence occurrence)
                                                   throws WTException
Throws:
WTException

getUsesOccurrencesForDelete

protected QueryResult getUsesOccurrencesForDelete(WTCollection occLinks)
                                           throws WTException
Throws:
WTException

getSuperPathOccurrences

public QueryResult getSuperPathOccurrences(PathOccurrence subPath)
                                    throws WTException
Throws:
WTException

saveIteratedOccurrenceData

private Iterated saveIteratedOccurrenceData(Iterated iteration)
                                     throws WTException
Save an iterated occurrence data instance.

Parameters:
iteration - the occurrence data instance containing the new state (of IBA values)
Returns:
the updated occurrence data instance
Throws:
WTException

iterateOccurrenceData

private Iterated iterateOccurrenceData(Iterated iteration)
                                throws WTException
Create a new iteration for an existing occurrence data instance.

Parameters:
iteration - the occurrence data instance for which we will create a new iteration
Returns:
the new occurrence data iteration
Throws:
WTException

propagateDeleteToUsesOccurrences

protected void propagateDeleteToUsesOccurrences(OccurrenceableLink deleteTarget)
                                         throws WTException
Deprecated.  

This method has been deprecated. Use propagateDeleteToUsesOccurrences(WTCollection) instead.

Throws:
WTException

getUsesOccurrencesForDelete

public QueryResult getUsesOccurrencesForDelete(OccurrenceableLink occurrenceableLink)
                                        throws WTException
Deprecated.  

This method has been deprecated. Use getUsesOccurrencesForDelete(WTCollection) instead.

Throws:
WTException

copyUsesOccurrences

protected void copyUsesOccurrences(OccurrenceableLink originalLink,
                                   OccurrenceableLink newLink)
                            throws WTException,
                                   PersistenceException
Deprecated.  

This method has been deprecated. Use processCopyLinkEvent(KeyedEvent) instead.

Throws:
WTException
PersistenceException

propagateDeleteToUsesOccurrenceData

protected void propagateDeleteToUsesOccurrenceData(UsesOccurrence deleteTarget)
                                            throws WTException
Deprecated.  

This method has been deprecated. Use deleteOrphanedOccurrenceData instead.

Throws:
WTException

copyCombinedPathOccurrenceData

protected void copyCombinedPathOccurrenceData(PathOccurrenceContext context)
                                       throws WTException
Deprecated.  

Makes copies of all the PathOccurrenceData objects associated with the given PathOccurrenceContext; this method should only be called internally when a new version of the PathOccurrenceContext has been created.

Supported API: false This method has been deprecated. Functionality moved to processNewIterationEvent.

Parameters:
context -
Throws:
WTException

copyPathOccurrenceData

protected void copyPathOccurrenceData(PathOccurrenceContext context)
                               throws WTException
Deprecated.  

Makes copies of all the PathOccurrenceData objects associated with the given PathOccurrenceContext; this method should only be called internally when a new version of the PathOccurrenceContext has been created.

Supported API: false This method has been deprecated. Functionality moved to processNewIterationEvent.

Parameters:
context -
Throws:
WTException

copyUsesOccurrenceData

protected Vector copyUsesOccurrenceData(UsesOccurrence occurrence)
                                 throws WTException
Deprecated.  

Returns an array with a new copy of the given UsesOccurrence in [0] and the new copies of the UsesOccurrenceData in the following slots; this method should only be used internally when doing a lazy copy.

Supported API: false This method has been deprecated. Does not appear to be used.

Parameters:
occurrence -
Returns:
Vector
Throws:
WTException

propagateDeleteToPathOccurrenceData

protected void propagateDeleteToPathOccurrenceData(PathOccurrence deleteTarget,
                                                   PathOccurrenceDataLink deleteLink)
                                            throws WTException
Deprecated.  

This method has been deprecated. No indication of use.

Throws:
WTException

propagateDeleteToCombinedPathOccurrenceData

protected void propagateDeleteToCombinedPathOccurrenceData(PathOccurrenceContext target,
                                                           ContextCombinedPathOccurrenceData deleteLink)
                                                    throws WTException
Deprecated.  

This method has been deprecated. No indication of use.

Throws:
WTException

propagateDeleteToCombinedPathOccurrenceData

protected void propagateDeleteToCombinedPathOccurrenceData(CombinedPathOccurrence deleteTarget,
                                                           CombinedPathOccurrenceDataLink deleteLink)
                                                    throws WTException
Deprecated.  

This method has been deprecated. No indication of use.

Throws:
WTException

propagateDeleteToUsesOccurrence

protected void propagateDeleteToUsesOccurrence(OccurrenceableLink deleteTarget,
                                               LinkUsesOccurrence deleteLink)
                                        throws WTException
Deprecated.  

This method has been deprecated. No indication of use.

Throws:
WTException

propagateDeleteToPathOccurrenceData

protected void propagateDeleteToPathOccurrenceData(PathOccurrenceContext target,
                                                   ContextPathOccurrenceData deleteLink)
                                            throws WTException
Deprecated.  

This method has been deprecated. No indication of use.

Throws:
WTException

simpleSaveUsesOccurrenceAndData

protected QueryResult simpleSaveUsesOccurrenceAndData(UsesOccurrence occurrence,
                                                      Vector occurrenceData)
                                               throws WTException
Deprecated.  

This method should always be used to insert or store an Occurrence and/or OccurrenceData objects since they need special identifiers that must be obtained in a special way.

Returns a QueryResult of the Occurrence and the OccurrenceDatas that have been inserted or updated. Note that some other OccurrenceDatas may have been updated, too, but since the user of this method did not have them in their list they will not be returned.

If the Occurrence has a unique Occurrence#occurrenceDataIdentifier (no other Occurrence shares that occurrenceDataIdentifier), then save the OccurrenceData associated to the occurrence, but otherwise, copy the Occurrence to get one with a new dataIdentifier and copy all the associated OccurrenceData objects and then save the occurrenceData associated to the newly copied Occurrence.

Supported API: false This method has been deprecated. Does not appear to be used.

Parameters:
occurrence -
occurrenceData -
Returns:
QueryResult
Throws:
WTException

isDataUnique

protected boolean isDataUnique(UsesOccurrence occurrence)
                        throws WTException
Deprecated.  

Determines if the occurrence is unique in terms of its Occurrence#dataIdentifier.

Supported API: false This method has been deprecated. Use getUniqueDataSubSet and getNonUniqueDataSubSet instead.

Parameters:
occurrence -
Returns:
boolean
Throws:
WTException

addMissingUsesOccurrenceData

public Vector addMissingUsesOccurrenceData(UsesOccurrence occurrence,
                                           Vector occurrenceData,
                                           Vector occurrenceDataToDelete)
                                    throws WTException
Deprecated.  

This method has been deprecated. No indication of use.

Throws:
WTException

validateOccurrenceableLinkModify

protected void validateOccurrenceableLinkModify(OccurrenceableLink modifiedLink)
                                         throws WTException
Deprecated.  

This method has been deprecated. No indication of use.

Throws:
WTException
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD