it.eng.spago.cms.operations
Class GetOperation

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

public class GetOperation
extends java.lang.Object

Models an inquiry operation on the repostiroty . The operation has six attributes:

To gather information about the current version of an node it's necessary to set only the path attribute. To gather information about a specific version of a node it's necessary to set the path and the version name of the node. The configuration of the operation is stored into a Spago SourceBean structured like below:
 <OPERATION name="">
            <GETOPERATION path="?" version="?" getVersions="(true/false)" getChilds="(true/false)" 
                                  getContent="(true/false)" getProperties="(true/false)" />
 </OPERATION>
 


Constructor Summary
GetOperation()
          Constructor of the class useful to build an empty get operation.
GetOperation(java.lang.String path, boolean getChild, boolean getProps, boolean getCont, boolean getVers)
          Constructor of the class useful to build a get operation setting the path, getChilds, getProperties, getVersions, getContent attributes.
GetOperation(java.lang.String path, java.lang.String version, boolean getChild, boolean getProps, boolean getCont, boolean getVers)
          Constructor of the class useful to build a get operation setting the path, version, getChilds, getProperties, getVersions, getContent attributes.
 
Method Summary
 SourceBean getOperationDescriptor()
          Gets the Internal SourceBean which defines the internal structure of the operation
 void setPath(java.lang.String path)
          Set the path of the cms node
 void setRetriveChildsInformation(java.lang.String getChilds)
          Set the getChilds attribute of the get operation
 void setRetriveContentInformation(java.lang.String getContent)
          Set the getContent attribute of the get operation
 void setRetrivePropertiesInformation(java.lang.String getProperties)
          Set the getProperties attribute of the get operation
 void setRetriveVersionsInformation(java.lang.String getVersion)
          Set the getVersions attribute of the get operation
 void setVersion(java.lang.String ver)
          Set the versione of the cms node
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

GetOperation

public GetOperation()
             throws BuildOperationException
Constructor of the class useful to build an empty get operation. Attributes which have a default value are filled with it

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

GetOperation

public GetOperation(java.lang.String path,
                    boolean getChild,
                    boolean getProps,
                    boolean getCont,
                    boolean getVers)
             throws BuildOperationException
Constructor of the class useful to build a get operation setting the path, getChilds, getProperties, getVersions, getContent attributes.

Parameters:
path - The Path of the cms node to examine
getChild - Flag to activate or deactivate the child information gathering
getProps - Flag to activate or deactivate the properties information gathering
getCont - Flag to activate or deactivate the content gathering
getVers - Flag to activate or deactivate the version information gathering
Throws:
BuildOperationException - Thrown if an error occurs during the creation

GetOperation

public GetOperation(java.lang.String path,
                    java.lang.String version,
                    boolean getChild,
                    boolean getProps,
                    boolean getCont,
                    boolean getVers)
             throws BuildOperationException
Constructor of the class useful to build a get operation setting the path, version, getChilds, getProperties, getVersions, getContent attributes.

Parameters:
path - The Path of the cms node
version - The version of the node to examine
getChild - Flag to activate or deactivate the child information gathering
getProps - Flag to activate or deactivate the properties information gathering
getCont - Flag to activate or deactivate the content gathering
getVers - Flag to activate or deactivate the version information gathering
Throws:
BuildOperationException - Thrown if an error occurs during the creation
Method Detail

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

setPath

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

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

setVersion

public void setVersion(java.lang.String ver)
                throws BuildOperationException
Set the versione of the cms node

Parameters:
version - Version of the cms node
Throws:
BuildOperationException - Thrown if an error occurs during the setting

setRetriveVersionsInformation

public void setRetriveVersionsInformation(java.lang.String getVersion)
                                   throws BuildOperationException
Set the getVersions attribute of the get operation

Parameters:
getVersion - Flag to activate or deactivate the version information gathering
Throws:
BuildOperationException - Thrown if an error occurs during the setting

setRetriveContentInformation

public void setRetriveContentInformation(java.lang.String getContent)
                                  throws BuildOperationException
Set the getContent attribute of the get operation

Parameters:
getContent - Flag to activate or deactivate the content gathering
Throws:
BuildOperationException - Thrown if an error occurs during the setting

setRetrivePropertiesInformation

public void setRetrivePropertiesInformation(java.lang.String getProperties)
                                     throws BuildOperationException
Set the getProperties attribute of the get operation

Parameters:
getProperties - Flag to activate or deactivate the information gathering about node properties
Throws:
BuildOperationException - Thrown if an error occurs during the setting

setRetriveChildsInformation

public void setRetriveChildsInformation(java.lang.String getChilds)
                                 throws BuildOperationException
Set the getChilds attribute of the get operation

Parameters:
getChilds - Flag to activate or deactivate the information gathering about node childs
Throws:
BuildOperationException - Thrown if an error occurs during the setting