Overview    Package  Object Type   Deprecated   Index   Help  
Oracle Application Server Portal PL/SQL API Reference - 10.1.4
PREV PACKAGE    NEXT PACKAGE FRAMES    NO FRAMES
SUMMARY: EXCEPTION | TYPE | CONSTANT | VARIABLE | FUNCTION/PROCEDURE DETAIL: EXCEPTION | TYPE | CONSTANT | VARIABLE | FUNCTION/PROCEDURE

Package wwsbr_api

This package contains the supported Content Repository APIs for OracleAS Portal 10G version 10.1.4. These APIs are backward compatible with the Oracle9iAS Portal 3.0.9 Content Area APIs, except as noted. To maintain compatibility, many of the API signatures (procedure and parameter names) continue to use 3.0.9 object names, page groups are referred to as content areas, pages are referred to as folders, and navigation pages are referred to as navigation bars. Other than procedure and parameter names, this document employs the new terminology. For more information about these APIs and examples of how to use them, refer to the Oracle Application Server Developer's Guide, available on the Oracle Technology Network (http://www.oracle.com/technology/products/ias/portal).

Differences Between 3.0.9 and 10.1.4 APIs

In this release, these APIs are backwards compatible with the 3.0.9 APIs, with the following exceptions:

  • Programs calling the APIs must now process cache invalidations, as described below.
  • Search folders are no longer supported in OracleAS Portal 10G. Therefore, the constant FOLDER_TYPE_SEARCH is deprecated and this value can no longer be used in add_folder.
  • Application component and Java application item types are no longer supported in OracleAS Portal 10G. The related constants ITEM_TYPE_APP_COMP, ITEM_TYPE_SIMPLE_APP_COMP, ITEM_TYPE_JAVA_APP, and ITEM_TYPE_SIMPLE_JAVA_APP have been deprecated and these values can no longer be used in the add_item APIs. The parameters p_app_component, p_app_param_screen, p_jarfile_filename, p_initial_page_name, and p_java_app_type in add_item(), add_item_post_upload(), modify_item(), and modify_item_post_upload() have been removed.
  • The item region IDs used in 3.0.9 (values 1 - 5) are no longer used. For backward compatibility, an item is added to the default item region on a page if one of these region IDs is used in the add_item APIs.
  • Certain constants and exceptions are no longer used. These have been noted in the documentation.
  • The parameter p_root_folder_type in the add_content_area() function has been deprecated. The root page of a page group must be a standard page.
  • The parameter p_master_item_id in the add_item() and add_item_post_upload() functions has been deprecated. Do not use this parameter. Any value passed to it (other than null) may cause errors.
  • The content area search API (WWSBR_SEARCH_API) package has been deprecated.

New functions and new parameters to support the new functionality have been added to the API set, as noted in this documentation. For a full description of the new functionality and how it compares to the 3.0.9 release, please see the OracleAS Portal 10G Upgrade Guide or the tech note "What Happened to Content Areas?", both available on Portal Center.

See Secure Content Repository Views for more information.

Scope:
Public



Exception Summary
ATTRIBUTE_NOT_FOUND
Raised when an invalid attribute is passed.
CANNOT_ASSIGN_ITEM_TEMPLATE
Raised while trying to assign item template to an item which cannot be assigned one.
CANNOT_DELETE_ROOT_PAGE
Raised when trying to delete a root page of a page group.
CANNOT_INSERT_DOCUMENT
Raised when an attempt to upload a blob to the document table fails.
CATEGORY_NOT_FOUND
Raised when an invalid category is passed.
DRAFT_OR_PENDING_EXISTS
Raised when editing an item not consistent with draft or pending status of item.
DUPLICATE_ID
This exception is deprecated.
DUPLICATE_NAME
Raised when an object with the same name already exists.
EDIT_CHARACTER_SET_ERROR
Raised when error occurs while trying to edit CHARACTER SET attribute.
EDIT_CUSTOM_ATTR
Raised when error occurs while trying to modify a custom attribute.
EDIT_MIME_TYPE_ERROR
Raised when error occurs while trying to edit MIME TYPE attribute.
EDIT_PORTAL_SMART_LINK
Raised when error occurs while trying to edit smart link attribute.
EDIT_PORTAL_SMART_TEXT
Raised when error occurs while trying to edit smart text attribute.
EDIT_ROLLOVER_IMAGE_ERROR
Raised when error occurs while trying to edit rollover image attribute.
FOLDER_VERSIONING_IS_AUDIT
Raised when attempting to update the current version of an item but page versioning is set to AUDIT.
FOLDER_VERSIONING_IS_NONE
Raised when attempting to add a new version of an item but page versioning is set to NONE.
ILS_DISABLED
Raised when attempting to set item level access privileges when Item Level Security is not enabled for the page.
ILS_DISABLED_FOR_ITEM
Raised when attempting to add access privileges to an item but the item is not set up to use ILS privileges.
INVALID_CACHE_EXPIRY
Raised when the value for cache expiry is invalid.
INVALID_CAID
Raised when an invalid page group is specified.
INVALID_CATEGORY
Raised when the value of p_parent_id for a category is invalid.
INVALID_CHARACTER_SET_VALUE
Raised when an invalid value is passed to p_attribute_value in case of CHARACTER SET attribute.
INVALID_CHECKOUT_VALUE
Raised when an invalid value is passed in case of ITEMCHECKOUT attribute.
INVALID_DATE_FORMAT
Raised when an invalid date (in the wrong format) is passed.
INVALID_DISPLAY_OPT_VALUE
Raised when an invalid value is passed in case of DISPLAYOPTION attribute.
INVALID_EXPIRATION_PER_VALUE
Raised when the attribute value passed is neither a number nor a date in case of EXPIRATION PER attribute.
INVALID_EXPIRE_DATE
Raised when the value of p_expire_mode is EXP_DATE and an invalid date is passed for p_expiration.
INVALID_EXPIRE_DATE_FORMAT
Raised when the value of p_expire_mode is EXP_DATE and an invalid date format is passed for p_expiration.
INVALID_EXPIRE_NUMBER
Raised when the value of p_expire_mode is EXP_NUMBER and an invalid number is passed for p_expiration.
INVALID_FOLDER
Raised when the value of p_parent_id for a folder is invalid.
INVALID_ID
Raised when an invalid value is passed (in format siteid_id) in attribute value.
INVALID_IMAGE_ALIGN_VALUE
Raised when an invalid value is passed in case of ATTRIBUTE_IMAGEALIGN attribute.
INVALID_ITEM_ID
Raised in currently unsupported routines .
INVALID_ITEM_LINK_SITE_ID
Raised while trying to create an item link pointing to an item on some other pagegroup, which is not valid.
INVALID_ITEM_TEMPLATE_VALUE
Raised when portal template does not exist for the attribute value (id and siteid) passed in case of item template attribute.
INVALID_ITEMTYPE
This exception is deprecated.
INVALID_LOV_VALUE
Raised when an invalid value is passed (a value that does not match with one of the values in the LOV).
INVALID_MIME_TYPE_VALUE
Raised when an invalid value is passed to p_attribute_value in case of MIME TYPE attribute.
INVALID_MODE
Raised when an invalid mode is specified when deleting an item.
INVALID_MOVE
Raised when trying to move an object to be a child of the object itself.
INVALID_NAME
Raised when a value containing spaces or special characters is passed to p_name.
INVALID_NUMBER
Raised when an non-numeric value is passed to a NUMBER parameter.
INVALID_PAGE_TIMEOUT
Raised when the value for page timeout is invalid.
INVALID_PERSPECTIVE
Raised when the value of p_parent_id for a perspective is invalid.
INVALID_PLSQL_EXECUTE_USER
Raised when the value for p_plsql_execute_user or plsql_executor of the page record is invalid.
INVALID_PUBLISH_DATE_FORMAT
Raised when the date format for p_publish_date is invalid.
INVALID_PUBLISH_DATE_VALUE
Raised when the date value for publish date is invalid (Publish date must be today or later and publish date must be greater than the expiry date).
INVALID_SMART_LINK_VALUE
Raised when an invalid value is passed to p_attribute_value in case of SMART LINK attribute.
INVALID_SMART_TEXT_VALUE
Raised when an invalid value is passed to p_attribute_value in case of SMART TEXT attribute.
INVALID_TEMPLATE_FOR_ITEMS
Raised when the template defined for the page's items does not contain a placeholder item.
INVALID_USERNAME
Raised when an invalid user name is passed for the PL/SQL execute options.
INVALID_VERSION_NUMBER
Raised when an invalid number is entered for the version number attribute.
ITEM_ACTIVE_VERSION
Raised when the current version is specified.
ITEM_ALREADY_CHECKED_OUT
Raised while trying to checkout an item that is already checked out.
ITEM_ALREADY_DELETED
Raised when an already deleted version is specified.
ITEM_CHECKED_OUT
Raised when deleting an item and either it is checked out or one (or more) of its sub-items is checked out (at any level) by another user.
ITEM_CREATION_ERROR
Raised when there is an unspecified error in adding an item.
ITEM_NOT_FOR_UPDATE
Raised when the status of item is either Rejected, Deleted or Marked for delete.
ITEM_NOT_FOUND_ERROR
Raised when the value of p_master_item_id for an item is invalid.
ITEM_UPDATE_ERROR
Raised when there is an unspecified error modifying an item.
LOCAL_OBJECT
Raised when attempting to copy or move an item across page groups.
MISSING_DISPLAY_NAME
Raised when the required value p_display_name is not passed.
MISSING_ITEM_TYPE
Raised when the required value p_type_id is not passed for an item.
MISSING_NAME
Raised when the required value p_name is not passed.
MISSING_PLSQL_EXECUTE_USER
Raised when the required value p_plsql_execute_user is not passed or plsql_executor of the page record is empty.
MISSING_TEMPLATE_FOR_ITEMS
Raised when the template defined for the page's items does not exist.
NAME_NOT_UNIQUE
Raised when the item name is not unique.
NAME_TOO_LONG
Raised when a value exceeding the maximum limit (60 characters) is passed to p_name.
NO_ITEM_REGION
Raised when an attempt is made to add an item to a page that does not contain an item region.
NO_MASTER_ITEM_ID
This exception is deprecated.
NOT_AN_ITEM_REGION
Raised when the region id passed is not an item region.
NOT_AUTHORIZED_USER
Raised when the user trying to modify the item is neither the approver nor the user who has checked-out the item.
NOT_AVAIL_FOR_CHECK_OUT
Raised while trying to checkout an item that has not been enabled for checkout.
NOT_ENOUGH_PRIVS
Raised when the calling user does not have the correct authorization.
NULL_ATTRIBUTE_NAME
Raised when null value is passed to p_attribute_value for NAME attribute.
NULL_ATTRIBUTE_VALUE
Raised when null value is passed to p_attribute_value in case of a REQUIRED attribute.
NULL_EXPIRATION_PERIOD
Raised when null value is passed to p_attribute_value in case of EXPIRATION PERIOD attribute.
NULL_EXPIRE_DATE
Raised when p_expire_mode is EXP_DATE and no value is passed for p_expiration.
NULL_EXPIRE_NUMBER
Raised when p_expire_mode is EXP_NUMBER and no value is passed for p_expiration.
NULL_PUBLISH_DATE
Raised when null value is passed to p_attribute_value in case of PUBLISH DATE attribute.
NULL_USER_NAME
Raised when no user name is passed for the PL/SQL execute options.
PAGE_NOT_FOUND
Raised when an invalid page is passed.
PENDING_ITEMS_EXIST
Raised when an inappropriate action is performed on an item that has a pending sub-item (at any level).
PERMISSION_DENIED
Raised when the calling user does not have the correct authorization.
PLSQL_REQUIRED
Raised when a PLSQL value is not passed to the p_value parameter while creating a page based on the PLSQL base type or modifying such a page with empty plsql code in the page record.
QUOTA_EXCEEDED
Raised when the added/modified item exceeds the page group quota.
REGION_NOT_FOUND
Raised when an invalid region id is passed.
REQD_ATTR_MISSING
Raised when a required attribute is not passed while adding an item.
SUBTYPEATTRIBUTE_NOT_FOUND
Raised when an item type-attribute association does not exist.
TEXT_TOO_LONG
Raised when the value passed to a text attribute is more than 32K.
UNKNOWN_ERROR
Raised when an unknown error occurs.
URL_REQUIRED
Raised when a URL value is not passed to the p_value parameter while creating a page based on the URL base type.

Type Summary
g_array
 subtype
g_caid_array
 subtype
g_perspectiveidarray
 subtype
page_record
 subtype

Constant Summary
ALIGN_ABSOLUTE_BOTTOM
 varchar2(30)
ALIGN_ABSOLUTE_MIDDLE
 varchar2(30)
ALIGN_BASELINE
 varchar2(30)
ALIGN_BOTTOM
 varchar2(30)
ALIGN_IMAGE_ABOVE_LINK
 varchar2(30)
ALIGN_LEFT
 varchar2(30)
ALIGN_MIDDLE
 varchar2(30)
ALIGN_RIGHT
 varchar2(30)
ALIGN_TEXT_TOP
 varchar2(30)
ALIGN_TOP
 varchar2(30)
ARABIC_LANGUAGE
 varchar2(3)
ATTR_DISPLAY_TYPE
 number
ATTR_ELEMENT_MAP_TYPE
 number
ATTR_FUNCTION_ID
 number
ATTR_LOGIN_IMAGE
 number
ATTR_LOGIN_LINK
 number
ATTR_LOGOUT_IMAGE
 number
ATTR_LOGOUT_LINK
 number
ATTR_OBJECT_LIST
 number
ATTR_OBJECT_TYPE_LIST
 number
ATTR_PATH_DEPTH
 number
ATTR_PATH_SEPARATOR
 number
ATTR_PORTAL_SMART_LINK
 number
ATTR_SEARCH_BOX_WIDTH
 number
ATTR_SEARCH_PAGE_GROUP_ID
 number
ATTR_TEXT_TYPE
 number
ATTRIBUTE_AUTHOR
 pls_integer
ATTRIBUTE_CATEGORY
 pls_integer
ATTRIBUTE_CHARSET
 pls_integer
ATTRIBUTE_DESCRIPTION
 pls_integer
ATTRIBUTE_DISP_NAME_DEF
 pls_integer
ATTRIBUTE_DISPLAYOPTION
 pls_integer
ATTRIBUTE_EXPIRATIONPER
 pls_integer
ATTRIBUTE_FILE
 pls_integer
ATTRIBUTE_IMAGE
 pls_integer
ATTRIBUTE_IMAGEALIGN
 pls_integer
ATTRIBUTE_IMAGEMAP
 pls_integer
ATTRIBUTE_ITEM_LINK
 pls_integer
ATTRIBUTE_ITEM_TEMPLATE
 pls_integer
ATTRIBUTE_ITEMCHECKOUT
 pls_integer
ATTRIBUTE_KEYWORDS
 pls_integer
ATTRIBUTE_MIME_TYPE
 pls_integer
ATTRIBUTE_NAME
 pls_integer
ATTRIBUTE_PAGE_LINK
 pls_integer
ATTRIBUTE_PERSPECTIVES
 pls_integer
ATTRIBUTE_PLSQL
 pls_integer
ATTRIBUTE_PUBLISHDATE
 pls_integer
ATTRIBUTE_ROLLOVERIMAGE
 pls_integer
ATTRIBUTE_SMARTLINK
 pls_integer
ATTRIBUTE_SMARTTEXT
 pls_integer
ATTRIBUTE_TEXT
 pls_integer
ATTRIBUTE_TITLE
 pls_integer
ATTRIBUTE_URL
 number
ATTRIBUTE_USE_DISP_NAME_DEF
 pls_integer
ATTRIBUTE_VERSION_NUMBER
 pls_integer
BRAZILIAN_PORTUGUESE_LANG
 varchar2(3)
CANADIAN_FRENCH_LANGUAGE
 varchar2(3)
CREATOR_SCHEMA
 varchar2(20)
CROTIAN_LANGUAGE
 varchar2(3)
CZECH_LANGUAGE
 varchar2(3)
DANISH_LANGUAGE
 varchar2(3)
DATA_TYPE_DATE
 varchar2(30)
DATA_TYPE_FILE
 varchar2(30)
DATA_TYPE_NUMBER
 varchar2(30)
DATA_TYPE_OTHER
 varchar2(30)
DATA_TYPE_TEXT
 varchar2(30)
DB_USER
 varchar(20)
DELETE_ITEM_DEFAULT
 varchar2(30)
DELETE_ITEM_LAZYDELETE
 varchar2(30)
DELETE_ITEM_PURGE
 varchar2(30)
DISABLE_ITEM_FOR_CHECK_OUT
 number
DUTCH_LANGUAGE
 varchar2(3)
ENABLE_ITEM_FOR_CHECK_OUT
 number
ENGLISH_LANGUAGE
 varchar2(3)
EXP_DATE
 varchar2(20)
EXP_NUMBER
 varchar2(20)
FINNISH_LANGUAGE
 varchar2(3)
FOLDER_ACCESS
 varchar2(30)
FOLDER_TYPE_CONTAINER
 number
FOLDER_TYPE_PLSQL
 number
FOLDER_TYPE_SEARCH
This value is deprecated.
 number
FOLDER_TYPE_URL
 number
FRENCH_LANGUAGE
 varchar2(3)
FULL_SCREEN
 varchar2(30)
GENERAL_CATEGORY
 number
GERMAN_LANGUAGE
 varchar2(3)
GREEK_LANGUAGE
 varchar2(3)
HEBREW_LANGUAGE
 varchar2(3)
HUNGARIAN_LANGUAGE
 varchar2(3)
IN_FRAME
 varchar2(30)
IN_PLACE
 varchar2(30)
IS_OFF
 number
IS_ON
 number
ITALIAN_LANGUAGE
 varchar2(3)
ITEM_ACCESS
 varchar2(30)
ITEM_CHECKEDOUT
 number
ITEM_NOT_CHECKEDOUT
 number
ITEM_TYPE_APP_COMP
This value is deprecated.
 number
ITEM_TYPE_BASIC_SEARCH
 number
ITEM_TYPE_ELEMENT_LIST
 number
ITEM_TYPE_FILE
 number
ITEM_TYPE_FOLDER_LINK
 number
ITEM_TYPE_IMAGE
 number
ITEM_TYPE_IMAGE_MAP
 number
ITEM_TYPE_JAVA_APP
This value is deprecated.
 number
ITEM_TYPE_LOGIN_LOGOUT
 number
ITEM_TYPE_MAP_LINK
 number
ITEM_TYPE_PAGE_FUNCTION
 number
ITEM_TYPE_PAGE_PATH
 number
ITEM_TYPE_PLSQL
 number
ITEM_TYPE_PORTLET_INST
 number
ITEM_TYPE_SIMPLE_APP_COMP
This value is deprecated.
 number
ITEM_TYPE_SIMPLE_FILE
 number
ITEM_TYPE_SIMPLE_IMAGE
 number
ITEM_TYPE_SIMPLE_JAVA_APP
This value is deprecated.
 number
ITEM_TYPE_SIMPLE_PAGE_LINK
 number
ITEM_TYPE_SIMPLE_PLSQL
 number
ITEM_TYPE_SIMPLE_TEXT
 number
ITEM_TYPE_SIMPLE_URL
 number
