wt.sandbox
Interface SandboxService

All Known Implementing Classes:

SandboxServiceFwd, StandardSandboxService

public interface SandboxService

Remote interface for operations specific to sandbox containers.

Many of the get*() methods in this class take a Collecion as one of the input arguments. In general such a collection is presumed to be a collection of WTReferences or a WTCollection. When a WTCollection is passed in and the formal return result is a Set, the actual result type will be an instanceof WTSet. When a WTCollection is passed in and the formal return result is a Map, then an effort is made to return an appropriate WTKeyedMap or WTValuedMap. See such routines for details.

Although there are single-object-based methods in this interface, many remain for historical compatibility and/or special use cases and the multi-object methods are preferable whenever one has multiple input objects to process in one's overall algorithm.

Supported API: false

Extendable: false

Method Summary

SandboxBaseline	addToSandboxBaseline(WTCollection wtCollOfBaselineables, WTContainerRef sandboxContainer) Add a collection of baselinables to the SandboxBaseline associated with the given sandbox container.
SandboxBaseline	addToSandboxBaseline(WTCollection wtCollOfBaselineables, WTContainerRef sandboxContainer, boolean replaceEntriesFromSameMasters) Add a collection of baselinables to the SandboxBaseline associated with the given sandbox container.
void	checkin(WTKeyedMap inputRefToInitialCheckinDataMap, String note) Check-in a group of versioned objects from a sandbox container to the larger enterprise.
Map	checkin(WTKeyedMap inputRefToInitialCheckinDataMap, String note, InitialCheckinDataApplicator applicator, boolean returnCheckedinVersions) Check-in a group of versioned objects from a sandbox container to the larger enterprise.
void	checkout(WTCollection wtOrigCopiesSet, WTContainerRef targetContainerRef, Folder targetFolder, String note) Check-out a group of versioned objects from the larger enterprise to a sandbox container.
Map	checkout(WTCollection wtOrigCopiesSet, WTContainerRef targetContainerRef, Folder targetFolder, String note, boolean returnCheckedoutVersions) Check-out a group of versioned objects from the larger enterprise to a sandbox container.
Versioned	getCheckedinCopyOf(Versioned version) Given a sandbox iteration that has been checked in returns the resulting checked-in iteration -- otherwise returns null.
Map	getCheckedInCopyToSandboxCopyRefMap(Collection wtCollOfCheckedinCopies) Gets map from any sandbox check ins in the input collection to sandbox copies.
Map	getCheckinsToSandboxesMap(Collection wtColl) Gets map from any sandbox check ins from input collection to sandboxes containers from which they were checked in.
Map	getMapToSandboxBaselineIterations(Collection wtCollOfBaselineables, WTContainerRef containerRef, boolean restrictToSameBranch) Gets map from any master, iteration, or version in the input collection to the corresponding iteration in the sandbox baseline.
Versioned	getOriginalCopyOf(Versioned version) Similar to method of the same name in WorkInProgressService.
Map	getOriginalCopyToWorkingCopyRefMap(Collection wtColl) Get map from any sandbox original copies in the input collection to corresopnding working copies.
Map	getOriginalCopyToWorkingCopyRefMap(Collection wtColl, boolean allowWorkingCopyInputs) Get map from any sandbox original copies in the input collection to corresopnding working copies.
Map	getOriginalsToSandboxesMap(Collection wtColl) Gets map from any sandbox check out original copies in the input collection to sandboxes containers to which they have been checked out.
Map	getRefreshCandidates(WTContainerRef sandboxRef, EPMDocConfigSpec docConfigSpec, WTPartConfigSpec partConfigSpec, boolean isDocCentric) For all objects shared from PDM to Sandbox, returns newer iterations available in PDM.
WTContainerRef	getRelatedSandboxRef(Versioned originalCopy, boolean previous) Given an iteration, returns a reference to the "related" sandbox container.
SandboxBaseline	getSandboxBaseline(WTContainerRef sandboxContainer) Returns the given sandbox container's baseline.
Baselineable	getSandboxBaselineIteration(Baselineable baselineable, WTContainerRef containerRef) Returns the iteration found in the sandbox baseline for the given object and containerRef.
Versioned	getSandboxCopyOf(Versioned version) Given an iteration which resulted from a sandbox check-in, returns the original sandbox iteration -- otherwise returns null.
Map	getSandboxCopyToCheckedInCopyRefMap(Collection wtCollOfSandboxCopies) Get map from any sandbox (inactive working) copies in input collection to corresponding checked-in copies.
WTValuedMap	getSandboxToBaselineRefMap(Collection wtCollOfSandboxRefs, boolean inflateBaselineRefs) Gets map from any sandbox containers in the input collection to the corresponding sandbox baselines.
Set	getSandboxWorkingCopySubset(Collection wtColl, boolean excludeTerminalCopies) Returns those objects from the input collection that are sandbox working copies.
Set	getSubsetCheckedOutToSandbox(Collection wtColl, WTContainerRef containerRef) Returns those objects from the input collection that are checked out to the given sandbox.
WTSet	getWorkingCopies(WTPrincipalReference principal, boolean includePersonalCheckouts) Get set of sandbox working copies checked out by a given individual.
Versioned	getWorkingCopyOf(Versioned version) Similar to method of the same name in WorkInProgressService.
Map	getWorkingCopyToOriginalCopyRefMap(Collection wtColl) Get map from any sandbox working copies in the input collection to corresopnding original copies.
Map	getWorkingCopyToOriginalCopyRefMap(Collection wtColl, boolean allowOrigCopyInputs) Get map from any sandbox working copies in the input collection to corresopnding original copies.
boolean	isCheckedOutToSandbox(Versioned version, WTContainerRef containerRef) Returns whether the given version is checked out to the given sandbox container.
boolean	isWorkingCopy(Versioned version) Returns true if the given version branch was the direct result of a sandbox check-out, i.e.
void	preCheckinValidate(Map versionRefToInitialCheckinDataMap) Attempts to validate InitialCheckinData items within versionRefToInitialCheckinDataMap against each other and existing masters for uniqueness, etc.
void	preCheckinValidate(Map versionRefToInitialCheckinDataMap, InitialCheckinDataApplicator applicator) Attempts to validate InitialCheckinData items within versionRefToInitialCheckinDataMap against each other and existing masters for uniqueness, etc.
void	removeObjects(WTCollection objectsToRemove) Remove the given set of objects from the project.
void	undoCheckout(WTCollection inputRefs) Undo check-out of a set of versioned objects from the sandbox container.
Set	undoCheckout(WTCollection inputRefs, boolean returnOriginalCopies) Undo check-out of a set of versioned objects from the sandbox container.

