org.ametys.odf

Class ODFHelper

java.lang.Object

org.ametys.runtime.plugin.component.AbstractLogEnabled

org.ametys.odf.ODFHelper

All Implemented Interfaces:

LogEnabled, PluginAware, Component, Serviceable

public class ODFHelper
extends AbstractLogEnabled
implements Component, Serviceable, PluginAware

Helper for ODF contents

Field Summary

Fields

Modifier and Type	Field and Description
protected static int	__INITIAL_WORKFLOW_ACTION_ID The default id of initial workflow action
protected ContentWorkflowHelper	_contentWorkflowHelper The content workflow helper
protected ContentTypeExtensionPoint	_cTypeEP The content types manager
protected CurrentUserProvider	_currentUserProvider The current user provider
protected ExternalizableMetadataProviderExtensionPoint	_externalizableMetadataProviderEP Provider for externalizable metadata
protected ObservationManager	_observationManager The observation manager
protected RootOrgUnitProvider	_ouRootProvider Root orgunit
private String	_pluginName
protected AmetysObjectResolver	_resolver Ametys object resolver
protected ShareableCourseHelper	_shareableCourseHelper Helper for shareable course
static String	ROLE The component role.

Constructor Summary

Constructors

Constructor and Description
ODFHelper()

Method Summary