ITEM_TYPE_SMART_LINK
 number
ITEM_TYPE_SMART_TEXT
 number
ITEM_TYPE_TEXT
 number
ITEM_TYPE_URL
 number
ITEM_TYPE_ZIP_FILE
 number
JAPANESE_LANGUAGE
 varchar2(3)
KOREAN_LANGUAGE
 varchar2(3)
NEW_WINDOW
 varchar2(30)
NO
 number
NORWEGIAN_LANGUAGE
 varchar2(3)
PERMANENT
 varchar2(20)
POLISH_LANGUAGE
 varchar2(3)
PORTUGUESE_LANGUAGE
 varchar2(3)
PUBLIC_SCHEMA
 varchar2(20)
ROMANIAN_LANGUAGE
 varchar2(3)
RUSSIAN_LANGUAGE
 varchar2(3)
SHARED_OBJECTS
 number
SIMPLIFIED_CHINESE_LANGUAGE
 varchar2(3)
SLOVAK_LANGUAGE
 varchar2(3)
SMART_TEXT_CURRENT_DATE
 varchar2(30)
SMART_TEXT_CURRENT_PAGE
 varchar2(30)
SMART_TEXT_CURRENT_USER
 varchar2(30)
SPANISH_ARGENTINA_LANGUAGE
 varchar2(3)
SPANISH_LANGUAGE
 varchar2(3)
SWEDISH_LANGUAGE
 varchar2(3)
THAI_LANGUAGE
 varchar2(3)
TRADITIONAL_CHINESE_LANGUAGE
 varchar2(3)
TURKISH_LANGUAGE
 varchar2(3)
VALUE_ACCOUNT_INFO
 varchar2(30)
VALUE_ADVANCED_SEARCH
 varchar2(30)
VALUE_APP_SHOCKWAVE_FLASH
 varchar2(50)
VALUE_APPLICATION_ANDREW_INSET
 varchar2(50)
VALUE_APPLICATION_BCPIO
 varchar2(50)
VALUE_APPLICATION_CD_LINK
 varchar2(50)
VALUE_APPLICATION_CHESS_PGN
 varchar2(50)
VALUE_APPLICATION_CPIO
 varchar2(50)
VALUE_APPLICATION_CSH
 varchar2(50)
VALUE_APPLICATION_DIRECTOR
 varchar2(50)
VALUE_APPLICATION_DVI
 varchar2(50)
VALUE_APPLICATION_FUTURE_SPLSH
 varchar2(50)
VALUE_APPLICATION_HDF
 varchar2(50)
VALUE_APPLICATION_JAVASCRIPT
 varchar2(50)
VALUE_APPLICATION_KOAN
 varchar2(50)
VALUE_APPLICATION_LATEX
 varchar2(50)
VALUE_APPLICATION_MAC_BIN_HEX
 varchar2(50)
VALUE_APPLICATION_MAC_COMPACT
 varchar2(50)
VALUE_APPLICATION_MS_EXCEL
 varchar2(50)
VALUE_APPLICATION_MSWORD
 varchar2(50)
VALUE_APPLICATION_NETCDF
 varchar2(50)
VALUE_APPLICATION_OCTET_STREAM
 varchar2(50)
VALUE_APPLICATION_ODA
 varchar2(50)
VALUE_APPLICATION_PDF
 varchar2(50)
VALUE_APPLICATION_POST_SCRIPT
 varchar2(50)
VALUE_APPLICATION_POWER_POINT
 varchar2(50)
VALUE_APPLICATION_RTF
 varchar2(50)
VALUE_APPLICATION_SH
 varchar2(50)
VALUE_APPLICATION_SHAR
 varchar2(50)
VALUE_APPLICATION_SMIL
 varchar2(50)
VALUE_APPLICATION_STUFFIT
 varchar2(50)
VALUE_APPLICATION_SV4CPIO
 varchar2(50)
VALUE_APPLICATION_SV4CRC
 varchar2(50)
VALUE_APPLICATION_TAR
 varchar2(50)
VALUE_APPLICATION_TCL
 varchar2(50)
VALUE_APPLICATION_TEX
 varchar2(50)
VALUE_APPLICATION_TEX_INFO
 varchar2(50)
VALUE_APPLICATION_TROFF
 varchar2(50)
VALUE_APPLICATION_TROFF_MAN
 varchar2(50)
VALUE_APPLICATION_TROFF_ME
 varchar2(50)
VALUE_APPLICATION_TROFF_MS
 varchar2(50)
VALUE_APPLICATION_USTAR
 varchar2(50)
VALUE_APPLICATION_WAIS_SOURCE
 varchar2(50)
VALUE_APPLICATION_XGTAR
 varchar2(50)
VALUE_APPLICATION_ZIP
 varchar2(50)
VALUE_AUDIO_AIFF
 varchar2(50)
VALUE_AUDIO_BASIC
 varchar2(50)
VALUE_AUDIO_MIDI
 varchar2(50)
VALUE_AUDIO_MPEG
 varchar2(50)
VALUE_AUDIO_RMF
 varchar2(50)
VALUE_AUDIO_WAV
 varchar2(50)
VALUE_AUDIO_XWAV
 varchar2(50)
VALUE_AUIDO_REAL_AUDIO
 varchar2(50)
VALUE_BIG5
 varchar2(20)
VALUE_BUILDER
 varchar2(30)
VALUE_CHEMICAL_PDB
 varchar2(50)
VALUE_COMMUNITY
 varchar2(30)
VALUE_CONTACT
 varchar2(30)
VALUE_CURRENT_DATE
 varchar2(30)
VALUE_CURRENT_PAGE
 varchar2(30)
VALUE_CURRENT_USER
 varchar2(30)
VALUE_CUST_MOBILE_HOME_PAGE
 varchar2(30)
VALUE_CUSTOMIZE_PAGE
 varchar2(30)
VALUE_EDIT_PAGE
 varchar2(30)
VALUE_EUC_JP
 varchar2(20)
VALUE_FAVOURITES
 varchar2(30)
VALUE_GBK
 varchar2(20)
VALUE_HELP
 varchar2(30)
VALUE_IMAGE_BMP
 varchar2(50)
VALUE_IMAGE_CMU_RASTER
 varchar2(50)
VALUE_IMAGE_GIF
 varchar2(50)
VALUE_IMAGE_IEF
 varchar2(50)
VALUE_IMAGE_JPEG
 varchar2(50)
VALUE_IMAGE_PNG
 varchar2(50)
VALUE_IMAGE_PORTABLE_ANYMAP
 varchar2(50)
VALUE_IMAGE_PORTABLE_BITMAP
 varchar2(50)
VALUE_IMAGE_PORTABLE_GRAYMAP
 varchar2(50)
VALUE_IMAGE_PORTABLE_PIXMAP
 varchar2(50)
VALUE_IMAGE_RGB
 varchar2(50)
VALUE_IMAGE_TIFF
 varchar2(50)
VALUE_IMAGE_XBITMAP
 varchar2(50)
VALUE_IMAGE_XPIXMAP
 varchar2(50)
VALUE_IMAGE_XWINDOW_DUMP
 varchar2(50)
VALUE_ISO_8859
 varchar2(20)
VALUE_M0DEL_MESH
 varchar2(50)
VALUE_MODEL_IGES
 varchar2(50)
VALUE_MODEL_VRML
 varchar2(50)
VALUE_NAVIGATOR
 varchar2(30)
VALUE_PAGE_GROUP_HOME
 varchar2(30)
VALUE_PERSONAL_PAGE
 varchar2(30)
VALUE_PORTAL_HOME
 varchar2(30)
VALUE_PORTLET_REPOS
 varchar2(30)
VALUE_PORTLET_REPOS_REF_STATUS
 varchar2(30)
VALUE_PROPERTY_SHEET
 varchar2(30)
VALUE_REAL_AUDIO
 varchar2(50)
VALUE_REAL_AUDIO_PLUGIN
 varchar2(50)
VALUE_REF_PORTLET_REPOS
 varchar2(30)
VALUE_REFRESH_PAGE
 varchar2(30)
VALUE_SHIFT_JIS
 varchar2(20)
VALUE_SUBSCRIBE
 varchar2(30)
VALUE_TEXT_CSS
 varchar2(50)
VALUE_TEXT_HTML
 varchar2(50)
VALUE_TEXT_PLAIN
 varchar2(50)
VALUE_TEXT_RICHTEXT
 varchar2(50)
VALUE_TEXT_SETEXT
 varchar2(50)
VALUE_TEXT_SGML
 varchar2(50)
VALUE_TEXT_TAB_SEP_VALUES
 varchar2(50)
VALUE_TEXT_XML
 varchar2(50)
VALUE_US_ASCII
 varchar2(20)
VALUE_UTF8
 varchar2(20)
VALUE_VIDEO_COOLTALK
 varchar2(50)
VALUE_VIDEO_MPEG
 varchar2(50)
VALUE_VIDEO_MSVIDEO
 varchar2(50)
VALUE_VIDEO_QUICKTIME
 varchar2(50)
VALUE_VIDEO_SGI_MOVIE
 varchar2(50)
VALUE_WINDOWS_1252
 varchar2(20)
VERSIONING_AUDIT
 varchar2(30)
VERSIONING_NONE
 varchar2(30)
VERSIONING_SIMPLE
 varchar2(30)
YES
 number

Variable Summary
g_empty_array
 g_array
g_empty_caid_array
 g_caid_array
g_perspectiveidemptyarray
 g_perspectiveidarray

Function/Procedure Summary
add_category
Creates a new category in a page group.
 number
add_content_area
Creates a new page group.
 number
add_folder
Creates a new page in a page group.
 number
add_item
Creates a new item on a specified page in a page group.
 number
add_item_ils_privileges
Adds item level security access privileges for one or more users or groups to a single specified item.
 
add_item_post_upload
Creates a new item on a page and links it to existing document(s) in the document table.
 number
add_perspective
Creates a new perspective in a page group.
 number
approve
Approves an item that has been submitted for approval.
 
check_in_item
Checks in an item, provided it is checked-out.
 
check_out_item
Checks out an item, provided the item is enabled for check-out.
 
clear_cmef_context
Clears the Content Management Event Framework (CMEF) context.
 
copy_folder
Copy a page within the same page group.
 number
copy_item
Copies an item to a page either within the same page group or across page groups.
 number
delete_folder
Delete a page.
 
delete_ils_privilege
Deletes the item level security access privileges for a user or group on a single specified item.
 
delete_item
Deletes an item present in a particular page and page group.
 
enable_ils_for_item
Enables item level security for a specified item.
 
inherit_folder_privileges
Causes an item that is enabled for item level security to inherit its privileges from the page on which it resides.
 
modify_folder
Modifies a page's properties.
 
modify_item
Modifies an item in a particular page and page group.
 number
modify_item_post_upload
Modifies an item and links it to existing document(s) in the document table.
 number
move_category
Moves a category within a pagegroup.
 
move_folder
Move a page to be another page's sub page within the same page group.
 
move_item
Move an item either within the same page group or across page groups.
 
move_perspective
The procedure to move a perspective within a pagegroup.
 
reject
Rejects an item that has been submitted for approval.
 
set_attribute
Modifies attribute values for a particular version of an item.
 
undelete_item
Unndeletes an item (and its sub-items).
 
upload_blob
Uploads document content to the document table.
 varchar2

Exception Detail

ATTRIBUTE_NOT_FOUND

       
ATTRIBUTE_NOT_FOUND exception
    
Raised when an invalid attribute is passed. The following routines raise this exception:
  • set_attribute

CANNOT_ASSIGN_ITEM_TEMPLATE

       
CANNOT_ASSIGN_ITEM_TEMPLATE exception
    
Raised while trying to assign item template to an item which cannot be assigned one. The following routines raise this exception:
  • set_attribute

CANNOT_DELETE_ROOT_PAGE

       
CANNOT_DELETE_ROOT_PAGE exception
    
Raised when trying to delete a root page of a page group. Routine delete_folder raises this exception.

CANNOT_INSERT_DOCUMENT

       
CANNOT_INSERT_DOCUMENT exception
    
Raised when an attempt to upload a blob to the document table fails. The following routines raise this exception:
  • upload_blob

CATEGORY_NOT_FOUND

       
CATEGORY_NOT_FOUND exception
    
Raised when an invalid category is passed. The following routines raise this exception:
  • add_item
  • add_item_post_upload
  • modify_item
  • modify_item_post_upload

DRAFT_OR_PENDING_EXISTS

       
DRAFT_OR_PENDING_EXISTS exception
    
Raised when editing an item not consistent with draft or pending status of item. This occurs in the following scenarios:
  • Edit active version of the item when draft exists.
  • Edit draft created by another user.
  • Edit item pending for approval.
The following routines raise this exception:
  • modify_item
  • modify_item_post_upload

DUPLICATE_ID

       
DUPLICATE_ID exception
    
This exception is deprecated.

DUPLICATE_NAME

       
DUPLICATE_NAME exception
    
Raised when an object with the same name already exists. The following routines raise this exception:
  • add_content_area
  • add_folder
  • modify_folder
  • copy_folder
  • move_folder
  • add_category
  • add_perspective

EDIT_CHARACTER_SET_ERROR

       
EDIT_CHARACTER_SET_ERROR exception
    
Raised when error occurs while trying to edit CHARACTER SET attribute. The following routines raise this exception:
  • set_attribute

EDIT_CUSTOM_ATTR

       
EDIT_CUSTOM_ATTR exception
    
Raised when error occurs while trying to modify a custom attribute. The following routines raise this exception:
  • set_attribute

EDIT_MIME_TYPE_ERROR

       
EDIT_MIME_TYPE_ERROR exception
    
Raised when error occurs while trying to edit MIME TYPE attribute. The following routines raise this exception:
  • set_attribute

EDIT_PORTAL_SMART_LINK

       
EDIT_PORTAL_SMART_LINK exception
    
Raised when error occurs while trying to edit smart link attribute. The following routines raise this exception:
  • set_attribute

EDIT_PORTAL_SMART_TEXT

       
EDIT_PORTAL_SMART_TEXT exception
    
Raised when error occurs while trying to edit smart text attribute. The following routines raise this exception:
  • set_attribute

EDIT_ROLLOVER_IMAGE_ERROR

       
EDIT_ROLLOVER_IMAGE_ERROR exception
    
Raised when error occurs while trying to edit rollover image attribute. The following routines raise this exception:
  • set_attribute

FOLDER_VERSIONING_IS_AUDIT

       
FOLDER_VERSIONING_IS_AUDIT exception
    
Raised when attempting to update the current version of an item but page versioning is set to AUDIT. The following routines raise this exception:
  • modify_item
  • modify_item_post_upload

FOLDER_VERSIONING_IS_NONE

       
FOLDER_VERSIONING_IS_NONE exception
    
Raised when attempting to add a new version of an item but page versioning is set to NONE. The following routines raise this exception:
  • modify_item
  • modify_item_post_upload

ILS_DISABLED

       
ILS_DISABLED exception
    
Raised when attempting to set item level access privileges when Item Level Security is not enabled for the page. The following routines raise this exception:
  • modify_item
  • modify_item_post_upload
  • enable_ils_for_item
  • inherit_folder_privileges
  • add_item_ils_privileges

ILS_DISABLED_FOR_ITEM

       
ILS_DISABLED_FOR_ITEM exception
    
Raised when attempting to add access privileges to an item but the item is not set up to use ILS privileges. The following routines raise this exception:
  • add_item_ils_privileges

INVALID_CACHE_EXPIRY

       
INVALID_CACHE_EXPIRY exception
    
Raised when the value for cache expiry is invalid. The following routines raise this exception:
  • modify_folder

INVALID_CAID

       
INVALID_CAID exception
    
Raised when an invalid page group is specified. The following routines raise this exception:
  • move_category
  • move_perspective
  • undelete_item
  • check_out_item
  • check_in_item
  • copy_item
  • move_item
  • delete_item

INVALID_CATEGORY

       
INVALID_CATEGORY exception
    
Raised when the value of p_parent_id for a category is invalid. The following routines raise this exception:
  • add_category
  • move_category

INVALID_CHARACTER_SET_VALUE

       
INVALID_CHARACTER_SET_VALUE exception
    
Raised when an invalid value is passed to p_attribute_value in case of CHARACTER SET attribute. The following routines raise this exception:
  • set_attribute

INVALID_CHECKOUT_VALUE

       
INVALID_CHECKOUT_VALUE exception
    
Raised when an invalid value is passed in case of ITEMCHECKOUT attribute. The following routines raise this exception:
  • set_attribute

INVALID_DATE_FORMAT

       
INVALID_DATE_FORMAT exception
    
Raised when an invalid date (in the wrong format) is passed. The following routines raise this exception:
  • add_item
  • add_item_post_upload
  • modify_item
  • modify_item_post_upload

INVALID_DISPLAY_OPT_VALUE

       
INVALID_DISPLAY_OPT_VALUE exception
    
Raised when an invalid value is passed in case of DISPLAYOPTION attribute. The following routines raise this exception:
  • set_attribute

INVALID_EXPIRATION_PER_VALUE

       
INVALID_EXPIRATION_PER_VALUE exception
    
Raised when the attribute value passed is neither a number nor a date in case of EXPIRATION PER attribute. The following routines raise this exception:
  • set_attribute

INVALID_EXPIRE_DATE

       
INVALID_EXPIRE_DATE exception
    
Raised when the value of p_expire_mode is EXP_DATE and an invalid date is passed for p_expiration. The following routines raise this exception:
  • add_item
  • add_item_post_upload
  • modify_item
  • modify_item_post_upload

INVALID_EXPIRE_DATE_FORMAT

       
INVALID_EXPIRE_DATE_FORMAT exception
    
Raised when the value of p_expire_mode is EXP_DATE and an invalid date format is passed for p_expiration. The following routines raise this exception:
  • add_item
  • add_item_post_upload
  • modify_item
  • modify_item_post_upload

INVALID_EXPIRE_NUMBER

       
INVALID_EXPIRE_NUMBER exception
    
Raised when the value of p_expire_mode is EXP_NUMBER and an invalid number is passed for p_expiration. The following routines raise this exception:
  • add_item
  • add_item_post_upload
  • modify_item
  • modify_item_post_upload

INVALID_FOLDER

       
INVALID_FOLDER exception
    
Raised when the value of p_parent_id for a folder is invalid. The following routines raise this exception:
  • add_folder
  • copy_folder
  • move_folder

INVALID_ID

       
INVALID_ID exception
    
Raised when an invalid value is passed (in format siteid_id) in attribute value. The following routines raise this exception:
  • set_attribute

INVALID_IMAGE_ALIGN_VALUE

       
INVALID_IMAGE_ALIGN_VALUE exception
    
Raised when an invalid value is passed in case of ATTRIBUTE_IMAGEALIGN attribute. The following routines raise this exception:
  • set_attribute

INVALID_ITEM_ID

       
INVALID_ITEM_ID exception
    
Raised in currently unsupported routines . The following routines raise this exception:
  • move_item
  • delete_item

INVALID_ITEM_LINK_SITE_ID

       
INVALID_ITEM_LINK_SITE_ID exception
    
Raised while trying to create an item link pointing to an item on some other pagegroup, which is not valid. An item can be linked to another item only if it belongs to the same pagegroup. The following routines raise this exception:
  • set_attribute

