Package wt.enterprise

Interface EnterpriseService

@RemoteInterface
public interface EnterpriseService

This service supports one RevisionControlled object being made from another RevisionControlled object (or made into if you look at it the other way) and persisting the relationship; one method, saveCopy(CopyRules,RevisionControlled,RevisionControlled), uses CopyRules.

• Cookie: None
• Helper: EnterpriseHelper
• Service implementation: StandardEnterpriseService has listeners
• ServiceEvent: EnterpriseServiceEvent
• ServiceException: WTException

Supported API: true

Extendable: false

Method Summary

Modifier and Type	Method	Description
RevisionControlled	navigateMadeFrom(RevisionControlled object)	Return the object that this object was made from (copied).
QueryResult	navigateMadeInto(RevisionControlled object)	Return a query result of the objects that were made from (copied from) this version of the object.
RevisionControlled	newCopy(RevisionControlled object)	Copy the object, but do not persist it.
CopyObjectInfo[]	newMultiObjectCopy(RevisionControlled[] originalObjects)	Copy the objects, but do not persist them.
SortedEnumeration	presentMadeInto(RevisionControlled object, Vector displayAttributes, String sortPreference, Locale locale)	Return a sorted enumeration of the objects that were made from (copied from) this version of this object.
RevisionControlled	saveCopy(RevisionControlled original, RevisionControlled copy)	Used after the client has called newCopy and set any attributes on the object that it wants to change.
RevisionControlled	saveFromTemplateObject(RevisionControlled original, RevisionControlled copy)	This method persists the object created from a source object and copies the relationships from the source to the target object.
CopyObjectInfo[]	saveMultiObjectCopy(CopyObjectInfo[] copyInformation)	Used after the client has called newMultiObjectCopy and set any attributes on the objects that it wants to change.
CopyObjectInfo[]	saveMultiObjectCopy(CopyObjectInfo[] copyInformation, WTCollection objectsToPrune)	Overloaded API to allow for pruning with the "Save As" functionality.

Method Details

newCopy

RevisionControlled newCopy(RevisionControlled object)
                    throws WTException

Copy the object, but do not persist it. Serves as a begining step to initialize all of the business attributes.

Supported API: true

Parameters:

object - The original object to copy.

Returns:

RevisionControlled

Throws:

WTException

saveCopy

RevisionControlled saveCopy(RevisionControlled original,
 RevisionControlled copy)
                     throws WTException

Used after the client has called newCopy and set any attributes on the object that it wants to change. Persists the object and creates any of the post persistance processing such as copying content or creating relationships. Uses the rules in the properties.

Supported API: true

Parameters:

original - The original object that was copied.

copy - The new copy that needs to be persisted..

Returns:

RevisionControlled

Throws:

WTException

navigateMadeFrom

RevisionControlled navigateMadeFrom(RevisionControlled object)
                             throws WTException

Return the object that this object was made from (copied).

Supported API: true

Parameters:

object - Object to find what it was copied from.

Returns:

RevisionControlled

Throws:

WTException

navigateMadeInto

QueryResult navigateMadeInto(RevisionControlled object)
                      throws WTException

Return a query result of the objects that were made from (copied from) this version of the object.

Supported API: true

Parameters:

object - Object to find what was copied from it.

Returns:

QueryResult

Throws:

WTException

presentMadeInto

SortedEnumeration presentMadeInto(RevisionControlled object,
 Vector displayAttributes,
 String sortPreference,
 Locale locale)
                           throws WTException

Return a sorted enumeration of the objects that were made from (copied from) this version of this object. Presentable version of results.

Supported API: true

Parameters:

object - Object to find what was copied from it.

displayAttributes - The list of attributes that the client wants to display from the results.

sortPreference - To specify the sort preference for post processing of the results.

locale - The locale of the client, used in the sorting of the results.

Returns:

SortedEnumeration

Throws:

WTException

newMultiObjectCopy

CopyObjectInfo[] newMultiObjectCopy(RevisionControlled[] originalObjects)
                             throws WTException

Copy the objects, but do not persist them. Serves as a beginning step to initialize all of the business attributes.

Supported API: true

Parameters:

originalObjects - The original objects to copy.

Returns:

CopyObjectInfo[]

Throws:

WTException

saveMultiObjectCopy

CopyObjectInfo[] saveMultiObjectCopy(CopyObjectInfo[] copyInformation)
                              throws WTException

Used after the client has called newMultiObjectCopy and set any attributes on the objects that it wants to change. Persists the objects and creates any of the post persistance processing such as copying content or creating relationships. Uses the rules in the properties.

Supported API: true

Parameters:

copyInformation - Contains original, copy and rules for each object.

Returns:

CopyObjectInfo[]

Throws:

WTException

saveMultiObjectCopy

CopyObjectInfo[] saveMultiObjectCopy(CopyObjectInfo[] copyInformation,
 WTCollection objectsToPrune)
                              throws WTException

Overloaded API to allow for pruning with the "Save As" functionality. Performs validations as appropriate and creates copies of the associated links as appropriate, while taking into account the objects in the input collection.

Supported API: true

Parameters:

copyInformation - CopyObjectInfo[] Container for original, copy and rules for each object.

objectsToPrune - WTCollection Collection of objects to prune part masters.

Returns:

CopyObjectInfo[]

Throws:

WTException

saveFromTemplateObject

RevisionControlled saveFromTemplateObject(RevisionControlled original,
 RevisionControlled copy)
                                   throws WTException

This method persists the object created from a source object and copies the relationships from the source to the target object. However it does not copy the content forward from the source to the target object.

Supported API: true

Parameters:

original - The original object that was copied.

copy - The new copy that needs to be persisted..

Returns:

RevisionControlled

Throws:

WTException