Copyright © 2024, Oracle and/or its affiliates.
Field Index SQL Mapping

Class /rate_plan

Rate plan defines the ordering in which rates are applied. What type of date, day and TOD ranges are used, etc.

Notes

  • This object can be read by the owner or any billing group leader who is an ancestor of the owner.
  • This object can be modified only by the owner.
  • This object can be created by anyone.

Links



Field Index

Type Field Name
poid PIN_FLD_POID
timestamp PIN_FLD_CREATED_T
timestamp PIN_FLD_MOD_T
string PIN_FLD_READ_ACCESS
string PIN_FLD_WRITE_ACCESS
string PIN_FLD_CREATE_ACCESS
poid PIN_FLD_ACCOUNT_OBJ
string PIN_FLD_NAME
string PIN_FLD_CODE
int PIN_FLD_CURRENCY
poid PIN_FLD_PRODUCT_OBJ
string PIN_FLD_TAX_CODE
enum PIN_FLD_TAX_WHEN
string PIN_FLD_EVENT_TYPE
int PIN_FLD_CYCLE_FEE_FLAGS
int PIN_FLD_BILL_OFFSET
enum PIN_FLD_OFFSET_UNIT
poid PIN_FLD_SELECTOR_OBJ
array PIN_FLD_RATE_TIERS
string
decimal
enum
poid
array PIN_FLD_DATE_RANGES
string
string
timestamp
timestamp
int
int
enum
enum
poid
array PIN_FLD_DAY_RANGES
string
string
int
int
int
poid
array PIN_FLD_TOD_RANGES
string
string
int
int
poid


Field Details

poid PIN_FLD_POID

Object Identifier for an instance of this class. Portal object ids have four pieces of information: database number, class type, sequence id, revision.

Notes

  • System defined on object creation
  • Can be modified only by System

Links

timestamp PIN_FLD_CREATED_T

Time the object was created.

Notes

  • System defined on object creation
  • Can be modified only by System

Links

timestamp PIN_FLD_MOD_T

Time the object was last modified.

Notes

  • System defined on object creation
  • Can be modified only by System

Links

string PIN_FLD_READ_ACCESS

Read Access level for object. Valid values are S(Self), G(Global), L(BrandLineage), B(BrandGroup), A(Ancestral).

Notes

  • System defined on object creation
  • Can be modified only by System
  • Maximum length is 255 bytes

Links

string PIN_FLD_WRITE_ACCESS

Write Access level for object. Valid values are S(Self), G(Global), L(BrandLineage), B(BrandGroup), A(Ancestral).

Notes

  • System defined on object creation
  • Can be modified only by System
  • Maximum length is 255 bytes

Links

string PIN_FLD_CREATE_ACCESS

Create Access level for object. Valid values are O(BrandOwner), R(Root), N(Any).

Notes

  • System defined on object creation
  • Can be modified only by System
  • Maximum length is 255 bytes

Links

poid PIN_FLD_ACCOUNT_OBJ

Link to account object for which this object was created.

Notes

  • Required on object creation
  • Cannot be modified
  • Audit trail is created automatically when this field is modified.

Links

string PIN_FLD_NAME

Name of the rate_plan object.

Notes

  • Required on object creation
  • Can be modified
  • Audit trail is created automatically when this field is modified.
  • Maximum length is 255 bytes

Links

string PIN_FLD_CODE

Code of the rate_plan object.

Notes

  • Required on object creation
  • Cannot be modified
  • Audit trail is created automatically when this field is modified.
  • Maximum length is 255 bytes

Links

int PIN_FLD_CURRENCY

The currency resource that this rate plan impacts. All the rate objects in the rate plan can only impact this currency resource and non-currency resources. No other currency resources can be impacted by this rate plan.

Notes

  • Required on object creation
  • Can be modified
  • Audit trail is created automatically when this field is modified.

Links

poid PIN_FLD_PRODUCT_OBJ

Product object that this rate plan object belongs to. Combined with currency, it must be unique within a product.

Notes

  • Required on object creation
  • Can be modified
  • Audit trail is created automatically when this field is modified.

Links

string PIN_FLD_TAX_CODE

Identifier used by the tax engine to calculate tax for this rate. Used only when the rate has currency balance impacts.

Notes

  • Can be specified on object creation
  • Can be modified
  • Audit trail is created automatically when this field is modified.
  • Maximum length is 255 bytes

Links

enum PIN_FLD_TAX_WHEN

Specifies when to apply taxes on the rate charges - no taxes (0), or tax when the event occurs (1), or defer to the end of the accounting or billing cycle (2). You can control deferred taxing using the CM pin.conf entry 'cycle_tax_interval'.

Notes

  • Can be specified on object creation
  • Can be modified
  • Audit trail is created automatically when this field is modified.

Links

