| 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 | |||||||
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:
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.
| Exception Summary | |
ATTRIBUTE_NOT_FOUND | |
CANNOT_ASSIGN_ITEM_TEMPLATE | |
CANNOT_DELETE_ROOT_PAGE | |
CANNOT_INSERT_DOCUMENT | |
CATEGORY_NOT_FOUND | |
DRAFT_OR_PENDING_EXISTS | |
DUPLICATE_ID | |
DUPLICATE_NAME | |
EDIT_CHARACTER_SET_ERROR | |
EDIT_CUSTOM_ATTR | |
EDIT_MIME_TYPE_ERROR | |
EDIT_PORTAL_SMART_LINK | |
EDIT_PORTAL_SMART_TEXT | |
EDIT_ROLLOVER_IMAGE_ERROR | |
FOLDER_VERSIONING_IS_AUDIT | |
FOLDER_VERSIONING_IS_NONE | |
ILS_DISABLED | |
ILS_DISABLED_FOR_ITEM | |
INVALID_CACHE_EXPIRY | |
INVALID_CAID | |
INVALID_CATEGORY | |
INVALID_CHARACTER_SET_VALUE | |
INVALID_CHECKOUT_VALUE | |
INVALID_DATE_FORMAT | |
INVALID_DISPLAY_OPT_VALUE | |
INVALID_EXPIRATION_PER_VALUE | |
INVALID_EXPIRE_DATE | |
INVALID_EXPIRE_DATE_FORMAT | |
INVALID_EXPIRE_NUMBER | |
INVALID_FOLDER | |
INVALID_ID | |
INVALID_IMAGE_ALIGN_VALUE | |
INVALID_ITEM_ID | |
INVALID_ITEM_LINK_SITE_ID | |
INVALID_ITEM_TEMPLATE_VALUE | |
INVALID_ITEMTYPE | |
INVALID_LOV_VALUE | |
INVALID_MIME_TYPE_VALUE | |
INVALID_MODE | |
INVALID_MOVE | |
INVALID_NAME | |
INVALID_NUMBER | |
INVALID_PAGE_TIMEOUT | |
INVALID_PERSPECTIVE | |
INVALID_PLSQL_EXECUTE_USER | |
INVALID_PUBLISH_DATE_FORMAT | |
INVALID_PUBLISH_DATE_VALUE | |
INVALID_SMART_LINK_VALUE | |
INVALID_SMART_TEXT_VALUE | |
INVALID_TEMPLATE_FOR_ITEMS | |
INVALID_USERNAME | |
INVALID_VERSION_NUMBER | |
ITEM_ACTIVE_VERSION | |
ITEM_ALREADY_CHECKED_OUT | |
ITEM_ALREADY_DELETED | |
ITEM_CHECKED_OUT | |
ITEM_CREATION_ERROR | |
ITEM_NOT_FOR_UPDATE | |
ITEM_NOT_FOUND_ERROR | |
ITEM_UPDATE_ERROR | |
LOCAL_OBJECT | |
MISSING_DISPLAY_NAME | |
MISSING_ITEM_TYPE | |
MISSING_NAME | |
MISSING_PLSQL_EXECUTE_USER | |
MISSING_TEMPLATE_FOR_ITEMS | |
NAME_NOT_UNIQUE | |
NAME_TOO_LONG | |
NO_ITEM_REGION | |
NO_MASTER_ITEM_ID | |
NOT_AN_ITEM_REGION | |
NOT_AUTHORIZED_USER | |
NOT_AVAIL_FOR_CHECK_OUT | |
NOT_ENOUGH_PRIVS | |
NULL_ATTRIBUTE_NAME | |
NULL_ATTRIBUTE_VALUE | |
NULL_EXPIRATION_PERIOD | |
NULL_EXPIRE_DATE | |
NULL_EXPIRE_NUMBER | |
NULL_PUBLISH_DATE | |
NULL_USER_NAME | |
PAGE_NOT_FOUND | |
PENDING_ITEMS_EXIST | |
PERMISSION_DENIED | |
PLSQL_REQUIRED | |
QUOTA_EXCEEDED | |
REGION_NOT_FOUND | |
REQD_ATTR_MISSING | |
SUBTYPEATTRIBUTE_NOT_FOUND | |
TEXT_TOO_LONG | |
UNKNOWN_ERROR | |
URL_REQUIRED | |
| Type Summary | |
g_array | subtype |
g_caid_array | subtype |
g_perspectiveidarray | subtype |
page_record | subtype |
| Variable Summary | |
g_empty_array | g_array |
g_empty_caid_array | g_caid_array |
g_perspectiveidemptyarray | g_perspectiveidarray |
| Function/Procedure Summary | |
add_category | number |
add_content_area | number |
add_folder | number |
add_item | number |
add_item_ils_privileges | |
add_item_post_upload | number |
add_perspective | number |
approve | |
check_in_item | |
check_out_item | |
clear_cmef_context | |
copy_folder | number |
copy_item | number |
delete_folder | |
delete_ils_privilege | |
delete_item | |
enable_ils_for_item | |
inherit_folder_privileges | |
modify_folder | |
modify_item | number |
modify_item_post_upload | number |
move_category | |
move_folder | |
move_item | |
move_perspective | |
reject | |
set_attribute | |
undelete_item | |
upload_blob | varchar2 |
| Exception Detail |
ATTRIBUTE_NOT_FOUND exception
CANNOT_ASSIGN_ITEM_TEMPLATE exception
CANNOT_DELETE_ROOT_PAGE exception
CANNOT_INSERT_DOCUMENT exception
CATEGORY_NOT_FOUND exception
DRAFT_OR_PENDING_EXISTS exception
DUPLICATE_ID exception
DUPLICATE_NAME exception
EDIT_CHARACTER_SET_ERROR exception
EDIT_CUSTOM_ATTR exception
EDIT_MIME_TYPE_ERROR exception
EDIT_PORTAL_SMART_LINK exception
EDIT_PORTAL_SMART_TEXT exception
EDIT_ROLLOVER_IMAGE_ERROR exception
FOLDER_VERSIONING_IS_AUDIT exception
FOLDER_VERSIONING_IS_NONE exception
ILS_DISABLED exception
ILS_DISABLED_FOR_ITEM exception
INVALID_CACHE_EXPIRY exception
INVALID_CAID exception
INVALID_CATEGORY exception
INVALID_CHARACTER_SET_VALUE exception
INVALID_CHECKOUT_VALUE exception
INVALID_DATE_FORMAT exception
INVALID_DISPLAY_OPT_VALUE exception
INVALID_EXPIRATION_PER_VALUE exception
INVALID_EXPIRE_DATE exception
INVALID_EXPIRE_DATE_FORMAT exception
INVALID_EXPIRE_NUMBER exception
INVALID_FOLDER exception
INVALID_ID exception
INVALID_IMAGE_ALIGN_VALUE exception
INVALID_ITEM_ID exception
INVALID_ITEM_LINK_SITE_ID exception
INVALID_ITEM_TEMPLATE_VALUE exception
INVALID_ITEMTYPE exception
INVALID_LOV_VALUE exception
INVALID_MIME_TYPE_VALUE exception
INVALID_MODE exception
INVALID_MOVE exception
INVALID_NAME exception
INVALID_NUMBER exception
INVALID_PAGE_TIMEOUT exception
INVALID_PERSPECTIVE exception
INVALID_PLSQL_EXECUTE_USER exception
INVALID_PUBLISH_DATE_FORMAT exception
INVALID_PUBLISH_DATE_VALUE exception
INVALID_SMART_LINK_VALUE exception
INVALID_SMART_TEXT_VALUE exception
INVALID_TEMPLATE_FOR_ITEMS exception
INVALID_USERNAME exception
INVALID_VERSION_NUMBER exception
ITEM_ACTIVE_VERSION exception
ITEM_ALREADY_CHECKED_OUT exception
ITEM_ALREADY_DELETED exception
ITEM_CHECKED_OUT exception
ITEM_CREATION_ERROR exception
ITEM_NOT_FOR_UPDATE exception
ITEM_NOT_FOUND_ERROR exception
ITEM_UPDATE_ERROR exception
LOCAL_OBJECT exception
MISSING_DISPLAY_NAME exception
MISSING_ITEM_TYPE exception
MISSING_NAME exception
MISSING_PLSQL_EXECUTE_USER exception
MISSING_TEMPLATE_FOR_ITEMS exception
NAME_NOT_UNIQUE exception
NAME_TOO_LONG exception
NO_ITEM_REGION exception
NO_MASTER_ITEM_ID exception
NOT_AN_ITEM_REGION exception
NOT_AUTHORIZED_USER exception
NOT_AVAIL_FOR_CHECK_OUT exception
NOT_ENOUGH_PRIVS exception
NULL_ATTRIBUTE_NAME exception
NULL_ATTRIBUTE_VALUE exception
NULL_EXPIRATION_PERIOD exception
NULL_EXPIRE_DATE exception
NULL_EXPIRE_NUMBER exception
NULL_PUBLISH_DATE exception
NULL_USER_NAME exception
PAGE_NOT_FOUND exception
PENDING_ITEMS_EXIST exception
PERMISSION_DENIED exception
PLSQL_REQUIRED exception
QUOTA_EXCEEDED exception
REGION_NOT_FOUND exception
REQD_ATTR_MISSING exception
SUBTYPEATTRIBUTE_NOT_FOUND exception
TEXT_TOO_LONG exception
UNKNOWN_ERROR exception
URL_REQUIRED exception
| Type Detail |
subtype g_array is wwsbr_type.array
subtype g_caid_array is wwsbr_type.array
subtype g_perspectiveidarray is wwv_perspectivedb.perspectiveidarray
subtype page_record is wwpob_api_type.page_record
| Constant Detail |
ALIGN_ABSOLUTE_BOTTOM constant varchar2(30) := 'absbottom'
ALIGN_ABSOLUTE_MIDDLE constant varchar2(30) := 'absmiddle'
ALIGN_BASELINE constant varchar2(30) := 'baseline'
ALIGN_BOTTOM constant varchar2(30) := 'bottom'
ALIGN_IMAGE_ABOVE_LINK constant varchar2(30) := 'image_above_link'
ALIGN_LEFT constant varchar2(30) := 'left'
ALIGN_MIDDLE constant varchar2(30) := 'middle'
ALIGN_RIGHT constant varchar2(30) := 'right'
ALIGN_TEXT_TOP constant varchar2(30) := 'texttop'
ALIGN_TOP constant varchar2(30) := 'top'
ARABIC_LANGUAGE constant varchar2(3) := 'ar'
ATTR_DISPLAY_TYPE constant number := 63
ATTR_ELEMENT_MAP_TYPE constant number := 67
ATTR_FUNCTION_ID constant number := 68
ATTR_LOGIN_IMAGE constant number := 58
ATTR_LOGIN_LINK constant number := 57
ATTR_LOGOUT_IMAGE constant number := 60
ATTR_LOGOUT_LINK constant number := 59
ATTR_OBJECT_LIST constant number := 65
ATTR_OBJECT_TYPE_LIST constant number := 64
ATTR_PATH_DEPTH constant number := 69
ATTR_PATH_SEPARATOR constant number := 70
ATTR_PORTAL_SMART_LINK constant number := 56
ATTR_SEARCH_BOX_WIDTH constant number := 62
ATTR_SEARCH_PAGE_GROUP_ID constant number := 61
ATTR_TEXT_TYPE constant number := 66
ATTRIBUTE_AUTHOR constant pls_integer := 5
ATTRIBUTE_CATEGORY constant pls_integer := 48
ATTRIBUTE_CHARSET constant pls_integer := 127
ATTRIBUTE_DESCRIPTION constant pls_integer := 4
ATTRIBUTE_DISP_NAME_DEF constant pls_integer := 93
ATTRIBUTE_DISPLAYOPTION constant pls_integer := 42
ATTRIBUTE_EXPIRATIONPER constant pls_integer := 47
ATTRIBUTE_FILE constant pls_integer := 46
ATTRIBUTE_IMAGE constant pls_integer := 6
ATTRIBUTE_IMAGEALIGN constant pls_integer := 45
ATTRIBUTE_IMAGEMAP constant pls_integer := 53
ATTRIBUTE_ITEM_LINK constant pls_integer := 113
ATTRIBUTE_ITEM_TEMPLATE constant pls_integer := 110
ATTRIBUTE_ITEMCHECKOUT constant pls_integer := 44
ATTRIBUTE_KEYWORDS constant pls_integer := 8
ATTRIBUTE_MIME_TYPE constant pls_integer := 126
ATTRIBUTE_NAME constant pls_integer := 78
ATTRIBUTE_PAGE_LINK constant pls_integer := 52
ATTRIBUTE_PERSPECTIVES constant pls_integer := 17
ATTRIBUTE_PLSQL constant pls_integer := 51
ATTRIBUTE_PUBLISHDATE constant pls_integer := 41
ATTRIBUTE_ROLLOVERIMAGE constant pls_integer := 7
ATTRIBUTE_SMARTLINK constant pls_integer := 56
ATTRIBUTE_SMARTTEXT constant pls_integer := 66
ATTRIBUTE_TEXT constant pls_integer := 50
ATTRIBUTE_TITLE constant pls_integer := 3
ATTRIBUTE_URL constant number := 49
ATTRIBUTE_USE_DISP_NAME_DEF constant pls_integer := 94
ATTRIBUTE_VERSION_NUMBER constant pls_integer := 123
BRAZILIAN_PORTUGUESE_LANG constant varchar2(3) := 'ptb'
CANADIAN_FRENCH_LANGUAGE constant varchar2(3) := 'frc'
CREATOR_SCHEMA constant varchar2(20) := '$CREATOR$'
CROTIAN_LANGUAGE constant varchar2(3) := 'hr'
CZECH_LANGUAGE constant varchar2(3) := 'cs'
DANISH_LANGUAGE constant varchar2(3) := 'dk'
DATA_TYPE_DATE constant varchar2(30) := 'date'
DATA_TYPE_FILE constant varchar2(30) := 'file'
DATA_TYPE_NUMBER constant varchar2(30) := 'number'
DATA_TYPE_OTHER constant varchar2(30) := 'other'
DATA_TYPE_TEXT constant varchar2(30) := 'text'
DB_USER constant varchar(20) := 'db_user'
DELETE_ITEM_DEFAULT constant varchar2(30) := 'DEFAULT_PAGE_GROUP_SETTING'
DELETE_ITEM_LAZYDELETE constant varchar2(30) := 'MARK_FOR_DELETE'
DELETE_ITEM_PURGE constant varchar2(30) := 'PURGE'
DISABLE_ITEM_FOR_CHECK_OUT constant number := 0
DUTCH_LANGUAGE constant varchar2(3) := 'nl'
ENABLE_ITEM_FOR_CHECK_OUT constant number := 1
ENGLISH_LANGUAGE constant varchar2(3) := 'us'
EXP_DATE constant varchar2(20) := 'DATE'
EXP_NUMBER constant varchar2(20) := 'NUMBER'
FINNISH_LANGUAGE constant varchar2(3) := 'sf'
FOLDER_ACCESS constant varchar2(30) := 'folder'
FOLDER_TYPE_CONTAINER constant number := 1
FOLDER_TYPE_PLSQL constant number := 4
FOLDER_TYPE_SEARCH constant number := 3
FOLDER_TYPE_URL constant number := 2
FRENCH_LANGUAGE constant varchar2(3) := 'f'
FULL_SCREEN constant varchar2(30) := 'fullscreen'
GENERAL_CATEGORY constant number := 30
GERMAN_LANGUAGE constant varchar2(3) := 'd'
GREEK_LANGUAGE constant varchar2(3) := 'el'
HEBREW_LANGUAGE constant varchar2(3) := 'iw'
HUNGARIAN_LANGUAGE constant varchar2(3) := 'hu'
IN_FRAME constant varchar2(30) := 'inframe'
IN_PLACE constant varchar2(30) := 'inplace'
IS_OFF constant number := 0
IS_ON constant number := 1
ITALIAN_LANGUAGE constant varchar2(3) := 'i'
ITEM_ACCESS constant varchar2(30) := 'item'
ITEM_CHECKEDOUT constant number := 1
ITEM_NOT_CHECKEDOUT constant number := 0
ITEM_TYPE_APP_COMP constant number := 6
ITEM_TYPE_BASIC_SEARCH constant number := 24
ITEM_TYPE_ELEMENT_LIST constant number := 25
ITEM_TYPE_FILE constant number := 1
ITEM_TYPE_FOLDER_LINK constant number := 4
ITEM_TYPE_IMAGE constant number := 8
ITEM_TYPE_IMAGE_MAP constant number := 31
ITEM_TYPE_JAVA_APP constant number := 11
ITEM_TYPE_LOGIN_LOGOUT constant number := 23
ITEM_TYPE_MAP_LINK constant number := 27
ITEM_TYPE_PAGE_FUNCTION constant number := 34
ITEM_TYPE_PAGE_PATH constant number := 30
ITEM_TYPE_PLSQL constant number := 5
ITEM_TYPE_PORTLET_INST constant number := 13
ITEM_TYPE_SIMPLE_APP_COMP constant number := 18
ITEM_TYPE_SIMPLE_FILE constant number := 14
ITEM_TYPE_SIMPLE_IMAGE constant number := 20
ITEM_TYPE_SIMPLE_JAVA_APP constant number := 28
ITEM_TYPE_SIMPLE_PAGE_LINK constant number := 19
ITEM_TYPE_SIMPLE_PLSQL constant number := 17
ITEM_TYPE_SIMPLE_TEXT constant number := 16
ITEM_TYPE_SIMPLE_URL constant number := 15
ITEM_TYPE_SMART_LINK constant number := 22
ITEM_TYPE_SMART_TEXT constant number := 26
ITEM_TYPE_TEXT constant number := 2
ITEM_TYPE_URL constant number := 3
ITEM_TYPE_ZIP_FILE constant number := 12
JAPANESE_LANGUAGE constant varchar2(3) := 'ja'
KOREAN_LANGUAGE constant varchar2(3) := 'ko'
NEW_WINDOW constant varchar2(30) := 'newbrowserwindow'
NO constant number := 0
NORWEGIAN_LANGUAGE constant varchar2(3) := 'n'
PERMANENT constant varchar2(20) := 'PERMANENT'
POLISH_LANGUAGE constant varchar2(3) := 'pl'
PORTUGUESE_LANGUAGE constant varchar2(3) := 'pt'
PUBLIC_SCHEMA constant varchar2(20) := '$PUBLIC$'
ROMANIAN_LANGUAGE constant varchar2(3) := 'ro'
RUSSIAN_LANGUAGE constant varchar2(3) := 'ru'
SHARED_OBJECTS constant number := 0
SIMPLIFIED_CHINESE_LANGUAGE constant varchar2(3) := 'zhs'
SLOVAK_LANGUAGE constant varchar2(3) := 'sk'
SMART_TEXT_CURRENT_DATE constant varchar2(30) := 'Current Date'
SMART_TEXT_CURRENT_PAGE constant varchar2(30) := 'Current Page'
SMART_TEXT_CURRENT_USER constant varchar2(30) := 'Current User'
SPANISH_ARGENTINA_LANGUAGE constant varchar2(3) := 'esa'
SPANISH_LANGUAGE constant varchar2(3) := 'e'
SWEDISH_LANGUAGE constant varchar2(3) := 's'
THAI_LANGUAGE constant varchar2(3) := 'th'
TRADITIONAL_CHINESE_LANGUAGE constant varchar2(3) := 'zht'
TURKISH_LANGUAGE constant varchar2(3) := 'tr'
VALUE_ACCOUNT_INFO constant varchar2(30) := 'account'
VALUE_ADVANCED_SEARCH constant varchar2(30) := 'advanced_search'
VALUE_APP_SHOCKWAVE_FLASH constant varchar2(50) := 'application/x-shockwave-flash'
VALUE_APPLICATION_ANDREW_INSET constant varchar2(50) := 'application/andrew-inset'
VALUE_APPLICATION_BCPIO constant varchar2(50) := 'application/x-bcpio'
VALUE_APPLICATION_CD_LINK constant varchar2(50) := 'application/x-cdlink'
VALUE_APPLICATION_CHESS_PGN constant varchar2(50) := 'application/x-chess-pgn'
VALUE_APPLICATION_CPIO constant varchar2(50) := 'application/x-cpio'
VALUE_APPLICATION_CSH constant varchar2(50) := 'application/x-csh'
VALUE_APPLICATION_DIRECTOR constant varchar2(50) := 'application/x-director'
VALUE_APPLICATION_DVI constant varchar2(50) := 'application/x-dvi'
VALUE_APPLICATION_FUTURE_SPLSH constant varchar2(50) := 'application/x-futuresplash'
VALUE_APPLICATION_HDF constant varchar2(50) := 'application/x-hdf'
VALUE_APPLICATION_JAVASCRIPT constant varchar2(50) := 'application/x-javascript'
VALUE_APPLICATION_KOAN constant varchar2(50) := 'application/x-koan'
VALUE_APPLICATION_LATEX constant varchar2(50) := 'application/x-latex'
VALUE_APPLICATION_MAC_BIN_HEX constant varchar2(50) := 'application/mac-binhex40'
VALUE_APPLICATION_MAC_COMPACT constant varchar2(50) := 'application/mac-compactpro'
VALUE_APPLICATION_MS_EXCEL constant varchar2(50) := 'application/vnd.ms-excel'
VALUE_APPLICATION_MSWORD constant varchar2(50) := 'application/msword'
VALUE_APPLICATION_NETCDF constant varchar2(50) := 'application/x-netcdf'
VALUE_APPLICATION_OCTET_STREAM constant varchar2(50) := 'application/octet-stream'
VALUE_APPLICATION_ODA constant varchar2(50) := 'application/oda'
VALUE_APPLICATION_PDF constant varchar2(50) := 'application/pdf'
VALUE_APPLICATION_POST_SCRIPT constant varchar2(50) := 'application/postscript'
VALUE_APPLICATION_POWER_POINT constant varchar2(50) := 'application/vnd.ms-powerpoint'
VALUE_APPLICATION_RTF constant varchar2(50) := 'application/rtf'
VALUE_APPLICATION_SH constant varchar2(50) := 'application/x-sh'
VALUE_APPLICATION_SHAR constant varchar2(50) := 'application/x-shar'
VALUE_APPLICATION_SMIL constant varchar2(50) := 'application/smil'
VALUE_APPLICATION_STUFFIT constant varchar2(50) := 'application/x-stuffit'
VALUE_APPLICATION_SV4CPIO constant varchar2(50) := 'application/x-sv4cpio'
VALUE_APPLICATION_SV4CRC constant varchar2(50) := 'application/x-sv4crc'
VALUE_APPLICATION_TAR constant varchar2(50) := 'application/x-tar'
VALUE_APPLICATION_TCL constant varchar2(50) := 'application/x-tcl'
VALUE_APPLICATION_TEX constant varchar2(50) := 'application/x-tex'
VALUE_APPLICATION_TEX_INFO constant varchar2(50) := 'application/x-texinfo'
VALUE_APPLICATION_TROFF constant varchar2(50) := 'application/x-troff'
VALUE_APPLICATION_TROFF_MAN constant varchar2(50) := 'application/x-troff-man'
VALUE_APPLICATION_TROFF_ME constant varchar2(50) := 'application/x-troff-me'
VALUE_APPLICATION_TROFF_MS constant varchar2(50) := 'application/x-troff-ms'
VALUE_APPLICATION_USTAR constant varchar2(50) := 'application/x-ustar'
VALUE_APPLICATION_WAIS_SOURCE constant varchar2(50) := 'application/x-wais-source'
VALUE_APPLICATION_XGTAR constant varchar2(50) := 'application/x-gtar'
VALUE_APPLICATION_ZIP constant varchar2(50) := 'application/zip'
VALUE_AUDIO_AIFF constant varchar2(50) := 'audio/x-aiff'
VALUE_AUDIO_BASIC constant varchar2(50) := 'audio/basic'
VALUE_AUDIO_MIDI constant varchar2(50) := 'audio/midi'
VALUE_AUDIO_MPEG constant varchar2(50) := 'audio/mpeg'
VALUE_AUDIO_RMF constant varchar2(50) := 'audio/x-rmf'
VALUE_AUDIO_WAV constant varchar2(50) := 'audio/wav'
VALUE_AUDIO_XWAV constant varchar2(50) := 'audio/x-wav'
VALUE_AUIDO_REAL_AUDIO constant varchar2(50) := 'audio/x-pn-realaudio'
VALUE_BIG5 constant varchar2(20) := 'ZHT16BIG5'
VALUE_BUILDER constant varchar2(30) := 'builder'
VALUE_CHEMICAL_PDB constant varchar2(50) := 'chemical/x-pdb'
VALUE_COMMUNITY constant varchar2(30) := 'community'
VALUE_CONTACT constant varchar2(30) := 'contact'
VALUE_CURRENT_DATE constant varchar2(30) := 'currentdate'
VALUE_CURRENT_PAGE constant varchar2(30) := 'currentpage'
VALUE_CURRENT_USER constant varchar2(30) := 'currentuser'
VALUE_CUST_MOBILE_HOME_PAGE constant varchar2(30) := 'mobile'
VALUE_CUSTOMIZE_PAGE constant varchar2(30) := 'customize'
VALUE_EDIT_PAGE constant varchar2(30) := 'edit'
VALUE_EUC_JP constant varchar2(20) := 'JA16EUC'
VALUE_FAVOURITES constant varchar2(30) := 'favorites'
VALUE_GBK constant varchar2(20) := 'ZHS16CGB231280'
VALUE_HELP constant varchar2(30) := 'help'
VALUE_IMAGE_BMP constant varchar2(50) := 'image/bmp'
VALUE_IMAGE_CMU_RASTER constant varchar2(50) := 'image/x-cmu-raster'
VALUE_IMAGE_GIF constant varchar2(50) := 'image/gif'
VALUE_IMAGE_IEF constant varchar2(50) := 'image/ief'
VALUE_IMAGE_JPEG constant varchar2(50) := 'image/jpeg'
VALUE_IMAGE_PNG constant varchar2(50) := 'image/png'
VALUE_IMAGE_PORTABLE_ANYMAP constant varchar2(50) := 'image/x-portable-anymap'
VALUE_IMAGE_PORTABLE_BITMAP constant varchar2(50) := 'image/x-portable-bitmap'
VALUE_IMAGE_PORTABLE_GRAYMAP constant varchar2(50) := 'image/x-portable-bitmap'
VALUE_IMAGE_PORTABLE_PIXMAP constant varchar2(50) := 'image/x-portable-pixmap'
VALUE_IMAGE_RGB constant varchar2(50) := 'image/x-rgb'
VALUE_IMAGE_TIFF constant varchar2(50) := 'image/tiff'
VALUE_IMAGE_XBITMAP constant varchar2(50) := 'image/x-xbitmap'
VALUE_IMAGE_XPIXMAP constant varchar2(50) := 'image/x-xpixmap'
VALUE_IMAGE_XWINDOW_DUMP constant varchar2(50) := 'image/x-xwindowdump'
VALUE_ISO_8859 constant varchar2(20) := 'WE8ISO8859P1'
VALUE_M0DEL_MESH constant varchar2(50) := 'model/mesh'
VALUE_MODEL_IGES constant varchar2(50) := 'model/iges'
VALUE_MODEL_VRML constant varchar2(50) := 'model/vrml'
VALUE_NAVIGATOR constant varchar2(30) := 'navigator'
VALUE_PAGE_GROUP_HOME constant varchar2(30) := 'page_group_home'
VALUE_PERSONAL_PAGE constant varchar2(30) := 'personal_page'
VALUE_PORTAL_HOME constant varchar2(30) := 'home'
VALUE_PORTLET_REPOS constant varchar2(30) := 'portlet_repos'
VALUE_PORTLET_REPOS_REF_STATUS constant varchar2(30) := 'refprovstatus'
VALUE_PROPERTY_SHEET constant varchar2(30) := 'sheet'
VALUE_REAL_AUDIO constant varchar2(50) := 'audio/x-realaudio'
VALUE_REAL_AUDIO_PLUGIN constant varchar2(50) := 'audio/x-pn-realaudio-plugin'
VALUE_REF_PORTLET_REPOS constant varchar2(30) := 'refprovs'
VALUE_REFRESH_PAGE constant varchar2(30) := 'refresh'
VALUE_SHIFT_JIS constant varchar2(20) := 'JA16SJIS'
VALUE_SUBSCRIBE constant varchar2(30) := 'subscribe'
VALUE_TEXT_CSS constant varchar2(50) := 'text/css'
VALUE_TEXT_HTML constant varchar2(50) := 'text/html'
VALUE_TEXT_PLAIN constant varchar2(50) := 'text/plain'
VALUE_TEXT_RICHTEXT constant varchar2(50) := 'text/richtext'
VALUE_TEXT_SETEXT constant varchar2(50) := 'text/x-setext'
VALUE_TEXT_SGML constant varchar2(50) := 'text/sgml'
VALUE_TEXT_TAB_SEP_VALUES constant varchar2(50) := 'text/tab-separated-values'
VALUE_TEXT_XML constant varchar2(50) := 'text/xml'
VALUE_US_ASCII constant varchar2(20) := 'US7ASCII'
VALUE_UTF8 constant varchar2(20) := 'UTF8'
VALUE_VIDEO_COOLTALK constant varchar2(50) := 'x-conference/x-cooltalk'
VALUE_VIDEO_MPEG constant varchar2(50) := 'video/mpeg'
VALUE_VIDEO_MSVIDEO constant varchar2(50) := 'video/x-msvideo'
VALUE_VIDEO_QUICKTIME constant varchar2(50) := 'video/quicktime'
VALUE_VIDEO_SGI_MOVIE constant varchar2(50) := 'video/x-sgi-movie'
VALUE_WINDOWS_1252 constant varchar2(20) := 'WE8MSWIN1252'
VERSIONING_AUDIT constant varchar2(30) := 'versionaudit'
VERSIONING_NONE constant varchar2(30) := 'versionnone'
VERSIONING_SIMPLE constant varchar2(30) := 'versionsimple'
YES constant number := 1
| Variable Detail |
g_empty_array g_array
g_empty_caid_array g_caid_array
g_perspectiveidemptyarray g_perspectiveidarray
| Function/Procedure Detail |
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 numberp_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.MISSING_NAME - No value passed for p_nameMISSING_DISPLAY_NAME - No value passed for p_display_nameINVALID_CATEGORY - Parent category specified does not existINVALID_NAME - Invalid value passed for p_nameDUPLICATE_NAME - Category with same name already existsPERMISSION_DENIED - Calling user does not have the authorization
to create a category
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 numberp_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:
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.INVALID_NAME - Page group name contains spaces or special charactersDUPLICATE_NAME - A page group with p_name value already existsMISSING_NAME - No value was passed for the page group nameNAME_TOO_LONG - Name must be less than 60 charactersMISSING_DISPLAY_NAME - No value was passed for the page group display name
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 numberp_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:
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:
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.DUPLICATE_NAME - A page with p_name value already exists in
selected parent page idINVALID_NAME - Page name must not contain spaces or special charactersMISSING_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 charactersURL_REQUIRED - For a page with a base type of URL, a URL is required.
It must be passed to the p_value parameterPLSQL_REQUIRED - For a page with a base type of PLSQL, plsql code
is required. It must be passed to p_valueINVALID_PLSQL_EXECUTE_USER - The value for p_plsql_excute_user is invalidMISSING_PLSQL_EXECUTE_USER - The value for p_plsql_excute_user is missing
when plsql_execute_mode is set to DB_USERINVALID_FOLDER - Invalid parent page idNOT_ENOUGH_PRIVS - Calling user does not have authorization to add a page
under the specified parent page.
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 numberp_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:
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.
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.
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: 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:
p_expiration - Qualifier for p_expire_mode.
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.MISSING_ITEM_TYPE - No value was passed for p_type_idQUOTA_EXCEEDED - The uploaded file exceeds the page group quotaNOT_ENOUGH_PRIVS - Calling user does not have authorization to
add an item to the specified pageINVALID_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 dateNULL_EXPIRE_NUMBER - If value for p_expire_mode is EXP_NUMBER,
then a value is required for p_expirationINVALID_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_expirationINVALID_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 invalidREQD_ATTR_MISSING - Required custom attribute was not passed when adding
an item for a custom item typeNO_ITEM_REGION - The page does not contain an item regionPERMISSION_DENIED - User does not have adequate privileges to
perform this operation.ITEM_CREATION_ERROR - Some other error occurred
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
) 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.
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.ITEM_NOT_FOUND_ERROR - An item with the given master item ID does not existILS_DISABLED - Page does not allow Item Level Security.
Cannot add item specific privilegesILS_DISABLED_FOR_ITEM - Item not set up to use own ILS privileges.
Use enable_ils_for_item() before calling this procedure for this itemNOT_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
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 numberThis 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().
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:
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:
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:
p_expiration - Qualifier for p_expire_mode.
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.MISSING_ITEM_TYPE - No value was passed for p_type_idQUOTA_EXCEEDED - The uploaded file exceeds the page group quotaINVALID_PUBLISH_DATE_FORMAT - Date format for publish date is invalidINVALID_PUBLISH_DATE_VALUE - Publish date must be today or later,
and publish date must be later than the expire dateNULL_EXPIRE_NUMBER - If value for p_expire_mode is EXP_NUMBER,
then a value is required for p_expirationINVALID_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_expirationINVALID_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 invalidREQD_ATTR_MISSING - Required custom attribute was not passed when adding an
item for a custom item typePERMISSION_DENIED - User does not have adequate privileges to
perform this operation.ITEM_CREATION_ERROR - Some other error occurred
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 numberp_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.MISSING_NAME - No value passed for p_nameMISSING_DISPLAY_NAME - No value passed for p_display_nameINVALID_PERSPECTIVE - Parent perspective specified does not existINVALID_NAME - Invalid value passed for p_nameDUPLICATE_NAME - Perspective with same name already existsPERMISSION_DENIED - Calling user does not have the authorization
to create a perspective
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
)
approve (
p_item_id => 32123,
p_site_id => 33
);
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.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.
procedure check_in_item(
p_master_item_id in number,
p_caid in number
) p_master_item_id - Masterthingid of the item.p_caid - Site id of the item.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.
procedure check_out_item(
p_master_item_id in number,
p_caid in number
) p_master_item_id - Masterthingid of the item.p_caid - Site id of the item.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.procedure clear_cmef_context
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 numberp_id - the id of the original pagep_siteid - the id of the page group which the original page is inp_name - the name for the new pagep_title - the display name for the new pagep_copy_content - a flag which indicates whether to copy the content
of the original pagep_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 pagep_copy_subpages - a flag which indicates whether to copy the original
page's all sub-pagesNOT_ENOUGH_PRIVS - Calling user does not have authorization to
copy the pagePAGE_NOT_FOUND - the source page with the given id and page
group id does not existINVALID_FOLDER - the parent page does not existINVALID_NAME - Page name must not contain spaces or special charactersDUPLICATE_NAME - A page with p_name value already exists in the
selected parent page id
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 numberp_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).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.
procedure delete_folder(
p_id in number,
p_siteid in number
) p_id - the id of the pagep_siteid - the id of the page group which the page is inNOT_ENOUGH_PRIVS - Calling user does not have authorization to
delete the pagePAGE_NOT_FOUND - a page with the given id and page group id
does not existCANNOT_DELETE_ROOT_PAGE - the root page of a page group cannot
be deleted.
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
) 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:
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;
p_grantee_type - specifies if privileges are being removed for
a user or group. Use the following constants:
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.ITEM_NOT_FOUND_ERROR - An item with the given master item ID does not existNOT_ENOUGH_PRIVS - Calling user does not have the authorization to remove
the privileges. Requires Manage privilege or higher
on the item or the page.
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
) 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.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.
procedure enable_ils_for_item(
p_master_item_id in number,
p_caid in number,
p_folder_id in number
) See also add_item_ils_privileges(), delete_ils_privilege(), and inherit_folder_privileges().
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.ITEM_NOT_FOUND_ERROR - An item with the given master item ID does not existILS_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.
procedure inherit_folder_privileges(
p_master_item_id in number,
p_caid in number,
p_folder_id in number
) Notes:
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);
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.ITEM_NOT_FOUND_ERROR - An item with the given master item ID does not existILS_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.
procedure modify_folder(
p_page in page_record,
p_new_url in varchar2 default null
) NOT_ENOUGH_PRIVS - Calling user does not have authorization to
modify the pagePAGE_NOT_FOUND - a page with the given id and page group id
does not existINVALID_NAME - Page name must not contain spaces or special
charactersDUPLICATE_NAME - A page with the same name already exists under
the same parentPLSQL_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 invalidMISSING_PLSQL_EXECUTE_USER - The value for p_page.plsql_executor
is missingINVALID_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.
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 numberSee also add_item(), modify_item_post_upload().
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:
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.
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.
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: 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:
p_expiration - Qualifier for p_expire_mode.
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_NOT_FOUND_ERROR - An item with the given master item ID and ID
does not existFOLDER_VERSIONING_IS_NONE - Attempted to add a new version
when page versioning is set to NONEFOLDER_VERSIONING_IS_AUDIT - Attempted to update the current version
when page versioning is set to AUDITILS_DISABLED - Attempted to set item level access privileges
when Item Level Security is not enabled for the pageQUOTA_EXCEEDED - Uploaded file exceeds the page group quotaINVALID_PUBLISH_DATE_FORMAT - Date format for publish date is invalidINVALID_PUBLISH_DATE_VALUE - Publish date must be today or later
and publish date must be later than the expire dateNULL_EXPIRE_NUMBER - If value for p_expire_mode is EXP_NUMBER,
then a value is required for p_expirationINVALID_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_expirationINVALID_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 invalidITEM_UPDATE_ERROR - Some other error occurredITEM_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
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 numberThis 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().
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:
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: 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:
p_expiration - Qualifier for p_expire_mode.
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_NOT_FOUND_ERROR - An item with the given master item ID and ID
does not existFOLDER_VERSIONING_IS_NONE - Attempted to add a new version
when page versioning is set to NONEFOLDER_VERSIONING_IS_AUDIT - Attempted to update the current version
when page versioning is set to AUDITILS_DISABLED - Attempted to set item level access privileges
when Item Level Security is not enabled for the pageQUOTA_EXCEEDED - Uploaded file exceeds the page group quotaINVALID_PUBLISH_DATE_FORMAT - Date format for publish date is invalidINVALID_PUBLISH_DATE_VALUE - Publish date must be today or later
and publish date must be later than the expire dateNULL_EXPIRE_NUMBER - If value for p_expire_mode is EXP_NUMBER,
then a value is required for p_expirationINVALID_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_expirationINVALID_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 invalidITEM_UPDATE_ERROR - Some other error occurredITEM_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
procedure move_category(
p_src_id in number,
p_dest_id in number,
p_siteid in number
) 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
);
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.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 pagegroupINVALID_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 specifiedUNKNOWN_ERROR - An unknown error occurred
procedure move_folder(
p_id in number,
p_siteid in number,
p_parent_id in number
) p_id - the id of the pagep_siteid - the id of the page group which the page is inNOT_ENOUGH_PRIVS - Calling user does not have authorization to
copy the pagePAGE_NOT_FOUND - the source page with the given id and page
group id does not existINVALID_FOLDER - the parent page does not existDUPLICATE_NAME - A page with p_name value already exists in the
selected parent page id
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
) 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).NOT_ENOUGH_PRIVS - Calling user does not have authorization to
move the item to the specified pageINVALID_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.
procedure move_perspective(
p_src_id in number,
p_dest_id in number,
p_siteid in number
) 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
);
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.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 pagegroupINVALID_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 specifiedUNKNOWN_ERROR - An unknown error occurred
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
)
reject (
p_item_id => 32123,
p_site_id => 33
);
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.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.
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
) 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.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.
procedure undelete_item(
p_thing_id in number,
p_caid in number
)
begin
wwsbr_api.undelete_item (
p_thing_id => 12345,
p_caid => 33
);
end;
p_thing_id - id of the item.p_caid - site id of the item.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.
function upload_blob(
p_file_name in varchar2,
p_blob in blob,
p_mime_type in varchar2
) return varchar2Uploads 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().
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.CANNOT_INSERT_DOCUMENT - The blob could not be inserted in the document table
| 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 | |||||||