Method Detail

isWorkingCopy

public boolean isWorkingCopy(Versioned version)
                      throws WTException

Returns true if the given version branch was the direct result of a sandbox check-out, i.e. that it is a working copy branch.

See getSandboxWorkingCopySubset() for a multi-object equivalent of this routine.

Supported API: false

Parameters:

version - sandbox version to make determination for

Returns:

boolean

Throws:

WTException

getSandboxWorkingCopySubset

public Set getSandboxWorkingCopySubset(Collection wtColl,
                                       boolean excludeTerminalCopies)
                                throws WTException

Returns those objects from the input collection that are sandbox working copies.

When the input Collection is a WTCollection, the actual method result will be a WTSet.

Supported API: false

Parameters:

wtColl - accepts a Collection of WTReferences or a WTCollection

excludeTerminalCopies - Whether TERMINAL (inactive/checked-in) working copies should be excluded.

Returns:

Set

Throws:

WTException

isCheckedOutToSandbox

public boolean isCheckedOutToSandbox(Versioned version,
                                     WTContainerRef containerRef)
                              throws WTException

Returns whether the given version is checked out to the given sandbox container.

See getSubsetCheckedOutToSandbox() for a multi-object equivalent of this routine.

Supported API: false

Parameters:

version - sandbox version to make determination for

containerRef - reference to sandbox container

Returns:

boolean

Throws:

WTException

getSubsetCheckedOutToSandbox

public Set getSubsetCheckedOutToSandbox(Collection wtColl,
                                        WTContainerRef containerRef)
                                 throws WTException

Returns those objects from the input collection that are checked out to the given sandbox.

When the input Collection is a WTCollection, the actual method result will be a WTSet.

Supported API: false

Parameters:

wtColl - accepts a Collection of WTReferences or a WTCollection

