Index: openacs-4/packages/acs-content-repository/www/doc/api/folder.adp =================================================================== RCS file: /usr/local/cvsroot/openacs-4/packages/acs-content-repository/www/doc/api/folder.adp,v diff -u -r1.2.2.3 -r1.2.2.4 --- openacs-4/packages/acs-content-repository/www/doc/api/folder.adp 9 Jun 2016 08:44:49 -0000 1.2.2.3 +++ openacs-4/packages/acs-content-repository/www/doc/api/folder.adp 1 Jul 2016 09:17:32 -0000 1.2.2.4 @@ -15,10 +15,11 @@

Content folders contain related content items and allow content managers to group content as they see fit. Within a content folder, content items must have unique names since this is where they will -be served from. For example within the folder "movies" (served from -"/movies") all items must have unique names, such as: "terminator," -"terminator2" (served from "/movies/terminator, -"/movies/terminator2" respectively).

+be served from. For example within the folder "movies" +(served from "/movies") all items must have unique names, +such as: "terminator," "terminator2" (served +from "/movies/terminator, "/movies/terminator2" +respectively).

 

Related Objects

@@ -36,12 +37,12 @@ Returns:The item ID of the index page Parameters:
-
folder_id The:  folder id
Declaration:

+Declaration:

 function get_index_page (
   folder_id in cr_folders.folder_id%TYPE
 ) return cr_items.item_id%TYPE;
 
-

+

 

  • Function: content_folder.get_label @@ -50,15 +51,15 @@ Author:Karl Goldstein -Returns:The folder's label +Returns:The folder's label Parameters:
    -
    folder_id:  The folder id
    Declaration:
    
+Declaration:
    
 function get_label (
   folder_id in cr_folders.folder_id%TYPE
 ) return cr_folders.label%TYPE;
 
-
    
+
    See Also:acs_object_type.create_type, the docs for the name_method parameter @@ -69,16 +70,16 @@ Author:Karl Goldstein -Returns:'t' if the folder contains no subfolders or items, -'f' otherwise +Returns:'t' if the folder contains no subfolders +or items, 'f' otherwise Parameters:
    -
    folder_id:  The folder id
    Declaration:
    
+Declaration:
    
 function is_empty (
   folder_id  in cr_folders.folder_id%TYPE
 ) return varchar2;
 
-
    
+
    See Also:content_folder.is_folder

     

    @@ -88,15 +89,16 @@ Author:Karl Goldstein -Returns:'t' if the item is a folder, 'f' otherwise +Returns:'t' if the item is a folder, 'f' +otherwise Parameters:
    -
    item_id:  The item id
    Declaration:
    
+Declaration:
    
 function is_folder (
   item_id         in cr_items.item_id%TYPE
 ) return char;
 
-
    
+
    See Also:content_folder.new, content_folder.is_sub_folder

     

    @@ -108,53 +110,55 @@ Author:Karl Goldstein -Returns:'t' if the type is registered to this folder, 'f' -otherwise +Returns:'t' if the type is registered to this +folder, 'f' otherwise Parameters:
    - + -
    folder_id:  The folder id
    content_type:  The content type to be checked
    include_subtypes:  If 't', all subtypes of the content_type will be -checked, returning 't' if all of them are registered. If 'f', only -an exact match with content_type will be performed.include_subtypes:  If 't', all subtypes of the content_type +will be checked, returning 't' if all of them are +registered. If 'f', only an exact match with +content_type will be performed.
    Declaration:
    
+Declaration:
    
 function is_registered (
   folder_id             in cr_folders.folder_id%TYPE,
   content_type          in cr_folder_type_map.content_type%TYPE,
   include_subtypes      in varchar2 default 'f'
 ) return varchar2;
 
-
    
+
    See Also:content_folder.register_content_type, content_folder.unregister_content_type,

     

  • Function: content_folder.is_sub_folder -

    Determine if the item target_folder_id is a subfolder -of the item folder_id +

    Determine if the item target_folder_id is a subfolder +of the item folder_id

    - +
    Author:Karl Goldstein
    Returns:'t' if the item target_folder_id is a -subfolder of the item folder_id, 'f' otherwiseReturns:'t' if the item +target_folder_id is a subfolder of the item +folder_id, 'f' otherwise
    Parameters:
    -
    folder_id:  The superfolder id
    target_folder_id:  The subfolder id
    Declaration:
    
+
    Declaration:
    
 function is_sub_folder (
   folder_id             in cr_folders.folder_id%TYPE,
   target_folder_id      in cr_folders.folder_id%TYPE
 ) return char;
 
-
    + See Also:content_folder.is_folder

     

    @@ -179,16 +183,16 @@ revision_id:  The id of the new revision. A new id will be allocated by default -creation_date:  As in acs_object.new +creation_date:  As in acs_object.new -creation_ip:  As in acs_object.new +creation_ip:  As in acs_object.new -creation_user:  As in acs_object.new +creation_user:  As in acs_object.new -Declaration:
    
+Declaration:
    
 function new (
   name          in cr_items.name%TYPE,
   label         in cr_folders.label%TYPE,
@@ -202,7 +206,7 @@
   creation_ip   in acs_objects.creation_ip%TYPE default null
 ) return cr_folders.folder_id%TYPE;
 
-
    
+
    See Also:acs_object.new, content_item.new

     

    @@ -220,13 +224,13 @@ target_folder_id:  The destination folder -Declaration:
    
+Declaration:
    
 procedure copy (
   folder_id             in cr_folders.folder_id%TYPE,
   target_folder_id      in cr_folders.folder_id%TYPE
 );
 
-
    
+
    See Also:content_folder.new, content_folder.copy

     

    @@ -238,12 +242,12 @@ Author:Karl Goldstein Parameters:
    -
    folder_id:  The id of the folder to delete
    Declaration:
    
+Declaration:
    
 procedure delete (
   folder_id     in cr_folders.folder_id%TYPE
 );
 
-
    
+
    See Also:acs_object.delete, content_item.delete

     

    @@ -261,13 +265,13 @@ target_folder_id:  The destination folder -Declaration:
    
+Declaration:
    
 procedure move (
   folder_id             in cr_folders.folder_id%TYPE,
   target_folder_id      in cr_folders.folder_id%TYPE
 );
 
-
    
+
    See Also:content_folder.new, content_folder.copy

     

    @@ -285,14 +289,14 @@ content_type:  The content type to be registered -Declaration:
    
+Declaration:
    
 procedure register_content_type (
   folder_id             in cr_folders.folder_id%TYPE,
   content_type          in cr_folder_type_map.content_type%TYPE,
   include_subtypes      in varchar2 default 'f'
 );
 
-
    
+
    See Also:content_folder.unregister_content_type, content_folder.is_registered @@ -307,24 +311,24 @@ folder_id:  The id of the folder to modify name:  The new name for the folder. An error will be thrown if an item -with this name already exists under this folder's parent. If this -parameter is null, the old name will be preserved +with this name already exists under this folder's parent. If +this parameter is null, the old name will be preserved label:  The new label for the folder. The old label will be preserved if this parameter is null label:  The new description for the folder. The old description will be preserved if this parameter is null -Declaration:
    
+Declaration:
    
 procedure rename (
   folder_id      in cr_folders.folder_id%TYPE,
   name           in cr_items.name%TYPE default null,
   label          in cr_folders.label%TYPE default null,
   description    in cr_folders.description%TYPE default null
 );
 
-
    
+
    See Also:content_folder.new

     

    @@ -343,17 +347,17 @@ content_type:  The content type to be unregistered -include_subtypes:  If 't', all subtypes of content_type will be +include_subtypes:  If 't', all subtypes of content_type will be unregistered as well -Declaration:
    
+Declaration:
    
 procedure unregister_content_type (
   folder_id             in cr_folders.folder_id%TYPE,
   content_type          in cr_folder_type_map.content_type%TYPE,
   include_subtypes      in varchar2 default 'f'
 );
 
-
    
+
    See Also:content_folder.register_content_type, content_folder.is_registered @@ -362,5 +366,5 @@

     

    -Last Modified: $‌Id: folder.html,v 1.2.18.1 2016/06/09 08:21:01 +Last Modified: $‌Id: folder.html,v 1.2.18.2 2016/06/22 07:40:41 gustafn Exp $