INVALID_ITEM_TEMPLATE_VALUE

       
INVALID_ITEM_TEMPLATE_VALUE exception
    
Raised when portal template does not exist for the attribute value (id and siteid) passed in case of item template attribute. The following routines raise this exception:
  • set_attribute

INVALID_ITEMTYPE

       
INVALID_ITEMTYPE exception
    
This exception is deprecated.

INVALID_LOV_VALUE

       
INVALID_LOV_VALUE exception
    
Raised when an invalid value is passed (a value that does not match with one of the values in the LOV). The following routines raise this exception:
  • add_item
  • add_item_post_upload
  • modify_item
  • modify_item_post_upload

INVALID_MIME_TYPE_VALUE

       
INVALID_MIME_TYPE_VALUE exception
    
Raised when an invalid value is passed to p_attribute_value in case of MIME TYPE attribute. The following routines raise this exception:
  • set_attribute

INVALID_MODE

       
INVALID_MODE exception
    
Raised when an invalid mode is specified when deleting an item. The following routines raise this exception:
  • delete_item

INVALID_MOVE

       
INVALID_MOVE exception
    
Raised when trying to move an object to be a child of the object itself. The following routines raise this exception:
  • move_folder
  • move_item
  • move_category
  • move_perspective

INVALID_NAME

       
INVALID_NAME exception
    
Raised when a value containing spaces or special characters is passed to p_name. The following routines raise this exception:
  • add_content_area
  • add_folder
  • modify_folder
  • copy_folder
  • add_category
  • add_perspective

INVALID_NUMBER

       
INVALID_NUMBER exception
    
Raised when an non-numeric value is passed to a NUMBER parameter. The following routines raise this exception:
  • add_item
  • modify_item

INVALID_PAGE_TIMEOUT

       
INVALID_PAGE_TIMEOUT exception
    
Raised when the value for page timeout is invalid. The following routines raise this exception:
  • modify_folder

INVALID_PERSPECTIVE

       
INVALID_PERSPECTIVE exception
    
Raised when the value of p_parent_id for a perspective is invalid. The following routines raise this exception:
  • add_perspective
  • move_perspective

INVALID_PLSQL_EXECUTE_USER

       
INVALID_PLSQL_EXECUTE_USER exception
    
Raised when the value for p_plsql_execute_user or plsql_executor of the page record is invalid. The following routines raise this exception:
  • add_folder
  • modify_folder

INVALID_PUBLISH_DATE_FORMAT

       
INVALID_PUBLISH_DATE_FORMAT exception
    
Raised when the date format for p_publish_date is invalid. The following routines raise this exception:
  • add_item
  • add_item_post_upload
  • modify_item
  • modify_item_post_upload

INVALID_PUBLISH_DATE_VALUE

       
INVALID_PUBLISH_DATE_VALUE exception
    
Raised when the date value for publish date is invalid (Publish date must be today or later and publish date must be greater than the expiry date). The following routines raise this exception:
  • add_item
  • add_item_post_upload
  • modify_item
  • modify_item_post_upload

INVALID_SMART_LINK_VALUE

       
INVALID_SMART_LINK_VALUE exception
    
Raised when an invalid value is passed to p_attribute_value in case of SMART LINK attribute. The following routines raise this exception:
  • set_attribute

INVALID_SMART_TEXT_VALUE

       
INVALID_SMART_TEXT_VALUE exception
    
Raised when an invalid value is passed to p_attribute_value in case of SMART TEXT attribute. The following routines raise this exception:
  • set_attribute

INVALID_TEMPLATE_FOR_ITEMS

       
INVALID_TEMPLATE_FOR_ITEMS exception
    
Raised when the template defined for the page's items does not contain a placeholder item. The following routines raise this exception:
  • modify_folder

INVALID_USERNAME

       
INVALID_USERNAME exception
    
Raised when an invalid user name is passed for the PL/SQL execute options. The following routines raise this exception:
  • add_item
  • add_item_post_upload
  • modify_item
  • modify_item_post_upload

INVALID_VERSION_NUMBER

       
INVALID_VERSION_NUMBER exception
    
Raised when an invalid number is entered for the version number attribute. The following routines raise this exception:
  • add_item
  • add_item_post_upload
  • modify_item
    • delete_item
  • modify_item_post_upload

ITEM_ACTIVE_VERSION

       
ITEM_ACTIVE_VERSION exception
    
Raised when the current version is specified. The following routines raise this exception:
  • delete_item

ITEM_ALREADY_CHECKED_OUT

       
ITEM_ALREADY_CHECKED_OUT exception
    
Raised while trying to checkout an item that is already checked out. The following routines raise this exception:
  • set_attribute

ITEM_ALREADY_DELETED

       
ITEM_ALREADY_DELETED exception
    
Raised when an already deleted version is specified. The following routines raise this exception:
  • delete_item

ITEM_CHECKED_OUT

       
ITEM_CHECKED_OUT exception
    
Raised when deleting an item and either it is checked out or one (or more) of its sub-items is checked out (at any level) by another user. The following routines raise this exception:
  • delete_item

ITEM_CREATION_ERROR

       
ITEM_CREATION_ERROR exception
    
Raised when there is an unspecified error in adding an item. The following routines raise this exception:
  • add_item
  • add_item_post_upload

ITEM_NOT_FOR_UPDATE

       
ITEM_NOT_FOR_UPDATE exception
    
Raised when the status of item is either Rejected, Deleted or Marked for delete. Such an item cannot be updated. The following routines raise this exception:
  • modify_item
  • set_attribute

ITEM_NOT_FOUND_ERROR

       
ITEM_NOT_FOUND_ERROR exception
    
Raised when the value of p_master_item_id for an item is invalid. The following routines raise this exception:
  • modify_item
  • modify_item_post_upload
  • enable_ils_for_item
  • inherit_folder_privileges
  • add_item_ils_privileges
  • delete_ils_privilege

ITEM_UPDATE_ERROR

       
ITEM_UPDATE_ERROR exception
    
Raised when there is an unspecified error modifying an item. The following routines raise this exception:
  • modify_item
  • modify_item_post_upload

LOCAL_OBJECT

       
LOCAL_OBJECT exception
    
Raised when attempting to copy or move an item across page groups. This ocurs in the following scenarios:
  • The item is based on a local item type.
  • The item has a local category attached to it.
  • The item has one or more local perspectives attached to it.
The following routines raise this exception:
  • copy_item
  • move_item

MISSING_DISPLAY_NAME

       
MISSING_DISPLAY_NAME exception
    
Raised when the required value p_display_name is not passed. The following routines raise this exception:
  • add_content_area
  • add_folder
  • add_category
  • add_perspective

MISSING_ITEM_TYPE

       
MISSING_ITEM_TYPE exception
    
Raised when the required value p_type_id is not passed for an item. The following routines raise this exception:
  • add_item
  • add_item_post_upload
  • modify_item
  • modify_item_post_upload

MISSING_NAME

       
MISSING_NAME exception
    
Raised when the required value p_name is not passed. The following routines raise this exception:
  • add_content_area
  • add_folder
  • add_category
  • add_perspective

MISSING_PLSQL_EXECUTE_USER

       
MISSING_PLSQL_EXECUTE_USER exception
    
Raised when the required value p_plsql_execute_user is not passed or plsql_executor of the page record is empty. The following routines raise this exception:
  • add_folder
  • modify_folder

MISSING_TEMPLATE_FOR_ITEMS

       
MISSING_TEMPLATE_FOR_ITEMS exception
    
Raised when the template defined for the page's items does not exist. The following routines raise this exception:
  • modify_folder

NAME_NOT_UNIQUE

       
NAME_NOT_UNIQUE exception
    
Raised when the item name is not unique. The following routines raise this exception:
  • add_item
  • add_item_post_upload
  • modify_item
  • modify_item_post_upload

NAME_TOO_LONG

       
NAME_TOO_LONG exception
    
Raised when a value exceeding the maximum limit (60 characters) is passed to p_name. The following routines raise this exception:
  • add_content_area
  • add_folder

NO_ITEM_REGION

       
NO_ITEM_REGION exception
    
Raised when an attempt is made to add an item to a page that does not contain an item region. The following routines raise this exception:
  • add_item
  • add_item_post_upload

NO_MASTER_ITEM_ID

       
NO_MASTER_ITEM_ID exception
    
This exception is deprecated.

NOT_AN_ITEM_REGION

       
NOT_AN_ITEM_REGION exception
    
Raised when the region id passed is not an item region. The following routines raise this exception:
  • add_item
  • add_item_post_upload

NOT_AUTHORIZED_USER

       
NOT_AUTHORIZED_USER exception
    
Raised when the user trying to modify the item is neither the approver nor the user who has checked-out the item. The following routines raise this exception:
  • set_attribute

NOT_AVAIL_FOR_CHECK_OUT

       
NOT_AVAIL_FOR_CHECK_OUT exception
    
Raised while trying to checkout an item that has not been enabled for checkout. The following routines raise this exception:
  • set_attribute

NOT_ENOUGH_PRIVS

       
NOT_ENOUGH_PRIVS exception
    
Raised when the calling user does not have the correct authorization. The following routines raise this exception:
  • add_item
  • move_item
  • modify_item
  • enable_ils_for_item
  • inherit_folder_privileges
  • add_item_ils_privileges
  • delete_ils_privilege
  • move_category
  • move_perspective
  • modify_folder
  • add_folder
  • delete_folder
  • copy_folder
  • move_folder

NULL_ATTRIBUTE_NAME

       
NULL_ATTRIBUTE_NAME exception
    
Raised when null value is passed to p_attribute_value for NAME attribute. The following routines raise this exception:
  • set_attribute

NULL_ATTRIBUTE_VALUE

       
NULL_ATTRIBUTE_VALUE exception
    
Raised when null value is passed to p_attribute_value in case of a REQUIRED attribute. The following routines raise this exception:
  • set_attribute

NULL_EXPIRATION_PERIOD

       
NULL_EXPIRATION_PERIOD exception
    
Raised when null value is passed to p_attribute_value in case of EXPIRATION PERIOD attribute. The following routines raise this exception:
  • set_attribute

NULL_EXPIRE_DATE

       
NULL_EXPIRE_DATE exception
    
Raised when p_expire_mode is EXP_DATE and no value is passed for p_expiration. The following routines raise this exception:
  • add_item
  • add_item_post_upload
  • modify_item
  • modify_item_post_upload

NULL_EXPIRE_NUMBER

       
NULL_EXPIRE_NUMBER exception
    
Raised when p_expire_mode is EXP_NUMBER and no value is passed for p_expiration. The following routines raise this exception:
  • add_item
  • add_item_post_upload
  • modify_item
  • modify_item_post_upload

NULL_PUBLISH_DATE

       
NULL_PUBLISH_DATE exception
    
Raised when null value is passed to p_attribute_value in case of PUBLISH DATE attribute. The following routines raise this exception:
  • set_attribute

NULL_USER_NAME

       
NULL_USER_NAME exception
    
Raised when no user name is passed for the PL/SQL execute options. The following routines raise this exception:
  • add_item
  • add_item_post_upload
  • modify_item
  • modify_item_post_upload

PAGE_NOT_FOUND

       
PAGE_NOT_FOUND exception
    
Raised when an invalid page is passed. The following routines raise this exception:
  • modify_folder
  • delete_folder
  • copy_folder
  • move_folder

PENDING_ITEMS_EXIST

       
PENDING_ITEMS_EXIST exception
    
Raised when an inappropriate action is performed on an item that has a pending sub-item (at any level). This occurs with the following actions:
  • Copy (across pages or page groups).
  • Move (across pages or page groups, but not within a page).
  • Delete.
The following routines raise this exception:
  • copy_item
  • move_item
  • delete_item

PERMISSION_DENIED

       
PERMISSION_DENIED exception
    
Raised when the calling user does not have the correct authorization. Similar to NOT_ENOUGH_PRIVS exception. The following routines raise this exception:
  • add_category
  • add_perspective

PLSQL_REQUIRED

       
PLSQL_REQUIRED exception
    
Raised when a PLSQL value is not passed to the p_value parameter while creating a page based on the PLSQL base type or modifying such a page with empty plsql code in the page record. The following routines raise this exception:
  • add_folder
  • modify_folder

QUOTA_EXCEEDED

       
QUOTA_EXCEEDED exception
    
Raised when the added/modified item exceeds the page group quota. The following routines raise this exception:
  • add_item
  • add_item_post_upload
  • modify_item
  • modify_item_post_upload

REGION_NOT_FOUND

       
REGION_NOT_FOUND exception
    
Raised when an invalid region id is passed. The following routines raise this exception:
  • add_item
  • add_item_post_upload

REQD_ATTR_MISSING

       
REQD_ATTR_MISSING exception
    
Raised when a required attribute is not passed while adding an item. The following routines raise this exception:
  • add_item
  • add_item_post_upload

SUBTYPEATTRIBUTE_NOT_FOUND

       
SUBTYPEATTRIBUTE_NOT_FOUND exception
    
Raised when an item type-attribute association does not exist. The following routines raise this exception:
  • set_attribute

TEXT_TOO_LONG

       
TEXT_TOO_LONG exception
    
Raised when the value passed to a text attribute is more than 32K. The following routines raise this exception:
  • add_item
  • add_item_post_upload
  • modify_item
  • modify_item_post_upload

UNKNOWN_ERROR

       
UNKNOWN_ERROR exception
    
Raised when an unknown error occurs. The following routines raise this exception:
  • modify_item
  • delete_item
  • modify_item_post_upload

URL_REQUIRED

       
URL_REQUIRED exception
    
Raised when a URL value is not passed to the p_value parameter while creating a page based on the URL base type. The following routines raise this exception:
  • add_folder

Type Detail

g_array

subtype  
      
g_array is wwsbr_type.array
    

g_caid_array

subtype  
      
g_caid_array is wwsbr_type.array
    

g_perspectiveidarray

subtype  
      
g_perspectiveidarray is wwv_perspectivedb.perspectiveidarray
    

page_record

subtype  
      
page_record is wwpob_api_type.page_record
    

Constant Detail

ALIGN_ABSOLUTE_BOTTOM

       
ALIGN_ABSOLUTE_BOTTOM constant varchar2(30) := 'absbottom'
    

ALIGN_ABSOLUTE_MIDDLE

       
ALIGN_ABSOLUTE_MIDDLE constant varchar2(30) := 'absmiddle'
    

ALIGN_BASELINE

       
ALIGN_BASELINE constant varchar2(30) := 'baseline'
    

ALIGN_BOTTOM

       
ALIGN_BOTTOM constant varchar2(30) := 'bottom'
    

ALIGN_IMAGE_ABOVE_LINK

       
ALIGN_IMAGE_ABOVE_LINK constant varchar2(30) := 'image_above_link'
    

ALIGN_LEFT

       
ALIGN_LEFT constant varchar2(30) := 'left'
    

ALIGN_MIDDLE

       
ALIGN_MIDDLE constant varchar2(30) := 'middle'
    

ALIGN_RIGHT

       
ALIGN_RIGHT constant varchar2(30) := 'right'
    

ALIGN_TEXT_TOP

       
ALIGN_TEXT_TOP constant varchar2(30) := 'texttop'
    

ALIGN_TOP

       
ALIGN_TOP constant varchar2(30) := 'top'
    

ARABIC_LANGUAGE

       
ARABIC_LANGUAGE constant varchar2(3) := 'ar'
    

ATTR_DISPLAY_TYPE

       
ATTR_DISPLAY_TYPE constant number := 63
    

ATTR_ELEMENT_MAP_TYPE

       
ATTR_ELEMENT_MAP_TYPE constant number := 67
    

ATTR_FUNCTION_ID

       
ATTR_FUNCTION_ID constant number := 68
    

ATTR_LOGIN_IMAGE

       
ATTR_LOGIN_IMAGE constant number := 58
    

ATTR_LOGIN_LINK

       
ATTR_LOGIN_LINK constant number := 57
    

ATTR_LOGOUT_IMAGE

       
ATTR_LOGOUT_IMAGE constant number := 60
    

ATTR_LOGOUT_LINK

       
ATTR_LOGOUT_LINK constant number := 59
    

ATTR_OBJECT_LIST

       
ATTR_OBJECT_LIST constant number := 65
    

ATTR_OBJECT_TYPE_LIST

       
ATTR_OBJECT_TYPE_LIST constant number := 64
    

ATTR_PATH_DEPTH

       
ATTR_PATH_DEPTH constant number := 69
    

ATTR_PATH_SEPARATOR

       
ATTR_PATH_SEPARATOR constant number := 70
    

ATTR_PORTAL_SMART_LINK

       
ATTR_PORTAL_SMART_LINK constant number := 56
    

ATTR_SEARCH_BOX_WIDTH

       
ATTR_SEARCH_BOX_WIDTH constant number := 62
    

ATTR_SEARCH_PAGE_GROUP_ID

       
ATTR_SEARCH_PAGE_GROUP_ID constant number := 61
    

ATTR_TEXT_TYPE

       
ATTR_TEXT_TYPE constant number := 66
    

ATTRIBUTE_AUTHOR

       
ATTRIBUTE_AUTHOR constant pls_integer := 5
    

ATTRIBUTE_CATEGORY

       
ATTRIBUTE_CATEGORY constant pls_integer := 48
    

ATTRIBUTE_CHARSET

       
ATTRIBUTE_CHARSET constant pls_integer := 127
    

ATTRIBUTE_DESCRIPTION

       
ATTRIBUTE_DESCRIPTION constant pls_integer := 4
    

ATTRIBUTE_DISP_NAME_DEF

       
ATTRIBUTE_DISP_NAME_DEF constant pls_integer := 93
    

ATTRIBUTE_DISPLAYOPTION

       
ATTRIBUTE_DISPLAYOPTION constant pls_integer := 42
    

ATTRIBUTE_EXPIRATIONPER

       
ATTRIBUTE_EXPIRATIONPER constant pls_integer := 47
    

ATTRIBUTE_FILE

       
ATTRIBUTE_FILE constant pls_integer := 46
    

ATTRIBUTE_IMAGE

       
ATTRIBUTE_IMAGE constant pls_integer := 6
    

ATTRIBUTE_IMAGEALIGN

       
ATTRIBUTE_IMAGEALIGN constant pls_integer := 45
    

ATTRIBUTE_IMAGEMAP

       
ATTRIBUTE_IMAGEMAP constant pls_integer := 53
    

ATTRIBUTE_ITEM_LINK

       
ATTRIBUTE_ITEM_LINK constant pls_integer := 113
    

ATTRIBUTE_ITEM_TEMPLATE

       
ATTRIBUTE_ITEM_TEMPLATE constant pls_integer := 110
    

ATTRIBUTE_ITEMCHECKOUT

       
ATTRIBUTE_ITEMCHECKOUT constant pls_integer := 44
    

ATTRIBUTE_KEYWORDS

       
ATTRIBUTE_KEYWORDS constant pls_integer := 8
    

ATTRIBUTE_MIME_TYPE

       
ATTRIBUTE_MIME_TYPE constant pls_integer := 126
    

ATTRIBUTE_NAME

       
ATTRIBUTE_NAME constant pls_integer := 78
    

ATTRIBUTE_PAGE_LINK

       
ATTRIBUTE_PAGE_LINK constant pls_integer := 52
    

ATTRIBUTE_PERSPECTIVES

       
ATTRIBUTE_PERSPECTIVES constant pls_integer := 17
    

