xccdf_item Struct Reference
[XCCDF]

A base class for XCCDF items. More...

#include <xccdf.h>

Public Member Functions

xccdf_type_t xccdf_item_get_type (const struct xccdf_item *item)
 Get item type.
const char * xccdf_item_get_id (const struct xccdf_item *item)
 Get item ID.
struct oscap_text_iteratorxccdf_item_get_title (const struct xccdf_item *item)
 Get item title.
struct oscap_text_iteratorxccdf_item_get_description (const struct xccdf_item *item)
 Get item description.
const char * xccdf_item_get_version (const struct xccdf_item *item)
 Get item version.
struct xccdf_itemxccdf_item_get_extends (const struct xccdf_item *item)
 Return item's parent in the inheritance hierarchy.
struct xccdf_itemxccdf_item_get_parent (const struct xccdf_item *item)
 Return item's parent in the grouping hierarchy.
struct xccdf_status_iteratorxccdf_item_get_statuses (const struct xccdf_item *item)
 Get an iterator to item statuses.
struct xccdf_reference_iteratorxccdf_item_get_references (const struct xccdf_item *item)
 Get an iterator to the XCCDF references of the item.
xccdf_status_type_t xccdf_item_get_current_status (const struct xccdf_item *item)
 Get item current status.
struct xccdf_benchmarkxccdf_item_to_benchmark (struct xccdf_item *item)
 Convert the item to a benchmark.
struct xccdf_profilexccdf_item_to_profile (struct xccdf_item *item)
 Convert the item to a profile.
struct xccdf_rulexccdf_item_to_rule (struct xccdf_item *item)
 Convert the item to a rule.
struct xccdf_groupxccdf_item_to_group (struct xccdf_item *item)
 Convert the item to a group.
struct xccdf_valuexccdf_item_to_value (struct xccdf_item *item)
 Convert the item to a value.
struct xccdf_resultxccdf_item_to_result (struct xccdf_item *item)
 Convert the item to a test result.
struct oscap_text_iteratorxccdf_item_get_question (const struct xccdf_item *item)
struct xccdf_warning_iteratorxccdf_item_get_warnings (const struct xccdf_item *item)
struct oscap_text_iteratorxccdf_item_get_rationale (const struct xccdf_item *item)
const char * xccdf_item_get_cluster_id (const struct xccdf_item *item)
const char * xccdf_item_get_version_update (const struct xccdf_item *item)
time_t xccdf_item_get_version_time (const struct xccdf_item *item)
float xccdf_item_get_weight (const struct xccdf_item *item)
struct xccdf_benchmarkxccdf_item_get_benchmark (const struct xccdf_item *item)
struct oscap_string_iteratorxccdf_item_get_platforms (const struct xccdf_item *item)

Data Fields

xccdf_type_t type
struct xccdf_item_base item
union {
   struct xccdf_profile_item   profile
   struct xccdf_benchmark_item   bench
   struct xccdf_rule_item   rule
   struct xccdf_group_item   group
   struct xccdf_value_item   value
   struct xccdf_result_item   result
sub

Detailed Description

A base class for XCCDF items.


Member Function Documentation

struct xccdf_benchmark * xccdf_item_get_benchmark ( const struct xccdf_item item  )  [read]
const char * xccdf_item_get_cluster_id ( const struct xccdf_item item  ) 
const char * xccdf_item_get_id ( const struct xccdf_item item  ) 

Get item ID.

struct xccdf_item * xccdf_item_get_parent ( const struct xccdf_item item  )  [read]

Return item's parent in the grouping hierarchy.

Returned item will be either a group or a benchmark.

struct oscap_string_iterator * xccdf_item_get_platforms ( const struct xccdf_item item  )  [read]
struct oscap_text_iterator * xccdf_item_get_question ( const struct xccdf_item item  )  [read]
struct oscap_text_iterator * xccdf_item_get_rationale ( const struct xccdf_item item  )  [read]
const char * xccdf_item_get_version ( const struct xccdf_item item  ) 

Get item version.

time_t xccdf_item_get_version_time ( const struct xccdf_item item  ) 
const char * xccdf_item_get_version_update ( const struct xccdf_item item  ) 
struct xccdf_warning_iterator * xccdf_item_get_warnings ( const struct xccdf_item item  )  [read]
float xccdf_item_get_weight ( const struct xccdf_item item  ) 
struct xccdf_benchmark * xccdf_item_to_benchmark ( struct xccdf_item item  )  [read]

Convert the item to a benchmark.

Returns:
Pointer to this item as the benchmark.
Return values:
NULL on faliure (e.g. item is not a benchmark)
struct xccdf_group * xccdf_item_to_group ( struct xccdf_item item  )  [read]

Convert the item to a group.

Returns:
Pointer to this item as the group.
Return values:
NULL on faliure (e.g. item is not a group)
struct xccdf_profile * xccdf_item_to_profile ( struct xccdf_item item  )  [read]

Convert the item to a profile.

Returns:
Pointer to this item as the profile.
Return values:
NULL on faliure (e.g. item is not a profile)
struct xccdf_result * xccdf_item_to_result ( struct xccdf_item item  )  [read]

Convert the item to a test result.

Returns:
Pointer to this item as the test result.
Return values:
NULL on faliure (e.g. item is not a test result)
struct xccdf_rule * xccdf_item_to_rule ( struct xccdf_item item  )  [read]

Convert the item to a rule.

Returns:
Pointer to this item as the rule.
Return values:
NULL on faliure (e.g. item is not a rule)
struct xccdf_value * xccdf_item_to_value ( struct xccdf_item item  )  [read]

Convert the item to a value.

Returns:
Pointer to this item as the value.
Return values:
NULL on faliure (e.g. item is not a value)

The documentation for this struct was generated from the following files:

Generated on 26 Feb 2010 for Open SCAP Library by  doxygen 1.6.1