containerRef - reference to sandbox container

Returns:

Set

Throws:

WTException

getRelatedSandboxRef

public WTContainerRef getRelatedSandboxRef(Versioned originalCopy,
                                           boolean previous)
                                    throws WTException

Given an iteration, returns a reference to the "related" sandbox container. This sandbox is either that to which the iteration has been checked out (if previous is false) or the sandbox from which this iteration was created via a sandbox check-in (if previous is true). Note that this routine does not require read access to either the working copy or sandbox container. This is not really breaking access control as all that is returned is a reference.

See getOriginalsToSandboxesMap() and getCheckinsToSandboxesMap() for multi-object equivalents of this routine.

Supported API: false

Parameters:

originalCopy - sandbox checked out to find sandbox for

previous - whether to return the "previous" sandbox (that from which this iteration was formed via a sandbox check-in) or the sandbox to which this iteration has been checked out to

Returns:

WTContainerRef

Throws:

WTException

getOriginalsToSandboxesMap

public Map getOriginalsToSandboxesMap(Collection wtColl)
                               throws WTException

Gets map from any sandbox check out original copies in the input collection to sandboxes containers to which they have been checked out.

In general, the actual result of this method will be a WTKeyedMap or WTValuedMap where possible while reusing the input reference objects. When the input Collection is a WTCollection, the output will be a WTValuedMap.

Supported API: false

Parameters:

wtColl - accepts a Collection of WTReferences or a WTCollection

Returns:

Map

Throws:

WTException

getCheckinsToSandboxesMap

public Map getCheckinsToSandboxesMap(Collection wtColl)
                              throws WTException

Gets map from any sandbox check ins from input collection to sandboxes containers from which they were checked in.

In general, the actual result of this method will be a WTKeyedMap or WTValuedMap where possible while reusing the input reference objects. When the input Collection is a WTCollection, the output will be a WTValuedMap.

Supported API: false

Parameters:

wtColl - accepts a Collection of WTReferences or a WTCollection

Returns:

Map

Throws:

WTException

getOriginalCopyOf

public Versioned getOriginalCopyOf(Versioned version)
                            throws WTException

Similar to method of the same name in WorkInProgressService. Given an iteration on a sandbox checkout branch, this routine returns the original iteration which was checked out to form this branch (i.e. the where this object should be checked back into). Returns null if the given version was created in the sandbox container and has not yet been checked in to an enterprise/PDM container.

See getWorkingCopyToOriginalCopyRefMap() methods for multi-object equivalents of this method.

Supported API: false

Parameters:

version - sandbox version object

Returns:

Versioned

Throws:

WTException

getWorkingCopyToOriginalCopyRefMap

public Map getWorkingCopyToOriginalCopyRefMap(Collection wtColl)
                                       throws WTException

Get map from any sandbox working copies in the input collection to corresopnding original copies.

In general, the actual result of this method will be a WTKeyedMap or WTValuedMap where possible while reusing the input reference objects. When the input Collection is a WTCollection, the output will be a WTValuedMap.

Supported API: false

Parameters:

wtColl - accepts a Collection of WTReferences or a WTCollection

Returns:

Map

Throws:

WTException

getWorkingCopyToOriginalCopyRefMap

public Map getWorkingCopyToOriginalCopyRefMap(Collection wtColl,
                                              boolean allowOrigCopyInputs)
                                       throws WTException

Get map from any sandbox working copies in the input collection to corresopnding original copies.

This method can optionally navigate for any sandbox original copies as well as working copies in its inputs (and thus including the correspoding working/original copy pair in the results), but in either case the returned map is always strictly from working copies to originals.

In general, the actual result of this method will be a WTKeyedMap or WTValuedMap where possible while reusing the input reference objects. When the input is a WTCollection and 'allowOrigCopyInputs' is false, the output will be a WTValuedMap.

Supported API: false

Parameters:

wtColl - accepts a Collection of WTReferences or a WTCollection

allowOrigCopyInputs - whether method should navigate from original copies in the inputs as well

Returns:

Map

Throws:

WTException

getWorkingCopyOf

public Versioned getWorkingCopyOf(Versioned version)
                           throws WTException

