Thor.API.Operations
Interface tcExportOperationsIntf

public interface tcExportOperationsIntf

Method Summary

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 name) Find the 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.

Method Detail

getExportView

public java.util.Collection getExportView()
                                   throws Thor.API.Exceptions.tcAPIException,
                                          tcAPIException

Get the tree view to be displayed for export operation

Returns:

Throws:

tcAPIException

getExportXML

public java.lang.String getExportXML(java.util.Collection rootObjects,
                                     java.lang.String description)
                              throws Thor.API.Exceptions.tcAPIException,
                                     tcAPIException

Export selected objects.

Parameters:

rootObjects -

Returns:

string containing the export XML

Throws:

tcAPIException

getDependencies

public java.util.Collection getDependencies(java.util.Collection rootObjects)
                                     throws Thor.API.Exceptions.tcAPIException,
                                            tcAPIException

Return a list of dependent objects for the selected root objects

Parameters:

rootObjects -

Returns:

Throws:

tcAPIException

findObjects

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

Find the 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 -

name -

Returns:

objects matched

Throws:

tcAPIException

retrieveCategories

public java.util.Collection retrieveCategories()
                                        throws tcAPIException

Retrieve categories

Returns:

category collection. Collection contains strings

Throws:

tcAPIException

retrieveChildren

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

Retrieve the children of the selected objects as a tree

Parameters:

objects -

Returns:

children of the selected elements as a tree

Throws:

tcAPIException

retrieveDependencyTree

public java.util.Collection retrieveDependencyTree(java.util.Collection objects)
                                            throws Thor.API.Exceptions.tcAPIException,
                                                   tcAPIException

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

Parameters:

objects -

Returns:

dependencies with all the children

Throws:

Thor.API.Exceptions.tcAPIException

arrangeSelectionAsATree

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

Arranges the passed objects as a Tree

Parameters:

objects -

Returns:

collection arranged as a tree as much as possible

Throws:

tcAPIException