Category  Locate

The Category API complements the Taxonomy API. It is used to query and to manipulate Internal taxonomies in Oracle Service Registry. The categories may be hierarchically organized. Each category may be top-level (without parent), it may have children, or it may be a child of another category. You can drill down through this pattern in the Registry Control.

Data Structures  Locate

The following structures are used by the Category API:

Categories  Locate

This structure is a container for zero or more category elements.

category  Locate

Table 22. Attributes

AttributeRequired
disabledNo
leafNo

This element contains a single keyedReference element that defines value of the category.

The disabled attribute is used to indicate that a category cannot be used as a valid option in keyedReferences. Either it has been deprecated or it is only a parent for other categories. The tModel key value in the uddi-org:types taxonomy is one such disabled category.

The leaf attribute indicates whether this category is a leaf in the category tree.

categoryList  Locate

Table 23. Attributes

AttributeRequired
truncatedNo

This structure serves as a container for optional listDescription and categories structures. The truncated attribute indicates whether a returned list of categories is truncated.

Operations  Locate
add_category  Locate

The add_category API call is used to add a new category to the Internal taxonomy identified by the tModelKey in the keyedReference. The parentKeyedReference element is used to define the parent category of new category to be saved. If the parentKeyedReference element is missing, then the new category will have no parent.

Syntax  Locate
Arguments  Locate
  • category:authInfo - This optional argument is an element that contains an authentication token.

  • category:category - Category to be added.

  • parentKeyedReference - Optional keyedReference; serves as parent of the new category.

Permissions  Locate

This API call requires API manager permission for org.systinet.uddi.client.category.v3.CategoryApi and for the action add_category.

delete_category  Locate

The delete_category API call deletes the selected category from Oracle Service Registry.

Syntax  Locate
Arguments  Locate
  • category:authInfo - This optional argument is an element that contains an authentication token.

  • keyedReference - Category to be deleted.

Permissions  Locate

This API call requires API manager permission for org.systinet.uddi.client.category.v3.CategoryApi and the action delete_category.

find_category  Locate

The find_category API call is used to query Oracle Service Registry for categories that match given criteria.

Syntax  Locate
Arguments  Locate
  • category:authInfo - This optional argument is an element that contains an authentication token.

  • category:findQualifiers - Optional list of findQualifiers, that modifies default behavior.

  • uddi:keyedReference - The category containing search arguments.

Behavior  Locate

FindByName and findByValue findQualifiers are used to distinguish whether the call will search by keyName or keyValue from the keyedReference that is the argument of the call. The default is to search by value.

The caseSensitiveMatch and caseInsensitiveMatch findQualifiers are used to control whether the search will be case sensitive; the default is case sensitive.

The ApproximateMatch findQualifier is used to search with SQL wildcards. The default findQualifier, exactMatch, instructs the search to perform an exact comparison.

Finally there are four findQualifiers that affect the order in which categories are returned:

  • sortByNameAsc

  • sortByNameDesc

  • sortByValueAsc (default)

  • sortByValueDesc

These find qualifiers are exclusive. If you combine them, an exception is thrown.

Returns  Locate

This API call returns a CategoryList upon success.

get_category  Locate

The get_category API call is used to get categories having a relation, identified by getQualifier, to the category identified by given keyedReference. If the getQualifier is childCategories, then the call returns categories that have the selected category as their parent. If the siblingCategories getQualifier is used, then categories having same parent as selected category are returned.

Syntax  Locate
Arguments  Locate
  • category:authInfo - This optional argument is an element that contains an authentication token.

  • category:getQualifier and category:getQualifier - Control search behavior.

  • uddi:keyedReference - The category whose relatives shall be received.

Returns  Locate

This API call returns a CategoryList upon success.

get_rootCategory  Locate

The get_rootCategory API call returns all categories of the Internal taxonomy identified by given tModelKey that have no parent.

Syntax  Locate
Arguments  Locate
  • category:authInfo - This optional argument is an element that contains an authentication token.

  • uddi:tModelKey - Required uddiKey value that represents an existing taxonomy tModel.

  • category:getQualifiers - Control search behavior.

Returns  Locate

This API call returns a CategoryList upon success.

get_rootPath  Locate

The get_rootPath API call returns categories from root category, then its child categories until the selected category in this order: root category, parent's parent, parent and the selected category.

Syntax  Locate
Arguments  Locate
  • category:authInfo - This optional argument is an element that contains an authentication token.

  • uddi:keyedReference - Category to be searched

Returns  Locate

This API call returns a CategoryList upon success.

move_category  Locate

The move_category API call is used to move selected category from current parent (if any) to a new parent category. If the newParentKeyedReference is not defined, then the category will have no parent.

Syntax  Locate
Arguments  Locate
  • category:authInfo - This optional argument is an element that contains an authentication token.

  • keyedReference - Category to be deleted.

  • newParentKeyedReference - Optional category, that becomes new parent of the category.

Permissions  Locate

This API call requires API manager permission for org.systinet.uddi.client.category.v3.CategoryApi and the action move_category.

set_category  Locate

The set_category API call is used to update the selected category in Oracle Service Registry.

Syntax  Locate
Arguments  Locate
  • category:authInfo - This optional argument is an element that contains an authentication token.

  • oldKeyedReference - Current category to be updated.

  • category:category - New category, that will replace selected category.

Permissions  Locate

This API call requires API manager permission for org.systinet.uddi.client.category.v3.CategoryApi and the action set_category.

WSDL  Locate

You can find this API's WSDL specification in the file category.wsdl.

API Endpoint   Locate

You can find the Category API at http://<host name>:<port>/<context>/uddi/category.

Java  Locate

Java API is generated from Category WSDL. You are encouraged to browse org.systinet.uddi.client.category.v3.CategoryApi and to read and try Category demos.