com.thortech.xl.ejb.beansimpl

Class tcExportOperationsBean

java.lang.Object

Thor.API.Base.tcBaseUtility

com.thortech.xl.ejb.beansimpl.tcExportOperationsBean

All Implemented Interfaces:

com.thortech.xl.dataobj.tcErrorReceiver, com.thortech.xl.orb.api.operations._tcUtilityIntfOperations, com.thortech.xl.server.tcOrbServerObject, java.io.Serializable, javax.ejb.EnterpriseBean, javax.ejb.SessionBean, tcUtilityOperationsIntf, tcExportOperationsIntf

public class tcExportOperationsBean
extends tcBaseUtility
implements javax.ejb.SessionBean, tcExportOperationsIntf

Server-side API class for Exports using Deployment Manager The APIs will be called in following order:

• findObjects : Find objects to be exported
• getExportXML(objectCollection, description) : Get the xml by passing the object collection

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class Thor.API.Base.tcBaseUtility

tcBaseUtility.Entities

Field Summary

Fields inherited from class Thor.API.Base.tcBaseUtility

ALL_ATTR_OB, DATE_FORMAT_SYS_PROP, DEFAULT_DATE_PATTERN, DEFAULT_LOCALE, DISPLAYNAME, FIRSTNAME, LASTNAME, LKU_GROUP, MANAGERKEY, OBJECTCLASS_COL_CODE, ORG_NAME, ORGANIZATION_KEY_COL_CODE, ORGANIZATION_NAME_COL_CODE, ORGANIZATION_PARENT_KEY_COL_CODE, ORGANIZATION_PARENT_NAME_COL_CODE, ORGKEY, ORGNAME, PARENTORGNAME, ROLE_KEY_COL_CODE, ROLE_NAME_COL_CODE, STATUS, USER_ENTITY, USER_MANAGEMENT, USERID, USERKEY, USR_DEFINED_COLUMN_CONSTANT, USR_KEY_COL_CODE, USR_MANAGER_DISPLAY_NAME_COL_CODE, USR_MANAGER_DISPLAY_NAME_LABEL, USR_MANAGER_FIRST_NAME_COL_CODE, USR_MANAGER_FIRST_NAME_COLUMN, USR_MANAGER_FIRST_NAME_LABEL, USR_MANAGER_KEY_COL_CODE, USR_MANAGER_LAST_NAME_COL_CODE, USR_MANAGER_LAST_NAME_COLUMN, USR_MANAGER_LAST_NAME_LABEL, USR_MANAGER_LOGIN_COL_CODE, USR_MANAGER_LOGIN_COLUMN, USR_MANAGER_LOGIN_LABEL

Constructor Summary

Constructors

Constructor and Description
tcExportOperationsBean()

Method Summary

Modifier and Type	Method and Description
java.util.Collection	arrangeSelectionAsATree(java.util.Collection objects) Arranges the passed objects as a Tree
void	ejbActivate() The ejbActivate() method as required by the EJB specification. The activate method is called when the instance is activated from its passive" state.
void	ejbCreate() Populate SchemaFacade and initializes SchemaInstance
void	ejbPassivate() The ejbPassivate() method as required by the EJB specification. The activate method is called when the instance is activated from its "passive" state.
java.util.Collection	findObjects(java.lang.String type, java.lang.String searchPattern) Find the objects for a given type, with a given searchPattern.
java.util.Collection	getDependencies(java.util.Collection root) 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.
com.thortech.xl.ddm.engine.SchemaFacade	getSchema()
java.util.Collection	retrieveCategories() Retrieve the categories name via iterating all the root objects metadata, which are having the actual data.
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.
void	setSchema(com.thortech.xl.ddm.engine.SchemaFacade schema)

Methods inherited from class Thor.API.Base.tcBaseUtility

addError, addErrorReceiver, addReject, clearErrors, close, ejbRemove, getDataBase, getDefaultLocaleCode, getEJBContext, getErrors, getMap, getMapping, getName, getQueryFilter, getRejections, getSessionContext, getUnAuthorizedTargetFieldSet, removeErrorReceiver, removeInstance, setCountry, setLanguage, setSessionContext, setVariant

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface javax.ejb.SessionBean