Modifier and Type	Method and Description
private void	_addFormValues(Map<Pair<String,String>,List<String>> values, String childMetadataPath, String parentMetadataPath, List<String> refChildIds)
protected void	_cleanContentMetadata(ModifiableContent createdContent) Clean the CONTENT metadata created after a copy but whose values reference the initial content' structure
private <C extends ModifiableContent> C	_copyODFContent(Content srcContent, String catalog, String code, String targetContentName, String targetContentLanguage, int initWorkflowActionId, String targetCatalog, boolean fullCopy, Map<String,String> copiedPrograms, Map<String,String> copiedSubPrograms, Map<String,String> copiedContainers, Map<String,String> copiedCourseLists, Map<String,String> copiedCourses, Map<String,String> copiedCourseParts) Copy a ProgramItem
private void	_editChildRelation(WorkflowAwareContent parentContent, Map<Pair<String,String>,List<String>> values)
private List<String>	_getContentParameters(Content srcContent, Content targetContent)
private <T> Set<T>	_getParentsOfType(ProgramItem programItem, Class<T> classToTest)
private <T> Set<T>	_getParentsOfType(ProgramItem programItem, Set<ProgramItem> visitedProgramItems, Class<T> classToTest)
private String	_getPathInCourse(Content content, Content parentContent)
private boolean	_isContentTypeCompatible(Content srcContent, Content targetContent)
private void	_putInCopiedMap(Content srcContent, ModifiableContent createdContent, Map<String,String> copiedPrograms, Map<String,String> copiedSubPrograms, Map<String,String> copiedContainers, Map<String,String> copiedCourseLists, Map<String,String> copiedCourses, Map<String,String> copiedCourseParts)
<C extends ModifiableContent> C	copyCoursePart(CoursePart srcContent, String targetContentName, String targetContentLanguage, int initWorkflowActionId, String targetCatalog, boolean fullCopy, Map<String,String> copiedPrograms, Map<String,String> copiedSubPrograms, Map<String,String> copiedContainers, Map<String,String> copiedCourseLists, Map<String,String> copiedCourses, Map<String,String> copiedCourseParts) Copy a CoursePart
<C extends ModifiableContent> C	copyProgramItem(ProgramItem srcContent, String targetCatalog, boolean fullCopy, Map<String,String> copiedPrograms, Map<String,String> copiedSubPrograms, Map<String,String> copiedContainers, Map<String,String> copiedCourseLists, Map<String,String> copiedCourses, Map<String,String> copiedCourseParts) Copy a ProgramItem
<C extends ModifiableContent> C	copyProgramItem(ProgramItem srcContent, String targetContentName, String targetContentLanguage, int initWorkflowActionId, String targetCatalog, boolean fullCopy, Map<String,String> copiedPrograms, Map<String,String> copiedSubPrograms, Map<String,String> copiedContainers, Map<String,String> copiedCourseLists, Map<String,String> copiedCourses, Map<String,String> copiedCourseParts) Copy a ProgramItem
<C extends ModifiableContent> C	copyProgramItem(ProgramItem srcContent, String targetContentName, String targetContentLanguage, String targetCatalog, boolean fullCopy, Map<String,String> copiedPrograms, Map<String,String> copiedSubPrograms, Map<String,String> copiedContainers, Map<String,String> copiedCourseLists, Map<String,String> copiedCourses, Map<String,String> copiedCourseParts) Copy a ProgramItem
protected void	copyProgramItemStructure(ProgramItem srcContent, ModifiableContent targetContent, String targetContentLanguage, int initWorkflowActionId, String targetCatalogName, Map<String,String> copiedPrograms, Map<String,String> copiedSubPrograms, Map<String,String> copiedContainers, Map<String,String> copiedCourseLists, Map<String,String> copiedCourses, Map<String,String> copiedCourseParts) Copy the structure of a ProgramItem
List<ProgramItem>	getChildProgramItems(ProgramItem programItem) Get the child program items of a ProgramItem
Set<SubProgram>	getChildSubPrograms(ProgramPart programPart) Get the child subprograms of a ProgramPart
CoursePart	getCoursePart(CoursePart srcCoursePart, String catalogName, String lang) Get the equivalent CoursePart of the source CoursePart in given catalog and language
<T extends AmetysObject> T	getODFContent(String contentType, String odfContentCode, String catalogName, String lang) Get the equivalent Content having the same code in given catalog and language
String	getOrgUnitPath(String orgUnitId) Get the hierarchical path of a OrgUnit from the root orgunit. The path is construct with the contents' names and the used separator is '/'.
String	getOrgUnitPath(String orgUnitId, String rootOrgUnitId) Get the hierarchical path of a OrgUnit from the root orgunit id. The path is construct with the contents' names and the used separator is '/'.
Set<AbstractProgram>	getParentAbstractPrograms(ProgramItem programItem) Gets (recursively) parent abstract programs of this program item.
Set<Container>	getParentContainers(ProgramItem programItem) Gets (recursively) parent containers of this program item.
ProgramItem	getParentProgramItem(ProgramItem programItem, AbstractProgram parentProgram) Get the nearest program item parent into the given parent AbstractProgram
List<ProgramItem>	getParentProgramItems(ProgramItem programItem) Get the parent program items of a ProgramItem
Set<Program>	getParentPrograms(ProgramItem programItem) Gets (recursively) parent programs of this program item.
String	getPathInCourse(Content courseOrList, Course parentCourse) Get the path of a Course or a CourseList into a Course The path is construct with the contents' names and the used separator is '/'.
String	getPathInCourse(String contentId, String parentCourseId) Get the path of a Course or a CourseList into a Course The path is construct with the contents' names and the used separator is '/'.
String	getPathInProgram(ProgramItem item, Program parentProgram) Get the path of a ODF content into a Program. The path is construct with the contents' names and the used separator is '/'.
String	getPathInProgram(String programItemId, String programId) Get the path of a ProgramItem into a Program The path is construct with the contents' names and the used separator is '/'.
protected List<String>	getPaths(ProgramItem item, String separator) Get all the paths of a ODF content. The path is construct with the contents' title
<T extends ProgramItem> T	getProgramItem(T srcProgramItem, String catalogName, String lang) Get the equivalent ProgramItem of the source ProgramItem in given catalog and language
<C extends Content> AmetysObjectIterable<C>	getProgramItems(String cTypeId, String code, String catalogName, String lang) Get the ProgramItems matching the given arguments
<C extends Content> AmetysObjectIterable<C>	getProgramItems(String cTypeId, String code, String catalogName, String lang, Expression additionnalExpr, SortCriteria sortCriteria) Get the ProgramItems matching the given arguments
AmetysObjectCollection	getRootContent() Gets the root for ODF contents
AmetysObjectCollection	getRootContent(boolean create) Gets the root for ODF contents
Map<String,Object>	getStructureInfo(String programItemId) Get information of the program item structure (type, if program has children)
boolean	hasAncestor(ProgramPart part, String parentId) Return true if the given ProgramPart has in its hierarchy a parent of given id
boolean	isRelationCompatible(Content srcContent, Content targetContent, List<I18nizableText> errors, Map<String,Object> contextualParameters) Check if a relation can be establish between two ODF contents
void	service(ServiceManager manager)
void	setPluginInfo(String pluginName, String featureName, String id) Sets the plugin info relative to the current component. Note : The feature name may be null if the targeted component in declared at plugin level.

