This chapter outlines the classes, methods, and returns used to develop and implement XYZ Application. Sample code demonstrating how to use these objects is provided at the end of this chapter.
XYZ Application uses the classes and methods identified in the following table:
Many of XYZ Application's methods return validation rules in the form of an encoded XML product. These products list the values that define each property. In the following example, the validation rules are underlined:
The Prod class provides the methods for tasks such as creating and modifying associations between related families. This class must be registered in order to access XYZ Application. For more information about registering XYZ Application, refer to the Commerce Co, Inc. Installation and Maintenance Guide.
The following table describes methods for this object.
Applications can be installed multiple times on a single extranet, as long as each installation (or "instance") has a unique name. Each method uses the AppID parameter to identify a particular installation of an application. For example, XYZ Application can be installed as "ProductCatalog" and as "ProdCatalog." Although the application names are different, each is considered an "instance" of the core application, XYZ Application.
AppID has a one-to-one relationship with "application name" and "application instance" as those terms are used in the Commerce Co, Inc. manuals.
The AssignToColl method assigns products to collections.
A user must belong to a security collection with the AssignproductToColl permission to access this method. For a detailed description of the permissions associated with XYZ Application, refer to .
The SessionID stores the user's permissions. A developer can call the CCUserSession.HasPermission method to determine whether the user has the required permission. For more information on checking permissions, refer to the Relationship Manager Developer Reference Guide.
AppID |
The ID of a particular instance of the XYZ Application application. For more information on AppID, refer to AppID. |
SessionID |
Session ID of the user who is currently logged on to the system. |
CollID |
ID of the collection to which you are assigning the product. |
productID |
For further information on productID, see Prod.Create.
For further information on CollID, see Coll.Create.
The Browse method queries for a list of all products for a specific AppID.
A user must belong to a security collection with the Viewproducts or ViewAllproducts permission to access this method. For a detailed description of the permissions associated with XYZ Application, refer to .
The SessionID stores the user's permissions. A developer can call the CCUserSession.HasPermission method to determine whether the user has the required permission. For more information on checking permissions, refer to the Relationship Manager Developer Reference Guide.
Optional RetrieveLevels As Integer=0,
Optional StartRow As Integer=-1,
Optional EndRow As Integer=-1,
Optional ReturnPropDefXML As Boolean=False)
AppID |
The ID of a particular instance of the XYZ Application application. For more information on AppID, refer to AppID. |
SessionID |
Session ID of the user who is currently logged on to the system. |
Filter |
|
RetrieveLevels |
Specifies which properties and values are returned. See usage notes. |
SortField |
Name of a property by which to sort the final results. Results are always ascending. |
StartRow |
First product row to return. Used in pagination. See usage notes |
EndRow |
Last product row to return. Used in pagination. See usage notes. |
ReturnPropDefXML |
This method returns an XML product. A complete XML schema for XYZ Application is included in .
|
<Property nam="Prop1" id="1">1</Property> <Property nam="Prop2" id="2">3</Property> <Property nam="Prop3" id="3">2</Property> |
Each criterion in the CollType is formatted in the following manner: {PropertyName} = `Value'.
Retrieve levels are defined as follows:
-1 returns all properties
0 returns header properties (only in DMproduct database table)
>0 returns some or all user defined properties
-1 entered in the StartRow or the EndRow field returns all rows.
The BrowseByCollID method queries by CollID for all products for a specific collection.
A user must belong to a security collection with the Veiwproducts or ViewAllproducts permission to access this method. For a detailed description of the permissions associated with XYZ Application, refer to .
The SessionID stores the user's permissions. A developer can call the CCUserSession.HasPermission method to determine whether the user has the required permission. For more information on checking permissions, refer to the Relationship Manager Developer Reference Guide.
AppID |
The ID of a particular instance of the XYZ Application application. For more information on AppID, refer to AppID. |
SessionID |
Session ID of the user who is currently logged on to the system. |
CollID |
This method returns an XML product. A complete XML schema for XYZ Application is included in .
For further information on CollID, see Coll.Create.
The Create method creates an empty XML product that contains all the properties required by this type of product.
A user must belong to a security collection with the Addproducts permission to access this method. For a detailed description of the permissions associated with XYZ Application, refer to .
The SessionID stores the user's permissions. A developer can call the CCUserSession.HasPermission method to determine whether the user has the required permission. For more information on checking permissions, refer to the Relationship Manager Developer Reference Guide.
AppID |
The ID of a particular instance of the XYZ Application application. For more information on AppID, refer to AppID. |
SessionID |
Session ID of the user who is currently logged on to the system. |
ProdType |
This method returns an XML product. A complete XML schema for XYZ Application is included in .
|
<product id="" nam="" restricted="" restricteduid="" active="1" doctype="As-built drawings" doctypeid="2"> <Property id="8" nam="Author" typ="CharValue" validation="[Encoded XML product. See Validation example]"/> |
For further information on ProdTypeID, see tProdType.Create.
The Delete method deletes a specific product.
A user must belong to a security collection with the Deleteproducts permission to access this method. For a detailed description of the permissions associated with XYZ Application, refer to .
The SessionID stores the user's permissions. A developer can call the CCUserSession.HasPermission method to determine whether the user has the required permission. For more information on checking permissions, refer to the Relationship Manager Developer Reference Guide.
AppID |
The ID of a particular instance of the XYZ Application application. For more information on AppID, refer to AppID. |
SessionID |
Session ID of the user who is currently logged on to the system. |
productID |
For further information on productID, seeProd.Create.
The GetRelatedproducts method gets all products related to a specific product.
A user must belong to a security collection with the Viewproducts or ViewAllproducts permission to access this method. For a detailed description of the permissions associated with XYZ Application, refer to .
The SessionID stores the user's permissions. A developer can call the CCUserSession.HasPermission method to determine whether the user has the required permission. For more information on checking permissions, refer to the Relationship Manager Developer Reference Guide.
AppID |
The ID of a particular instance of the XYZ Application application. For more information on AppID, refer to AppID. |
SessionID |
Session ID of the user who is currently logged on to the system. |
productID |
The ID of the product for which you are getting related products. |
This method returns an XML product. A complete XML schema for XYZ Application is included in .
For further information on productID, see Prod.Create.
The Relateproduct method relates one product to another.
A user must belong to a security collection with the Viewproducts or ViewAllproducts permission to access this method. For a detailed description of the permissions associated with XYZ Application, refer to .
The SessionID stores the user's permissions. A developer can call the CCUserSession.HasPermission method to determine whether the user has the required permission. For more information on checking permissions, refer to the Relationship Manager Developer Reference Guide.
ByVal LinkToproductID As String
AppID |
The ID of a particular instance of the XYZ Application application. For more information on AppID, refer to AppID. |
SessionID |
Session ID of the user who is currently logged on to the system. |
productID |
|
LinkToproductID |
|
LinkTypeID |
This method returns an XML product. A complete XML schema for XYZ Application is included in .
LinkToproductID uses the productID of the product you are linking.
For further information on productID, see Prod.Create.
For further information on LinkTypeID, see ProdLinkType.Create.
The RemoveFromColl method removes a product from a collection.
A user must belong to a security collection with the EditColls permission to access this method. For a detailed description of the permissions associated with XYZ Application, refer to .
The SessionID stores the user's permissions. A developer can call the CCUserSession.HasPermission method to determine whether the user has the required permission. For more information on checking permissions, refer to the Relationship Manager Developer Reference Guide.
AppID |
The ID of a particular instance of the XYZ Application application. For more information on AppID, refer to AppID. |
SessionID |
Session ID of the user who is currently logged on to the system. |
CollID |
ID of the collection from which you are removing assignment. |
productID |
For further information on productID, see Prod.Create.
For further information on CollID, see Coll.Create.
The RemoveRelateproduct method removes the link of one product to another.
A user must belong to a security collection with the Relateproducts permission to access this method. For a detailed description of the permissions associated with XYZ Application, refer to .
The SessionID stores the user's permissions. A developer can call the CCUserSession.HasPermission method to determine whether the user has the required permission. For more information on checking permissions, refer to the Relationship Manager Developer Reference Guide.
ByVal LinkToproductID As String,
AppID |
The ID of a particular instance of the XYZ Application application. For more information on AppID, refer to AppID. |
SessionID |
Session ID of the user who is currently logged on to the system. |
productID |
|
LinkToproduct |
|
LinkTypeID |
LinkToproductID uses the productID of the product you are linking.
For further information on productID, see Prod.Create.
For further information on LinkTypeID, see ProdLinkType.Create.
The RetrieveRecordCount method retrieves the record count.
Optional ByVal Filter As String)
AppID |
The ID of a particular instance of the XYZ Application application. For more information on AppID, refer to AppID. |
SessionID |
Session ID of the user who is currently logged on to the system. |
Filter |
The Retrieve method retrieves a specific product.
A user must belong to a security collection with the Viewproducts or ViewAllproducts permission to access this method. For a detailed description of the permissions associated with XYZ Application, refer to .
The SessionID stores the user's permissions. A developer can call the CCUserSession.HasPermission method to determine whether the user has the required permission. For more information on checking permissions, refer to the Relationship Manager Developer Reference Guide.
AppID |
The ID of a particular instance of the XYZ Application application. For more information on AppID, refer to AppID. |
SessionID |
Session ID of the user who is currently logged on to the system. |
productID |
This method returns an XML product. A complete XML schema for XYZ Application is included in .
|
<product id="" nam="" restricted="" restricteduid="" doctype="Pressure" doctypeid="" active=""> <Property id="2" nam="Model Name Description" typ="CharValue" validation="[Encoded XML product. See Validation example]"></Property> <Property id="3" nam="Brand" typ="CharValue" validation="Encoded XML product. See Validation example]"> |
For further information on productID, see Prod.Create.
The Save method saves the products to the database.
A user must belong to a security collection with the Editproducts permission to access this method. For a detailed description of the permissions associated with XYZ Application, refer to .
The SessionID stores the user's permissions. A developer can call the CCUserSession.HasPermission method to determine whether the user has the required permission. For more information on checking permissions, refer to the Relationship Manager Developer Reference Guide.
AppID |
The ID of a particular instance of the XYZ Application application. For more information on AppID, refer to AppID. |
SessionID |
Session ID of the user who is currently logged on to the system. |
XML |
This method returns an XML product. A complete XML schema for XYZ Application is included in .
|
<product id='5762' nam='test' restricted='' restricteduid='' active='1' doctype='As-built drawings' doctypeid='2'> <Property id='8' nam='Author' typ='CharValue' validation='[Encoded XML product. See Validation example]'>2</Property> <product id="5762" nam="test" restricted="" restricteduid="" active="1" doctype="As-built drawings" doctypeid="2"> <Description>Test</Description> <Property id="8" nam="Author" typ="CharValue" validation="[Encoded XML product. See Validation example]">2</Property> |
The ProdLinkType class provides the methods for tasks such as creating and modifying product link types. This class must be registered in order to access XYZ Application. For more information about registering XYZ Application, refer to the Commerce Co, Inc. Installation and Maintenance Guide.
The following table describes methods for this object.
|
Queries for a list of all product link types for a specific AppID. |
|
|
Creates an empty XML product used to create a new product link type. |
|
Applications can be installed multiple times on a single extranet, as long as each installation (or "instance") has a unique name. Each method uses the AppID parameter to identify a particular installation of an application. For example, XYZ Application can be installed as "ProductCatalog" and as "ProdCatalog." Although the application names are different, each is considered an "instance" of the core application, XYZ Application.
AppID has a one-to-one relationship with "application name" and "application instance" as those terms are used in the Commerce Co, Inc. manuals.
The Browse method queries for a list of all product link types for a specific AppID.
A user must belong to a security collection with the ViewproductLinkTypes permission to access this method. For a detailed description of the permissions associated with XYZ Application, refer to .
The SessionID stores the user's permissions. A developer can call the CCUserSession.HasPermission method to determine whether the user has the required permission. For more information on checking permissions, refer to the Relationship Manager Developer Reference Guide.
AppID |
The ID of a particular instance of the XYZ Application application. For more information on AppID, refer to AppID. |
SessionID |
Session ID of the user who is currently logged on to the system. |
This method returns an XML product. A complete XML schema for XYZ Application is included in .
The Create method creates an empty XML product used to create a new product link type.
A user must belong to a security collection with the AddproductLinkTypes permission to access this method. For a detailed description of the permissions associated with XYZ Application, refer to .
The SessionID stores the user's permissions. A developer can call the CCUserSession.HasPermission method to determine whether the user has the required permission. For more information on checking permissions, refer to the Relationship Manager Developer Reference Guide.
AppID |
The ID of a particular instance of the XYZ Application application. For more information on AppID, refer to AppID. |
SessionID |
Session ID of the user who is currently logged on to the system. |
This method returns an XML product. A complete XML schema for XYZ Application is included in .
The Delete method deletes a specific product link type.
A user must belong to a security collection with the DeleteproductLinkTypes permission to access this method. For a detailed description of the permissions associated with XYZ Application, refer to .
The SessionID stores the user's permissions. A developer can call the CCUserSession.HasPermission method to determine whether the user has the required permission. For more information on checking permissions, refer to the Relationship Manager Developer Reference Guide.
ByVal ProdLinkTypeID As String)
AppID |
The ID of a particular instance of the XYZ Application application. For more information on AppID, refer to AppID. |
SessionID |
Session ID of the user who is currently logged on to the system. |
ProdLinkTypeID |
For further information on ProdLinkTypeID, see ProdLinkType.Create.
The Retrieve method retrieves a specific product link type.
A user must belong to a security collection with the ViewproductLinkTypes permission to access this method. For a detailed description of the permissions associated with XYZ Application, refer to .
The SessionID stores the user's permissions. A developer can call the CCUserSession.HasPermission method to determine whether the user has the required permission. For more information on checking permissions, refer to the Relationship Manager Developer Reference Guide.
ByVal ProdLinkTypeID As String)
AppID |
The ID of a particular instance of the XYZ Application application. For more information on AppID, refer to AppID. |
SessionID |
Session ID of the user who is currently logged on to the system. |
ProdLinkTypeID |
This method returns an XML product. A complete XML schema for XYZ Application is included in .
The Save method saves product link types to the database.
A user must belong to a security collection with the EditproductLinkTypes permission to access this method. For a detailed description of the permissions associated with XYZ Application, refer to .
The SessionID stores the user's permissions. A developer can call the CCUserSession.HasPermission method to determine whether the user has the required permission. For more information on checking permissions, refer to the Relationship Manager Developer Reference Guide.
AppID |
The ID of a particular instance of the XYZ Application application. For more information on AppID, refer to AppID. |
SessionID |
Session ID of the user who is currently logged on to the system. |
XML |
This method returns an XML product. A complete XML schema for XYZ Application is included in .
The ProdType class provides the methods for tasks such as creating and modifying families for specific categories of product lines. This class must be registered in order to access XYZ Application. For more information about registering XYZ Application, refer to the Commerce Co, Inc. Installation and Maintenance Guide.
The following table describes methods for this object.
Applications can be installed multiple times on a single extranet, as long as each installation (or "instance") has a unique name. Each method uses the AppID parameter to identify a particular installation of an application. For example, XYZ Application can be installed as "ProductCatalog" and as "ProdCatalog." Although the application names are different, each is considered an "instance" of the core application, XYZ Application.
AppID has a one-to-one relationship with "application name" and "application instance" as those terms are used in the Commerce Co, Inc. manuals.
The Browse method queries for all product types for a specific AppID.
A user must belong to a security collection with the ViewproductTypes permission to access this method. For a detailed description of the permissions associated with XYZ Application, refer to .
The SessionID stores the user's permissions. A developer can call the CCUserSession.HasPermission method to determine whether the user has the required permission. For more information on checking permissions, refer to the Relationship Manager Developer Reference Guide.
AppID |
The ID of a particular instance of the XYZ Application application. For more information on AppID, refer to AppID. |
SessionID |
Session ID of the user who is currently logged on to the system. |
This method returns an XML product. A complete XML schema for XYZ Application is included in .
|
<productType id="2" nam="As-built drawings"> <Property id="8" nam="Author" priority="1" retrievelevel="1" meta="" validation="[Encoded XML product. See Validation example]"/> |
The Create method creates an empty XML product used to create a new product type.
A user must belong to a security collection with the AddproductTypes permission to access this method. For a detailed description of the permissions associated with XYZ Application, refer to .
The SessionID stores the user's permissions. A developer can call the CCUserSession.HasPermission method to determine whether the user has the required permission. For more information on checking permissions, refer to the Relationship Manager Developer Reference Guide.
AppID |
The ID of a particular instance of the XYZ Application application. For more information on AppID, refer to AppID. |
SessionID |
Session ID of the user who is currently logged on to the system. |
This method returns an XML product. A complete XML schema for XYZ Application is included in .
The Delete method deletes a specific product type.
A user must belong to a security collection with the DeleteproductTypes permission to access this method. For a detailed description of the permissions associated with XYZ Application, refer to .
The SessionID stores the user's permissions. A developer can call the CCUserSession.HasPermission method to determine whether the user has the required permission. For more information on checking permissions, refer to the Relationship Manager Developer Reference Guide.
AppID |
The ID of a particular instance of the XYZ Application application. For more information on AppID, refer to AppID. |
SessionID |
Session ID of the user who is currently logged on to the system. |
ProdTypeID |
For further information on ProdTypeID, see ProdType.Create.
The Retrieve method retrieves a specific product type.
A user must belong to a security collection with the ViewproductTypes permission to access this method. For a detailed description of the permissions associated with XYZ Application, refer to .
The SessionID stores the user's permissions. A developer can call the CCUserSession.HasPermission method to determine whether the user has the required permission. For more information on checking permissions, refer to the Relationship Manager Developer Reference Guide.
AppID |
The ID of a particular instance of the XYZ Application application. For more information on AppID, refer to AppID. |
SessionID |
Session ID of the user who is currently logged on to the system. |
ProdTypeID |
This method returns an XML product. A complete XML schema for XYZ Application is included in .
|
<productType id="1" nam="Application Notes/Tech. Briefs"><Property id="7" nam="Application" priority="1" retrievelevel="1" meta="" validation="[Encoded XML product. See Validation example]"/> |
For further information on ProdTypeID, see ProdType.Create.
The Save method saves product types to the database.
A user must belong to a security collection with the EditproductTypes permission to access this method. For a detailed description of the permissions associated with XYZ Application, refer to .
The SessionID stores the user's permissions. A developer can call the CCUserSession.HasPermission method to determine whether the user has the required permission. For more information on checking permissions, refer to the Relationship Manager Developer Reference Guide.
AppID |
The ID of a particular instance of the XYZ Application application. For more information on AppID, refer to AppID. |
SessionID |
Session ID of the user who is currently logged on to the system. |
XML |
This method returns an XML product. A complete XML schema for XYZ Application is included in .
The Coll class provides the methods for tasks such as creating and modifying families. This class must be registered in order to access XYZ Application. For more information about registering XYZ Application, refer to the Commerce Co, Inc. Installation and Maintenance Guide.
The following table describes methods for this object.
|
Creates an empty XML product used to create a new collection. |
|
|
Gets all collections under the specified StartNode in hierarchical XML. |
|
Applications can be installed multiple times on a single extranet, as long as each installation (or "instance") has a unique name. Each method uses the AppID parameter to identify a particular installation of an application. For example, XYZ Application can be installed as "ProductCatalog"and as "ProdCatalog." Although the application names are different, each is considered an "instance" of the core application, XYZ Application.
AppID has a one-to-one relationship with "application name" and "application instance" as those terms are used in the Commerce Co, Inc. manuals.
The Browse method queries for all collections for a specific AppID.
A user must belong to a security collection with the ViewColls permission to access this method. For a detailed description of the permissions associated with XYZ Application, refer to .
The SessionID stores the user's permissions. A developer can call the CCUserSession.HasPermission method to determine whether the user has the required permission. For more information on checking permissions, refer to the Relationship Manager Developer Reference Guide.
AppID |
The ID of a particular instance of the XYZ Application application. For more information on AppID, refer to AppID. |
SessionID |
Session ID of the user who is currently logged on to the system. |
This method returns an XML product. A complete XML schema for XYZ Application is included in .
The Create method creates an empty XML product used to create a new collection.
A user must belong to a security collection with the AddColls permission to access this method. For a detailed description of the permissions associated with XYZ Application, refer to .
The SessionID stores the user's permissions. A developer can call the CCUserSession.HasPermission method to determine whether the user has the required permission. For more information on checking permissions, refer to the Relationship Manager Developer Reference Guide.
Optional ByVal CollType As String)
AppID |
The ID of a particular instance of the XYZ Application application. For more information on AppID, refer to AppID. |
SessionID |
Session ID of the user who is currently logged on to the system. |
CollType |
This method returns an XML product. A complete XML schema for XYZ Application is included in .
|
<Coll id='' nam='' parentid='' collectiontypeid=''> <Coll id="" nam="" parentid="" collectiontypeid="1"> <Property id="1" nam="Test04/10" typ="CharValue" validation="[Encoded XML product. See Validation example]"/> |
CollType is required to save properties within the collection. It is optional for 4.0 compatibility.
The Delete method deletes a specific collection.
A user must belong to a security collection with the DeleteColls permission to access this method. For a detailed description of the permissions associated with XYZ Application, refer to .
The SessionID stores the user's permissions. A developer can call the CCUserSession.HasPermission method to determine whether the user has the required permission. For more information on checking permissions, refer to the Relationship Manager Developer Reference Guide.
AppID |
The ID of a particular instance of the XYZ Application application. For more information on AppID, refer to AppID. |
SessionID |
Session ID of the user who is currently logged on to the system. |
CollID |
For further information on CollID, see Coll.Create.
The GetTree method gets all collections under the specified StartNode in hierarchical XML.
A user must belong to a security collection with the ViewColls permission to access this method. For a detailed description of the permissions associated with XYZ Application, refer to .
The SessionID stores the user's permissions. A developer can call the CCUserSession.HasPermission method to determine whether the user has the required permission. For more information on checking permissions, refer to the Relationship Manager Developer Reference Guide.
Optional ByVal StartNode As String = "")
AppID |
The ID of a particular instance of the XYZ Application application. For more information on AppID, refer to AppID. |
SessionID |
Session ID of the user who is currently logged on to the system. |
StartNode |
This method returns an XML product. A complete XML schema for XYZ Application is included in .
For further information on CollID, see Coll.Create.
The Retrieve method retrieves a specific collection.
A user must belong to a security collection with the ViewColls permission to access this method. For a detailed description of the permissions associated with XYZ Application, refer to .
The SessionID stores the user's permissions. A developer can call the CCUserSession.HasPermission method to determine whether the user has the required permission. For more information on checking permissions, refer to the Relationship Manager Developer Reference Guide.