Similar to method of the same name in WorkInProgressService. Given an iteration that has been checked out to a sandbox, this routine will return the working copy iteration in the sandbox (assuming the current user has read access to it).

See getOriginalCopyToWorkingCopyRefMap() methods for multi-object equivalents of this method.

Supported API: false

Parameters:

version - sandbox version object

Returns:

Versioned

Throws:

WTException

getOriginalCopyToWorkingCopyRefMap

public Map getOriginalCopyToWorkingCopyRefMap(Collection wtColl)
                                       throws WTException

Get map from any sandbox original copies in the input collection to corresopnding working copies.

In general, the actual result of this method will be a WTKeyedMap or WTValuedMap where possible while reusing the input reference objects. When the input Collection is a WTCollection, the output will be a WTValuedMap.

Supported API: false

Parameters:

wtColl - accepts a Collection of WTReferences or a WTCollection

Returns:

Map

Throws:

WTException

getOriginalCopyToWorkingCopyRefMap

public Map getOriginalCopyToWorkingCopyRefMap(Collection wtColl,
                                              boolean allowWorkingCopyInputs)
                                       throws WTException

Get map from any sandbox original copies in the input collection to corresopnding working copies.

This method can optionally navigate from sandbox working copies as well as original copies in its inputs (and thus including the correspoding working/original copy pair in the results), but in either case the returned map is always strictly from working copies to originals.

In general, the actual result of this method will be a WTKeyedMap or WTValuedMap where possible while resuing the input reference objects. When the input is a WTCollection and 'allowWorkingCopyInputs' is false, the output will be a WTValuedMap.

Supported API: false

Parameters:

wtColl - accepts a Collection of WTReferences or a WTCollection

allowWorkingCopyInputs - whether method should navigate from working copies in the inputs as well

Returns:

Map

Throws:

WTException

getSandboxCopyOf

public Versioned getSandboxCopyOf(Versioned version)
                           throws WTException

Given an iteration which resulted from a sandbox check-in, returns the original sandbox iteration -- otherwise returns null.

See getCheckedInCopyToSandboxCopyRefMap() for a multi-object equivalent to this method.

Supported API: false

Parameters:

version - sandbox version object

Returns:

Versioned

Throws:

WTException

getCheckedInCopyToSandboxCopyRefMap

public Map getCheckedInCopyToSandboxCopyRefMap(Collection wtCollOfCheckedinCopies)
                                        throws WTException

Gets map from any sandbox check ins in the input collection to sandbox copies.

In general, the actual result of this method will be a WTKeyedMap or WTValuedMap where possible while reusing the input reference objects. When the input Collection is a WTCollection, the output will be a WTValuedMap.

Supported API: false

Parameters:

wtCollOfCheckedinCopies - accepts a Collection of WTReferences or a WTCollection

Returns:

Map

Throws:

WTException

getCheckedinCopyOf

public Versioned getCheckedinCopyOf(Versioned version)
                             throws WTException

Given a sandbox iteration that has been checked in returns the resulting checked-in iteration -- otherwise returns null.

See getSandboxCopyToCheckedInCopyRefMap() for a multi-object equivalent to this method.

Supported API: false

Parameters:

version - sandbox version object

Returns:

Versioned

Throws:

WTException

getSandboxCopyToCheckedInCopyRefMap

public Map getSandboxCopyToCheckedInCopyRefMap(Collection wtCollOfSandboxCopies)
                                        throws WTException

Get map from any sandbox (inactive working) copies in input collection to corresponding checked-in copies.

In general, the actual result of this method will be a WTKeyedMap or WTValuedMap where possible while reusing the input reference objects. When the input Collection is a WTCollection, the output will be a WTValuedMap.

Supported API: false

Parameters:

wtCollOfSandboxCopies - accepts a Collection of WTReferences or a WTCollection

Returns:

Map

Throws:

WTException

getSandboxBaseline

public SandboxBaseline getSandboxBaseline(WTContainerRef sandboxContainer)
                                   throws WTException

Returns the given sandbox container's baseline.

Note that a given sandbox container may not have an associated baseline and thus the result may be null. Also, note that any additions to the baseline should be made via addToSandboxBaseline() rather than by using the result of this method in a normal baseline addition operation.

See getSandboxToBaselineRefMap() for a multi-object equivalent of this routine.

Supported API: false