ATTRIBUTE_PLSQL

       
ATTRIBUTE_PLSQL constant pls_integer := 51
    

ATTRIBUTE_PUBLISHDATE

       
ATTRIBUTE_PUBLISHDATE constant pls_integer := 41
    

ATTRIBUTE_ROLLOVERIMAGE

       
ATTRIBUTE_ROLLOVERIMAGE constant pls_integer := 7
    

ATTRIBUTE_SMARTLINK

       
ATTRIBUTE_SMARTLINK constant pls_integer := 56
    

ATTRIBUTE_SMARTTEXT

       
ATTRIBUTE_SMARTTEXT constant pls_integer := 66
    

ATTRIBUTE_TEXT

       
ATTRIBUTE_TEXT constant pls_integer := 50
    

ATTRIBUTE_TITLE

       
ATTRIBUTE_TITLE constant pls_integer := 3
    

ATTRIBUTE_URL

       
ATTRIBUTE_URL constant number := 49
    

ATTRIBUTE_USE_DISP_NAME_DEF

       
ATTRIBUTE_USE_DISP_NAME_DEF constant pls_integer := 94
    

ATTRIBUTE_VERSION_NUMBER

       
ATTRIBUTE_VERSION_NUMBER constant pls_integer := 123
    

BRAZILIAN_PORTUGUESE_LANG

       
BRAZILIAN_PORTUGUESE_LANG constant varchar2(3) := 'ptb'
    

CANADIAN_FRENCH_LANGUAGE

       
CANADIAN_FRENCH_LANGUAGE constant varchar2(3) := 'frc'
    

CREATOR_SCHEMA

       
CREATOR_SCHEMA constant varchar2(20) := '$CREATOR$'
    

CROTIAN_LANGUAGE

       
CROTIAN_LANGUAGE constant varchar2(3) := 'hr'
    

CZECH_LANGUAGE

       
CZECH_LANGUAGE constant varchar2(3) := 'cs'
    

DANISH_LANGUAGE

       
DANISH_LANGUAGE constant varchar2(3) := 'dk'
    

DATA_TYPE_DATE

       
DATA_TYPE_DATE constant varchar2(30) := 'date'
    

DATA_TYPE_FILE

       
DATA_TYPE_FILE constant varchar2(30) := 'file'
    

DATA_TYPE_NUMBER

       
DATA_TYPE_NUMBER constant varchar2(30) := 'number'
    

DATA_TYPE_OTHER

       
DATA_TYPE_OTHER constant varchar2(30) := 'other'
    

DATA_TYPE_TEXT

       
DATA_TYPE_TEXT constant varchar2(30) := 'text'
    

DB_USER

       
DB_USER constant varchar(20) := 'db_user'
    

DELETE_ITEM_DEFAULT

       
DELETE_ITEM_DEFAULT constant varchar2(30) := 'DEFAULT_PAGE_GROUP_SETTING'
    

DELETE_ITEM_LAZYDELETE

       
DELETE_ITEM_LAZYDELETE constant varchar2(30) := 'MARK_FOR_DELETE'
    

DELETE_ITEM_PURGE

       
DELETE_ITEM_PURGE constant varchar2(30) := 'PURGE'
    

DISABLE_ITEM_FOR_CHECK_OUT

       
DISABLE_ITEM_FOR_CHECK_OUT constant number := 0
    

DUTCH_LANGUAGE

       
DUTCH_LANGUAGE constant varchar2(3) := 'nl'
    

ENABLE_ITEM_FOR_CHECK_OUT

       
ENABLE_ITEM_FOR_CHECK_OUT constant number := 1
    

ENGLISH_LANGUAGE

       
ENGLISH_LANGUAGE constant varchar2(3) := 'us'
    

EXP_DATE

       
EXP_DATE constant varchar2(20) := 'DATE'
    

EXP_NUMBER

       
EXP_NUMBER constant varchar2(20) := 'NUMBER'
    

FINNISH_LANGUAGE

       
FINNISH_LANGUAGE constant varchar2(3) := 'sf'
    

FOLDER_ACCESS

       
FOLDER_ACCESS constant varchar2(30) := 'folder'
    

FOLDER_TYPE_CONTAINER

       
FOLDER_TYPE_CONTAINER constant number := 1
    

FOLDER_TYPE_PLSQL

       
FOLDER_TYPE_PLSQL constant number := 4
    

FOLDER_TYPE_SEARCH

       
FOLDER_TYPE_SEARCH constant number := 3
    
This value is deprecated.

FOLDER_TYPE_URL

       
FOLDER_TYPE_URL constant number := 2
    

FRENCH_LANGUAGE

       
FRENCH_LANGUAGE constant varchar2(3) := 'f'
    

FULL_SCREEN

       
FULL_SCREEN constant varchar2(30) := 'fullscreen'
    

GENERAL_CATEGORY

       
GENERAL_CATEGORY constant number := 30
    

GERMAN_LANGUAGE

       
GERMAN_LANGUAGE constant varchar2(3) := 'd'
    

GREEK_LANGUAGE

       
GREEK_LANGUAGE constant varchar2(3) := 'el'
    

HEBREW_LANGUAGE

       
HEBREW_LANGUAGE constant varchar2(3) := 'iw'
    

HUNGARIAN_LANGUAGE

       
HUNGARIAN_LANGUAGE constant varchar2(3) := 'hu'
    

IN_FRAME

       
IN_FRAME constant varchar2(30) := 'inframe'
    

IN_PLACE

       
IN_PLACE constant varchar2(30) := 'inplace'
    

IS_OFF

       
IS_OFF constant number := 0
    

IS_ON

       
IS_ON constant number := 1
    

ITALIAN_LANGUAGE

       
ITALIAN_LANGUAGE constant varchar2(3) := 'i'
    

ITEM_ACCESS

       
ITEM_ACCESS constant varchar2(30) := 'item'
    

ITEM_CHECKEDOUT

       
ITEM_CHECKEDOUT constant number := 1
    

ITEM_NOT_CHECKEDOUT

       
ITEM_NOT_CHECKEDOUT constant number := 0
    

ITEM_TYPE_APP_COMP

       
ITEM_TYPE_APP_COMP constant number := 6
    
This value is deprecated.

ITEM_TYPE_BASIC_SEARCH

       
ITEM_TYPE_BASIC_SEARCH constant number := 24
    

ITEM_TYPE_ELEMENT_LIST

       
ITEM_TYPE_ELEMENT_LIST constant number := 25
    

ITEM_TYPE_FILE

       
ITEM_TYPE_FILE constant number := 1
    

ITEM_TYPE_FOLDER_LINK

       
ITEM_TYPE_FOLDER_LINK constant number := 4
    

ITEM_TYPE_IMAGE

       
ITEM_TYPE_IMAGE constant number := 8
    

ITEM_TYPE_IMAGE_MAP

       
ITEM_TYPE_IMAGE_MAP constant number := 31
    

ITEM_TYPE_JAVA_APP

       
ITEM_TYPE_JAVA_APP constant number := 11
    
This value is deprecated.

ITEM_TYPE_LOGIN_LOGOUT

       
ITEM_TYPE_LOGIN_LOGOUT constant number := 23
    

ITEM_TYPE_MAP_LINK

       
ITEM_TYPE_MAP_LINK constant number := 27
    

ITEM_TYPE_PAGE_FUNCTION

       
ITEM_TYPE_PAGE_FUNCTION constant number := 34
    

ITEM_TYPE_PAGE_PATH

       
ITEM_TYPE_PAGE_PATH constant number := 30
    

ITEM_TYPE_PLSQL

       
ITEM_TYPE_PLSQL constant number := 5
    

ITEM_TYPE_PORTLET_INST

       
ITEM_TYPE_PORTLET_INST constant number := 13
    

ITEM_TYPE_SIMPLE_APP_COMP

       
ITEM_TYPE_SIMPLE_APP_COMP constant number := 18
    
This value is deprecated.

ITEM_TYPE_SIMPLE_FILE

       
ITEM_TYPE_SIMPLE_FILE constant number := 14
    

ITEM_TYPE_SIMPLE_IMAGE

       
ITEM_TYPE_SIMPLE_IMAGE constant number := 20
    

ITEM_TYPE_SIMPLE_JAVA_APP

       
ITEM_TYPE_SIMPLE_JAVA_APP constant number := 28
    
This value is deprecated.

ITEM_TYPE_SIMPLE_PAGE_LINK

       
ITEM_TYPE_SIMPLE_PAGE_LINK constant number := 19
    

ITEM_TYPE_SIMPLE_PLSQL

       
ITEM_TYPE_SIMPLE_PLSQL constant number := 17
    

ITEM_TYPE_SIMPLE_TEXT

       
ITEM_TYPE_SIMPLE_TEXT constant number := 16
    

ITEM_TYPE_SIMPLE_URL

       
ITEM_TYPE_SIMPLE_URL constant number := 15
    

ITEM_TYPE_SMART_LINK

       
ITEM_TYPE_SMART_LINK constant number := 22
    

ITEM_TYPE_SMART_TEXT

       
ITEM_TYPE_SMART_TEXT constant number := 26
    

ITEM_TYPE_TEXT

       
ITEM_TYPE_TEXT constant number := 2
    

ITEM_TYPE_URL

       
ITEM_TYPE_URL constant number := 3
    

ITEM_TYPE_ZIP_FILE

       
ITEM_TYPE_ZIP_FILE constant number := 12
    

JAPANESE_LANGUAGE

       
JAPANESE_LANGUAGE constant varchar2(3) := 'ja'
    

KOREAN_LANGUAGE

       
KOREAN_LANGUAGE constant varchar2(3) := 'ko'
    

NEW_WINDOW

       
NEW_WINDOW constant varchar2(30) := 'newbrowserwindow'
    

NO

       
NO constant number := 0
    

NORWEGIAN_LANGUAGE

       
NORWEGIAN_LANGUAGE constant varchar2(3) := 'n'
    

PERMANENT

       
PERMANENT constant varchar2(20) := 'PERMANENT'
    

POLISH_LANGUAGE

       
POLISH_LANGUAGE constant varchar2(3) := 'pl'
    

PORTUGUESE_LANGUAGE

       
PORTUGUESE_LANGUAGE constant varchar2(3) := 'pt'
    

PUBLIC_SCHEMA

       
PUBLIC_SCHEMA constant varchar2(20) := '$PUBLIC$'
    

ROMANIAN_LANGUAGE

       
ROMANIAN_LANGUAGE constant varchar2(3) := 'ro'
    

RUSSIAN_LANGUAGE

       
RUSSIAN_LANGUAGE constant varchar2(3) := 'ru'
    

SHARED_OBJECTS

       
SHARED_OBJECTS constant number := 0
    

SIMPLIFIED_CHINESE_LANGUAGE

       
SIMPLIFIED_CHINESE_LANGUAGE constant varchar2(3) := 'zhs'
    

SLOVAK_LANGUAGE

       
SLOVAK_LANGUAGE constant varchar2(3) := 'sk'
    

SMART_TEXT_CURRENT_DATE

       
SMART_TEXT_CURRENT_DATE constant varchar2(30) := 'Current Date'
    

SMART_TEXT_CURRENT_PAGE

       
SMART_TEXT_CURRENT_PAGE constant varchar2(30) := 'Current Page'
    

SMART_TEXT_CURRENT_USER

       
SMART_TEXT_CURRENT_USER constant varchar2(30) := 'Current User'
    

SPANISH_ARGENTINA_LANGUAGE

       
SPANISH_ARGENTINA_LANGUAGE constant varchar2(3) := 'esa'
    

SPANISH_LANGUAGE

       
SPANISH_LANGUAGE constant varchar2(3) := 'e'
    

SWEDISH_LANGUAGE

       
SWEDISH_LANGUAGE constant varchar2(3) := 's'
    

THAI_LANGUAGE

       
THAI_LANGUAGE constant varchar2(3) := 'th'
    

TRADITIONAL_CHINESE_LANGUAGE

       
TRADITIONAL_CHINESE_LANGUAGE constant varchar2(3) := 'zht'
    

TURKISH_LANGUAGE

       
TURKISH_LANGUAGE constant varchar2(3) := 'tr'
    

VALUE_ACCOUNT_INFO

       
VALUE_ACCOUNT_INFO constant varchar2(30) := 'account'
    

VALUE_ADVANCED_SEARCH

       
VALUE_ADVANCED_SEARCH constant varchar2(30) := 'advanced_search'
    

VALUE_APP_SHOCKWAVE_FLASH

       
VALUE_APP_SHOCKWAVE_FLASH constant varchar2(50) := 'application/x-shockwave-flash'
    

VALUE_APPLICATION_ANDREW_INSET

       
VALUE_APPLICATION_ANDREW_INSET constant varchar2(50) := 'application/andrew-inset'
    

VALUE_APPLICATION_BCPIO

       
VALUE_APPLICATION_BCPIO constant varchar2(50) := 'application/x-bcpio'
    

VALUE_APPLICATION_CD_LINK

       
VALUE_APPLICATION_CD_LINK constant varchar2(50) := 'application/x-cdlink'
    

VALUE_APPLICATION_CHESS_PGN

       
VALUE_APPLICATION_CHESS_PGN constant varchar2(50) := 'application/x-chess-pgn'
    

VALUE_APPLICATION_CPIO

       
VALUE_APPLICATION_CPIO constant varchar2(50) := 'application/x-cpio'
    

VALUE_APPLICATION_CSH

       
VALUE_APPLICATION_CSH constant varchar2(50) := 'application/x-csh'
    

VALUE_APPLICATION_DIRECTOR

       
VALUE_APPLICATION_DIRECTOR constant varchar2(50) := 'application/x-director'
    

VALUE_APPLICATION_DVI

       
VALUE_APPLICATION_DVI constant varchar2(50) := 'application/x-dvi'
    

VALUE_APPLICATION_FUTURE_SPLSH

       
VALUE_APPLICATION_FUTURE_SPLSH constant varchar2(50) := 'application/x-futuresplash'
    

VALUE_APPLICATION_HDF

       
VALUE_APPLICATION_HDF constant varchar2(50) := 'application/x-hdf'
    

VALUE_APPLICATION_JAVASCRIPT

       
VALUE_APPLICATION_JAVASCRIPT constant varchar2(50) := 'application/x-javascript'
    

VALUE_APPLICATION_KOAN

       
VALUE_APPLICATION_KOAN constant varchar2(50) := 'application/x-koan'
    

VALUE_APPLICATION_LATEX

       
VALUE_APPLICATION_LATEX constant varchar2(50) := 'application/x-latex'
    

VALUE_APPLICATION_MAC_BIN_HEX

       
VALUE_APPLICATION_MAC_BIN_HEX constant varchar2(50) := 'application/mac-binhex40'
    

VALUE_APPLICATION_MAC_COMPACT

       
VALUE_APPLICATION_MAC_COMPACT constant varchar2(50) := 'application/mac-compactpro'
    

VALUE_APPLICATION_MS_EXCEL

       
VALUE_APPLICATION_MS_EXCEL constant varchar2(50) := 'application/vnd.ms-excel'
    

VALUE_APPLICATION_MSWORD

       
VALUE_APPLICATION_MSWORD constant varchar2(50) := 'application/msword'
    

VALUE_APPLICATION_NETCDF

       
VALUE_APPLICATION_NETCDF constant varchar2(50) := 'application/x-netcdf'
    

VALUE_APPLICATION_OCTET_STREAM

       
VALUE_APPLICATION_OCTET_STREAM constant varchar2(50) := 'application/octet-stream'
    

VALUE_APPLICATION_ODA

       
VALUE_APPLICATION_ODA constant varchar2(50) := 'application/oda'
    

VALUE_APPLICATION_PDF

       
VALUE_APPLICATION_PDF constant varchar2(50) := 'application/pdf'
    

VALUE_APPLICATION_POST_SCRIPT

       
VALUE_APPLICATION_POST_SCRIPT constant varchar2(50) := 'application/postscript'
    

VALUE_APPLICATION_POWER_POINT

       
VALUE_APPLICATION_POWER_POINT constant varchar2(50) := 'application/vnd.ms-powerpoint'
    

VALUE_APPLICATION_RTF

       
VALUE_APPLICATION_RTF constant varchar2(50) := 'application/rtf'
    

VALUE_APPLICATION_SH

       
VALUE_APPLICATION_SH constant varchar2(50) := 'application/x-sh'
    

VALUE_APPLICATION_SHAR

       
VALUE_APPLICATION_SHAR constant varchar2(50) := 'application/x-shar'
    

VALUE_APPLICATION_SMIL

       
VALUE_APPLICATION_SMIL constant varchar2(50) := 'application/smil'
    

VALUE_APPLICATION_STUFFIT

       
VALUE_APPLICATION_STUFFIT constant varchar2(50) := 'application/x-stuffit'
    

VALUE_APPLICATION_SV4CPIO

       
VALUE_APPLICATION_SV4CPIO constant varchar2(50) := 'application/x-sv4cpio'
    

VALUE_APPLICATION_SV4CRC

       
VALUE_APPLICATION_SV4CRC constant varchar2(50) := 'application/x-sv4crc'
    

VALUE_APPLICATION_TAR

       
VALUE_APPLICATION_TAR constant varchar2(50) := 'application/x-tar'
    

VALUE_APPLICATION_TCL

       
VALUE_APPLICATION_TCL constant varchar2(50) := 'application/x-tcl'
    

VALUE_APPLICATION_TEX

       
VALUE_APPLICATION_TEX constant varchar2(50) := 'application/x-tex'
    

VALUE_APPLICATION_TEX_INFO

       
VALUE_APPLICATION_TEX_INFO constant varchar2(50) := 'application/x-texinfo'
    

VALUE_APPLICATION_TROFF

       
VALUE_APPLICATION_TROFF constant varchar2(50) := 'application/x-troff'
    

VALUE_APPLICATION_TROFF_MAN

       
VALUE_APPLICATION_TROFF_MAN constant varchar2(50) := 'application/x-troff-man'
    

VALUE_APPLICATION_TROFF_ME

       
VALUE_APPLICATION_TROFF_ME constant varchar2(50) := 'application/x-troff-me'
    

VALUE_APPLICATION_TROFF_MS

       
VALUE_APPLICATION_TROFF_MS constant varchar2(50) := 'application/x-troff-ms'
    

VALUE_APPLICATION_USTAR

       
VALUE_APPLICATION_USTAR constant varchar2(50) := 'application/x-ustar'
    

VALUE_APPLICATION_WAIS_SOURCE

       
VALUE_APPLICATION_WAIS_SOURCE constant varchar2(50) := 'application/x-wais-source'
    

VALUE_APPLICATION_XGTAR

       
VALUE_APPLICATION_XGTAR constant varchar2(50) := 'application/x-gtar'
    

VALUE_APPLICATION_ZIP

       
VALUE_APPLICATION_ZIP constant varchar2(50) := 'application/zip'
    

VALUE_AUDIO_AIFF

       
VALUE_AUDIO_AIFF constant varchar2(50) := 'audio/x-aiff'
    

VALUE_AUDIO_BASIC

       
VALUE_AUDIO_BASIC constant varchar2(50) := 'audio/basic'
    

VALUE_AUDIO_MIDI

       
VALUE_AUDIO_MIDI constant varchar2(50) := 'audio/midi'
    