Methods inherited from class org.ametys.runtime.plugin.component.AbstractLogEnabled

getLogger, setLogger

Methods inherited from class java.lang.Object

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

Field Detail

ROLE

public static final String ROLE

The component role.

__INITIAL_WORKFLOW_ACTION_ID

protected static final int __INITIAL_WORKFLOW_ACTION_ID

The default id of initial workflow action

See Also:

Constant Field Values

_resolver

protected AmetysObjectResolver _resolver

Ametys object resolver

_contentWorkflowHelper

protected ContentWorkflowHelper _contentWorkflowHelper

The content workflow helper

_cTypeEP

protected ContentTypeExtensionPoint _cTypeEP

The content types manager

_observationManager

protected ObservationManager _observationManager

The observation manager

_currentUserProvider

protected CurrentUserProvider _currentUserProvider

The current user provider

_ouRootProvider

protected RootOrgUnitProvider _ouRootProvider

Root orgunit

_externalizableMetadataProviderEP

protected ExternalizableMetadataProviderExtensionPoint _externalizableMetadataProviderEP

Provider for externalizable metadata

_shareableCourseHelper

protected ShareableCourseHelper _shareableCourseHelper

Helper for shareable course

_pluginName

private String _pluginName

Constructor Detail

ODFHelper

public ODFHelper()

Method Detail

service

public void service(ServiceManager manager)
             throws ServiceException

Specified by:

service in interface Serviceable

Throws:

ServiceException

setPluginInfo

public void setPluginInfo(String pluginName,
                          String featureName,
                          String id)

Description copied from interface: PluginAware

Sets the plugin info relative to the current component.
Note : The feature name may be null if the targeted component in declared at plugin level.

Specified by:

setPluginInfo in interface PluginAware

Parameters:

pluginName - Unique identifier for the plugin hosting the extension

featureName - Unique feature identifier (unique for a given pluginName)

id - Unique identifier of this component

getRootContent

public AmetysObjectCollection getRootContent()

Gets the root for ODF contents

Returns:

the root for ODF contents

getRootContent

public AmetysObjectCollection getRootContent(boolean create)

Gets the root for ODF contents

Parameters:

create - true to create automatically the root when missing.

Returns:

the root for ODF contents

getProgramItems

public <C extends Content> AmetysObjectIterable<C> getProgramItems(String cTypeId,
                                                                   String code,
                                                                   String catalogName,
                                                                   String lang)

Get the ProgramItems matching the given arguments

Type Parameters:

C - The content return type

Parameters:

cTypeId - The id of content type. Can be null to get program's items whatever their content type.

code - The code. Can be null to get program's items regardless of their code

catalogName - The search catalog. Can be null to get program's items regardless the catalog they belong to.

lang - The search language. Can be null to get program's items regardless of their language

Returns:

The matching program items

getProgramItems

public <C extends Content> AmetysObjectIterable<C> getProgramItems(String cTypeId,
                                                                   String code,
                                                                   String catalogName,
                                                                   String lang,
                                                                   Expression additionnalExpr,
                                                                   SortCriteria sortCriteria)

Get the ProgramItems matching the given arguments

Type Parameters:

C - The content return type

Parameters:

cTypeId - The id of content type. Can be null to get program's items whatever their content type.

code - The code. Can be null to get program's items regardless of their code

catalogName - The search catalog. Can be null to get program's items regardless the catalog they belong to.

lang - The search language. Can be null to get program's items regardless of their language

additionnalExpr - An additional expression for filtering result. Can be null

sortCriteria - criteria for sorting results

Returns:

The matching program items

getCoursePart

public CoursePart getCoursePart(CoursePart srcCoursePart,
                                String catalogName,
                                String lang)

Get the equivalent CoursePart of the source CoursePart in given catalog and language

Parameters:

srcCoursePart - The source course part

catalogName - The name of catalog to search into

lang - The search language

Returns:

The equivalent program item or null if not exists

getProgramItem

