Property DB API class

class cdb.common.db.api.propertyDbApi.PropertyDbApi
addAllowedPropertyValue(*args, **kwargs)

Add an allowed property value record.

Parameters:
  • propertyTypeName –
  • value –
  • units –
  • description –
  • sortOrder –
  • kwargs –
Returns:

(CdbObject) newly added record.
addPropertyType(*args, **kwargs)

Add a property type record.

Parameters:
  • propertyTypeName –
  • description –
  • propertyTypeCategoryName –
  • propertyTypeHandlerName –
  • defaultValue –
  • defaultUnits –
  • isUserWriteable –
  • isDynamic –
  • isInternal –
  • isActive –
  • kwargs –
Returns:

(CdbObject) newly added record.
addPropertyTypeCategory(*args, **kwargs)

Add a property type category record.

Parameters:
  • propertyTypeCategoryName –
  • description –
  • kwargs –
Returns:

(CdbObject) newly added record.
addPropertyTypeHandler(*args, **kwargs)

Add a property type handler.

Parameters:
  • propertyTypeHandlerName –
  • description –
  • kwargs –
Returns:

(CdbObject) newly added record.
getPropertyHandlerTypeHandlerByPropertyHandlerName(*args, **kwargs)

Get a property type handler by its name.

Parameters:
  • propertyHandlerName –
  • kwargs –
Returns:

(CdbObject) resulting record.
getPropertyTypeCategories(*args, **kwargs)

Get all property type category records.

Parameters:kwargs –
Returns:CdbObject List of resulting records.
getPropertyTypeHandlers(*args, **kwargs)

Get all property type handler records.

Parameters:kwargs –
Returns:CdbObject List of resulting records.
getPropertyTypes(*args, **kwargs)

Get all property type records.

Parameters:kwargs –
Returns:CdbObject List of resulting records.
getPropertyTypesByHandlerId(*args, **kwargs)

Get all property types by their handler id.

Parameters:
  • propertyHandlerid –
  • kwargs –
Returns:

CdbObject List of resulting records.
getPropertyValueListForItemElementId(*args, **kwargs)

Get a property value list for a particualr item element id.

NOTE: Item properties are in their ‘self element’. :param itemElementId: :param propertyTypeName: :param kwargs: :return: CdbObject List of resulting records.

getPropertyValuesByPropertyTypeId(*args, **kwargs)

Get all property values with a given property type id.

Parameters:
  • propertyTypeId –
  • kwargs –
Returns:

CdbObject List of resulting records.