VALUE_AUDIO_MPEG

       
VALUE_AUDIO_MPEG constant varchar2(50) := 'audio/mpeg'
    

VALUE_AUDIO_RMF

       
VALUE_AUDIO_RMF constant varchar2(50) := 'audio/x-rmf'
    

VALUE_AUDIO_WAV

       
VALUE_AUDIO_WAV constant varchar2(50) := 'audio/wav'
    

VALUE_AUDIO_XWAV

       
VALUE_AUDIO_XWAV constant varchar2(50) := 'audio/x-wav'
    

VALUE_AUIDO_REAL_AUDIO

       
VALUE_AUIDO_REAL_AUDIO constant varchar2(50) := 'audio/x-pn-realaudio'
    

VALUE_BIG5

       
VALUE_BIG5 constant varchar2(20) := 'ZHT16BIG5'
    

VALUE_BUILDER

       
VALUE_BUILDER constant varchar2(30) := 'builder'
    

VALUE_CHEMICAL_PDB

       
VALUE_CHEMICAL_PDB constant varchar2(50) := 'chemical/x-pdb'
    

VALUE_COMMUNITY

       
VALUE_COMMUNITY constant varchar2(30) := 'community'
    

VALUE_CONTACT

       
VALUE_CONTACT constant varchar2(30) := 'contact'
    

VALUE_CURRENT_DATE

       
VALUE_CURRENT_DATE constant varchar2(30) := 'currentdate'
    

VALUE_CURRENT_PAGE

       
VALUE_CURRENT_PAGE constant varchar2(30) := 'currentpage'
    

VALUE_CURRENT_USER

       
VALUE_CURRENT_USER constant varchar2(30) := 'currentuser'
    

VALUE_CUST_MOBILE_HOME_PAGE

       
VALUE_CUST_MOBILE_HOME_PAGE constant varchar2(30) := 'mobile'
    

VALUE_CUSTOMIZE_PAGE

       
VALUE_CUSTOMIZE_PAGE constant varchar2(30) := 'customize'
    

VALUE_EDIT_PAGE

       
VALUE_EDIT_PAGE constant varchar2(30) := 'edit'
    

VALUE_EUC_JP

       
VALUE_EUC_JP constant varchar2(20) := 'JA16EUC'
    

VALUE_FAVOURITES

       
VALUE_FAVOURITES constant varchar2(30) := 'favorites'
    

VALUE_GBK

       
VALUE_GBK constant varchar2(20) := 'ZHS16CGB231280'
    

VALUE_HELP

       
VALUE_HELP constant varchar2(30) := 'help'
    

VALUE_IMAGE_BMP

       
VALUE_IMAGE_BMP constant varchar2(50) := 'image/bmp'
    

VALUE_IMAGE_CMU_RASTER

       
VALUE_IMAGE_CMU_RASTER constant varchar2(50) := 'image/x-cmu-raster'
    

VALUE_IMAGE_GIF

       
VALUE_IMAGE_GIF constant varchar2(50) := 'image/gif'
    

VALUE_IMAGE_IEF

       
VALUE_IMAGE_IEF constant varchar2(50) := 'image/ief'
    

VALUE_IMAGE_JPEG

       
VALUE_IMAGE_JPEG constant varchar2(50) := 'image/jpeg'
    

VALUE_IMAGE_PNG

       
VALUE_IMAGE_PNG constant varchar2(50) := 'image/png'
    

VALUE_IMAGE_PORTABLE_ANYMAP

       
VALUE_IMAGE_PORTABLE_ANYMAP constant varchar2(50) := 'image/x-portable-anymap'
    

VALUE_IMAGE_PORTABLE_BITMAP

       
VALUE_IMAGE_PORTABLE_BITMAP constant varchar2(50) := 'image/x-portable-bitmap'
    

VALUE_IMAGE_PORTABLE_GRAYMAP

       
VALUE_IMAGE_PORTABLE_GRAYMAP constant varchar2(50) := 'image/x-portable-bitmap'
    

VALUE_IMAGE_PORTABLE_PIXMAP

       
VALUE_IMAGE_PORTABLE_PIXMAP constant varchar2(50) := 'image/x-portable-pixmap'
    

VALUE_IMAGE_RGB

       
VALUE_IMAGE_RGB constant varchar2(50) := 'image/x-rgb'
    

VALUE_IMAGE_TIFF

       
VALUE_IMAGE_TIFF constant varchar2(50) := 'image/tiff'
    

VALUE_IMAGE_XBITMAP

       
VALUE_IMAGE_XBITMAP constant varchar2(50) := 'image/x-xbitmap'
    

VALUE_IMAGE_XPIXMAP

       
VALUE_IMAGE_XPIXMAP constant varchar2(50) := 'image/x-xpixmap'
    

VALUE_IMAGE_XWINDOW_DUMP

       
VALUE_IMAGE_XWINDOW_DUMP constant varchar2(50) := 'image/x-xwindowdump'
    

VALUE_ISO_8859

       
VALUE_ISO_8859 constant varchar2(20) := 'WE8ISO8859P1'
    

VALUE_M0DEL_MESH

       
VALUE_M0DEL_MESH constant varchar2(50) := 'model/mesh'
    

VALUE_MODEL_IGES

       
VALUE_MODEL_IGES constant varchar2(50) := 'model/iges'
    

VALUE_MODEL_VRML

       
VALUE_MODEL_VRML constant varchar2(50) := 'model/vrml'
    

VALUE_NAVIGATOR

       
VALUE_NAVIGATOR constant varchar2(30) := 'navigator'
    

VALUE_PAGE_GROUP_HOME

       
VALUE_PAGE_GROUP_HOME constant varchar2(30) := 'page_group_home'
    

VALUE_PERSONAL_PAGE

       
VALUE_PERSONAL_PAGE constant varchar2(30) := 'personal_page'
    

VALUE_PORTAL_HOME

       
VALUE_PORTAL_HOME constant varchar2(30) := 'home'
    

VALUE_PORTLET_REPOS

       
VALUE_PORTLET_REPOS constant varchar2(30) := 'portlet_repos'
    

VALUE_PORTLET_REPOS_REF_STATUS

       
VALUE_PORTLET_REPOS_REF_STATUS constant varchar2(30) := 'refprovstatus'
    

VALUE_PROPERTY_SHEET

       
VALUE_PROPERTY_SHEET constant varchar2(30) := 'sheet'
    

VALUE_REAL_AUDIO

       
VALUE_REAL_AUDIO constant varchar2(50) := 'audio/x-realaudio'
    

VALUE_REAL_AUDIO_PLUGIN

       
VALUE_REAL_AUDIO_PLUGIN constant varchar2(50) := 'audio/x-pn-realaudio-plugin'
    

VALUE_REF_PORTLET_REPOS

       
VALUE_REF_PORTLET_REPOS constant varchar2(30) := 'refprovs'
    

VALUE_REFRESH_PAGE

       
VALUE_REFRESH_PAGE constant varchar2(30) := 'refresh'
    

VALUE_SHIFT_JIS

       
VALUE_SHIFT_JIS constant varchar2(20) := 'JA16SJIS'
    

VALUE_SUBSCRIBE

       
VALUE_SUBSCRIBE constant varchar2(30) := 'subscribe'
    

VALUE_TEXT_CSS

       
VALUE_TEXT_CSS constant varchar2(50) := 'text/css'
    

VALUE_TEXT_HTML

       
VALUE_TEXT_HTML constant varchar2(50) := 'text/html'
    

VALUE_TEXT_PLAIN

       
VALUE_TEXT_PLAIN constant varchar2(50) := 'text/plain'
    

VALUE_TEXT_RICHTEXT

       
VALUE_TEXT_RICHTEXT constant varchar2(50) := 'text/richtext'
    

VALUE_TEXT_SETEXT

       
VALUE_TEXT_SETEXT constant varchar2(50) := 'text/x-setext'
    

VALUE_TEXT_SGML

       
VALUE_TEXT_SGML constant varchar2(50) := 'text/sgml'
    

VALUE_TEXT_TAB_SEP_VALUES

       
VALUE_TEXT_TAB_SEP_VALUES constant varchar2(50) := 'text/tab-separated-values'
    

VALUE_TEXT_XML

       
VALUE_TEXT_XML constant varchar2(50) := 'text/xml'
    

VALUE_US_ASCII

       
VALUE_US_ASCII constant varchar2(20) := 'US7ASCII'
    

VALUE_UTF8

       
VALUE_UTF8 constant varchar2(20) := 'UTF8'
    

VALUE_VIDEO_COOLTALK

       
VALUE_VIDEO_COOLTALK constant varchar2(50) := 'x-conference/x-cooltalk'
    

VALUE_VIDEO_MPEG

       
VALUE_VIDEO_MPEG constant varchar2(50) := 'video/mpeg'
    

VALUE_VIDEO_MSVIDEO

       
VALUE_VIDEO_MSVIDEO constant varchar2(50) := 'video/x-msvideo'
    

VALUE_VIDEO_QUICKTIME

       
VALUE_VIDEO_QUICKTIME constant varchar2(50) := 'video/quicktime'
    

VALUE_VIDEO_SGI_MOVIE

       
VALUE_VIDEO_SGI_MOVIE constant varchar2(50) := 'video/x-sgi-movie'
    

VALUE_WINDOWS_1252

       
VALUE_WINDOWS_1252 constant varchar2(20) := 'WE8MSWIN1252'
    

VERSIONING_AUDIT

       
VERSIONING_AUDIT constant varchar2(30) := 'versionaudit'
    

VERSIONING_NONE

       
VERSIONING_NONE constant varchar2(30) := 'versionnone'
    

VERSIONING_SIMPLE

       
VERSIONING_SIMPLE constant varchar2(30) := 'versionsimple'
    

YES

       
YES constant number := 1
    

Variable Detail

g_empty_array

       
g_empty_array g_array
    

g_empty_caid_array

       
g_empty_caid_array g_caid_array
    

g_perspectiveidemptyarray

       
g_perspectiveidemptyarray g_perspectiveidarray
    

Function/Procedure Detail

add_category

function  
      
add_category(
    p_caid in number,
    p_parent_id in number default 0,
    p_name in varchar2,
    p_display_name in varchar2,
    p_description in varchar2 default null,
    p_is_portlet in number default no,
    p_banner_image in varchar2 default null,
    p_banner_icon in varchar2 default null,
    p_title_image in varchar2 default null,
    p_rollover_image in varchar2 default null
) return number
    
Creates a new category in a page group.
Parameters:
p_caid - Page group ID.
p_parent_id - Parent category ID. If there is no parent, use "0" (zero).
p_name - Internal name of the category. Must be unique within the parent category.
p_display_name - Display name of the category.
p_description - Description of the category.
p_is_portlet - Publish category as a portlet? Use constant values YES or NO.
p_banner_image - File location of the banner image associated with this category. This value must be a directory path and filename on the same server on which the Portal database is located (e.g. "/usr/images/banner.gif"). The image is uploaded from this location.
p_banner_icon - File location of the icon image associated with this category. This value must be a directory path and filename on the same server on which the Portal database is located (e.g. "/usr/images/bannericon.gif"). The image is uploaded from this location.
p_title_image - File location of the title image associated with this category. This value must be a directory path and filename on the same server on which the Portal database is located (e.g. "/usr/images/cattitle.gif"). The image is uploaded from this location.
p_rollover_image - File location of the rollover image associated with this category. This value must be a directory path and filename on the same server on which the Portal database is located (e.g. "/usr/images/catrollover.gif"). The image is uploaded from this location.
Returns:
number - New category ID.
Exceptions:
MISSING_NAME - No value passed for p_name
MISSING_DISPLAY_NAME - No value passed for p_display_name
INVALID_CATEGORY - Parent category specified does not exist
INVALID_NAME - Invalid value passed for p_name
DUPLICATE_NAME - Category with same name already exists
PERMISSION_DENIED - Calling user does not have the authorization to create a category

add_content_area

function  
      
add_content_area(
    p_name in varchar2,
    p_display_name in varchar2,
    p_versioning in varchar2 default versioning_none,
    p_default_language in varchar2 default 'us',
    p_root_folder_type in number default 1,
    p_logo_filename in varchar2 default null
) return number
    
Creates a new page group.
Parameters:
p_name - Internal reference name for the page group. Must be unique.
p_display_name - Display name for the page group.
p_versioning - Versioning level for items. Default is VERSIONING_NONE. Use the following constants:
  • VERSIONING_NONE - default
  • VERSIONING_SIMPLE
  • VERSIONING_AUDIT
p_default_language - Default language for the page group. Default is 'us'.
p_root_folder_type - Deprecated. The root page of a page group is always a standard page.
p_logo_filename - This parameter is DEPRECATED. The parameter has been retained for backward compatibility with the 3.0.9 API signatures, but its value is ignored.
Returns:
number - New page group ID.
Exceptions:
INVALID_NAME - Page group name contains spaces or special characters
DUPLICATE_NAME - A page group with p_name value already exists
MISSING_NAME - No value was passed for the page group name
NAME_TOO_LONG - Name must be less than 60 characters
MISSING_DISPLAY_NAME - No value was passed for the page group display name

add_folder

function  
      
add_folder(
    p_caid in number,
    p_parent_id in number default 1,
    p_name in varchar2,
    p_display_name in varchar2,
    p_type_id in number default folder_type_container,
    p_type_caid in number default shared_objects,
    p_value in varchar2 default null,
    p_plsql_execute_mode in varchar2 default null,
    p_plsql_execute_user in varchar2 default null,
    p_category_id in number default general_category,
    p_category_caid in number default shared_objects,
    p_isportlet in number default no,
    p_portlet_use_page_style in number default yes,
    p_perspectives in g_perspectiveidarray default g_perspectiveidemptyarray,
    p_perspectives_caid in g_caid_array default g_empty_caid_array,
    p_attribute_id in wwsbr_type.array default wwsbr_type . empty,
    p_attribute_caid in wwsbr_type.array default wwsbr_type . empty,
    p_attribute_data_type in wwsbr_type.array default wwsbr_type . empty,
    p_attribute_value in wwsbr_type.array default wwsbr_type . empty
) return number
    
Creates a new page in a page group.
Parameters:
p_caid - ID of the page group to which the page is added.
p_parent_id - ID of parent page. Default value is 1, which is the root page of the page group.
p_name - Internal reference name for the page. Must be unique within the parent page.
p_display_name - Display name (title) for the page.
p_type_id - ID of the page type for this page. The page type must be available in the page group in which the page is being created. Valid values:
  • FOLDER_TYPE_CONTAINER (constant) - default
  • FOLDER_TYPE_URL (constant)
  • FOLDER_TYPE_PLSQL (constant)
  • A value from column ID of the view WWSBR_FOLDER_TYPES
p_type_caid - Page group ID of the page type. Must be the same as p_caid or the ID of the Shared Objects page group (use the constant SHARED_OBJECTS).
p_value - For URL type pages, the value of the URL. For PL/SQL type pages, a block of PL/SQL code.
p_plsql_execute_mode - Execute mode for a PL/SQL type page. Use the following constants:
  • PUBLIC_SCHEMA
  • DB_USER
  • CREATOR_SCHEMA
p_plsql_execute_user - Database user name. Required when DB_USER execute mode is used for a PL/SQL type page.
p_category_caid - Page group ID of the category for the page. Default is the constant SHARED_OBJECTS.
p_isportlet - Flag that indicates if the page is exposed as a portlet. Use the constants YES or NO. The default value is NO. The flag is effective only if the page group is configured to not copy parent page properties.
p_portlet_use_page_style - Flag that indicates which style to use when the page is exposed as a portlet. Use the constants YES or NO. If YES, the portlet uses the style of the page on which it appears. If NO, the portlet uses its own page style. The default value is YES.
p_perspectives - Array of perspective IDs.
p_perspectives_caid - Array of page group IDs for the perspectives in p_perspectives. The position of each element in this array must match the position of the corresponding perspective ID in p_perspectives. p_perspectives_caid must be the same as p_caid or the ID of the Shared Objects page group (use the constant SHARED_OBJECTS).
p_attribute_id - Array of attribute IDs for the page. Used only when the page is based on a custom page type. The attribute must exist in the custom type definition, as shown in the view WWSBR_FOLDER_TYPE_ATTRIBUTES.
p_attribute_caid - Array of page group IDs for the attributes in p_attribute_id. The position of each element in this array must match the position of the corresponding attribute ID in p_attribute_id. p_attribute_caid must be the same as p_caid or the ID of the Shared Objects page group (use the constant SHARED_OBJECTS).
p_attribute_data_type - Array of attribute data types for the attributes in p_attribute_id. The value for this parameter can be found in the DATA_TYPE column in the view WWSBR_ATTRIBUTES, for example 'url', 'boolean', 'text', etc. The position of each element in this array must match the position of the corresponding attribute ID in p_attribute_id.
p_attribute_value - Array of attribute values for the attributes in p_attribute_id. All values are passed as varchar2. The position of each element in this array must match the position of the corresponding attribute ID in p_attribute_id.
Returns:
number - The new page ID
Exceptions:
DUPLICATE_NAME - A page with p_name value already exists in selected parent page id
INVALID_NAME - Page name must not contain spaces or special characters
MISSING_NAME - Name is required for the page (p_name)
MISSING_DISPLAY_NAME - Display name is required (p_display_name)
NAME_TOO_LONG - The page name exceeds limit. The maximum is 60 characters
URL_REQUIRED - For a page with a base type of URL, a URL is required. It must be passed to the p_value parameter
PLSQL_REQUIRED - For a page with a base type of PLSQL, plsql code is required. It must be passed to p_value
INVALID_PLSQL_EXECUTE_USER - The value for p_plsql_excute_user is invalid
MISSING_PLSQL_EXECUTE_USER - The value for p_plsql_excute_user is missing when plsql_execute_mode is set to DB_USER
INVALID_FOLDER - Invalid parent page id
NOT_ENOUGH_PRIVS - Calling user does not have authorization to add a page under the specified parent page.

add_item

function  
      
add_item(
    p_caid in number,
    p_folder_id in number,
    p_display_name in varchar2,
    p_type_id in number,
    p_type_caid in number,
    p_region_id in number default null,
    p_display_option in varchar2 default null,
    p_category_id in number default null,
    p_category_caid in number default null,
    p_perspectives in g_perspectiveidarray default g_perspectiveidemptyarray,
    p_perspectives_caid in g_caid_array default g_empty_caid_array,
    p_author in varchar2 default null,
    p_image_filename in varchar2 default null,
    p_image_referenced in boolean default false,
    p_post_upload in boolean default false,
    p_image_alignment in varchar2 default null,
    p_description in varchar2 default null,
    p_keywords in varchar2 default null,
    p_file_filename in varchar2 default null,
    p_text in varchar2 default null,
    p_url in varchar2 default null,
    p_plsql in varchar2 default null,
    p_plsql_execute_mode in varchar2 default null,
    p_plsql_execute_user in varchar2 default null,
    p_folderlink_id in number default null,
    p_folderlink_caid in number default null,
    p_publish_date in varchar2 default null,
    p_expire_mode in varchar2 default null,
    p_expiration in varchar2 default null,
    p_master_item_id in number default null,
    p_hide_in_browse in number default no,
    p_checkable in number default null,
    p_parent_item_id in number default 0,
    p_attribute_id in wwsbr_type.array default wwsbr_type . empty,
    p_attribute_caid in wwsbr_type.array default wwsbr_type . empty,
    p_attribute_data_type in wwsbr_type.array default wwsbr_type . empty,
    p_attribute_value in wwsbr_type.array default wwsbr_type . empty
) return number
    