string PIN_FLD_EVENT_TYPE

Type of event that this rate_plan specifies rating for. Subtypes are implicitly included.

Notes

  • Required on object creation
  • Can be modified
  • Audit trail is created automatically when this field is modified.
  • Maximum length is 255 bytes

Links

int PIN_FLD_CYCLE_FEE_FLAGS

This flag indicates whether the monthly/yearly cycle forwards should be aligned or not. Default is aligned (0). Other cycle forwards are never aligned to the accounting/billing cycles.

Notes

  • Can be specified on object creation
  • Can be modified
  • Audit trail is created automatically when this field is modified.

Links

int PIN_FLD_BILL_OFFSET

Specifies the offset (in days or months) to bill in advance.

Notes

  • Can be specified on object creation
  • Can be modified
  • Audit trail is created automatically when this field is modified.

Links

enum PIN_FLD_OFFSET_UNIT

Specifies the unit of measure (days or months) of the field PIN_FLD_BILL_OFFSET.

Notes

  • Can be specified on object creation
  • Can be modified
  • Audit trail is created automatically when this field is modified.

Links

poid PIN_FLD_SELECTOR_OBJ

Poid of the selector object.

Notes

  • Can be specified on object creation
  • Can be modified

Links

array PIN_FLD_RATE_TIERS

Rate tier groups the rates in a structured format.

Notes

  • Can be specified on object creation
  • Can be modified

Links

string PIN_FLD_NAME

Name of this rate tier. Must be unique within this rate plan.

Notes

Links

decimal PIN_FLD_PRIORITY

Priority of the rate tier. Higher number indicates higher priority.

Notes

Links

enum PIN_FLD_DATE_RANGE_TYPE

Specify which type of the date ranges are used in this tier. Value can be ABSOLUTE(0), RELATIVE(1).

Notes

Links

poid PIN_FLD_RATE_OBJ

Optional rate object. If not null, this rate object is valid for all time. Therefore, there is no need to specify date ranges.

Notes

Links

array PIN_FLD_DATE_RANGES

Array of date ranges. Lineage field is used to specify which rate tier the date range belongs to. Date ranges belongs to the same rate tier can't overlap. If non-contiguous date ranges are defined for the same rate tier, user confirmation is required.

Notes

  • Can be specified on object creation
  • Can be modified

Links

string PIN_FLD_LINEAGE

The array indexes of its ancestors separated by ','.

Notes

Links

string PIN_FLD_NAME

Name of this date range. Must be unique within the same rate tier.

Notes

Links

timestamp PIN_FLD_START_T

Inclusive start time of the validity period for the rate. If zero, the rate is valid immediately.

Notes

Links

timestamp PIN_FLD_END_T

Non-inclusive end time of the validity period for the rate. If the value is 0, the rate does not expire.

Notes

Links

int PIN_FLD_RELATIVE_START_OFFSET

Offset value from product purchase for start of relative date range. Inclusive. If zero, the rate is valid immediately.

Notes

Links

int PIN_FLD_RELATIVE_END_OFFSET

Offset value from product purchase for end of relative date range. Non-inclusive. If zero, the rate does not expire.

Notes

Links

enum PIN_FLD_RELATIVE_START_UNIT

Unit PIN_FLD_RELATIVE_START_OFFSET is expressed in. Value can be SECOND(1), MINUTE(2), HOUR(3) or DAY(4).

Notes

Links

enum PIN_FLD_RELATIVE_END_UNIT

Unit PIN_FLD_RELATIVE_END_OFFSET is expressed in. Value can be SECOND(1), MINUTE(2), HOUR(3) or DAY(4).

Notes

Links

poid PIN_FLD_RATE_OBJ

Optional rate object. If not null, this rate object is valid for the entire date range. Therefore, there is no need to specify day ranges.

Notes

Links

array PIN_FLD_DAY_RANGES

Array of day ranges. Lineage field is used to specify which date range the day range belongs to. Days are included in a day range only if they qualify under all criteria. Data ranges belongs to the same date range can't overlap.

Notes

  • Can be specified on object creation
  • Can be modified

Links

string PIN_FLD_LINEAGE

The array indexes of its ancestors separated by ','.

Notes

Links

string PIN_FLD_NAME

Name of this day range. Must be unique within the same date range.

Notes

Links

int PIN_FLD_VALID_DOW

Valid days-of-week flags. Each bit set is a day that rate object is valid. Bit 0 (LSB) = Sunday, bit 1 = Monday, etc. If entire field is zero, then rate is valid all days of the week.

Notes

Links

int PIN_FLD_VALID_DOM

Valid days-of-month flags. Each bit set is a day that rate object is valid. Bit 0 (LSB) = 1st, bit 1 = 2nd, etc. If entire field is zero, then rate is valid all days of the month.

Notes

Links

