wt.occurrence
Class OccurrenceServiceFwd

java.lang.Object
  wt.occurrence.OccurrenceServiceFwd

All Implemented Interfaces:

OccurrenceService, RemoteAccess, Serializable

public class OccurrenceServiceFwd

extends Object

implements RemoteAccess, OccurrenceService, Serializable

This service interface defines the API for managing UsesOccurrences, PathOccurrences, CombinedPathOccurrences, UsesOccurrenceData, PathOccurrenceData and CombinedPathOccurrenceData in the context of OccurrenceableLinks, PathOccurrenceContexts and CombinedPathOccurrenceContexts

• Cookie: None
• Helper: OccurrenceHelper has helper methods
• Service implementation: StandardOccurrenceService has listeners
• ServiceEvent: OccurrenceEvent
• ServiceException: OccurrenceException

Supported API: false

Extendable: false

See Also:

"Making Parts Content Holders" in Customizer's Guide", "Business Service Design Pattern" in "Application Developer's Guide", Serialized Form

Field Summary

private static String	CLASSNAME
private static String	FC_RESOURCE
(package private) static boolean	SERVER

Fields inherited from interface wt.method.RemoteAccess

versionID

Constructor Summary

OccurrenceServiceFwd()

Method Summary

CombinedPathOccurrenceData	deleteCombinedPathOccurrenceData(CombinedPathOccurrenceData combinedPathOccurrenceData) This method should always be used to delete a CombinedPathOccurrenceData.
PathOccurrenceData	deletePathOccurrenceData(PathOccurrenceData pathOccurrenceData) This method should always be used to delete a PathOccurrenceData.
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	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.
private static Manager	getManager()
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.
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.
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	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.
CombinedPathOccurrenceData	saveCombinedPathOccurrenceData(CombinedPathOccurrenceData combinedPathOccurrenceData) This method should always be used to insert or store a CombinedPathOccurrenceData.
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).

Methods inherited from class java.lang.Object

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

Field Detail

SERVER

static final boolean SERVER

FC_RESOURCE

private static final String FC_RESOURCE

See Also:

Constant Field Values

CLASSNAME

private static final String CLASSNAME

Constructor Detail

OccurrenceServiceFwd

public OccurrenceServiceFwd()

Method Detail

getManager

private static Manager getManager()
                           throws WTException

Returns:

Manager

Throws:

WTException

deleteCombinedPathOccurrenceData

public CombinedPathOccurrenceData deleteCombinedPathOccurrenceData(CombinedPathOccurrenceData combinedPathOccurrenceData)
                                                            throws WTException

This method should always be used to delete a CombinedPathOccurrenceData.

Supported API: false

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: false

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: false

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: false

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: false

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: false

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: false

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: false

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: false

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: false

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: false

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: false

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: false

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: false

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: false

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: false

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: false

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: false

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: false

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: false

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: false

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: false

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: false

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: false

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: false

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: false

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: false

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: false

Specified by:

getUsesOccurrences in interface OccurrenceService

Parameters:

links -

Returns:

WTKeyedMap

Throws:

WTException

saveCombinedPathOccurrenceData

public CombinedPathOccurrenceData saveCombinedPathOccurrenceData(CombinedPathOccurrenceData combinedPathOccurrenceData)
                                                          throws WTException

This method should always be used to insert or store a CombinedPathOccurrenceData.

Supported API: false

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: false

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: false

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: false

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: false

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: false

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