ejbRemove, setSessionContext

Methods inherited from interface Thor.API.Base.tcUtilityOperationsIntf

close, getName, setCountry, setLanguage, setVariant

Constructor Detail

tcExportOperationsBean

public tcExportOperationsBean()

Method Detail

ejbPassivate

public void ejbPassivate()
                  throws javax.ejb.EJBException,
                         java.rmi.RemoteException

Description copied from class: tcBaseUtility

The ejbPassivate() method as required by the EJB specification.
The activate method is called when the instance is activated from its "passive" state. The instance should acquire any resource that it has released earlier in the ejbActivate() method.
This method is called with no transaction context.

Specified by:

ejbPassivate in interface javax.ejb.SessionBean

Overrides:

ejbPassivate in class tcBaseUtility

Throws:

javax.ejb.EJBException - Thrown if the instance could not perform the function requested by the container because of an system-level error.

java.rmi.RemoteException

ejbActivate

public void ejbActivate()
                 throws javax.ejb.EJBException,
                        java.rmi.RemoteException

Description copied from class: tcBaseUtility

The ejbActivate() method as required by the EJB specification.
The activate method is called when the instance is activated from its passive" state. The instance should acquire any resource that it has released earlier in the ejbPassivate() method.
This method is called with no transaction context.

Specified by:

ejbActivate in interface javax.ejb.SessionBean

Overrides:

ejbActivate in class tcBaseUtility

Throws:

javax.ejb.EJBException - Thrown if the instance could not perform the function requested by the container because of an system-level error.

java.rmi.RemoteException

ejbCreate

public void ejbCreate()
               throws DDMException,
                      javax.ejb.CreateException

Populate SchemaFacade and initializes SchemaInstance

Throws:

DDMException

javax.ejb.CreateException

getExportView

public java.util.Collection getExportView()
                                   throws tcAPIException

Get the tree view to be displayed for export operation

Specified by:

getExportView in interface tcExportOperationsIntf

Returns:

Collection of RootObjects

Throws:

tcAPIException

getExportXML

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

Export selected objects. Generate doc object to export all the selected root objects in the form of xml.

Specified by:

getExportXML in interface tcExportOperationsIntf

Parameters:

rootObjects -

description - string containing the description of exported XML

Returns:

string containing the export XML

Throws:

tcAPIException

getDependencies

public java.util.Collection getDependencies(java.util.Collection root)
                                     throws tcAPIException

Return a list of dependent objects for the selected root objects

Specified by:

getDependencies in interface tcExportOperationsIntf

Parameters:

rootObjects -

Returns:

collection of dependent objects

Throws:

tcAPIException

tcAPIException

findObjects

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

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

Specified by:

findObjects in interface tcExportOperationsIntf

Parameters:

type -

name -

Returns:

objects matched

Throws:

tcAPIException

retrieveCategories

public java.util.Collection retrieveCategories()
                                        throws tcAPIException

Retrieve the categories name via iterating all the root objects metadata, which are having the actual data.

Specified by:

retrieveCategories in interface tcExportOperationsIntf

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

Specified by:

retrieveChildren in interface tcExportOperationsIntf

Parameters:

objects - (Collection of root objects)

Returns:

children of the selected elements as a tree

Throws:

DDMException

tcAPIException

retrieveDependencyTree

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

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

Specified by:

retrieveDependencyTree in interface tcExportOperationsIntf

Parameters:

objects -

Returns:

dependencies with all the children

Throws:

tcAPIException

arrangeSelectionAsATree

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

Arranges the passed objects as a Tree

Specified by:

arrangeSelectionAsATree in interface tcExportOperationsIntf

Parameters:

objects -

Returns:

collection arranged as a tree as much as possible

Throws:

tcAPIException

setSchema

public void setSchema(com.thortech.xl.ddm.engine.SchemaFacade schema)

getSchema

public com.thortech.xl.ddm.engine.SchemaFacade getSchema()