public <T extends ProgramItem> T getProgramItem(T srcProgramItem,
                                                String catalogName,
                                                String lang)

Get the equivalent ProgramItem of the source ProgramItem in given catalog and language

Type Parameters:

T - The type of returned object, it have to be a subclass of ProgramItem

Parameters:

srcProgramItem - The source program item

catalogName - The name of catalog to search into

lang - The search language

Returns:

The equivalent program item or null if not exists

getODFContent

public <T extends AmetysObject> T getODFContent(String contentType,
                                                String odfContentCode,
                                                String catalogName,
                                                String lang)

Get the equivalent Content having the same code in given catalog and language

Type Parameters:

T - The type of returned object, it have to be a subclass of AmetysObject

Parameters:

contentType - The content type to search for

odfContentCode - The code of the ODF content

catalogName - The name of catalog to search into

lang - The search language

Returns:

The equivalent content or null if not exists

getChildProgramItems

public List<ProgramItem> getChildProgramItems(ProgramItem programItem)

Get the child program items of a ProgramItem

Parameters:

programItem - The program item

Returns:

The child program items

getChildSubPrograms

public Set<SubProgram> getChildSubPrograms(ProgramPart programPart)

Get the child subprograms of a ProgramPart

Parameters:

programPart - The program part

Returns:

The child subprograms

getParentContainers

public Set<Container> getParentContainers(ProgramItem programItem)

Gets (recursively) parent containers of this program item.

Parameters:

programItem - The program item

Returns:

parent containers of this program item.

getParentPrograms

public Set<Program> getParentPrograms(ProgramItem programItem)

Gets (recursively) parent programs of this program item.

Parameters:

programItem - The program item

Returns:

parent programs of this program item.

getParentAbstractPrograms

public Set<AbstractProgram> getParentAbstractPrograms(ProgramItem programItem)

Gets (recursively) parent abstract programs of this program item.

Parameters:

programItem - The program item

Returns:

parent abstract programs of this program item.

_getParentsOfType

private <T> Set<T> _getParentsOfType(ProgramItem programItem,
                                     Class<T> classToTest)

_getParentsOfType

private <T> Set<T> _getParentsOfType(ProgramItem programItem,
                                     Set<ProgramItem> visitedProgramItems,
                                     Class<T> classToTest)

getParentProgramItems

public List<ProgramItem> getParentProgramItems(ProgramItem programItem)

Get the parent program items of a ProgramItem

Parameters:

programItem - The program item

Returns:

The parent program items

getParentProgramItem

public ProgramItem getParentProgramItem(ProgramItem programItem,
                                        AbstractProgram parentProgram)

Get the nearest program item parent into the given parent AbstractProgram

Parameters:

programItem - The program item

parentProgram - The parent program or subprogram. If null, the nearest abstract program will be returned.

Returns:

The parent program item or null if not found.

getStructureInfo

public Map<String,Object> getStructureInfo(String programItemId)

Get information of the program item structure (type, if program has children)

Parameters:

programItemId - the program item id

Returns:

a map of information

getPaths

protected List<String> getPaths(ProgramItem item,
                                String separator)

Get all the paths of a ODF content.
The path is construct with the contents' title

Parameters:

separator - The path separator

item - The program item

Returns:

the paths in parent program items

getPathInProgram

public String getPathInProgram(String programItemId,
                               String programId)

Get the path of a ProgramItem into a Program
The path is construct with the contents' names and the used separator is '/'.

Parameters:

programItemId - The id of the program item

programId - The id of program. Can not be null.

Returns:

the path into the parent program or null if the item is not part of this program.

getPathInProgram

public String getPathInProgram(ProgramItem item,
                               Program parentProgram)

Get the path of a ODF content into a Program.
The path is construct with the contents' names and the used separator is '/'.

Parameters:

item - The program item

parentProgram - The parent root (sub)program. Can not be null.

Returns:

the path from the parent program

getPathInCourse

public String getPathInCourse(String contentId,
                              String parentCourseId)

Get the path of a Course or a CourseList into a Course
The path is construct with the contents' names and the used separator is '/'.

Parameters:

contentId - The id of the content

parentCourseId - The id of parent course. Can not be null.

Returns:

the path into the parent course or null if the item is not part of this course.

getPathInCourse