Parameters:

sandboxContainer - reference to sandbox container

Returns:

SandboxBaseline

Throws:

WTException

getSandboxToBaselineRefMap

public WTValuedMap getSandboxToBaselineRefMap(Collection wtCollOfSandboxRefs,
                                              boolean inflateBaselineRefs)
                                       throws WTException

Gets map from any sandbox containers in the input collection to the corresponding sandbox baselines.

Supported API: false

Parameters:

wtCollOfSandboxRefs - accepts a Collection of WTReferences or a WTCollection

inflateBaselineRefs - whether the resulting sandbox baseline references should be inflated or not

Returns:

WTValuedMap

Throws:

WTException

getSandboxBaselineIteration

public Baselineable getSandboxBaselineIteration(Baselineable baselineable,
                                                WTContainerRef containerRef)
                                         throws WTException

Returns the iteration found in the sandbox baseline for the given object and containerRef.

The sandbox baseline associated to the passed in containerRef is consulted to determine which iteration of the passed in object is in the baseline. If an iteration is found in the baseline it is returned, otherwise the latest iteration of the object is returned.

See getMapToSandboxBaselineIterations() for a multi-object equivalent to this method.

Supported API: false

Parameters:

baselineable - The object for which the sandbox baseline iteration is desired to be found.

containerRef - reference to sandbox container

Returns:

Baselineable

Throws:

WTException

getMapToSandboxBaselineIterations

public Map getMapToSandboxBaselineIterations(Collection wtCollOfBaselineables,
                                             WTContainerRef containerRef,
                                             boolean restrictToSameBranch)
                                      throws WTException

Gets map from any master, iteration, or version in the input collection to the corresponding iteration in the sandbox baseline.

In general, the actual result of this method will be a WTKeyedMap or WTValuedMap where possible while reusing the input reference objects. When the input Collection is a WTCollection, the output will be a WTValuedMap.

Supported API: false

Parameters:

wtCollOfBaselineables - accepts a Collection of WTReferences or a WTCollection

containerRef - reference to sandbox container

restrictToSameBranch - when true only iterations from the same branch as the inputs will be returned

Returns:

Map

Throws:

WTException

getWorkingCopies

public WTSet getWorkingCopies(WTPrincipalReference principal,
                              boolean includePersonalCheckouts)
                       throws WTException

Get set of sandbox working copies checked out by a given individual.

Supported API: false

Parameters:

principal - individual in question

includePersonalCheckouts - whether sandbox working copies that are also checked out to the same individual via WIP should be included in the results

Returns:

WTSet

Throws:

WTException

getRefreshCandidates

public Map getRefreshCandidates(WTContainerRef sandboxRef,
                                EPMDocConfigSpec docConfigSpec,
                                WTPartConfigSpec partConfigSpec,
                                boolean isDocCentric)
                         throws WTException

For all objects shared from PDM to Sandbox, returns newer iterations available in PDM.

Returns Map of ObjectReference of shared Iteration in Sandbox as key and new iteration as value.

This method works in two modes, docCentric and partCentric. In docCentric mode, EPMDocuments are refreshed first and latest compatible WTParts are added to refresh Map. Then for any left over WTParts (that are not associated with any EPMDocuments), WTParts are refreshed and added to refresh Map.

In partCentric mode, WTParts are refreshed first and latest compatible EPMDocuments are added to refresh Map. Then for any leftover EPMDocuments (that are not associated with any WTParts), WTParts are refreshed and added to refresh Map.

Supported API: false

Parameters:

sandboxRef - reference to sandbox container

docConfigSpec - EPM document config spec

partConfigSpec - WTPart config spec

isDocCentric - whether navigation should be document or part centric

Returns:

Map

Throws:

WTException

checkout

public void checkout(WTCollection wtOrigCopiesSet,
                     WTContainerRef targetContainerRef,
                     Folder targetFolder,
                     String note)
              throws WTException,
                     WTPropertyVetoException,
                     SandboxValidationException

Check-out a group of versioned objects from the larger enterprise to a sandbox container. Note this differs radically from a wt.vc.wip check-out and is best considered a separate "sandbox" type of check out.

Supported API: false

Parameters:

wtOrigCopiesSet - a collection of objects to be checked out

