Related Topics
This object represents a MetaData Category.
Properties
PROPERTY NAME | DATA TYPE | DESCRIPTION |
|---|---|---|
PID | String | The Partition ID. |
Name | String | TheName of the Meta Data category. |
CATID | String | The ID of the Meta Data category. |
Methods
GetCategory (Static Method)This API will return a MetaCategory Object for a specified Meta Data Category.
Parameters
BP: The Process Director BP Object
PID: The Partition ID of the partition containing the Meta Data Category.
CATID: A string containing the Name or CATID of the Meta Data Category.
Returns
MetaCategory: A MetaCategory object.
Example
MetaCategory myCat = GetCategory(bp, "PID", "CategoryName");
GetCategoryByID (Static Method)This API will return a MetaCategory Object for a specified Meta Data Category identified by CATID.
Parameters
BP: The Process Director BP Object
PID: The Partition ID of the partition containing the Meta Data Category.
CATID: A string containing the Name or CATID of the Meta Data Category.
Returns
MetaCategory: A MetaCategory object.
Example
MetaCategory myCat = GetCategoryByID(bp, "PID", "CATID");
GetCategoryByName (Static Method)This API will return a MetaCategory Object for a specified Meta Data Category identified by Category Name.
Parameters
BP: The Process Director BP Object
PID: The Partition ID of the partition containing the Meta Data Category.
Name: A string containing the Name or Name of the Meta Data Category.
Returns
MetaCategory: A MetaCategory object.
Example
MetaCategory myCat = GetCategoryByName(bp, "PID", "CategoryName");
GetCategoryID (Static Method)This API will accept either a Category name or CATID and return a string containing the CATID for the specified Category, or "" if the Category isn't found.
Parameters
BP: The Process Director BP Object
PID: The Partition ID of the partition containing the Meta Data Category.
CATID: A string containing the Name or CATID of the Meta Data Category.
Returns
String: The CATID for the specified Category, or "" if the Category isn't found.
Example
string myCat = GetCategoryID(bp, "PID", "CategoryName");
GetRootCategory (Static Method)This API will return the root-level MetaCategory Object for a specified Partition.
Parameters
BP: The Process Director BP Object
PID: The Partition ID of the partition.
Returns
MetaCategory: A MetaCategory object.
Example
MetaCategory myCat = GetRootCategory (bp, "PID");
Documentation Feedback and Questions
If you notice some way that this document can be improved, we're happy to hear your suggestions. Similarly, if you can't find an answer you're looking for, ask it via feedback. Simply click on the button below to provide us with your feedback or ask a question. Please remember, though, that not every issue can be addressed through documentation. So, if you have a specific technical issue with Process Director, please open a support ticket.