public String getPathInCourse(Content courseOrList,
                              Course parentCourse)

Get the path of a Course or a CourseList into a Course
The path is construct with the contents' names and the used separator is '/'.

Parameters:

courseOrList - The course or the course list

parentCourse - The parent course. Can not be null.

Returns:

the path into the parent course or null if the item is not part of this course.

_getPathInCourse

private String _getPathInCourse(Content content,
                                Content parentContent)

getOrgUnitPath

public String getOrgUnitPath(String orgUnitId,
                             String rootOrgUnitId)

Get the hierarchical path of a OrgUnit from the root orgunit id.
The path is construct with the contents' names and the used separator is '/'.

Parameters:

orgUnitId - The id of the orgunit

rootOrgUnitId - The root orgunit id

Returns:

the path into the parent program or null if the item is not part of this program.

getOrgUnitPath

public String getOrgUnitPath(String orgUnitId)

Get the hierarchical path of a OrgUnit from the root orgunit.
The path is construct with the contents' names and the used separator is '/'.

Parameters:

orgUnitId - The id of the orgunit

Returns:

the path into the parent program or null if the item is not part of this program.

hasAncestor

public boolean hasAncestor(ProgramPart part,
                           String parentId)

Return true if the given ProgramPart has in its hierarchy a parent of given id

Parameters:

part - The program part

parentId - The ancestor id

Returns:

true if the given ProgramPart has in its hierarchy a parent of given id

isRelationCompatible

public boolean isRelationCompatible(Content srcContent,
                                    Content targetContent,
                                    List<I18nizableText> errors,
                                    Map<String,Object> contextualParameters)

Check if a relation can be establish between two ODF contents

Parameters:

srcContent - The source content (copied or moved)

targetContent - The target content

errors - The list of error messages

contextualParameters - the contextual parameters

Returns:

true if the relation is valid, false otherwise

_isContentTypeCompatible

private boolean _isContentTypeCompatible(Content srcContent,
                                         Content targetContent)

_getContentParameters

private List<String> _getContentParameters(Content srcContent,
                                           Content targetContent)

copyProgramItem

public <C extends ModifiableContent> C copyProgramItem(ProgramItem srcContent,
                                                       String targetCatalog,
                                                       boolean fullCopy,
                                                       Map<String,String> copiedPrograms,
                                                       Map<String,String> copiedSubPrograms,
                                                       Map<String,String> copiedContainers,
                                                       Map<String,String> copiedCourseLists,
                                                       Map<String,String> copiedCourses,
                                                       Map<String,String> copiedCourseParts)
                                                throws AmetysRepositoryException,
                                                       com.opensymphony.workflow.WorkflowException

Copy a ProgramItem

Type Parameters:

C - The modifiable content return type

Parameters:

srcContent - The program item to copy

targetCatalog - The target catalog. Can be null. The target catalog will be the catalog of the source object.

fullCopy - Set to true to copy the sub-structure

copiedPrograms - the id of initial programs with their copied content

copiedSubPrograms - the id of initial subprograms with their copied content

copiedContainers - the id of initial containers with their copied content

copiedCourseLists - the id of initial course lists with their copied content

copiedCourses - the id of initial courses with their copied content

copiedCourseParts - the id of initial course parts with their copied content

Returns:

The created content

Throws:

AmetysRepositoryException - If an error occurred during copy

com.opensymphony.workflow.WorkflowException - If an error occurred during copy

copyProgramItem

public <C extends ModifiableContent> C copyProgramItem(ProgramItem srcContent,
                                                       String targetContentName,
                                                       String targetContentLanguage,
                                                       String targetCatalog,
                                                       boolean fullCopy,
                                                       Map<String,String> copiedPrograms,
                                                       Map<String,String> copiedSubPrograms,
                                                       Map<String,String> copiedContainers,
                                                       Map<String,String> copiedCourseLists,
                                                       Map<String,String> copiedCourses,
                                                       Map<String,String> copiedCourseParts)
                                                throws AmetysRepositoryException,
                                                       com.opensymphony.workflow.WorkflowException

Copy a ProgramItem

Type Parameters:

C - The modifiable content return type

Parameters:

srcContent - The program item to copy

targetContentName - The name of content to created. Can be null. If null, the new name will be get from the source object.