Creates a new item on a specified page in a page group. The function can also be used to upload files that are associated with the item. If you need to upload files in a separate step, use add_item_post_upload instead of add_item.
Parameters:
p_caid - ID of the page group to which the item is added.
p_folder_id - ID of the page to which the item is added.
p_display_name - Display name (title) for the item.
p_type_id - ID of the item type for this item. You can use one of the ITEM_TYPE constants for a supplied item type (ITEM_TYPE_FILE, ITEM_TYPE_IMAGE, ITEM_TYPE_TEXT, etc.), or a value from the column ID of the view WWSBR_ITEM_TYPES. The item type must be available in the page group in which the item is being created, and therefore listed in the view WWSBR_CONTENT_AREA_ITEM_TYPES.
p_type_caid - Page group ID for the item type. Must be the same as p_caid or the ID of the Shared Objects page group (use the constant SHARED_OBJECTS).
p_region_id - ID of the region to which the item is added. If no region is specified, the item is placed in the default item region defined for the page. Use the view WWSBR_ALL_FOLDER_REGIONS to look up the region id. Note that the valid region IDs used in 3.0.9 (values 1 - 5) are no longer used; for backward compatibility, the item is added to the default item region if one of these region IDs is used.
p_display_option - How the item should be displayed. Used for file, text, url, and pl/sql item types, ignored for others. Use the following constants:
  • FULL_SCREEN (link that displays the item in the same browser window)
  • NEW_WINDOW (link that displays the item in a new browser window)
  • IN_PLACE (displays the item in the region - only used for text and pl/sql item types)
p_category_id - ID of category for the item. Default is the unassigned category.
p_category_caid - Page group ID of category for item.
p_perspectives - Array of perspective IDs.
p_perspectives_caid - Array of page group IDs for the perspectives in p_perspectives. The position of each element in this array must match the position of the corresponding perspective ID in p_perspectives.
p_author - Author of the item.
p_image_filename - Location of the image associated with this item or the image itself if this is an image item.
  • If p_image_referenced is FALSE, p_image_filename must be a directory path and filename on the same server on which the Portal database is located. The image is uploaded from this location, unless the value of p_post_upload is TRUE.
  • If p_image_referenced is TRUE, p_image_filename is expected to be a URL to the image (equivalent to the src attribute in an IMG tag) or the internal name of an image in the Portal document table (e.g. 5678.GIF).
p_image_referenced - Boolean flag that indicates if p_image_filename is a reference, or a file location for uploading the item's image. Valid values are TRUE (image is referenced) or FALSE (image is not referenced and is uploaded from the file location specified in p_image_filename).
p_post_upload - Boolean flag that indicates if the documents associated with this item have already been uploaded. Used for file and image attributes, ignored for others. If TRUE, documents will not be uploaded when this function is called.
p_image_alignment - Rendering alignment for the item's image. See the constants prefixed with "ALIGN_" for valid values.
p_description - Description of the item.
p_keywords - Keywords for the item.
p_file_filename - Location of the file associated with this item. Used with the file item type, ignored for other item types.
  • If p_post_upload is FALSE, p_file_filename must be a directory path and filename on the same server on which the Portal database is located. The file is uploaded from this location.
  • If p_post_upload is TRUE, p_file_filename is ignored. To associate a new item with a file that already exists in the document table, see add_item_post_upload().
p_text - The text for a text item type.
p_url - The url for a url item type.
p_plsql - The plsql code for a plsql item type.
p_plsql_execute_mode - Execute mode for a PL/SQL type item. Use the following constants:
  • PUBLIC_SCHEMA
  • DB_USER
  • CREATOR_SCHEMA
p_plsql_execute_user - Database user name. Required when DB_USER execute mode is used for a PL/SQL type item.
p_folderlink_id - Page ID for a page link item type.
p_folderlink_caid - Page group ID for a page link item type. May be any valid page group.
p_publish_date - Date on which the item is published. Must be in the format of 'dd-mon-yyyy HH12:MI PM'. If no value is passed, the item is published immediately.
p_expire_mode - Expiration mode for the item. Use the following constants:
  • PERMANENT
  • EXP_NUMBER
  • EXP_DATE
p_expiration - Qualifier for p_expire_mode.
  • If p_expire_mode = PERMANENT, p_expiration must be null.
  • If p_expire_mode = EXP_NUMBER, p_expiration must be set to the number of days until expiry.
  • If p_expire_mode = EXP_DATE, p_expiration must be set to a valid expiration date in the future in the format of 'dd-mon-yyyy HH12:MI PM'.
p_master_item_id - This parameter is DEPRECATED. It has been retained for backward compatibility with the 3.0.9 API signature. Do not use this parameter. Any value passed to it (other than null) may cause errors.
p_hide_in_browse - Pass wwsbr_api.YES to hide the item.
p_checkable - Flag that determines if the item can be checked out. Valid constant values are YES, NO or null. Default is null.
p_parent_item_id - A MASTER item id. If passed, the new item is created as a sub-item of this item.
p_attribute_id - Array of attribute IDs for the item. Used for attributes for which no other parameter exists (e.g. custom attributes). The attribute must exist in the item's type definition, as shown in the view WWSBR_ITEM_TYPE_ATTRIBUTES.
p_attribute_caid - Array of page group IDs for the attributes in p_attribute_id. The position of each element in this array must match the position of the corresponding attribute ID in p_attribute_id. p_attribute_caid must be the same as p_caid or the ID of the Shared Objects page group (use the constant SHARED_OBJECTS). Must be the same as p_caid or the ID of the Shared Objects page group (use the constant SHARED_OBJECTS).
p_attribute_data_type - Array of attribute data types for the attributes in p_attribute_id. The value for this parameter can be found in the DATA_TYPE column in the view WWSBR_ATTRIBUTES, for example 'url', 'boolean', 'text', etc. The position of each element in this array must match the position of the corresponding attribute ID in p_attribute_id.
p_attribute_value - Array of attribute values for the attributes in p_attribute_id. All values are passed as varchar2. The position of each element in this array must match the position of the corresponding attribute ID in p_attribute_id.
Returns:
number - The master item ID.
Exceptions:
MISSING_ITEM_TYPE - No value was passed for p_type_id
QUOTA_EXCEEDED - The uploaded file exceeds the page group quota
NOT_ENOUGH_PRIVS - Calling user does not have authorization to add an item to the specified page
INVALID_PUBLISH_DATE_FORMAT - Date format for publish date is invalid.
INVALID_PUBLISH_DATE_VALUE - Publish date must be today or later, and publish date must be later than the expire date
NULL_EXPIRE_NUMBER - If value for p_expire_mode is EXP_NUMBER, then a value is required for p_expiration
INVALID_EXPIRE_NUMBER - Invalid number passed for p_expiration (only raised if p_expire_mode = EXP_NUMBER)
NULL_EXPIRE_DATE - If value for p_expire_mode is EXP_DATE, then a value is required for p_expiration
INVALID_EXPIRE_DATE - Invalid expiration date was passed. The expiration date must be later than the current date.
INVALID_EXPIRE_DATE_FORMAT - Date format for expiry date is invalid
REQD_ATTR_MISSING - Required custom attribute was not passed when adding an item for a custom item type
NO_ITEM_REGION - The page does not contain an item region
PERMISSION_DENIED - User does not have adequate privileges to perform this operation.
ITEM_CREATION_ERROR - Some other error occurred

add_item_ils_privileges

procedure  
      
add_item_ils_privileges(
    p_master_item_id in number,
    p_caid in number,
    p_folder_id in number,
    p_itemown_user in wwsbr_type.array default wwsbr_type . empty,
    p_itemmanage_user in wwsbr_type.array default wwsbr_type . empty,
    p_itemview_user in wwsbr_type.array default wwsbr_type . empty,
    p_itemown_group in wwsbr_type.array default wwsbr_type . empty,
    p_itemmanage_group in wwsbr_type.array default wwsbr_type . empty,
    p_itemview_group in wwsbr_type.array default wwsbr_type . empty
)
    
Adds item level security access privileges for one or more users or groups to a single specified item.

See also delete_ils_privilege(), enable_ils_for_item(), and inherit_folder_privileges(). modify_item() and modify_item_post_upload() can also be used to define ILS access privileges for an item.

Parameters:
p_master_item_id - Master_item_id of the item. This value is found in the column MASTERID in the view WWSBR_ALL_ITEMS.
p_caid - ID of the page group in which the item resides.
p_folder_id - ID of the page on which the item resides.
p_itemown_user - Array of user IDs to which Manage privilege is granted.
p_itemmanage_user - Array of user IDs to which Edit privilege is granted.
p_itemview_user - Array of user IDs to which View privilege is granted.
p_itemown_group - Array of group IDs to which Manage privilege is granted.
p_itemmanage_group - Array of group IDs to which Edit privilege is granted.
p_itemview_group - Array of group IDs to which View privilege is granted.
Exceptions:
ITEM_NOT_FOUND_ERROR - An item with the given master item ID does not exist
ILS_DISABLED - Page does not allow Item Level Security. Cannot add item specific privileges
ILS_DISABLED_FOR_ITEM - Item not set up to use own ILS privileges. Use enable_ils_for_item() before calling this procedure for this item
NOT_ENOUGH_PRIVS - Calling user does not have the authorization to assign the privileges. Requires Manage privilege or higher on the item or the page.
ITEM_UPDATE_ERROR - Some other error occurred during item update

add_item_post_upload

function  
      
add_item_post_upload(
    p_caid in number,
    p_folder_id in number,
    p_display_name in varchar2,
    p_type_id in number,
    p_type_caid in number,
    p_region_id in number default null,
    p_display_option in varchar2 default null,
    p_category_id in number default null,
    p_category_caid in number default null,
    p_perspectives in g_perspectiveidarray default g_perspectiveidemptyarray,
    p_perspectives_caid in g_caid_array default g_empty_caid_array,
    p_author in varchar2 default null,
    p_image_name in varchar2 default null,
    p_image_alignment in varchar2 default null,
    p_description in varchar2 default null,
    p_keywords in varchar2 default null,
    p_file_name in varchar2 default null,
    p_text in varchar2 default null,
    p_url in varchar2 default null,
    p_plsql in varchar2 default null,
    p_plsql_execute_mode in varchar2 default null,
    p_plsql_execute_user in varchar2 default null,
    p_folderlink_id in number default null,
    p_folderlink_caid in number default null,
    p_publish_date in varchar2 default null,
    p_expire_mode in varchar2 default null,
    p_expiration in varchar2 default null,
    p_master_item_id in number default null,
    p_hide_in_browse in number default no,
    p_checkable in number default null,
    p_parent_item_id in number default 0,
    p_attribute_id in wwsbr_type.array default wwsbr_type . empty,
    p_attribute_caid in wwsbr_type.array default wwsbr_type . empty,
    p_attribute_data_type in wwsbr_type.array default wwsbr_type . empty,
    p_attribute_value in wwsbr_type.array default wwsbr_type . empty
) return number
    
Creates a new item on a page and links it to existing document(s) in the document table. Use this API instead of add_item to create a new item when documents have been uploaded to the repository document table in a separate step.

This API requires that all files and images have already been uploaded to the document table in the repository.

See also add_item() and upload_blob().

Parameters:
p_caid - ID of the page group to which the item is added.
p_folder_id - ID of the page to which the item is added.
p_display_name - Display name (title) for the item.
p_type_id - ID of the item type for this item. You can use one of the ITEM_TYPE constants for a supplied item type (ITEM_TYPE_FILE, ITEM_TYPE_IMAGE, ITEM_TYPE_TEXT, etc.), or a value from the column ID of the view WWSBR_ITEM_TYPES. The item type must be available in the page group in which the item is being created, and therefore listed in the view WWSBR_CONTENT_AREA_ITEM_TYPES.
p_type_caid - Page group ID for the item type. Must be the same as p_caid or the ID of the Shared Objects page group (use the constant SHARED_OBJECTS).
p_region_id - ID of the region to which the item is added. If no region is specified, the item is placed in the default item region defined for the page. Use the view WWSBR_ALL_FOLDER_REGIONS to look up the region id. Note that the valid region IDs used in 3.0.9 (values 1 - 5) are no longer used; for backward compatibility, the item is added to the default item region if one of these region IDs is used.
p_display_option - How the item should be displayed. Used for file, text, url, and pl/sql item types, ignored for others. Use the following constants:
  • FULL_SCREEN (link that displays the item in the same browser window)
  • NEW_WINDOW (link that displays the item in a new browser window)
  • IN_PLACE (displays the item in the region - only used for text and pl/sql item types)
p_category_id - ID of category for the item. Default is the unassigned category.
p_category_caid - Page group ID of category for item.
p_perspectives - Array of perspective IDs.
p_perspectives_caid - Array of page group IDs for the perspectives in p_perspectives. The position of each element in this array must match the position of the corresponding perspective ID in p_perspectives.
p_author - Author of the item.
p_image_name - Internal document name for the item's image, matching a document in the document table. Pass the value returned from upload_blob() to this parameter to reference the uploaded document as the image for this item.
p_image_alignment - Rendering alignment for the item's image. See the constants prefixed with "ALIGN_" for valid values.
p_description - Description of the item.
p_keywords - Keywords for the item.
p_file_name - Internal document name for a file type item, matching a document in the document table. Pass the value returned from upload_blob() to this parameter to reference the uploaded document as the file for this item.
p_text - The text for a text item type.
p_url - The url for a url item type.
p_plsql - The plsql code for a plsql item type.
p_plsql_execute_mode - Execute mode for a PL/SQL type item. Use the following constants:
  • PUBLIC_SCHEMA
  • DB_USER
  • CREATOR_SCHEMA
p_plsql_execute_user - Database user name. Required when DB_USER execute mode is used for a PL/SQL type item.
p_folderlink_id - Page ID for a page link item type.
p_folderlink_caid - Page group ID for a page link item type. May be any valid page group.
p_publish_date - Date on which the item is published. Must be in the format 'dd-mon-yyyy HH12:MI PM'. If no value is passed, the item is published immediately.
p_expire_mode - Expiration mode for the item. Use the following constants:
  • PERMANENT
  • EXP_NUMBER
  • EXP_DATE
p_expiration - Qualifier for p_expire_mode.
  • If p_expire_mode = PERMANENT, p_expiration must be null.
  • If p_expire_mode = EXP_NUMBER, p_expiration must be set to the number of days until expiry.
  • If p_expire_mode = EXP_DATE, p_expiration must be set to a valid expiration date in the future in the format of 'dd-mon-yyyy HH12:MI PM'.
p_master_item_id - This parameter is DEPRECATED. It has been retained for backward compatibility with the 3.0.9 API signature. Do not use this parameter. Any value passed to it (other than null) may cause errors.
p_hide_in_browse - Pass wwsbr_api.YES to hide the item.
p_checkable - Flag that determines if the item can be checked out. Valid constant values are YES, NO or null. Default is null.
p_parent_item_id - A MASTER item id. If passed, the new item is created as a sub-item of this item.
p_attribute_id - Array of attribute IDs for the item. Used for attributes for which no other parameter exists (e.g. custom attributes). The attribute must exist in the item's type definition, as shown in the view WWSBR_ITEM_TYPE_ATTRIBUTES.
p_attribute_caid - Array of page group IDs for the attributes in p_attribute_id. The position of each element in this array must match the position of the corresponding attribute ID in p_attribute_id. p_attribute_caid must be the same as p_caid or the ID of the Shared Objects page group (use the constant SHARED_OBJECTS).
p_attribute_data_type - Array of attribute data types for the attributes in p_attribute_id. The value for this parameter can be found in the DATA_TYPE column in the view WWSBR_ATTRIBUTES, for example 'url', 'boolean', 'text', etc. The position of each element in this array must match the position of the corresponding attribute ID in p_attribute_id.
p_attribute_value - Array of attribute values for the attributes in p_attribute_id. All values are passed as varchar2. The position of each element in this array must match the position of the corresponding attribute ID in p_attribute_id.
Returns:
number - The master item ID.
Exceptions:
MISSING_ITEM_TYPE - No value was passed for p_type_id
QUOTA_EXCEEDED - The uploaded file exceeds the page group quota
INVALID_PUBLISH_DATE_FORMAT - Date format for publish date is invalid
INVALID_PUBLISH_DATE_VALUE - Publish date must be today or later, and publish date must be later than the expire date
NULL_EXPIRE_NUMBER - If value for p_expire_mode is EXP_NUMBER, then a value is required for p_expiration
INVALID_EXPIRE_NUMBER - Invalid number passed for p_expiration (only raised if p_expire_mode = EXP_NUMBER)
NULL_EXPIRE_DATE - If value for p_expire_mode is EXP_DATE, then a value is required for p_expiration
INVALID_EXPIRE_DATE - Invalid expiration date was passed. The expiration date must be later than the current date.
INVALID_EXPIRE_DATE_FORMAT - Date format for expiry date is invalid
REQD_ATTR_MISSING - Required custom attribute was not passed when adding an item for a custom item type
PERMISSION_DENIED - User does not have adequate privileges to perform this operation.
ITEM_CREATION_ERROR - Some other error occurred

add_perspective

function  
      
add_perspective(
    p_caid in number,
    p_parent_id in number default 0,
    p_name in varchar2,
    p_display_name in varchar2,
    p_description in varchar2 default null,
    p_is_portlet in number default no,
    p_banner_image in varchar2 default null,
    p_banner_icon in varchar2 default null,
    p_title_image in varchar2 default null,
    p_rollover_image in varchar2 default null
) return number
    
Creates a new perspective in a page group.
Parameters:
p_caid - Page group ID.
p_parent_id - Parent perspective ID. If there is no parent, use "0" (zero).
p_name - Internal name of the perspective. Must be unique within parent perspective.
p_display_name - Display name of the perspective.
p_description - Description of the perspective.
p_is_portlet - Publish perspective as a portlet? Use constant values YES or NO.
p_banner_image - File location of the banner image associated with this perspective. This value must be a directory path and filename on the same server on which the Portal database is located (e.g. "/usr/images/banner.gif"). The image is uploaded from this location.
p_banner_icon - File location of the icon image associated with this perspective. This value must be a directory path and filename on the same server on which the Portal database is located (e.g. "/usr/images/bannericon.gif"). The image is uploaded from this location.
p_title_image - File location of the title image associated with this perspective. This value must be a directory path and filename on the same server on which the Portal database is located (e.g. "/usr/images/perstitle.gif"). The image is uploaded from this location.
p_rollover_image - File location of the rollover image associated with this perspective. This value must be a directory path and filename on the same server on which the Portal database is located (e.g. "/usr/images/persrollover.gif"). The image is uploaded from this location.
Returns:
number - The new perspective ID.
Exceptions:
MISSING_NAME - No value passed for p_name
MISSING_DISPLAY_NAME - No value passed for p_display_name
INVALID_PERSPECTIVE - Parent perspective specified does not exist
INVALID_NAME - Invalid value passed for p_name
DUPLICATE_NAME - Perspective with same name already exists
PERMISSION_DENIED - Calling user does not have the authorization to create a perspective

approve

procedure  
      
