Package Thor.API.Operations
Interface tcExportOperationsIntf
- All Superinterfaces:
tcUtilityOperationsIntf
- All Known Implementing Classes:
tcExportOperationsBean
-
Method Summary
Modifier and TypeMethodDescriptionarrangeSelectionAsATree
(Collection objects) Arranges the passed objects as a TreefindObjects
(String type, String searchCriteria) Find the Root objects for a given type, with a given name.getDependencies
(Collection rootObjects) Return a list of dependent objects for the selected root objectsGet the tree view to be displayed for export operationgetExportXML
(Collection rootObjects, String description) Export selected objects.Retrieve categoriesretrieveChildren
(Collection objects) Retrieve the children of the selected objects as a treeretrieveDependencyTree
(Collection objects) Find dependencies, and return them as a tree.Methods inherited from interface Thor.API.Base.tcUtilityOperationsIntf
close, getName, setCountry, setLanguage, setVariant
-
Method Details
-
getExportView
Get the tree view to be displayed for export operation- Returns:
- Collection of RootObjects
- Throws:
tcAPIException
-
getExportXML
String getExportXML(Collection rootObjects, String description) throws tcAPIException, tcAPIException Export selected objects.- Parameters:
rootObjects
-- Returns:
- string containing the export XML
- Throws:
tcAPIException
-
getDependencies
Return a list of dependent objects for the selected root objects- Parameters:
rootObjects
-- Returns:
- Throws:
tcAPIException
-
findObjects
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 TypesearchCriteria
- Search criteria for searching Object- Returns:
- objects matched
- Throws:
tcAPIException
-
retrieveCategories
Retrieve categories- Returns:
- category collection. Collection contains strings
- Throws:
tcAPIException
-
retrieveChildren
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
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
tcAPIException
-
arrangeSelectionAsATree
Arranges the passed objects as a Tree- Parameters:
objects
- Collection of RootObjects- Returns:
- collection arranged as a tree as much as possible
- Throws:
tcAPIException
-