|
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||
public interface OccurrenceService
This service interface defines the API for managing UsesOccurrences,
PathOccurrences, CombinedPathOccurrences, UsesOccurrenceData,
PathOccurrenceData and CombinedPathOccurrenceData in
the context of OccurrenceableLinks, PathOccurrenceContexts
and CombinedPathOccurrenceContexts
OccurrenceHelper has helper methodsStandardOccurrenceService has
listenersOccurrenceEventOccurrenceException
| 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. |
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. |
| Method Detail |
|---|
CombinedPathOccurrenceData deleteCombinedPathOccurrenceData(CombinedPathOccurrenceData combinedPathOccurrenceData)
throws WTException
CombinedPathOccurrenceData.
combinedPathOccurrenceData -
WTException
PathOccurrenceData deletePathOccurrenceData(PathOccurrenceData pathOccurrenceData)
throws WTException
PathOccurrenceData.
pathOccurrenceData -
WTException
QueryResult getCombinedPathOccurrenceData(CombinedPathOccurrence occurrence,
PathOccurrenceContext context,
Class target)
throws WTException
CombinedPathOccurrenceData objects of
the given Class that are associated with the given CombinedPathOccurrence and PathOccurrenceContext.
occurrence - context - target -
WTException
QueryResult getCombinedPathOccurrenceData(CombinedPathOccurrence occurrence,
PathOccurrenceContext context,
Vector targets)
throws WTException
CombinedPathOccurrenceData objects of
any of the Classes in the targets Vector
associated with the given CombinedPathOccurrence and PathOccurrenceContext.
occurrence - context - targets -
WTException
QueryResult getCombinedPathOccurrenceData(PathOccurrenceContext context)
throws WTException
CombinedPathOccurrenceData objects associated
with the given PathOccurrenceContext.
context -
WTException
CombinedPathOccurrence getCombinedPathOccurrence(PathOccurrence parentOccurrence,
PathParentableOccurrence childOccurrence)
throws WTException
CombinedPathOccurrence with the given parent PathOccurrence and child PathParentableOccurrence.
parentOccurrence - childOccurrence - This Vector of OccurrenceableLinks should be used to find the associated UsesOccurrence objects.
WTException
QueryResult getCombinedPathOccurrences(PathOccurrenceMasterContext context)
throws WTException
QueryResult of CombinedPathOccurrences
having the given context.
context - This Vector of OccurrenceableLinks should be used to find the associated UsesOccurrence objects.
WTException
QueryResult getCombinedPathOccurrencesForChild(PathParentableOccurrence childPathOccurrence)
throws WTException
QueryResult of CombinedPathOccurrences
where the given PathOccurrence plays the 'child' role.
childPathOccurrence - This Vector of OccurrenceableLinks should be used to find the associated UsesOccurrence objects.
WTException
QueryResult getCombinedPathOccurrencesForParent(PathOccurrence parentPathOccurrence)
throws WTException
QueryResult of CombinedPathOccurrences
where the given PathOccurrence plays the 'parent' role.
parentPathOccurrence - This Vector of OccurrenceableLinks should be used to find the associated UsesOccurrence objects.
WTException
QueryResult getOccurrences(Vector occurrenceableLinks)
throws WTException
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
occurrenceableLinks - This Vector of OccurrenceableLinks should be used to find the associated UsesOccurrence objects.
WTException
QueryResult getOccurrences(Vector occurrenceableLinks,
PathOccurrence subPathOccurrence)
throws WTException
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
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.
WTException
QueryResult getPathOccurrenceData(PathOccurrence occurrence,
PathOccurrenceContext context,
Class target)
throws WTException
PathOccurrenceData objects associated
with the given PathOccurrence and PathOccurrenceContext.
occurrence - context - target -
WTException
QueryResult getPathOccurrenceData(PathOccurrence occurrence,
PathOccurrenceContext context,
Vector targets)
throws WTException
PathOccurrenceData objects associated
with the given PathOccurrence and PathOccurrenceContext.
occurrence - context - targets -
WTException
QueryResult getPathOccurrenceData(PathOccurrenceContext context)
throws WTException
PathOccurrenceData objects associated
with the given PathOccurrenceContext.
context -
WTException
Persistable[][][] getPathOccurrencePopulatedUsages(Persistable[][][] usages,
List pathOccurrences)
throws WTException
OccurrenceableLinks in the usages
array by setting their usesOccurrenceVector with UsesOccurrences and setting PathOccurrences on the UsesOccurrences.
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.
usages array passed in, with UsesOccurrences
and PathOccurrences populated.
WTException
Persistable[][][] getPathOccurrenceDataPopulatedUsages(Persistable[][][] usages,
PathOccurrenceContext occurrenceContext,
Class occurrenceDataClass)
throws WTException
PathOccurrences in the usages array
by adding PathOccurrenceData of the specified type for the
specified PathOccurrenceContext.
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.
usages array passed in, with the path occurrence
data added.
WTException
QueryResult getPathOccurrences(UsesOccurrence uses)
throws WTException
QueryResult PathOccurrences related
to the given UsesOccurrence.
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.
WTException
QueryResult getPathOccurrences(PathOccurrenceMasterContext context)
throws WTException
QueryResult of PathOccurrences having
the given context.
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.
WTException
Vector getPopulatedOccurrenceableLinks(Vector occurrenceableLinks,
PathOccurrence subPathOccurrence)
throws WTException
Vector of OccurrenceableLinks with
their usesOccurrenceVector populated with their UsesOccurrences; note that the UsesOccurrences also
have their pathOccurrence populated.
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.
WTException
Vector getPopulatedOccurrenceableLinks(Vector occurrenceableLinks)
throws WTException
Vector of OccurrenceableLinks with
their usesOccurrenceVector populated with their UsesOccurrences; note that the UsesOccurrences also
have their pathOccurrence populated.
occurrenceableLinks - This Vector of OccurrenceableLinks should be used to find the associated UsesOccurrence objects.
WTException
QueryResult getUsesOccurrences(PathOccurrence path)
throws OccurrenceException,
WTException
UsesOccurrences associated with the given PathOccurrence.
path -
OccurrenceException
WTException
WTKeyedMap getUsesOccurrenceData(WTCollection occs)
throws WTException
occs -
WTException
QueryResult getUsesOccurrenceData(UsesOccurrence occurrence)
throws WTException
UsesOccurrenceData objects associated
with the given UsesOccurrence object.
occurrence -
WTException
QueryResult getUsesOccurrenceData(UsesOccurrence occurrence,
Vector classes)
throws WTException
UsesOccurrenceData objects of the given
classes and associated with the given UsesOccurrence object.
occurrence - classes -
WTException
QueryResult getUsesOccurrences(Vector occurrenceableLinks)
throws WTException
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
occurrenceableLinks -
WTException
QueryResult getUsesOccurrences(OccurrenceableLink link)
throws WTException
QueryResult of UsesOccurrence objects.
link -
WTException
QueryResult getUsesOccurrences(UsesOccurrenceContext context)
throws WTException
QueryResult of UsesOccurrence objects
having the given context.
context -
WTException
WTKeyedMap getUsesOccurrences(WTCollection links)
throws WTException
WTKeyedMap where the keys are the input collection
of OccurrenceableLinks and the values are WTCollections of the corresponding
UsesOccurrence objects.
links -
WTException
CombinedPathOccurrenceData saveCombinedPathOccurrenceData(CombinedPathOccurrenceData combinedPathOccurrenceData)
throws WTException
CombinedPathOccurrenceData.
combinedPathOccurrenceData -
WTException
PathOccurrenceData savePathOccurrenceData(PathOccurrenceData pathOccurrenceData)
throws WTException
pathOccurrenceData -
WTException
QueryResult saveUsesOccurrenceAndData(UsesOccurrence occurrence,
Vector occurrenceData)
throws WTException
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
occurrence - occurrenceData -
WTException
QueryResult saveUsesOccurrenceAndData(UsesOccurrence occurrence,
Vector occurrenceData,
Vector occurrenceDataToDelete)
throws WTException
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
occurrence - occurrenceData - occurrenceDataToDelete -
WTException
WTCollection saveUsesOccurrenceAndData(WTKeyedMap occDataMap)
throws WTException
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
occDataMap -
WTException
WTCollection saveUsesOccurrenceAndData(WTKeyedMap occDataMap,
WTKeyedMap occDataToDeleteMap)
throws WTException
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
occDataMap - occDataToDeleteMap -
WTException
|
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||