com.softwareag.centrasite.api.csom.action
Interface NewVersionAction

All Superinterfaces:
CSOAction

public interface NewVersionAction
extends CSOAction

NewVersionAction creates a new version of a CentraSiteRegistryObject.
It can only be applied to a single CSRO


Method Summary
 java.util.Collection<Organization> getApplicableOrganizations()
          Returns the applicable organization for the action.
 java.lang.String getChangeLog()
          Returns the change log parameter.
 java.lang.String getNamespace()
          Returns the namespace parameter from the action.
 java.util.Collection<CentraSiteObject> getNewVersionObjects()
          returns the collection of newly versioned objects, null incase version action is not executed successfully.
 Organization getSelectedOrganization()
          Returns the organizatin parameter of the action.
 java.lang.String getUserVersion()
          Returns the user version parameter
 boolean isPropagateVersion()
          Returns whether propagate version to dependent object is set or not.
 void setChangeLog(java.lang.String changeLog)
          Sets the change log entry for he new version.
 void setNamespace(java.lang.String nameSpace)
          Sets the namespace for the new version.
 void setPropagateVersion(boolean isDeepVersion)
          Sets the "Propagate versions to dependent object" for creating the new version.
 void setSelectedOrganization(Organization organization)
          Sets the organization for the new parameter
 void setUserVersion(java.lang.String userVersion)
          Sets the user version for hte new version.
 
Methods inherited from interface com.softwareag.centrasite.api.csom.action.CSOAction
cancel, executeNextStep, executePreviousStep, finishAllSteps, getCurrentState, getGroup, getIconURL, getId, getName, getSkippedObjectsWithReason, isAllowed, isApplicable, setObjects
 

Method Detail

getNamespace

java.lang.String getNamespace()
Returns the namespace parameter from the action.

Returns:
Namespace parameter from the action

setNamespace

void setNamespace(java.lang.String nameSpace)
                  throws CLLException
Sets the namespace for the new version.

Parameters:
nameSpace -
Throws:
CLLException

getApplicableOrganizations

java.util.Collection<Organization> getApplicableOrganizations()
                                                              throws CLLException
Returns the applicable organization for the action. Which are the organizations the user has asset create permission for.

Returns:
applicable organization for the action
Throws:
CLLException

getSelectedOrganization

Organization getSelectedOrganization()
                                     throws CLLException
Returns the organizatin parameter of the action.

Returns:
selected organizatin of the action.
Throws:
CLLException

setSelectedOrganization

void setSelectedOrganization(Organization organization)
                             throws CLLException
Sets the organization for the new parameter

Parameters:
organization -
Throws:
CLLException

getUserVersion

java.lang.String getUserVersion()
Returns the user version parameter

Returns:
user version parameter

setUserVersion

void setUserVersion(java.lang.String userVersion)
                    throws CLLException
Sets the user version for hte new version.

Parameters:
userVersion -
Throws:
CLLException

isPropagateVersion

boolean isPropagateVersion()
Returns whether propagate version to dependent object is set or not.

Returns:
true if propagate version set to dependent object otherwise false

setPropagateVersion

void setPropagateVersion(boolean isDeepVersion)
                         throws CLLException
Sets the "Propagate versions to dependent object" for creating the new version.

Parameters:
isDeepVersion - boolean flag indicating whether DEEP/SHALLOW Copy
Throws:
CLLException

getChangeLog

java.lang.String getChangeLog()
Returns the change log parameter.

Returns:
change log parameter

setChangeLog

void setChangeLog(java.lang.String changeLog)
                  throws CLLException
Sets the change log entry for he new version.

Parameters:
changeLog -
Throws:
CLLException

getNewVersionObjects

java.util.Collection<CentraSiteObject> getNewVersionObjects()
returns the collection of newly versioned objects, null incase version action is not executed successfully.

Returns:
collection of newly versioned objects