targetContentLanguage - The name of content to created. Can be null. If null, the language of target content will be the same as source object.

targetCatalog - The target catalog. Can be null. The target catalog will be the catalog of the source object.

fullCopy - Set to true to copy the sub-structure

copiedPrograms - the id of initial programs with their copied content

copiedSubPrograms - the id of initial subprograms with their copied content

copiedContainers - the id of initial containers with their copied content

copiedCourseLists - the id of initial course lists with their copied content

copiedCourses - the id of initial courses with their copied content

copiedCourseParts - the id of initial course parts with their copied content

Returns:

The created content

Throws:

AmetysObjectExistsException - If a program item with same code, catalog and language already exists

AmetysRepositoryException - If an error occurred

com.opensymphony.workflow.WorkflowException - If an error occurred

copyCoursePart

public <C extends ModifiableContent> C copyCoursePart(CoursePart srcContent,
                                                      String targetContentName,
                                                      String targetContentLanguage,
                                                      int initWorkflowActionId,
                                                      String targetCatalog,
                                                      boolean fullCopy,
                                                      Map<String,String> copiedPrograms,
                                                      Map<String,String> copiedSubPrograms,
                                                      Map<String,String> copiedContainers,
                                                      Map<String,String> copiedCourseLists,
                                                      Map<String,String> copiedCourses,
                                                      Map<String,String> copiedCourseParts)
                                               throws AmetysRepositoryException,
                                                      com.opensymphony.workflow.WorkflowException

Copy a CoursePart

Type Parameters:

C - The modifiable content return type

Parameters:

srcContent - The course part to copy

targetContentName - The name of content to created. Can be null. If null, the new name will be get from the source object.

targetContentLanguage - The name of content to created. Can be null. If null, the language of target content will be the same as source object.

initWorkflowActionId - The initial workflow action id

fullCopy - Set to true to copy the sub-structure

targetCatalog - The target catalog. Can be null. The target catalog will be the catalog of the source object.

copiedPrograms - the id of initial programs with their copied content

copiedSubPrograms - the id of initial subprograms with their copied content

copiedContainers - the id of initial containers with their copied content

copiedCourseLists - the id of initial course lists with their copied content

copiedCourses - the id of initial courses with their copied content

copiedCourseParts - the id of initial course parts with their copied content

Returns:

The created content

Throws:

AmetysObjectExistsException - If a program item with same code, catalog and language already exists

AmetysRepositoryException - If an error occurred

com.opensymphony.workflow.WorkflowException - If an error occurred

copyProgramItem

public <C extends ModifiableContent> C copyProgramItem(ProgramItem srcContent,
                                                       String targetContentName,
                                                       String targetContentLanguage,
                                                       int initWorkflowActionId,
                                                       String targetCatalog,
                                                       boolean fullCopy,
                                                       Map<String,String> copiedPrograms,
                                                       Map<String,String> copiedSubPrograms,
                                                       Map<String,String> copiedContainers,
                                                       Map<String,String> copiedCourseLists,
                                                       Map<String,String> copiedCourses,
                                                       Map<String,String> copiedCourseParts)
                                                throws AmetysRepositoryException,
                                                       com.opensymphony.workflow.WorkflowException

Copy a ProgramItem

Type Parameters:

C - The modifiable content return type

Parameters:

srcContent - The program item to copy

targetContentName - The name of content to created. Can be null. If null, the new name will be get from the source object.

targetContentLanguage - The name of content to created. Can be null. If null, the language of target content will be the same as source object.

initWorkflowActionId - The initial workflow action id

fullCopy - Set to true to copy the sub-structure

targetCatalog - The target catalog. Can be null. The target catalog will be the catalog of the source object.

copiedPrograms - the id of initial programs with their copied content

copiedSubPrograms - the id of initial subprograms with their copied content

copiedContainers - the id of initial containers with their copied content

copiedCourseLists - the id of initial course lists with their copied content

copiedCourses - the id of initial courses with their copied content

copiedCourseParts - the id of initial course parts with their copied content

Returns:

The created content

Throws:

AmetysObjectExistsException - If a program item with same code, catalog and language already exists

AmetysRepositoryException - If an error occurred

com.opensymphony.workflow.WorkflowException - If an error occurred

