Main Page | Modules | Files | Functions | Code Elements | Data Structures | Deprecated

PARTITION

Defines

Typedefs

Enumerations

Functions

Define Documentation

#define PREF_PARTITION_DEFAULT_REVRULE   "PTN_Default_Partition_RevRule"

Name of the default Revision Rule preference to configure partitions

Definition at line 38 of file partition.h.

Typedef Documentation

typedef enum ActionCode ActionCode_t

typedef enum ContentPersistenceMode ContentPersistenceMode_t

Enumeration Type Documentation

enum ActionCode

ActionCode is the enum used to update/get children or members for a Partition

Enumerator:
ADD_PARTITION 
REPLACE_PARTITION  adds child Partitions to a parent Partition or adds parent Partition to a child Partition or adds members to a Partition.
REMOVE_PARTITION  replaces an existing child partition in a parent partition or replaces parent Partition in a child Partition or replaces members of a Partition. removes an existing child partition from a parent partition or removes parent Partition from a child Partition or removes members of a Partition. Note that REMOVE_PARTITION does NOT delete the child partition. It just simply removes it from the parent.

Definition at line 43 of file partition.h.

enum ContentPersistenceMode

ContentPersistenceMode is the enum used to update/get members for a Partition.

Enumerator:
STATIC_MODE 
DYNAMIC_MODE  members of Partition are saved using persistent Membership option.
AUTO_MODE  Memberships are dynamic and it is defined by a search recipe on the Partition.
ALL_MODE  based on the definition of the Partition the mode is determined to be either STATIC or DYNAMIC. static Memberships are also created/searched for dynamic Partitions.

Definition at line 54 of file partition.h.

Function Documentation

PTN0PARTITION_API int PARTITION_find_model_with_id ( char *  model_id,
tag_t *  model_tag 
)

Finds the partition template model with the given Model Id The returned codes are:

  • ITK_ok on success.
  • PTN0PARTITION_internal_error on invalid model_id.
Parameters:
model_id  (I) Input model ID
model_tag  (O) Model tag

PTN0PARTITION_API int PARTITION_get_partitions ( tag_t  configuration_context,
tag_t  model_tag,
tag_t  scheme_tag,
int  max_partition_count,
int *  num_partitions,
tag_t **  partitions 
)

Gets Partitions in a given Application Model for the given input Partition Scheme The returned codes are:

  • ITK_ok on success.
  • PTN0PARTITION_wrong_input_supplied if the partition_scheme_tag is not a proper scheme tag.
  • CXPOM_invalid_tag if configuration_context tag is invalid.
Parameters:
configuration_context  (I) Configuration context tag
model_tag  (I) Application model tag
scheme_tag  (I) Partition scheme tag
max_partition_count  (I) Maximum number of partitions to be returned
num_partitions  (O) Number of the returned partitions
partitions  (OF) num_partitions Array of partition tags

PTN0PARTITION_API int PARTITION_get_schemes_in_model ( tag_t  model_tag,
int *  list_of_schemes_count,
tag_t **  list_of_schemes 
)

Finds and returns the partition schemes in a given application model The returned codes are:

  • ITK_ok on success.
  • CXPOM_invalid_tag if model_tag is invalid.
Parameters:
model_tag  (I) Application model tag
list_of_schemes_count  (O) Number of partition schemes
list_of_schemes  (OF) list_of_schemes_count Array of partition scheme tags

PTN0PARTITION_API int PARTITION_get_toplevel_partitions ( tag_t  configuration_context,
tag_t  model_tag,
tag_t  partition_scheme_tag,
int *  top_level_partitions_count,
tag_t **  top_level_partitions 
)

Finds and returns the array of top level partitions in a given Partition Scheme The returned codes are:

  • ITK_ok on success.
  • PTN0PARTITION_wrong_input_supplied if the partition_scheme_tag is not a proper scheme tag.
  • CXPOM_invalid_tag if configuration_context tag is invalid.
Parameters:
configuration_context  (I) Configuration context tag
model_tag  (I) Application model tag
partition_scheme_tag  (I) Partition scheme tag
top_level_partitions_count  (O) Count of top level Partitions
top_level_partitions  (OF) top_level_partitions_count Array of tags of top level Partitions

PTN0PARTITION_API int PARTITION_update_members_and_child_partitions ( tag_t  partition,
int  member_count,
tag_t *  members,
int  child_count,
tag_t *  children,
ActionCode_t  action_code,
ContentPersistenceMode_t  content_persistence_mode,
const tag_t  configuration_context,
int *  failed_members_count,
tag_t **  failed_members,
int *  failed_children_count,
tag_t **  failed_children,
int *  error_count,
int **  error_codes 
)

Updates members and child partitions of a given partition and tracks the failure per member The returned codes are:

  • ITK_ok on success.
  • PTN0PARTITION_internal_error when updateMembers or updateChildren fails.
Parameters:
partition  (I) Partition tag
member_count  (I) Count of new members
members  (I) Array of member tags
child_count  (I) Count of children
children  (I) Array of child partition tags
action_code  (I) 1-ADD, 2-REPLACE, 3-REMOVE
content_persistence_mode  (I) 1-STATIC, 2-DYNAMIC
configuration_context  (I) Input configuration context
failed_members_count  (O) Count of failed members
failed_members  (OF) failed_members_count Array of member tags that failed to update on a target partition
failed_children_count  (O) Count of failed children
failed_children  (OF) failed_children_count Array of child partitions that failed to update
error_count  (O) Count of the error codes
error_codes  (OF) error_count Array of error codes for failed member updates

PTN0PARTITION_API int PARTITION_where_partitioned ( tag_t  configuration_context,
tag_t  model_tag,
tag_t  scheme_tag,
tag_t  member_tag,
int *  partitions_count,
tag_t **  partitions 
)

Finds and returns the partition objects where a given member is partitioned The returned codes are:

  • ITK_ok on success.
  • CXPOM_invalid_tag if model_tag or configuration_context is invalid.
Parameters:
configuration_context  (I) Configuration context tag
model_tag  (I) Application model tag
scheme_tag  (I) Partition scheme tag
member_tag  (I) Member tag for which the where_partitioned is performed
partitions_count  (O) Number of partitions
partitions  (OF) partitions_count Array of partition tags