it.eng.spago.cms.operations
Class ExportOperation

java.lang.Object
  extended by it.eng.spago.cms.operations.ExportOperation

public class ExportOperation
extends java.lang.Object

Models a repository export operation. The operation has three attributes:

The configuration of the operation is stored into a Spago SourceBean structured like below:
 <OPERATION name="EXPORT">
            <EXPORTOPERATION path="?" stream="?" noRecurse="?" />  
 </OPERATION>
 


Constructor Summary
ExportOperation()
          Constructor of the class useful to build an empty export operation.
ExportOperation(java.lang.String path, java.io.OutputStream stream, boolean noRecurse)
          Constructor of the class useful to build an export operation setting the path, stream and noRestore attributes.
 
Method Summary
 SourceBean getOperationDescriptor()
          Gets the Internal SourceBean which defines the internal structure of the operation
 void setNoRecurse(boolean noRecurse)
          Set the noRecurse flag
 void setOutputStream(java.io.OutputStream stream)
          Set the output stream for the nodes serialization
 void setPath(java.lang.String path)
          Set the path of the cms node to the exported
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

ExportOperation

public ExportOperation()
                throws BuildOperationException
Constructor of the class useful to build an empty export operation.

Throws:
BuildOperationException - Thrown if an error occurs during the creation

ExportOperation

public ExportOperation(java.lang.String path,
                       java.io.OutputStream stream,
                       boolean noRecurse)
                throws BuildOperationException
Constructor of the class useful to build an export operation setting the path, stream and noRestore attributes.

Parameters:
path - The Path of the cms node to be exported
stream - The OutputStream for the nodes serialization
noRecurse - Flag: if it is true then only the node at path and its properties, but not its child nodes, are serialized; if it is false then the entire subtree rooted at path is serialized
Throws:
BuildOperationException - Thrown if an error occurs during the creation
Method Detail

setPath

public void setPath(java.lang.String path)
             throws BuildOperationException
Set the path of the cms node to the exported

Parameters:
path - Path of the cms node to the exported
Throws:
BuildOperationException - Thrown if an error occurs during the setting

setNoRecurse

public void setNoRecurse(boolean noRecurse)
                  throws BuildOperationException
Set the noRecurse flag

Parameters:
noRecurse - The noRecurse flag to set
Throws:
BuildOperationException - Thrown if an error occurs during the setting

setOutputStream

public void setOutputStream(java.io.OutputStream stream)
                     throws BuildOperationException
Set the output stream for the nodes serialization

Parameters:
stream - OutputStream for the cms nodes serialization
Throws:
BuildOperationException - Thrown if an error occurs during the setting

getOperationDescriptor

public SourceBean getOperationDescriptor()
Gets the Internal SourceBean which defines the internal structure of the operation

Returns:
The Internal SourceBean of the operation which defines the internal structure of the operation