targetContainerRef - a reference to the container that the versionRefSet will be checked out to

targetFolder - the target folder within the reference container to check out to

note - the note/comment to be provided on checkout

Throws:

WTException

WTPropertyVetoException

SandboxValidationException

checkout

public Map checkout(WTCollection wtOrigCopiesSet,
                    WTContainerRef targetContainerRef,
                    Folder targetFolder,
                    String note,
                    boolean returnCheckedoutVersions)
             throws WTException,
                    WTPropertyVetoException,
                    SandboxValidationException

Check-out a group of versioned objects from the larger enterprise to a sandbox container. Note this differs radically from a wt.vc.wip check-out and is best considered a separate "sandbox" type of check out.

This version of this routine can return a map containing newly checked out and original versions upon request.

Supported API: false

Parameters:

wtOrigCopiesSet - a collection of objects to be checked out

targetContainerRef - a reference to the container that the versionRefSet will be checked out to

targetFolder - the target folder within the reference container to check out to

note - the note/comment to be provided on checkout

returnCheckedoutVersions - whether the routine should return a map with keys of WTReferences to original enterprise versions and values of WTReferences to newly checked-out versions or null (for sake of reduced data transfer between processes)

Returns:

Map

Throws:

WTException

WTPropertyVetoException

SandboxValidationException

undoCheckout

public void undoCheckout(WTCollection inputRefs)
                  throws WTException,
                         WTPropertyVetoException,
                         SandboxValidationException

Undo check-out of a set of versioned objects from the sandbox container. Note this differs radically from a wt.vc.wip undo check-out and is best considered a separate "sandbox" type of undo check out.

Supported API: false

Parameters:

inputRefs - collection of objects to undo the sandbox check out of

Throws:

WTException

WTPropertyVetoException

SandboxValidationException

undoCheckout

public Set undoCheckout(WTCollection inputRefs,
                        boolean returnOriginalCopies)
                 throws WTException,
                        WTPropertyVetoException,
                        SandboxValidationException

Undo check-out of a set of versioned objects from the sandbox container. Note this differs radically from a wt.vc.wip undo check-out and is best considered a separate "sandbox" type of undo check out.

This method can return a set of references to the resulting original copies on request.

Supported API: false

Parameters:

inputRefs - collection of objects to undo the sandbox check out of

returnOriginalCopies - whether to return a set of WTReferences to the original copies or null (to reduce remote data marshalling)

Returns:

Set

Throws:

WTException

WTPropertyVetoException

SandboxValidationException

preCheckinValidate

public void preCheckinValidate(Map versionRefToInitialCheckinDataMap)
                        throws WTException,
                               CheckinUniquenessException

Attempts to validate InitialCheckinData items within versionRefToInitialCheckinDataMap against each other and existing masters for uniqueness, etc. Throws a SandboxException containing further detailed data if issues are found. For instance, for uniqueness violations a CheckinUniquenessException is thrown.

Supported API: false

Parameters:

versionRefToInitialCheckinDataMap - a Map (or WTKeyedMap) whose keys are WTReferences to versions to be checked in and whose values are InitialCheckinData objects, for objects created in the sandbox and being newly exposed to the enterprise, or null, for objects being merged back to an existing enterprise version

Throws:

WTException

CheckinUniquenessException

preCheckinValidate

public void preCheckinValidate(Map versionRefToInitialCheckinDataMap,
                               InitialCheckinDataApplicator applicator)
                        throws WTException,
                               CheckinUniquenessException

Attempts to validate InitialCheckinData items within versionRefToInitialCheckinDataMap against each other and existing masters for uniqueness, etc. Throws a SandboxException containing further detailed data if issues are found. For instance, for uniqueness violations a CheckinUniquenessException is thrown.

Supported API: false

Parameters:

versionRefToInitialCheckinDataMap - a Map (or WTKeyedMap) whose keys are WTReferences to versions to be checked in and whose values are InitialCheckinData objects, for objects created in the sandbox and being newly exposed to the enterprise, or null, for objects being merged back to an existing enterprise version

applicator - applicator object for InitialCheckinData instances

Throws:

WTException

CheckinUniquenessException

checkin

public void checkin(WTKeyedMap inputRefToInitialCheckinDataMap,
                    String note)
             throws WTException,
                    WTPropertyVetoException,
                    SandboxValidationException

