xccdf_rule Struct Reference
[XCCDFXCCDF Rule]

XCCDF Rule. More...

#include <xccdf.h>

Public Member Functions

const char * xccdf_rule_get_id (const struct xccdf_rule *rule)
 Get rule ID.
struct oscap_text_iteratorxccdf_rule_get_title (const struct xccdf_rule *rule)
 Get rule title.
struct oscap_text_iteratorxccdf_rule_get_description (const struct xccdf_rule *rule)
 Get rule description.
const char * xccdf_rule_get_version (const struct xccdf_rule *rule)
 Get rule version.
struct oscap_text_iteratorxccdf_rule_get_question (const struct xccdf_rule *rule)
 Get rule question.
struct xccdf_warning_iteratorxccdf_rule_get_warnings (const struct xccdf_rule *rule)
 Get rule question.
struct oscap_text_iteratorxccdf_rule_get_rationale (const struct xccdf_rule *rule)
 Get rule rationale.
const char * xccdf_rule_get_cluster_id (const struct xccdf_rule *rule)
 Get rule cluster ID.
struct xccdf_checkxccdf_rule_get_check (const struct xccdf_rule *rule)
 Get rule's currently selected check.
float xccdf_rule_get_weight (const struct xccdf_rule *rule)
 Get rule scoring weight.
struct xccdf_rulexccdf_rule_get_extends (const struct xccdf_rule *rule)
 Return rule's parent in the inheritance hierarchy.
struct xccdf_itemxccdf_rule_get_parent (const struct xccdf_rule *rule)
 Return rule's parent in the grouping hierarchy.
bool xccdf_rule_get_abstract (const struct xccdf_rule *rule)
 Return whether the rule is abstract.
bool xccdf_rule_get_prohibit_changes (const struct xccdf_rule *rule)
 Return whether the rule has the prohibit changes flag set to true.
bool xccdf_rule_get_hidden (const struct xccdf_rule *rule)
 Return whether the rule has the hidden flag set to true.
bool xccdf_rule_get_selected (const struct xccdf_rule *rule)
 Return whether the rule is selected.
bool xccdf_rule_get_multiple (const struct xccdf_rule *rule)
 Return whether the rule has the multiple flag set to true.
struct oscap_string_iteratorxccdf_rule_get_platforms (const struct xccdf_rule *rule)
 Get an iterator to rule platforms.
struct xccdf_status_iteratorxccdf_rule_get_statuses (const struct xccdf_rule *rule)
 Get an iterator to rule statuses.
struct xccdf_reference_iteratorxccdf_rule_get_references (const struct xccdf_rule *rule)
 Get an iterator to the XCCDF references of the rule.
xccdf_status_type_t xccdf_rule_get_status_current (const struct xccdf_rule *rule)
 Get rule current status.
const char * xccdf_rule_get_impact_metric (const struct xccdf_rule *rule)
 Get rule impact metric.
xccdf_role_t xccdf_rule_get_role (const struct xccdf_rule *rule)
 Get rule role.
xccdf_level_t xccdf_rule_get_severity (const struct xccdf_rule *rule)
 Get rule severity level.
struct xccdf_ident_iteratorxccdf_rule_get_idents (const struct xccdf_rule *rule)
 Get an iterator to the idents of the rule.
struct xccdf_check_iteratorxccdf_rule_get_checks (const struct xccdf_rule *rule)
 Get an iterator to the checks of the rule.
struct
xccdf_profile_note_iterator
xccdf_rule_get_profile_notes (const struct xccdf_rule *rule)
 Get an iterator to the profile notes of the rule.
struct xccdf_fix_iteratorxccdf_rule_get_fixes (const struct xccdf_rule *rule)
 Get an iterator to fixes for the rule.
struct xccdf_fixtext_iteratorxccdf_rule_get_fixtexts (const struct xccdf_rule *rule)
 Get an iterator to fix descriptions the rule.
const char * xccdf_rule_get_version_update (const struct xccdf_rule *rule)
time_t xccdf_rule_get_version_time (const struct xccdf_rule *rule)
struct xccdf_benchmarkxccdf_rule_get_benchmark (const struct xccdf_rule *rule)
bool xccdf_rule_get_resolved (const struct xccdf_rule *rule)
bool xccdf_rule_get_interactive (const struct xccdf_rule *rule)

Detailed Description

XCCDF Rule.


Member Function Documentation

struct xccdf_benchmark * xccdf_rule_get_benchmark ( const struct xccdf_rule rule  )  [read]
const char * xccdf_rule_get_cluster_id ( const struct xccdf_rule rule  ) 

Get rule cluster ID.

const char * xccdf_rule_get_id ( const struct xccdf_rule rule  ) 

Get rule ID.

bool xccdf_rule_get_interactive ( const struct xccdf_rule rule  ) 
struct xccdf_item * xccdf_rule_get_parent ( const struct xccdf_rule rule  )  [read]

Return rule's parent in the grouping hierarchy.

Returned item will be either a group or a benchmark.

struct oscap_string_iterator * xccdf_rule_get_platforms ( const struct xccdf_rule rule  )  [read]

Get an iterator to rule platforms.

bool xccdf_rule_get_resolved ( const struct xccdf_rule rule  ) 
const char * xccdf_rule_get_version ( const struct xccdf_rule rule  ) 

Get rule version.

time_t xccdf_rule_get_version_time ( const struct xccdf_rule rule  ) 
const char * xccdf_rule_get_version_update ( const struct xccdf_rule rule  ) 
float xccdf_rule_get_weight ( const struct xccdf_rule rule  ) 

Get rule scoring weight.


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

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