approve(
    p_item_id in number,
    p_site_id in number,
    p_is_indirect in boolean default false,
    p_comment in varchar2 default null
)
    
Approves an item that has been submitted for approval. This API is new with version 10.1.4.
     approve (
         p_item_id => 32123,
         p_site_id => 33
     );
Parameters:
p_item_id - Thing id of the item.
p_site_id - Site id of the item.
p_is_indirect - Is the item being approved by the current approver? If no, p_is_indirect will be TRUE.
p_comment - Approval comments.
Exceptions:
INVALID_ITEM_ID - Either the item ID or site ID is invalid (or) such an item is not pending approval anymore.
wwv_exceptions.PERMISSION - To be able to approve an item, the user should either be the current approver or should atleast have the 'Manage Content' privilege.

check_in_item

procedure  
      
check_in_item(
    p_master_item_id in number,
    p_caid in number
)
    
Checks in an item, provided it is checked-out. This API is new with version 10.1.4.
Parameters:
p_master_item_id - Masterthingid of the item.
p_caid - Site id of the item.
Exceptions:
INVALID_CAID - Source or destination site id was invalid.
INVALID_ITEM_ID - Masterthingid passed was invalid.
PERMISSION_DENIED - User does not have permission to perform this operation.

check_out_item

procedure  
      
check_out_item(
    p_master_item_id in number,
    p_caid in number
)
    
Checks out an item, provided the item is enabled for check-out. This API is new with version 10.1.4.
Parameters:
p_master_item_id - Masterthingid of the item.
p_caid - Site id of the item.
Exceptions:
INVALID_CAID - Source or destination site id was invalid.
INVALID_ITEM_ID - Masterthingid passed was invalid.
PERMISSION_DENIED - User does not have permission to perform this operation.

clear_cmef_context

procedure  
      
clear_cmef_context
    
Clears the Content Management Event Framework (CMEF) context. When multiple APIs are called within the same session, the CMEF context needs to be cleared so that messages get logged correctly.

copy_folder

function  
      
copy_folder(
    p_id in number,
    p_siteid in number,
    p_parent_id in number,
    p_name in varchar2,
    p_title in varchar2 default null,
    p_copy_content in boolean default true,
    p_copy_customization in boolean default true,
    p_copy_acl in boolean default true,
    p_copy_subpages in boolean default false
) return number
    
Copy a page within the same page group. This API is new with version 10.1.4.
Parameters:
p_id - the id of the original page
p_siteid - the id of the page group which the original page is in
p_name - the name for the new page
p_title - the display name for the new page
p_copy_content - a flag which indicates whether to copy the content of the original page
p_copy_customization - a flag which indicates whether to copy any personalizations that have been made to the portlets on the orginal page when p_copy_content is set to TRUE.
p_copy_acl - a flag which indicates whether to copy the access control settings of the original page
p_copy_subpages - a flag which indicates whether to copy the original page's all sub-pages
Returns:
the id of the new page
Exceptions:
NOT_ENOUGH_PRIVS - Calling user does not have authorization to copy the page
PAGE_NOT_FOUND - the source page with the given id and page group id does not exist
INVALID_FOLDER - the parent page does not exist
INVALID_NAME - Page name must not contain spaces or special characters
DUPLICATE_NAME - A page with p_name value already exists in the selected parent page id

copy_item

function  
      
copy_item(
    p_master_item_id in number,
    p_dest_page_id in number,
    p_caid in number,
    p_dest_caid in number default null,
    p_dest_region_id in number default null
) return number
    
Copies an item to a page either within the same page group or across page groups. This API is new with version 10.1.4.
Parameters:
p_master_item_id - Masterthingid of the item.
p_dest_page_id - Destination page id.
p_caid - Site id of the item.
p_dest_caid - Destination site id.
p_dest_region_id - Destination region id (optional).
Returns:
masterthingid of the new item
Exceptions:
INVALID_CAID - Source or destination site id was invalid.
INVALID_ITEM_ID - Masterthingid passed was invalid.
INVALID_FOLDER - Page id passed was invalid.
NO_ITEM_REGION - No item region is defined on the page.
LOCAL_OBJECT - Item is based on a local item type or has a local category or perspective(s) attached to it.
PENDING_ITEMS_EXIST - Sub-items exist in one of the approval states.

delete_folder

procedure  
      
delete_folder(
    p_id in number,
    p_siteid in number
)
    
Delete a page. This API is new with version 10.1.4.
Parameters:
p_id - the id of the page
p_siteid - the id of the page group which the page is in
Exceptions:
NOT_ENOUGH_PRIVS - Calling user does not have authorization to delete the page
PAGE_NOT_FOUND - a page with the given id and page group id does not exist
CANNOT_DELETE_ROOT_PAGE - the root page of a page group cannot be deleted.

delete_ils_privilege

procedure  
      
delete_ils_privilege(
    p_grantee_type in varchar2 default wwsec_api . grantee_user,
    p_user_or_group_id in number,
    p_master_item_id in number,
    p_folder_id in number,
    p_caid in number
)
    
Deletes the item level security access privileges for a user or group on a single specified item. Using this API is the same as removing a user or a user group from an item's access control list in the browser interface.

Use the functions in the PDK-PL/SQL package WWSEC_API to retrieve privilege lists, including the user and group IDs associated with an item.

Notes:

  • You must call wwpro_api_invalidation.execute_cache_invalidation() to process the cache invalidation messages generated by this API, as described in the introduction, above.
  • See also add_item_ils_privileges(), enable_ils_for_item(), and inherit_folder_privileges().

    Example:

       declare
          l_user_id number := 334;
          l_page_group_id number := 75;
          l_page_id number := 1;
          l_item_id := 74637;
    
        begin
            wwsbr_api.delete_ils_privilege(
                p_user_or_group_id => l_user_id,
                p_caid           => l_page_group_id,
                p_folder_id      => l_page_id,
                p_master_item_id => l_item_id);
            -- process cache invalidation messages
            wwpro_api_invalidation.execute_cache_invalidation;
       end;
    
Parameters:
p_grantee_type - specifies if privileges are being removed for a user or group. Use the following constants:
  • wwsec_api.GRANTEE_USER (default)
  • wwsec_api.GRANTEE_GROUP
p_user_or_group_id - ID of the user or group.
p_master_item_id - The master_item_id of the item. This value is found in the column MASTERID in the view WWSBR_ALL_ITEMS.
p_folder_id - ID of the page on which the item resides.
p_caid - ID of the page group in which the item resides.
Exceptions:
ITEM_NOT_FOUND_ERROR - An item with the given master item ID does not exist
NOT_ENOUGH_PRIVS - Calling user does not have the authorization to remove the privileges. Requires Manage privilege or higher on the item or the page.

delete_item

procedure  
      
delete_item(
    p_master_item_id in number,
    p_caid in number,
    p_version_number in number default null,
    p_mode in varchar2 default wwsbr_api . delete_item_default
)
    
Deletes an item present in a particular page and page group. This API is new with version 10.1.4.
Parameters:
p_master_item_id - Masterthingid of the item.
p_caid - Site id of the item.
p_version_number - Version Number of the Item.
p_mode - Mode used to delete the item.
Exceptions:
INVALID_CAID - Siteid was invalid.
INVALID_ITEM_ID - Item doesnt exist.
INVALID_MODE - Delete mode was invalid.
ITEM_ACTIVE_VERSION - Trying to delete active version.
ITEM_ALREADY_DELETED - Trying to delete an already deleted version.
INVALID_VERSION_NUMBER - Version Number doesnt exist.
ITEM_CHECKED_OUT - Either this item or one of the sub-items is checked out by another user.
PENDING_ITEMS_EXIST - Sub-items exist in one of the approval states.

enable_ils_for_item

procedure  
      
enable_ils_for_item(
    p_master_item_id in number,
    p_caid in number,
    p_folder_id in number
)
    
Enables item level security for a specified item.

See also add_item_ils_privileges(), delete_ils_privilege(), and inherit_folder_privileges().

Parameters:
p_master_item_id - The master_item_id of the item. This value is found in the column MASTERID in the view WWSBR_ALL_ITEMS.
p_caid - ID of the page group in which the item resides.
p_folder_id - ID of the page on which the item resides.
Exceptions:
ITEM_NOT_FOUND_ERROR - An item with the given master item ID does not exist
ILS_DISABLED - The page does not allow Item Level Security. Cannot add item specific privileges.
NOT_ENOUGH_PRIVS - Calling user does not have the authorization to assign the privileges. Requires Manage privilege on the item or the page.

inherit_folder_privileges

procedure  
      
inherit_folder_privileges(
    p_master_item_id in number,
    p_caid in number,
    p_folder_id in number
)
    
Causes an item that is enabled for item level security to inherit its privileges from the page on which it resides. This procedure can only be used if the page has been set up to permit ILS (Item Level Security). Using this procedure is the same as selecting the 'Inherit Parent Page Access Privileges' option via the browser interface.

Notes:

  • You must call wwpro_api_invalidation.execute_cache_invalidation() to process the cache invalidation messages generated by this API, as described in the introduction, above.

See also add_item_ils_privileges(), delete_ils_privilege(), and enable_ils_for_item().

Example:

   wwsbr_api.inherit_folder_privileges(
       p_master_item_id => 453,
       p_caid => 33,
       p_folder_id => 45);
Parameters:
p_master_item_id - The master_item_id of the item. This value is found in the column MASTERID in the view WWSBR_ALL_ITEMS.
p_caid - ID of the page group in which the item resides.
p_folder_id - ID of the page on which the item resides.
Exceptions:
ITEM_NOT_FOUND_ERROR - An item with the given master item ID does not exist
ILS_DISABLED - The page does not allow Item Level Security. Cannot add item specific privileges.
NOT_ENOUGH_PRIVS - Calling user does not have the authorization to assign the privileges. Requires Manage privilege on the item or the page.

modify_folder

procedure  
      
modify_folder(
    p_page in page_record,
    p_new_url in varchar2 default null
)
    
Modifies a page's properties. This API is new with version 10.1.4.
Exceptions:
NOT_ENOUGH_PRIVS - Calling user does not have authorization to modify the page
PAGE_NOT_FOUND - a page with the given id and page group id does not exist
INVALID_NAME - Page name must not contain spaces or special characters
DUPLICATE_NAME - A page with the same name already exists under the same parent
PLSQL_REQUIRED - For a page with a base type of PLSQL, plsql code is required. It must be passed to p_page.value.
INVALID_PLSQL_EXECUTE_USER - The value for p_page.plsql_executor is invalid
MISSING_PLSQL_EXECUTE_USER - The value for p_page.plsql_executor is missing
INVALID_CACHE_EXPIRY - For a page whose both definition and content are cached, cache expiry is required. It must be passed to p_page.cache_expires with a positive number.
INVALID_PAGE_TIMEOUT - The value for limit time spent fetching portlets is invalid. Pass the right value to p_page.timeout.
MISSING_TEMPLATE_FOR_ITEMS - The template specified for items on the page doesn't exist. Pass the correct portal template in p_page.item_page_id, p_page.item_page_site_id and p_page.item_page_tabstring.
INVALID_TEMPLATE_FOR_ITEMS - The template specified for items on the page is not a value template for items. Pass the correct portal template in p_page.item_page_id, p_page.item_page_site_id and p_page.item_page_tabstring.

modify_item

function  
      
modify_item(
    p_master_item_id in number,
    p_item_id in number,
    p_caid in number,
    p_folder_id in number,
    p_display_name in varchar2,
    p_region_id in number default null,
    p_display_option in varchar2 default null,
    p_category_id in number default null,
    p_category_caid in number default null,
    p_perspectives in g_perspectiveidarray default g_perspectiveidemptyarray,
    p_perspectives_caid in g_caid_array default g_empty_caid_array,
    p_author in varchar2 default null,
    p_image_filename in varchar2 default null,
    p_image_referenced in boolean default false,
    p_post_upload in boolean default false,
    p_image_alignment in varchar2 default null,
    p_description in varchar2 default null,
    p_keywords in varchar2 default null,
    p_file_filename in varchar2 default null,
    p_text in varchar2 default null,
    p_url in varchar2 default null,
    p_plsql in varchar2 default null,
    p_plsql_execute_mode in varchar2 default null,
    p_plsql_execute_user in varchar2 default null,
    p_folderlink_id in number default null,
    p_folderlink_caid in number default null,
    p_publish_date in varchar2 default null,
    p_expire_mode in varchar2 default null,
    p_expiration in varchar2 default null,
    p_hide_in_browse in number default no,
    p_checkable in number default no,
    p_attribute_id in wwsbr_type.array default wwsbr_type . empty,
    p_attribute_caid in wwsbr_type.array default wwsbr_type . empty,
    p_attribute_data_type in wwsbr_type.array default wwsbr_type . empty,
    p_attribute_value in wwsbr_type.array default wwsbr_type . empty,
    p_addnewversion in boolean default false,
    p_add_as_current_version in boolean default true,
    p_access_level in varchar2 default null
) return number
    
Modifies an item in a particular page and page group.

See also add_item(), modify_item_post_upload().

Parameters:
p_master_item_id - Required to identify the item that is modified. You can look up this value in the MASTERID column in the view WWSBR_ALL_ITEMS.
p_item_id - Required to identify the version of the item that is modified. This does not have to be the item's current version.
p_caid - ID of the item's page group.
p_folder_id - ID of the item's page.
p_display_name - Display name (title) for the item.
p_display_option - How the item should be displayed. Used for file, text, url, and pl/sql item types, ignored for others. Use the following constants:
  • FULL_SCREEN (link that displays the item in the same browser window)
  • NEW_WINDOW (link that displays the item in a new browser window)
  • IN_PLACE (displays the item in the region - only used for text and pl/sql item types)
p_category_id - ID of category for the item.
p_category_caid - Page group ID of category for item.
p_perspectives - Array of perspective IDs.
p_perspectives_caid - Array of page group IDs for the perspectives in p_perspectives. The position of each element in this array must match the position of the corresponding perspective ID in p_perspectives.
p_author - Author of the item.
p_image_filename - Location of the image associated with this item or the image itself if this is an image item.
  • If p_image_referenced is FALSE, p_image_filename must be a directory path and filename on the same server on which the Portal database is located. The image is uploaded from this location, unless the value of p_post_upload is TRUE.
  • If p_image_referenced is TRUE, p_image_filename is expected to be a URL to the image (equivalent to the src attribute in an IMG tag) or the internal name of an image in the Portal document table (e.g. 5678.GIF).
p_image_referenced - Boolean flag that indicates if p_image_filename is a reference, or a file location for uploading the item's image. Valid values are TRUE (image is referenced) or FALSE (image is not referenced and is uploaded from the file location specified in p_image_filename).
p_post_upload - Boolean flag that indicates if the documents associated with this item have already been uploaded. Used for file and image attributes, ignored for others. If TRUE, documents will not be uploaded when this function is called.
p_image_alignment - Rendering alignment for the item's image. See the constants prefixed with "ALIGN_" for valid values.
p_description - Description of the item.
p_keywords - Keywords for the item.
p_file_filename - Location of the file associated with this item. Used with the file item type, ignored for other item types.
  • If p_post_upload is FALSE, p_file_filename must be a directory path and filename on the same server on which the Portal database is located. The file is uploaded from this location.
  • If p_post_upload is TRUE, p_file_filename is ignored. To associate a new item with a file that already exists in the document table, see add_item_post_upload().
p_text - The text for a text item type.
p_url - The url for a url item type.
p_plsql - The plsql code for a plsql item type.
p_plsql_execute_mode - Execute mode for a PL/SQL type item. Use the following constants:
  • PUBLIC_SCHEMA
  • DB_USER
  • CREATOR_SCHEMA
p_plsql_execute_user - Database user name. Required when DB_USER execute mode is used for a PL/SQL type item.
p_folderlink_id - Page ID for a page link item type.
p_folderlink_caid - Page group ID for a page link item type. May be any valid page group.
p_publish_date - Date on which the item is published. Must be in the format 'dd-mon-yyyy HH12:MI PM'. If no value is passed, the item is published immediately.
p_expire_mode - Expiration mode for the item. Use the following constants:
  • PERMANENT
  • EXP_NUMBER
  • EXP_DATE
p_expiration - Qualifier for p_expire_mode.
  • If p_expire_mode = PERMANENT, p_expiration must be null.
  • If p_expire_mode = EXP_NUMBER, p_expiration must be set to the number of days until expiry.
  • If p_expire_mode = EXP_DATE, p_expiration must be set to a valid expiration date in the future in the format of 'dd-mon-yyyy HH12:MI PM'.
p_hide_in_browse - Pass wwsbr_api.YES to hide the item and wwsbr_api.NO to expose the item.
p_checkable - Flag that determines if the item can be checked out. Valid constant values are YES and NO. Default is NO.
p_attribute_id - Array of attribute IDs for the item. Used for attributes for which no other parameter exists (e.g. custom attributes). The attribute must exist in the item's type definition, as shown in the view WWSBR_ITEM_TYPE_ATTRIBUTES.
p_attribute_caid - Array of page group IDs for the attributes in p_attribute_id. The position of each element in this array must match the position of the corresponding attribute ID in p_attribute_id. p_attribute_caid must be the same as p_caid or the ID of the Shared Objects page group (use the constant SHARED_OBJECTS).
p_attribute_data_type - Array of attribute data types for the attributes in p_attribute_id. The value for this parameter can be found in the DATA_TYPE column in the view WWSBR_ATTRIBUTES, for example 'url', 'boolean', 'text', etc. The position of each element in this array must match the position of the corresponding attribute ID in p_attribute_id.
p_attribute_value - Array of attribute values for the attributes in p_attribute_id. All values are passed as varchar2. The position of each element in this array must match the position of the corresponding attribute ID in p_attribute_id.
p_addnewversion - Boolean flag. If TRUE, adds a new version of the item. If FALSE, updates the current version. Default is FALSE. Must be set to FALSE when the versioning property for the page is set to NONE. Must be set to TRUE when the versioning property for the page is set to AUDIT.
p_add_as_current_version - Determines if the new version would be set as the current version or otherwise. If TRUE, the new version would be added as the current version. If FALSE, the new version would be added as the non-current version. Default is TRUE.
p_access_level - Determines the access control level for the item. Use the following constant values:
  • ITEM_ACCESS - Enables item level security (ILS) for the item. ITEM_ACCESS has the same effect as using the procedure enable_ils_for_item(), and can be used only if the page has been set up to permit ILS.
  • FOLDER_ACCESS - Disables item level security for the item
Returns:
number - The master item ID
Exceptions:
ITEM_NOT_FOUND_ERROR - An item with the given master item ID and ID does not exist
FOLDER_VERSIONING_IS_NONE - Attempted to add a new version when page versioning is set to NONE
FOLDER_VERSIONING_IS_AUDIT - Attempted to update the current version when page versioning is set to AUDIT
ILS_DISABLED - Attempted to set item level access privileges when Item Level Security is not enabled for the page
QUOTA_EXCEEDED - Uploaded file exceeds the page group quota
INVALID_PUBLISH_DATE_FORMAT - Date format for publish date is invalid
INVALID_PUBLISH_DATE_VALUE - Publish date must be today or later and publish date must be later than the expire date
NULL_EXPIRE_NUMBER - If value for p_expire_mode is EXP_NUMBER, then a value is required for p_expiration
INVALID_EXPIRE_NUMBER - Invalid number passed for p_expiration (only raised if p_expire_mode = EXP_NUMBER)
NULL_EXPIRE_DATE - If value for p_expire_mode is EXP_DATE, then a value is required for p_expiration
INVALID_EXPIRE_DATE - An invalid expiration date was passed. The expiration date must be later than the current date.
INVALID_EXPIRE_DATE_FORMAT - Date format for expiry date is invalid
ITEM_UPDATE_ERROR - Some other error occurred
ITEM_NOT_FOR_UPDATE - Item cannot be updated as it is either deleted, or deleted and rejected. This exception is also raised when a pending item is attempted to be updated by someone other than the approver. Finally, it is also raised when a draft item is attempted to be updated by someone other than the submitter.
PERMISSION_DENIED - User does not have adequate privileges to perform this operation.
UNKNOWN_ERROR - An unknown error occurred