Check-in a group of versioned objects from a sandbox container to the larger enterprise. Note this differs radically from a wt.vc.wip check-in and is best considered a separate "sandbox" type of check in.

Supported API: false

Parameters:

inputRefToInitialCheckinDataMap - a map whose keys are objects to be checked in and whose values are InitialCheckinData objects, for objects created in the sandbox and being newly exposed to the enterprise, or null, for objects being merged back to an existing enterprise version

note - the note/comment to be provided on all new iterations created

Throws:

WTException

WTPropertyVetoException

SandboxValidationException

checkin

public Map checkin(WTKeyedMap inputRefToInitialCheckinDataMap,
                   String note,
                   InitialCheckinDataApplicator applicator,
                   boolean returnCheckedinVersions)
            throws WTException,
                   WTPropertyVetoException,
                   SandboxValidationException

Check-in a group of versioned objects from a sandbox container to the larger enterprise. Note this differs radically from a wt.vc.wip check-in and is best considered a separate "sandbox" type of check in.

This version of this routine allows specification of a custom InitialCheckinData applicator instance and can return a map containing newly checked in and original versions upon request.

Supported API: false

Parameters:

inputRefToInitialCheckinDataMap - a map whose keys are objects to be checked in and whose values are InitialCheckinData objects, for objects created in the sandbox and being newly exposed to the enterprise, or null, for objects being merged back to an existing enterprise version

note - the note/comment to be provided on all new iterations created

applicator - an instance of a sub-class of IntiialCheckinDataApplicator or null; intended to allow custom application of InitialCheckinData including specification of handling of custom subclasses thereof; pass null to obtain default handling of InitialCheckinData

returnCheckedinVersions - whether the routine should return a map with keys of WTReferences to original sandbox versions and values of WTReferences to newly checked-in versions or null (for sake of reduced data transfer between processes)

Returns:

Map

Throws:

WTException

WTPropertyVetoException

SandboxValidationException

addToSandboxBaseline

public SandboxBaseline addToSandboxBaseline(WTCollection wtCollOfBaselineables,
                                            WTContainerRef sandboxContainer)
                                     throws WTException,
                                            SandboxValidationException

Add a collection of baselinables to the SandboxBaseline associated with the given sandbox container.

Note that any iterations passed for which another iteration from the same master is a latest, non-terminal sandbox working iteration will be silently ignored as such iterations should never be added to the sandbox baseline.

Same as calling other version of addToSandboxBaseline() and passing a value of 'true' for the last, i.e. 'replaceEntriesFromSameMasters', argument.

Supported API: false

Parameters:

wtCollOfBaselineables - collection of baselinable objects to be added to the specified sandbox container's baseline

sandboxContainer - reference to sandbox container

Returns:

SandboxBaseline

Throws:

WTException

SandboxValidationException

addToSandboxBaseline

public SandboxBaseline addToSandboxBaseline(WTCollection wtCollOfBaselineables,
                                            WTContainerRef sandboxContainer,
                                            boolean replaceEntriesFromSameMasters)
                                     throws WTException,
                                            SandboxValidationException

Add a collection of baselinables to the SandboxBaseline associated with the given sandbox container.

Note that any iterations passed for which another iteration from the same master is a latest, non-terminal sandbox working iteration will be silently ignored as such iterations should never be added to the sandbox baseline.

Supported API: false

Parameters:

wtCollOfBaselineables - collection of baselinable objects to be added to the specified sandbox container's baseline

sandboxContainer - reference to sandbox container

replaceEntriesFromSameMasters - whether entries already in the baseline should be replaced when 'baselineables' contains other iterations from masters with iterations already in 'sandboxContainer's' baseline; if 'false', such entries will be ignored

Returns:

SandboxBaseline

Throws:

WTException

SandboxValidationException

removeObjects

public void removeObjects(WTCollection objectsToRemove)
                   throws WTException,
                          WTPropertyVetoException

Remove the given set of objects from the project. The "remove" operation includes deletion, undo checkout (both WIP and sandbox), and share removal as needed to accomplish the logical effect.

Supported API: false

Parameters:

objectsToRemove - set of objects to remove from sandbox

Throws:

WTException

WTPropertyVetoException