int PIN_FLD_VALID_MOY

Valid months-of-year flags. Each bit set is a month that rate object is valid. Bit 0 (LSB) = January, bit 1 = February, etc. If entire field is zero, then rate is valid all months of the year.

Notes

Links

poid PIN_FLD_RATE_OBJ

Optional rate object. If not null, this rate object is valid for the entire day range. Therefore, there is no need to specify tod ranges.

Notes

Links

array PIN_FLD_TOD_RANGES

Array of valid daily time ranges for the rate object. If no entries are present, valid range is entire day. Array element id is not significant.

Notes

  • Can be specified on object creation
  • Can be modified

Links

string PIN_FLD_LINEAGE

The array indexes of its ancestors separated by ','.

Notes

Links

string PIN_FLD_NAME

Name of this tod range. Must be unique within the same day range.

Notes

Links

int PIN_FLD_START_OFFSET

Valid start offset - seconds from beginning of day (inclusive).

Notes

Links

int PIN_FLD_END_OFFSET

Valid end offset - seconds from beginning of day (non-inclusive). Value less than start offset implies that TOD range wraps around midnight. If end offset is zero, valid range lasts through end of day.

Notes

Links

poid PIN_FLD_RATE_OBJ

Pointer to the rate object that is valid during the specified period. By storing the rate plan as a tree of validity ranges, we traverse the tree and locate one rate object that applies, so no searching is required.

Notes

Links



SQL Mapping


Type Field Name Table Column Name
base-class /rate_plan rate_plan_t
poid PIN_FLD_POID poid*
timestamp PIN_FLD_CREATED_T created_t
timestamp PIN_FLD_MOD_T mod_t
string PIN_FLD_READ_ACCESS read_access
string PIN_FLD_WRITE_ACCESS wrtie_access
string PIN_FLD_CREATE_ACCESS create_access
poid PIN_FLD_ACCOUNT_OBJ account_obj*
string PIN_FLD_NAME name
string PIN_FLD_CODE code
int PIN_FLD_CURRENCY currency
poid PIN_FLD_PRODUCT_OBJ product_obj*
string PIN_FLD_TAX_CODE tax_code
enum PIN_FLD_TAX_WHEN tax_when
string PIN_FLD_EVENT_TYPE event_type
int PIN_FLD_CYCLE_FEE_FLAGS cycle_fee_flags
int PIN_FLD_BILL_OFFSET bill_offset
enum PIN_FLD_OFFSET_UNIT offset_unit
poid PIN_FLD_SELECTOR_OBJ selector_obj*
array PIN_FLD_RATE_TIERS rate_tiers_t
string
PIN_FLD_NAME
 		name
decimal
PIN_FLD_PRIORITY
 		priority
enum
PIN_FLD_DATE_RANGE_TYPE
 		date_range_type
poid
PIN_FLD_RATE_OBJ
 		rate_obj*
array PIN_FLD_DATE_RANGES date_ranges_t
string
PIN_FLD_LINEAGE
 		lineage
string
PIN_FLD_NAME
 		name
timestamp
PIN_FLD_START_T
 		start_t
timestamp
PIN_FLD_END_T
 		end_t
int
PIN_FLD_RELATIVE_START_OFFSET
 		start_offset
int
PIN_FLD_RELATIVE_END_OFFSET
 		end_offset
enum
PIN_FLD_RELATIVE_START_UNIT
 		rel_start_unit
enum
PIN_FLD_RELATIVE_END_UNIT
 		rel_end_unit
poid
PIN_FLD_RATE_OBJ
 		rate_obj*
array PIN_FLD_DAY_RANGES day_ranges_t
string
PIN_FLD_LINEAGE
 		lineage
string
PIN_FLD_NAME
 		name
int
PIN_FLD_VALID_DOW
 		valid_dow
int
PIN_FLD_VALID_DOM
 		valid_dom
int
PIN_FLD_VALID_MOY
 		valid_moy
poid
PIN_FLD_RATE_OBJ
 		rate_obj*
array PIN_FLD_TOD_RANGES tod_ranges_t
string
PIN_FLD_LINEAGE
 		lineage
string
PIN_FLD_NAME
 		name
int
PIN_FLD_START_OFFSET
 		start_offset
int
PIN_FLD_END_OFFSET
 		end_offset
poid
PIN_FLD_RATE_OBJ
 		rate_obj*
Column names marked with * are actually column prefixes. For poid type fields, the column prefix is used to create the columns poid_id0, poid_db and poid_type if the prefix is "poid". For PIN_FLD_POID in the base table, an additional column named poid_rev is created to hold the poid revision. For buffer fields, two columns are created - one in the containing table and one in the buffer table. For example if the prefix is "buf", then the column name in the buffer table is buffer_buf and the column name in the containing table is buffer_size.

Field Index This Class