Thor.API.Operations

Interface tcExportOperationsIntf

All Superinterfaces:

tcUtilityOperationsIntf

All Known Implementing Classes:

tcExportOperationsBean

public interface tcExportOperationsIntf
extends tcUtilityOperationsIntf

Method Summary

Modifier and Type	Method and Description
java.util.Collection	arrangeSelectionAsATree(java.util.Collection objects) Arranges the passed objects as a Tree
java.util.Collection	findObjects(java.lang.String type, java.lang.String searchCriteria) Find the Root objects for a given type, with a given name.
java.util.Collection	getDependencies(java.util.Collection rootObjects) Return a list of dependent objects for the selected root objects
java.util.Collection	getExportView() Get the tree view to be displayed for export operation
java.lang.String	getExportXML(java.util.Collection rootObjects, java.lang.String description) Export selected objects.
java.util.Collection	retrieveCategories() Retrieve categories
java.util.Collection	retrieveChildren(java.util.Collection objects) Retrieve the children of the selected objects as a tree
java.util.Collection	retrieveDependencyTree(java.util.Collection objects) Find dependencies, and return them as a tree.

Methods inherited from interface Thor.API.Base.tcUtilityOperationsIntf

close, getName, setCountry, setLanguage, setVariant

Method Detail

getExportView

java.util.Collection getExportView()
                            throws tcAPIException,
                                   tcAPIException

Get the tree view to be displayed for export operation

Returns:

Collection of RootObjects

Throws:

tcAPIException

getExportXML

java.lang.String getExportXML(java.util.Collection rootObjects,
                              java.lang.String description)
                       throws tcAPIException,
                              tcAPIException

Export selected objects.

Parameters:

rootObjects -

Returns:

string containing the export XML

Throws:

tcAPIException

getDependencies

java.util.Collection getDependencies(java.util.Collection rootObjects)
                              throws tcAPIException,
                                     tcAPIException

Return a list of dependent objects for the selected root objects

Parameters:

rootObjects -

Returns:

Throws:

tcAPIException

findObjects

java.util.Collection findObjects(java.lang.String type,
                                 java.lang.String searchCriteria)
                          throws tcAPIException

Find the Root objects for a given type, with a given name. Name can have '*' to indicate any pattern Type can be a name, or '*' to indicate all types

Parameters:

type - RootObject Type

searchCriteria - Search criteria for searching Object

Returns:

objects matched

Throws:

tcAPIException

retrieveCategories

java.util.Collection retrieveCategories()
                                 throws tcAPIException

Retrieve categories

Returns:

category collection. Collection contains strings

Throws:

tcAPIException

retrieveChildren

java.util.Collection retrieveChildren(java.util.Collection objects)
                               throws tcAPIException

Retrieve the children of the selected objects as a tree

Parameters:

objects - Collection of RootObjects

Returns:

children of the selected elements as a tree

Throws:

tcAPIException

retrieveDependencyTree

java.util.Collection retrieveDependencyTree(java.util.Collection objects)
                                     throws tcAPIException,
                                            tcAPIException

Find dependencies, and return them as a tree. Tree only contains the children of the dependencies. Not their parents.

Parameters:

objects - Collection of RootObjects

Returns:

dependencies with all the children

Throws:

tcAPIException

arrangeSelectionAsATree

java.util.Collection arrangeSelectionAsATree(java.util.Collection objects)
                                      throws tcAPIException

Arranges the passed objects as a Tree

Parameters:

objects - Collection of RootObjects

Returns:

collection arranged as a tree as much as possible

Throws:

tcAPIException