modify_item_post_upload

function  
      
modify_item_post_upload(
    p_master_item_id in number,
    p_item_id in number,
    p_caid in number,
    p_folder_id in number,
    p_display_name in varchar2,
    p_region_id in number default null,
    p_display_option in varchar2 default null,
    p_category_id in number default null,
    p_category_caid in number default null,
    p_perspectives in g_perspectiveidarray default g_perspectiveidemptyarray,
    p_perspectives_caid in g_caid_array default g_empty_caid_array,
    p_author in varchar2 default null,
    p_image_name in varchar2 default null,
    p_image_alignment in varchar2 default null,
    p_description in varchar2 default null,
    p_keywords in varchar2 default null,
    p_file_name in varchar2 default null,
    p_text in varchar2 default null,
    p_url in varchar2 default null,
    p_plsql in varchar2 default null,
    p_plsql_execute_mode in varchar2 default null,
    p_plsql_execute_user in varchar2 default null,
    p_folderlink_id in number default null,
    p_folderlink_caid in number default null,
    p_publish_date in varchar2 default null,
    p_expire_mode in varchar2 default null,
    p_expiration in varchar2 default null,
    p_hide_in_browse in number default no,
    p_checkable in number default no,
    p_attribute_id in wwsbr_type.array default wwsbr_type . empty,
    p_attribute_caid in wwsbr_type.array default wwsbr_type . empty,
    p_attribute_data_type in wwsbr_type.array default wwsbr_type . empty,
    p_attribute_value in wwsbr_type.array default wwsbr_type . empty,
    p_addnewversion in boolean default false,
    p_add_as_current_version in boolean default true,
    p_access_level in varchar2 default null
) return number
    
Modifies an item and links it to existing document(s) in the document table. After a document has been uploaded to the document table, you can call this API to have an existing item "claim" the document.

This API requires that all files and images have already been uploaded to the document table. using the methods described under add_item_post_upload().

See also modify_item(), add_item_post_upload(), and upload_blob().

Parameters:
p_master_item_id - Required to identify the item that is modified. You can look up this value in the MASTERID column in the view WWSBR_ALL_ITEMS.
p_item_id - Required to identify the version of the item that is modified. This does not have to be the item's current version.
p_caid - ID of the item's page group.
p_folder_id - ID of the item's page.
p_display_name - Display name (title) for the item.
p_display_option - How the item should be displayed. Used for file, text, url, and pl/sql item types, ignored for others. Use the following constants:
  • FULL_SCREEN (link that displays the item in the same browser window)
  • NEW_WINDOW (link that displays the item in a new browser window)
  • IN_PLACE (displays the item in the region - only used for text and pl/sql item types)
p_category_id - ID of category for the item.
p_category_caid - Page group ID of category for item.
p_perspectives - Array of perspective IDs.
p_perspectives_caid - Array of page group IDs for the perspectives in p_perspectives. The position of each element in this array must match the position of the corresponding perspective ID in p_perspectives.
p_author - Author of the item.
p_image_name - Internal document name for the item's image, matching a document in the document table. Pass the value returned from upload_blob() to this parameter to reference the uploaded document as the image for this item.
p_image_alignment - Rendering alignment for the item's image. See the constants prefixed with "ALIGN_" for valid values.
p_description - Description of the item.
p_keywords - Keywords for the item.
p_file_name - Internal document name for a file type item, matching a document in the document table. Pass the value returned from upload_blob() to this parameter to reference the uploaded document as the file for this item.
p_text - The text for a text item type.
p_url - The url for a url item type.
p_plsql - The plsql code for a plsql item type.
p_plsql_execute_mode - Execute mode for a PL/SQL type item. Use the following constants:
  • PUBLIC_SCHEMA
  • DB_USER
  • CREATOR_SCHEMA
p_plsql_execute_user - Database user name. Required when DB_USER execute mode is used for a PL/SQL type item.
p_folderlink_id - Page ID for a page link item type.
p_folderlink_caid - Page group ID for a page link item type. May be any valid page group.
p_publish_date - Date on which the item is published. Must be in the format 'dd-mon-yyyy HH12:MI PM'. If no value is passed, the item is published immediately.
p_expire_mode - Expiration mode for the item. Use the following constants:
  • PERMANENT
  • EXP_NUMBER
  • EXP_DATE
p_expiration - Qualifier for p_expire_mode.
  • If p_expire_mode = PERMANENT, p_expiration must be null.
  • If p_expire_mode = EXP_NUMBER, p_expiration must be set to the number of days until expiry.
  • If p_expire_mode = EXP_DATE, p_expiration must be set to a valid expiration date in the future in the format of 'dd-mon-yyyy HH12:MI PM'.
p_hide_in_browse - Pass wwsbr_api.YES to hide the item and wwsbr_api.NO to expose the item.
p_checkable - Flag that determines if the item can be checked out. Valid constant values are YES and NO. Default is NO.
p_attribute_id - Array of attribute IDs for the item. Used for attributes for which no other parameter exists (e.g. custom attributes). The attribute must exist in the item's type definition, as shown in the view WWSBR_ITEM_TYPE_ATTRIBUTES.
p_attribute_caid - Array of page group IDs for the attributes in p_attribute_id. The position of each element in this array must match the position of the corresponding attribute ID in p_attribute_id. Must be the same as p_caid or the ID of the Shared Objects page group (use the constant SHARED_OBJECTS).
p_attribute_data_type - Array of attribute data types for the attributes in p_attribute_id. The value for this parameter can be found in the DATA_TYPE column in the view WWSBR_ATTRIBUTES, for example 'url', 'boolean', 'text', etc. The position of each element in this array must match the position of the corresponding attribute ID in p_attribute_id.
p_attribute_value - Array of attribute values for the attributes in p_attribute_id. All values are passed as varchar2. The position of each element in this array must match the position of the corresponding attribute ID in p_attribute_id.
p_addnewversion - Boolean flag. If TRUE, adds a new version of the item. If FALSE, updates the current version. Default is FALSE. Must be set to FALSE when the versioning property for the page is set to NONE. Must be set to TRUE when the versioning property for the page is set to AUDIT.
p_add_as_current_version - Determines if the new version would be set as the current version or otherwise. If TRUE, the new version would be added as the current version. If FALSE, the new version would be added as the non-current version.
p_access_level - Determines the access control level for the item. Use the following constant values:
  • ITEM_ACCESS - Enables item level security (ILS) for the item. ITEM_ACCESS has the same effect as using the procedure enable_ils_for_item(), and can be used only if the page has been set up to permit ILS.
  • FOLDER_ACCESS - Disables item level security for the item
Returns:
number - The master item ID
Exceptions:
ITEM_NOT_FOUND_ERROR - An item with the given master item ID and ID does not exist
FOLDER_VERSIONING_IS_NONE - Attempted to add a new version when page versioning is set to NONE
FOLDER_VERSIONING_IS_AUDIT - Attempted to update the current version when page versioning is set to AUDIT
ILS_DISABLED - Attempted to set item level access privileges when Item Level Security is not enabled for the page
QUOTA_EXCEEDED - Uploaded file exceeds the page group quota
INVALID_PUBLISH_DATE_FORMAT - Date format for publish date is invalid
INVALID_PUBLISH_DATE_VALUE - Publish date must be today or later and publish date must be later than the expire date
NULL_EXPIRE_NUMBER - If value for p_expire_mode is EXP_NUMBER, then a value is required for p_expiration
INVALID_EXPIRE_NUMBER - Invalid number passed for p_expiration (only raised if p_expire_mode = EXP_NUMBER)
NULL_EXPIRE_DATE - If value for p_expire_mode is EXP_DATE, then a value is required for p_expiration
INVALID_EXPIRE_DATE - An invalid expiration date was passed. The expiration date must be later than the current date.
INVALID_EXPIRE_DATE_FORMAT - Date format for expiry date is invalid
ITEM_UPDATE_ERROR - Some other error occurred
ITEM_NOT_FOR_UPDATE - Item cannot be updated as it is either deleted, or deleted and rejected. This exception is also raised when a pending item is attempted to be updated by someone other than the approver. Finally, it is also raised when a draft item is attempted to be updated by someone other than the submitter.
PERMISSION_DENIED - User does not have adequate privileges to perform this operation.
UNKNOWN_ERROR - An unknown error occurred

move_category

procedure  
      
move_category(
    p_src_id in number,
    p_dest_id in number,
    p_siteid in number
)
    
Moves a category within a pagegroup.

A user who has manage classification privileges on this site can call this procedure.

Example:

Move Category Procedure:

   wwsbr_api.move_category
   (
       p_src_id        =>2000,
       p_dest_id       =>3000,
       p_siteid        =>33
   );
Parameters:
p_src_id - a unique identifier used to identify the category that is to be reparented. A null value is not permitted.
p_dest_id - a unique identifier identifying the category under which the category given by p_src_id is to be moved. A null value is not permitted.
p_siteid - the id of the site to which both the above categories belong. A null value is not permitted.
Exceptions:
INVALID_CATEGORY - Raised if either source or destination perspective are invalid.
NOT_ENOUGH_PRIVS - Raised if user does not have manage classification privileges on the pagegroup
INVALID_MOVE - Raised if attempting to move a perspective to be a child of a perspective whcih is below it in the hierarchy.
INVALID_CAID - Raised if an invalid siteid is specified
UNKNOWN_ERROR - An unknown error occurred

move_folder

procedure  
      
move_folder(
    p_id in number,
    p_siteid in number,
    p_parent_id in number
)
    
Move a page to be another page's sub page within the same page group. This API is new with version 10.1.4.
Parameters:
p_id - the id of the page
p_siteid - the id of the page group which the page is in
Exceptions:
NOT_ENOUGH_PRIVS - Calling user does not have authorization to copy the page
PAGE_NOT_FOUND - the source page with the given id and page group id does not exist
INVALID_FOLDER - the parent page does not exist
DUPLICATE_NAME - A page with p_name value already exists in the selected parent page id

move_item

procedure  
      
move_item(
    p_master_item_id in number,
    p_dest_page_id in number,
    p_caid in number,
    p_dest_caid in number default null,
    p_dest_region_id in number default null
)
    
Move an item either within the same page group or across page groups. This API is new with version 10.1.4.
Parameters:
p_master_item_id - Masterthingid of the item.
p_dest_page_id - Destination page id.
p_caid - Source site id.
p_dest_caid - Destination site id.
p_dest_region_id - Destination region id (optional).
Exceptions:
NOT_ENOUGH_PRIVS - Calling user does not have authorization to move the item to the specified page
INVALID_CAID - Source or destination site id was invalid.
INVALID_ITEM_ID - Masterthingid passed was invalid.
INVALID_FOLDER - Page id passed was invalid.
NO_ITEM_REGION - No item region is defined on the page.
LOCAL_OBJECT - Item is based on a local item type or has a local category or perspective(s) attached to it.
PENDING_ITEMS_EXIST - Sub-items exist in one of the approval states.

move_perspective

procedure  
      
move_perspective(
    p_src_id in number,
    p_dest_id in number,
    p_siteid in number
)
    
The procedure to move a perspective within a pagegroup.

A user who has manage classification privileges on this site can call this procedure.

Example:

Move Perspective Procedure:

   wwsbr_api.move_perspective
   (
       p_src_id        =>2000,
       p_dest_id       =>3000,
       p_siteid        =>33
   );
Parameters:
p_src_id - a unique identifier used to identify the perspective that is to be reparented. A null value is not permitted.
p_dest_id - a unique identifier identifying the perpsective under which the perpsective given by p_src_id is to be moved. A null value is not permitted.
p_siteid - the id of the site to which both the above perpsectives belong. A null value is not permitted.
Exceptions:
INVALID_PERSPECTIVE - Raised if either source or destination perspective are invalid.
NOT_ENOUGH_PRIVS - Raised if user does not have manage classification privileges on the pagegroup
INVALID_MOVE - Raised if attempting to move a perspective to be a child of a perspective whcih is below it in the hierarchy.
INVALID_CAID - Raised if an invalid siteid is specified
UNKNOWN_ERROR - An unknown error occurred

reject

procedure  
      
reject(
    p_item_id in number,
    p_site_id in number,
    p_is_indirect in boolean default false,
    p_comment in varchar2 default null
)
    
Rejects an item that has been submitted for approval. This API is new with version 10.1.4.
     reject (
         p_item_id => 32123,
         p_site_id => 33
     );
Parameters:
p_item_id - Thing id of the item.
p_site_id - Site id of the item.
p_is_indirect - Is the item being approved by the current approver? If no, p_is_indirect will be TRUE.
p_comment - Approval comments.
Exceptions:
INVALID_ITEM_ID - Either the item ID or site ID is invalid (or) such an item is not pending approval anymore.
wwv_exceptions.PERMISSION - To be able to reject an item, the user should either be the current approver or should atleast have the 'Manage Content' privilege.

set_attribute

procedure  
      
set_attribute(
    p_site_id in number,
    p_thing_id in number,
    p_attribute_site_id in number,
    p_attribute_id in varchar2,
    p_attribute_value in varchar2 default null,
    p_language in varchar2 default null,
    p_log_cmef_message in boolean default true
)
    
Modifies attribute values for a particular version of an item. This API is new with version 10.1.4.
Parameters:
p_site_id - Site id of the item.
p_thing_id - Id of the item.
p_attribute_site_id - Site id of the attribute.
p_attribute_id - Attribute id.
p_attribute_value - Attribute value.
p_language - Language for which the entry needs to be updated. For translatable attribute: - if this value is passed then the api updates entries for that language. - if no value is passed, then the api updates the entry where language equals to the default language for the page group.
p_log_cmef_message - Should a message be logged? Default is TRUE. Passing FALSE would prevent the message from being logged and hence, should be done judiciously. Default is TRUE.
Exceptions:
ITEM_NOT_FOUND_ERROR - Item does not exist.
ATTRIBUTE_NOT_FOUND - Attribute does not exist.
CATEGORY_NOT_FOUND - Category does not exist.
SUBTYPEATTRIBUTE_NOT_FOUND - Item type-attribute association does not exist.
NOT_SHARED_SITE - Page group id is not 0 for base attribute.
NULL_ATTRIBUTE_VALUE - Attribute value was null for required attribute.
NULL_ATTRIBUTE_NAME - Null value for Name attribute.
NULL_PUBLISH_DATE - Null value for Publish Date attribute.
NULL_EXPIRATION_PERIOD - Null value for Expiration Period attribute.
INVALID_EXPIRATION_PER_VALUE - Invalid value for Expiration Period attribute.
INVALID_DISPLAY_OPT_VALUE - Invalid value for Display Option attribute.
INVALID_CHECKOUT_VALUE - Invalid value for Check Out attribute.
INVALID_IMAGE_ALIGN_VALUE - Invalid value for Image Align attribute.
EDIT_ROLLOVER_IMAGE_ERROR - Error while trying to edit rollover image attribute.
INVALID_ID - Invalid id (in format siteid_id) passed for attribute value.
INVALID_ITEM_LINK_SITE_ID - Trying to create an item link to some other pagegroup.
INVALID_VERSION_NUMBER - Invalid value (i.e. negative or null value) for Version Number attribute.
ITEM_NOT_FOR_UPDATE - Trying to update an item having status as Rejected, Deleted or Marked for Delete.
NAME_NOT_UNIQUE - Item name is not unique within the page (which also includes sub-pages and tabs on the page).
TEXT_TOO_LONG - Value exceeds 32k in case of ImageMap attribute.
NOT_AUTHORIZED_USER - When user trying to update an item is neither the current approver nor the user who has checked-out the item.
NOT_AVAIL_FOR_CHECK_OUT - Trying to checkout an item that cannot be checked out.
ITEM_ALREADY_CHECKED_OUT - Trying to checkout an item that is already checked out.
INVALID_SMART_TEXT_VALUE - Invalid value for Smart Text attribute.
EDIT_CUSTOM_ATTR - Error while trying to update custom attribute.
INVALID_SMART_LINK_VALUE - Invalid value for Smart Link attribute.
EDIT_PORTAL_SMART_LINK - Error while trying to update smart link attribute.
EDIT_PORTAL_SMART_TEXT - Error while trying to update smart text attribute.
INVALID_MIME_TYPE_VALUE - Invalid value for mime type attribute.
INVALID_CHARACTER_SET_VALUE - Invalid value for character set attribute.
EDIT_MIME_TYPE_ERROR - Error while trying to update mime type attribute.
EDIT_CHARACTER_SET_ERROR - Error while trying to update character set attribute.
UNKNOWN_ERROR - An unknown error occured.

undelete_item

procedure  
      
undelete_item(
    p_thing_id in number,
    p_caid in number
)
    
Unndeletes an item (and its sub-items). This API is new with version 10.1.4.
     begin
         wwsbr_api.undelete_item (
             p_thing_id => 12345,
             p_caid => 33
         );
     end;
Parameters:
p_thing_id - id of the item.
p_caid - site id of the item.
Exceptions:
INVALID_CAID - Source or destination site id was invalid.
INVALID_ITEM_ID - Masterthingid passed was invalid.
PERMISSION_DENIED - User does not have permission to perform this operation.

upload_blob

function  
      
upload_blob(
    p_file_name in varchar2,
    p_blob in blob,
    p_mime_type in varchar2
) return varchar2
    
Uploads document content to the document table. This API is new with version 9.0.2.6.

Uploads document content to the document table as an unclaimed document. This API returns a unique document name that can be used in file name and image name attributes in add_item_post_upload() and modify_item_post_upload().

See also add_item_post_upload(), modify_item_post_upload().

Parameters:
p_file_name - File name to be assigned to the blob. This is not the value returned by this function. Normally, this value is the file name by which the document is known on the source file system (e.g. "index.htm", "Expense Report.xls", etc.).
p_blob - The blob containing the content.
p_mime_type - The mime_type for the blob.
Returns:
varchar2 - A unique, system generated document name in the document table, in the format "NNNNN.<file extension>". For example, if p_file_name = "index.htm", the return value will look like "837569.HTM".
Exceptions:
CANNOT_INSERT_DOCUMENT - The blob could not be inserted in the document table

Overview    Package  Object Type   Deprecated   Index   Help  
Oracle Application Server Portal PL/SQL API Reference - 10.1.4
PREV PACKAGE    NEXT PACKAGE FRAMES    NO FRAMES
SUMMARY: EXCEPTION | TYPE | CONSTANT | VARIABLE | FUNCTION/PROCEDURE DETAIL: EXCEPTION | TYPE | CONSTANT | VARIABLE | FUNCTION/PROCEDURE