CCM NG/ccm-cms: Added information about coping/moving an item to another content section to the JavaDoc of the ContentItemManager#copy and ContentItemManager#move methods.
git-svn-id: https://svn.libreccm.org/ccm/ccm_ng@4375 8810af33-2d31-482b-a856-94f89814c4dfpull/2/head
parent
938f44f106
commit
3df912fe21
|
|
@ -234,11 +234,17 @@ public class ContentItemManager {
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Moves a content item to another folder in the same content section. This
|
* Moves a content item to another folder. If moving an item to another
|
||||||
|
* content section the caller should first check if the type of the item is
|
||||||
|
* registered in the target version using
|
||||||
|
* {@link ContentSectionManager#hasContentType(java.lang.Class, org.librecms.contentsection.ContentSection)}.
|
||||||
|
* If this method is called with for item and a folder in another content
|
||||||
|
* section and the type of the item is not registered for target section
|
||||||
|
* this method will throw an {@link IllegalArgumentException}. This method
|
||||||
* only moves the draft version of the item. The live version is moved after
|
* only moves the draft version of the item. The live version is moved after
|
||||||
* a the item is republished.
|
* a the item is republished.
|
||||||
*
|
*
|
||||||
* @param item The item to move.
|
* @param item The item to move.
|
||||||
* @param targetFolder The folder to which the item is moved.
|
* @param targetFolder The folder to which the item is moved.
|
||||||
*/
|
*/
|
||||||
@AuthorizationRequired
|
@AuthorizationRequired
|
||||||
|
|
@ -295,7 +301,13 @@ public class ContentItemManager {
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Creates an copy of the draft version of the item in the provided
|
* Creates an copy of the draft version of the item in the provided
|
||||||
* {@code targetFolder}.
|
* {@code targetFolder}. If the target folder belongs to another content
|
||||||
|
* section the caller should first check if the type of the item is
|
||||||
|
* registered for the target section by using
|
||||||
|
* {@link ContentSectionManager#hasContentType(java.lang.Class, org.librecms.contentsection.ContentSection)}.
|
||||||
|
* If this method is called for an item and a folder in another content
|
||||||
|
* section and the type of the item is not registered for the target section
|
||||||
|
* an {@link IllegalArgumentException} is thrown.
|
||||||
*
|
*
|
||||||
* @param item The item to copy.
|
* @param item The item to copy.
|
||||||
* @param targetFolder The folder in which the copy is created. If the
|
* @param targetFolder The folder in which the copy is created. If the
|
||||||
|
|
|
||||||
Loading…
Reference in New Issue