_copyODFContent

private <C extends ModifiableContent> C _copyODFContent(Content srcContent,
                                                        String catalog,
                                                        String code,
                                                        String targetContentName,
                                                        String targetContentLanguage,
                                                        int initWorkflowActionId,
                                                        String targetCatalog,
                                                        boolean fullCopy,
                                                        Map<String,String> copiedPrograms,
                                                        Map<String,String> copiedSubPrograms,
                                                        Map<String,String> copiedContainers,
                                                        Map<String,String> copiedCourseLists,
                                                        Map<String,String> copiedCourses,
                                                        Map<String,String> copiedCourseParts)
                                                 throws AmetysRepositoryException,
                                                        com.opensymphony.workflow.WorkflowException

Copy a ProgramItem

Type Parameters:

C - The modifiable content return type

Parameters:

srcContent - The program item to copy

catalog - The catalog

code - The odf content code

targetContentName - The name of content to created. Can be null. If null, the new name will be get from the source object.

targetContentLanguage - The name of content to created. Can be null. If null, the language of target content will be the same as source object.

initWorkflowActionId - The initial workflow action id

fullCopy - Set to true to copy the sub-structure

targetCatalog - The target catalog. Can be null. The target catalog will be the catalog of the source object.

copiedPrograms - the id of initial programs with their copied content

copiedSubPrograms - the id of initial subprograms with their copied content

copiedContainers - the id of initial containers with their copied content

copiedCourseLists - the id of initial course lists with their copied content

copiedCourses - the id of initial courses with their copied content

copiedCourseParts - the id of initial course parts with their copied content

Returns:

The created content

Throws:

AmetysObjectExistsException - If a program item with same code, catalog and language already exists

AmetysRepositoryException - If an error occurred

com.opensymphony.workflow.WorkflowException - If an error occurred

_putInCopiedMap

private void _putInCopiedMap(Content srcContent,
                             ModifiableContent createdContent,
                             Map<String,String> copiedPrograms,
                             Map<String,String> copiedSubPrograms,
                             Map<String,String> copiedContainers,
                             Map<String,String> copiedCourseLists,
                             Map<String,String> copiedCourses,
                             Map<String,String> copiedCourseParts)

copyProgramItemStructure

protected void copyProgramItemStructure(ProgramItem srcContent,
                                        ModifiableContent targetContent,
                                        String targetContentLanguage,
                                        int initWorkflowActionId,
                                        String targetCatalogName,
                                        Map<String,String> copiedPrograms,
                                        Map<String,String> copiedSubPrograms,
                                        Map<String,String> copiedContainers,
                                        Map<String,String> copiedCourseLists,
                                        Map<String,String> copiedCourses,
                                        Map<String,String> copiedCourseParts)
                                 throws AmetysRepositoryException,
                                        com.opensymphony.workflow.WorkflowException

Copy the structure of a ProgramItem

Parameters:

srcContent - the content to copy

targetContent - the target content

targetContentLanguage - The name of content to created. Can be null. If null, the language of target content will be the same as source object.

initWorkflowActionId - The initial workflow action id

targetCatalogName - The target catalog. Can be null. The target catalog will be the catalog of the source object.

copiedPrograms - the id of initial programs with their copied content

copiedSubPrograms - the id of initial subprograms with their copied content

copiedContainers - the id of initial containers with their copied content

copiedCourseLists - the id of initial course lists with their copied content

copiedCourses - the id of initial courses with their copied content

copiedCourseParts - the id of initial course parts with their copied content

Throws:

AmetysRepositoryException - If an error occurred during copy

com.opensymphony.workflow.WorkflowException - If an error occurred during copy

_addFormValues

private void _addFormValues(Map<Pair<String,String>,List<String>> values,
                            String childMetadataPath,
                            String parentMetadataPath,
                            List<String> refChildIds)

_editChildRelation

private void _editChildRelation(WorkflowAwareContent parentContent,
                                Map<Pair<String,String>,List<String>> values)
                         throws AmetysRepositoryException

Throws:

AmetysRepositoryException

_cleanContentMetadata

protected void _cleanContentMetadata(ModifiableContent createdContent)

Clean the CONTENT metadata created after a copy but whose values reference the initial content' structure

Parameters:

createdContent - The created content to clean