Transcription
Oracle Contracts for RightsAPI Reference GuideRelease 11iSeptember 2001Part No. A95209-01
Oracle Contracts for Rights API Reference Guide , Release 11iPart No. A95209-01Copyright 1996, 2001, Oracle Corporation. All rights reserved.The Programs (which include both the software and documentation) contain proprietary information ofOracle Corporation; they are provided under a license agreement containing restrictions on use anddisclosure and are also protected by copyright, patent, and other intellectual and industrial propertylaws. Reverse engineering, disassembly, or decompilation of the Programs is prohibited.The information contained in this document is subject to change without notice. If you find any problemsin the documentation, please report them to us in writing. Oracle Corporation does not warrant that thisdocument is error free. Except as may be expressly permitted in your license agreement for thesePrograms, no part of these Programs may be reproduced or transmitted in any form or by any means,electronic or mechanical, for any purpose, without the express written permission of Oracle Corporation.If the Programs are delivered to the U.S. Government or anyone licensing or using the programs onbehalf of the U.S. Government, the following notice is applicable:Restricted Rights Notice Programs delivered subject to the DOD FAR Supplement are "commercialcomputer software" and use, duplication, and disclosure of the Programs, including documentation,shall be subject to the licensing restrictions set forth in the applicable Oracle license agreement.Otherwise, Programs delivered subject to the Federal Acquisition Regulations are "restricted computersoftware" and use, duplication, and disclosure of the Programs shall be subject to the restrictions in FAR52.227-19, Commercial Computer Software - Restricted Rights (June, 1987). Oracle Corporation, 500Oracle Parkway, Redwood City, CA 94065.The Programs are not intended for use in any nuclear, aviation, mass transit, medical, or other inherentlydangerous applications. It shall be the licensee's responsibility to take all appropriate fail-safe, backup,redundancy, and other measures to ensure the safe use of such applications if the Programs are used forsuch purposes, and Oracle Corporation disclaims liability for any damages caused by such use of thePrograms.Oracle is a registered trademark of Oracle Corporation. Other names may be trademarks of theirrespective owners.
ContentsSend Us Your Comments . viiPreface. ixIntended Audience .Structure.Related Documents.Conventions.Documentation Accessibility 3.61.41.52ixxxixixiIntellectual Property Catalog APIs .Contract Catalog Public APIs .Parameter Specifications .Standard IN Parameters.Standard OUT Parameters.Parameter Size .Missing Parameter Attributes .Parameter Validations .Invalid Parameters .Version Information.Status Messages .1-11-21-21-31-31-41-41-51-51-51-6Intellectual Property Catalog Public APIs2.1Intellectual Property Catalog Public APIs . 2-1iii
.9.52.9.6ivPackage OKR IP PUB .Add Contributors .Remove Contributors.Update Contributors .Add Classifications .Remove Classifications.Update Classifications .Add Publication Mediums.Remove Publication Mediums .Update Publication Mediums.Package OKR IPT PUB.Create Property Type.Update Property Type .Package OKR SFT PUB .Create Software IP.Update Software IP .Package OKR FILM PUB .Create Film IP .Update Film IP.Package OKR LW PUB .Create Literary Work IP .Update Literary Work IP.Package OKR PHOTO PUB .Create Photo IP .Update Photo IP.Package OKR REL PROD PUB .Create Related Product for an IP.Remove Related Product for an IP.Package OKR IP IMPORT PUB .Validate Interface Rows.Copy Success Data .Import Catalog Data .Submit Validation Request .Submit Import Set .Submit Import 262-272-272-292-302-302-312-322-332-342-35
2.10Data Structure Specifications.2.10.1Data Structure pprv tbl type.2.10.2Data Structure pcnv tbl type.2.10.3Data Structure pmmv tbl type.2.10.4Data Structure iptv rec type.2.10.5Data Structure ipybv rec type.2.10.6Data Structure iswv rec type .2.10.7Data Structure ifmv rec type .2.10.8Data Structure ilwv rec type.2.10.9Data Structure ifmv rec type .2.10.10Data Structure ipobv rec type.2.10.11Data Structure iirv rec type.2.10.12Data Structure okrcomrectype 2-53Contract Catalog Public APIs3.1Contract Catalog Public Packages . 3-13.2Package OKR IP PUB. 3-43.2.1Create Header . 3-43.2.2Update Header . 3-63.2.3Create Party. 3-73.2.4Update Party . 3-93.2.5Delete Party. 3-103.2.6Create Party Contact. 3-113.2.7Update Party Contact . 3-123.2.8Delete Party Contact . 3-143.2.9Create Line . 3-153.2.10Update Line. 3-173.2.11Delete Line. 3-183.3Package OKR SECTIONS PUB. 3-193.3.1Create Section . 3-203.3.2Update Section. 3-213.3.3Delete Section. 3-233.3.4Create Section Content . 3-243.3.5Update Section Content. 3-253.3.6Delete Section Content . 3-27v
3.4Package OKR K ARTICLE PUB.3.4.1Create Contract Article .3.4.2Update Contract Article .3.4.3Delete Contract Article .3.5Package OKR ATTACHMENTS PUB .3.5.1Create Attachment .3.5.2Update Attachment.3.5.3Delete Attachment.3.6Package OKR QA CHECK PUB .3.6.1Execute QA Check List .3.7Package OKR CONTRACT APPROVAL PUB.3.7.1Contract Approval Start .3.8Package OKR VERSION PUB.3.8.1Version Contract.3.8.2Erase Saved Version.3.8.3Restore Version.3.9Package OKR COPY CONTRACT PUB .3.9.1Copy Contract .3.9.2Copy Contract Lines .3.9.3Copy Rules .3.9.4Copy Party Roles .3.10Data Structure Specifications .3.10.1Data Structure k header rec type.3.10.2Data Structure party rec type .3.10.3Data Structure ctcv rec type.3.10.4Data Structure right line rec type.3.10.5Data Structure rule tbl type .3.10.6Data Structure sections rec type.3.10.7Data Structure section contents rec type.3.10.8Data Structure k article rec type.3.10.9Data Structure attv rec type .3.10.10Data Structure okr msg tbl type .3.10.11Data Structure cvmv rec type -563-573-573-583-603-613-623-633-63
Send Us Your CommentsOracle Contracts for Rights API Reference Guide , Release 11iPart No. A95209-01Oracle Corporation welcomes your comments and suggestions on the quality and usefulness of thisdocument. Your input is an important part of the information used for revision. Did you find any errors?Is the information clearly presented?Do you need more information? If so, where?Are the examples correct? Do you need more examples?What features did you like most?If you find any errors or have any other suggestions for improvement, please indicate the documenttitle and part number, and the chapter, section, and page number (if available). You can send comments to us in the following ways:Electronic mail: rights@us.oracle.comPostal service:Oracle CorporationContracts for Rights Documentation Manager500 Oracle ParkwayRedwood Shores, CA 94065U.S.A.If you would like a reply, please give your name, address, telephone number, and (optionally) electronic mail address. If you have problems with the software, please contact your local Oracle Support Services.vii
viii
PrefaceWelcome to the Oracle Contracts for Rights API Reference Guide. This manualdescribes the Contracts for Right’s public APIs and provides information to helpyou work effectively with these public APIs.Note: This document provides API information for OracleContracts for Rights.This preface explains how the Reference Guide is organized and introduces othersources of information that can help you.Intended AudienceThis manual is intended for anyone who is interested in understanding or using(with minimal impact) the public APIs provided by Oracle Contracts for Rights.This includes the following: Oracle consultants Oracle internal development members Oracle support members Oracle customersThe information in this document is intended for experienced applicationprogrammers working in PL/SQL only.This guide assumes that you have the following prerequisites: Backgrounds in programming and databases.ix
Understanding of the company business processes. Knowledge of products and services as defined by your company.StructureThis manual contains the following chapters:Chapter 1Chapter 2Chapter 3xIntroductionIntellectualProperty CatalogPublic APIsContract CatalogPublic APIsDiscusses the following topics: API and parameter specifications Standard IN and OUT parameters Status messagesDiscusses the following APIs: Package OKR IP PUB Package OKR IPT PUB Package OKR SFT PUB Package OKR FILM PUB Package OKR LW PUB Package OKR PHOTO PUB Package OKR REL PROD PUB Package OKR IP IMPORT PUB Data Structure SpecificationsDiscusses the following APIs: Package OKR IP PUB Package OKR SECTIONS PUB Package OKR K ARTICLE PUB Package OKR ATTACHMENTS PUB Package OKR QA CHECK PUB Package OKR CONTRACT APPROVAL PUB Package OKR VERSION PUB Erase Saved Version Package OKR COPY CONTRACT PUB Data Structure Specifications
Related DocumentsFor more information, see the following manual:Oracle Contracts for Rights Concepts and Procedures ConventionsThe following conventions are used in this manual:ConventionMeaning.Vertical ellipsis points in an example mean that information notdirectly related to the example has been omitted.Horizontal ellipsis points in statements or commands mean thatparts of the statement or command not directly related to theexample have been omittedboldface textBoldface type in text indicates a term defined in the text, the glossary,or in both locations. Angle brackets enclose user-supplied names.[]Brackets enclose optional clauses from which you can choose one ornone.Documentation AccessibilityOur goal is to make Oracle products, services, and supporting documentationaccessible, with good usability, to the disabled community. To that end, ourdocumentation includes features that make information available to users ofassistive technology. This documentation is available in HTML format, and containsmarkup to facilitate access by the disabled community. Standards will continue toevolve over time, and Oracle Corporation is actively engaged with othermarket-leading technology vendors to address technical obstacles so that ourdocumentation can be accessible to all of our customers. For additional information,visit the Oracle Accessibility Program Web site athttp://www.oracle.com/accessibility/.xi
xii
1IntroductionThe Oracle Contracts for Rights APIs appear in this document in following groupsof public packages. Intellectual Property Catalog APIs Contract Catalog Public APIsWithin the appropriate package, the specifications for each API include: Code definition, including all of its parameters. API parameter definitions. Data structure definitions.Note: The words procedure and API are used interchangeably inthis document.1.1 Intellectual Property Catalog APIsThe Intellectual Property Catalog Public APIs comprise: Package OKR IP PUB Package OKR IPT PUB Package OKR SFT PUB Package OKR FILM PUB Package OKR LW PUB Package OKR PHOTO PUBIntroduction 1-1
Contract Catalog Public APIs Package OKR REL PROD PUB Package OKR IP IMPORT PUB1.2 Contract Catalog Public APIsThe Contract Catalog Public APIs comprise: Package OKR IP PUB Package OKR SECTIONS PUB Package OKR K ARTICLE PUB Package OKR ATTACHMENTS PUB Package OKR QA CHECK PUB Package OKR CONTRACT APPROVAL PUB Package OKR VERSION PUB Package OKR COPY CONTRACT PUB Data Structure Specifications1.3 Parameter SpecificationsThe specifications for the public APIs provided by the Oracle CRM ApplicationFoundation define four categories of parameters: Standard IN Standard OUT Procedure specific IN Procedure specific OUTThe API Coding Standards of the Oracle Applications business object specifystandard IN and OUT parameters. The following sections describe the standard INand OUT parameters.For more information on procedure specific IN and OUT parameters for a specificAPI, refer to that individual API.1-2Oracle Contracts for Rights API Reference Guide
Parameter Specifications1.3.1 Standard IN ParametersThe following table describes standard IN parameters, which are common to allpublic APIs provided by Oracle CRM Application Foundation.Table 1–1 Standard IN ParametersParameterData TypeRequiredDescriptionp api versionNUMBERYesThis must match the version number of theAPI. An unexpected error is returned if thecalling program version number isincompatible with the current API versionnumber (provided in the documentation).p init msg listVARCHAR2YesDefault FND API.G FALSE: p commitVARCHAR2(1)NoIf set to true, then the API makes a calltofnd msg pub.initialize to initialize themessage stack.If set to false then the calling programmust initialize the message stack. Thisaction is required to be performedonly once, even in the case wheremore than one API is called.Default FND API.G FALSE: If set to true, then the API commitsbefore returning to the callingprogram.If set to false, then it is the callingprogram’s responsibility to committhe transaction.1.3.2 Standard OUT ParametersThe following table describes standard OUT parameters, which are common to allpublic APIs provided by Oracle CRM Application Foundation.Note: All standard OUT parameters are required.Introduction 1-3
Parameter SpecificationsTable 1–2 Standard OUT ParametersParameterData TypeDescriptionx return statusVARCHAR2(1)Indicates the return status of the API. The valuesreturned are one of the following: FND API.G RET STS SUCCESSSuccess: Indicates the API call was successful FND API.G RET STS ERRORExpected Error: There is a validation error, ormissing data error. FND API.G RET STS UNEXP ERRORUnexpected Error: The calling program can notcorrect the error.x msg countNUMBERHolds the number of messages in the message list.x msg dataVARCHAR2(2000)Holds the encoded message if x msg count is equalto one.1.3.3 Parameter SizeVerify the size of the column from the base table for that column when passing aparameter of a specific length. For example, if you pass a NUMBER value, firstquery to find the exact value to pass. An incorrect value can cause the API call tofail.1.3.4 Missing Parameter AttributesThe following table describes optional IN parameters which are initialized topre-defined values representing missing constants. These constants are defined forthe common PL/SQL data types and should be used in the initialization of the APIformal parameters.Table 1–3 Initialized IN Parameters1-4ParameterTypeInitialized ValueG MISS NUMCONSTANTNUMBER: 9.99E125G MISS CHARCONSTANTVARCHAR2(1): chr(0)G MISS DATECONSTANTDATE: TO DATE('1','j');Oracle Contracts for Rights API Reference Guide
Version InformationThese constants are defined in the package FND API in the file fndpapis.pls. Allcolumns in a record definition are set to the G MISS X constant as defined for thedata type.1.3.5 Parameter ValidationsThe following types of parameters are always validated during the API call: Standard IN Standard OUT Mandatory procedure specific IN Procedure specific OUT1.3.6 Invalid ParametersIf the API encounters any invalid parameters during the API call, then one of thefollowing actions will occur: An exception is raised. An error message identifying the invalid parameter is generated. All API actions are cancelled.1.4 Version InformationIt is mandatory that every API call pass a version number for that API as its firstparameter (p api version).This version number must match the internal version number of that API. Anunexpected error is returned if the calling program version number is incompatiblewith the current API version number.Warning:The currently supported version at this time is 1.0.Use only this for the API version number.In addition, the object version number must be input for all update and delete APIs. If the object version number passed by the API matches that of the object in thedatabase, then the update is completed.Introduction 1-5
Status MessagesIf the object version number passed by the API does not match that of the objectin the database, then an error condition is generated. 1.5 Status MessagesNote: It is not required that all status notifications provide anumber identifier along with the message, although, in many cases,it is provided.Every API must return one of the following states as parameter x return status afterthe API is called: S (Success) E (Error) U (Unexpected error)Each state can be associated with a status message. The following table describeseach state.Table 1–4 Status Message and DescriptionStatusDescriptionSIndicates that the API performed all the operations requested by its caller. EA success return status may or may not be accompanied by messages inthe API message list.Currently, the CRM Foundation APIs do not provide a message for areturn status of success.Indicates that the API failed to perform one or more of the operationsrequested by its caller.An error return status is accompanied by one or more messages describingthe error.UIndicates that the API encountered an error condition it did not expect, orcould not handle, and that it is unable to continue with its regular processing. 1-6For example, certain programming errors such as attempting to adivision by zero will cause this error.These types of errors usually cannot be corrected by the user andrequires a system administrator or application developer to correct.Oracle Contracts for Rights API Reference Guide
Status MessagesWarning and Information MessagesIn addition to these three types of possible status messages, you can also code thefollowing additional message types: Warnings InformationTo create a warning message, perform the following steps:1.Create a global variable to be used to signal a warning condition. For example,this could be similar to the following:G RET STS WARNING : 'W’This global variable is not part of the FND API package.2.Return this value if the warning condition is encountered. For example, usingthe same example as in step one, set up the following code in the API to processthe warning conditi
Package OKR_IPT_PUB Package OKR_SFT_PUB Package OKR_FILM_PUB Package OKR_LW_PUB Package OKR_PHOTO_PUB Package OKR_REL_PROD_PUB Package OKR_IP_IMPORT_PUB Data Structure Specifications Chapter 3 Contract Catalog Public APIs Discusses the following APIs: Package OKR
