class Openwsman::EnumerateInfo

EnumerateInfo contains all information related to an enumeration request.

The initial client.enumerate operation only returns a context (String) which can be used to pull the next enumeration item. This item contains the next context in the chain.

Public Instance Methods

encoding → String click to toggle source

The current encoding (defaults to ‘utf-8’)

const char *encoding() {
    return $self->encoding;
  }
  /*
   * The Filter for this enumeration
   * call-seq:
   *    enumerate_info.filter -> Openwsman::Filter
   *
   */
  const filter_t *filter() {
    return $self->filter;
  }
  /*
   * The current index (number of the last returned item)
   * call-seq:
   *    enumerate_info.index -> Integer
   *
   */
  int index() {
    return $self->index;
  }

  %rename("index=") set_index(int i);

  /*
   * Set a specific index (used to skip ahead)
   * call-seq:
   *    enumerate_info.index = 42
   *
   */
  void set_index(int i) {
    $self->index = i;
  }
  /*
   * The total number of items in this enumeration
   *
   * index is the number already returned, this is the total number
   * call-seq:
   *    enumerate_info.total_items -> Integer
   *
   */
  int total_items() {
    return $self->totalItems;
  }

  %rename("total_items=") set_total_items(int i);

  /*
   * Set the total number of items in this enumeration
   * call-seq:
   *    enumerate_info.total_items = 10
   *
   */
  void set_total_items(int i) {
    $self->totalItems = i;
  }

  /*
   * XmlDoc representing the result pulled last
   * call-seq:
   *    enumerate_info.pull_result -> Openwsman::XmlDoc
   *
   */
  WsXmlDocH pull_result() {
    return (WsXmlDocH)$self->pullResultPtr;
  }

  %rename("pull_result=") set_pull_result(WsXmlDocH result);

  /*
   * Set the pull result (XmlDoc)
   *
   * Used for server-side plugin extensions
   * call-seq:
   *    enumerate_info.pull_result = xml_doc
   *
   */
  void set_pull_result(WsXmlDocH result) {
    $self->pullResultPtr = (void *)result;
  }
}

epr_to → String click to toggle source

The URL of the endpoint receiving the enumeration

const char *epr_to() {
    return $self->epr_to;
  }
  /*
   * The URI of the end point reference
   * call-seq:
   *    enumerate_info.epr_uri -> String
   *
   */
  const char *epr_uri() {
    return $self->epr_uri;
  }
  /*
   * The current encoding (defaults to 'utf-8')
   * call-seq:
   *    enumerate_info.encoding -> String
   *
   */
  const char *encoding() {
    return $self->encoding;
  }
  /*
   * The Filter for this enumeration
   * call-seq:
   *    enumerate_info.filter -> Openwsman::Filter
   *
   */
  const filter_t *filter() {
    return $self->filter;
  }
  /*
   * The current index (number of the last returned item)
   * call-seq:
   *    enumerate_info.index -> Integer
   *
   */
  int index() {
    return $self->index;
  }

  %rename("index=") set_index(int i);

  /*
   * Set a specific index (used to skip ahead)
   * call-seq:
   *    enumerate_info.index = 42
   *
   */
  void set_index(int i) {
    $self->index = i;
  }
  /*
   * The total number of items in this enumeration
   *
   * index is the number already returned, this is the total number
   * call-seq:
   *    enumerate_info.total_items -> Integer
   *
   */
  int total_items() {
    return $self->totalItems;
  }

  %rename("total_items=") set_total_items(int i);

  /*
   * Set the total number of items in this enumeration
   * call-seq:
   *    enumerate_info.total_items = 10
   *
   */
  void set_total_items(int i) {
    $self->totalItems = i;
  }

  /*
   * XmlDoc representing the result pulled last
   * call-seq:
   *    enumerate_info.pull_result -> Openwsman::XmlDoc
   *
   */
  WsXmlDocH pull_result() {
    return (WsXmlDocH)$self->pullResultPtr;
  }

  %rename("pull_result=") set_pull_result(WsXmlDocH result);

  /*
   * Set the pull result (XmlDoc)
   *
   * Used for server-side plugin extensions
   * call-seq:
   *    enumerate_info.pull_result = xml_doc
   *
   */
  void set_pull_result(WsXmlDocH result) {
    $self->pullResultPtr = (void *)result;
  }
}

epr_uri → String click to toggle source

The URI of the end point reference

const char *epr_uri() {
    return $self->epr_uri;
  }
  /*
   * The current encoding (defaults to 'utf-8')
   * call-seq:
   *    enumerate_info.encoding -> String
   *
   */
  const char *encoding() {
    return $self->encoding;
  }
  /*
   * The Filter for this enumeration
   * call-seq:
   *    enumerate_info.filter -> Openwsman::Filter
   *
   */
  const filter_t *filter() {
    return $self->filter;
  }
  /*
   * The current index (number of the last returned item)
   * call-seq:
   *    enumerate_info.index -> Integer
   *
   */
  int index() {
    return $self->index;
  }

  %rename("index=") set_index(int i);

  /*
   * Set a specific index (used to skip ahead)
   * call-seq:
   *    enumerate_info.index = 42
   *
   */
  void set_index(int i) {
    $self->index = i;
  }
  /*
   * The total number of items in this enumeration
   *
   * index is the number already returned, this is the total number
   * call-seq:
   *    enumerate_info.total_items -> Integer
   *
   */
  int total_items() {
    return $self->totalItems;
  }

  %rename("total_items=") set_total_items(int i);

  /*
   * Set the total number of items in this enumeration
   * call-seq:
   *    enumerate_info.total_items = 10
   *
   */
  void set_total_items(int i) {
    $self->totalItems = i;
  }

  /*
   * XmlDoc representing the result pulled last
   * call-seq:
   *    enumerate_info.pull_result -> Openwsman::XmlDoc
   *
   */
  WsXmlDocH pull_result() {
    return (WsXmlDocH)$self->pullResultPtr;
  }

  %rename("pull_result=") set_pull_result(WsXmlDocH result);

  /*
   * Set the pull result (XmlDoc)
   *
   * Used for server-side plugin extensions
   * call-seq:
   *    enumerate_info.pull_result = xml_doc
   *
   */
  void set_pull_result(WsXmlDocH result) {
    $self->pullResultPtr = (void *)result;
  }
}

filter → Openwsman::Filter click to toggle source

The Filter for this enumeration

const filter_t *filter() {
    return $self->filter;
  }
  /*
   * The current index (number of the last returned item)
   * call-seq:
   *    enumerate_info.index -> Integer
   *
   */
  int index() {
    return $self->index;
  }

  %rename("index=") set_index(int i);

  /*
   * Set a specific index (used to skip ahead)
   * call-seq:
   *    enumerate_info.index = 42
   *
   */
  void set_index(int i) {
    $self->index = i;
  }
  /*
   * The total number of items in this enumeration
   *
   * index is the number already returned, this is the total number
   * call-seq:
   *    enumerate_info.total_items -> Integer
   *
   */
  int total_items() {
    return $self->totalItems;
  }

  %rename("total_items=") set_total_items(int i);

  /*
   * Set the total number of items in this enumeration
   * call-seq:
   *    enumerate_info.total_items = 10
   *
   */
  void set_total_items(int i) {
    $self->totalItems = i;
  }

  /*
   * XmlDoc representing the result pulled last
   * call-seq:
   *    enumerate_info.pull_result -> Openwsman::XmlDoc
   *
   */
  WsXmlDocH pull_result() {
    return (WsXmlDocH)$self->pullResultPtr;
  }

  %rename("pull_result=") set_pull_result(WsXmlDocH result);

  /*
   * Set the pull result (XmlDoc)
   *
   * Used for server-side plugin extensions
   * call-seq:
   *    enumerate_info.pull_result = xml_doc
   *
   */
  void set_pull_result(WsXmlDocH result) {
    $self->pullResultPtr = (void *)result;
  }
}

flags → Integer click to toggle source

enumeration flags

int flags() {
    return $self->flags;
  }
  
  /*
   * The URL of the endpoint receiving the enumeration
   * call-seq:
   *    enumerate_info.epr_to -> String
   *
   */
  const char *epr_to() {
    return $self->epr_to;
  }
  /*
   * The URI of the end point reference
   * call-seq:
   *    enumerate_info.epr_uri -> String
   *
   */
  const char *epr_uri() {
    return $self->epr_uri;
  }
  /*
   * The current encoding (defaults to 'utf-8')
   * call-seq:
   *    enumerate_info.encoding -> String
   *
   */
  const char *encoding() {
    return $self->encoding;
  }
  /*
   * The Filter for this enumeration
   * call-seq:
   *    enumerate_info.filter -> Openwsman::Filter
   *
   */
  const filter_t *filter() {
    return $self->filter;
  }
  /*
   * The current index (number of the last returned item)
   * call-seq:
   *    enumerate_info.index -> Integer
   *
   */
  int index() {
    return $self->index;
  }

  %rename("index=") set_index(int i);

  /*
   * Set a specific index (used to skip ahead)
   * call-seq:
   *    enumerate_info.index = 42
   *
   */
  void set_index(int i) {
    $self->index = i;
  }
  /*
   * The total number of items in this enumeration
   *
   * index is the number already returned, this is the total number
   * call-seq:
   *    enumerate_info.total_items -> Integer
   *
   */
  int total_items() {
    return $self->totalItems;
  }

  %rename("total_items=") set_total_items(int i);

  /*
   * Set the total number of items in this enumeration
   * call-seq:
   *    enumerate_info.total_items = 10
   *
   */
  void set_total_items(int i) {
    $self->totalItems = i;
  }

  /*
   * XmlDoc representing the result pulled last
   * call-seq:
   *    enumerate_info.pull_result -> Openwsman::XmlDoc
   *
   */
  WsXmlDocH pull_result() {
    return (WsXmlDocH)$self->pullResultPtr;
  }

  %rename("pull_result=") set_pull_result(WsXmlDocH result);

  /*
   * Set the pull result (XmlDoc)
   *
   * Used for server-side plugin extensions
   * call-seq:
   *    enumerate_info.pull_result = xml_doc
   *
   */
  void set_pull_result(WsXmlDocH result) {
    $self->pullResultPtr = (void *)result;
  }
}

index → Integer click to toggle source

The current index (number of the last returned item)

int index() {
    return $self->index;
  }

  %rename("index=") set_index(int i);

  /*
   * Set a specific index (used to skip ahead)
   * call-seq:
   *    enumerate_info.index = 42
   *
   */
  void set_index(int i) {
    $self->index = i;
  }
  /*
   * The total number of items in this enumeration
   *
   * index is the number already returned, this is the total number
   * call-seq:
   *    enumerate_info.total_items -> Integer
   *
   */
  int total_items() {
    return $self->totalItems;
  }

  %rename("total_items=") set_total_items(int i);

  /*
   * Set the total number of items in this enumeration
   * call-seq:
   *    enumerate_info.total_items = 10
   *
   */
  void set_total_items(int i) {
    $self->totalItems = i;
  }

  /*
   * XmlDoc representing the result pulled last
   * call-seq:
   *    enumerate_info.pull_result -> Openwsman::XmlDoc
   *
   */
  WsXmlDocH pull_result() {
    return (WsXmlDocH)$self->pullResultPtr;
  }

  %rename("pull_result=") set_pull_result(WsXmlDocH result);

  /*
   * Set the pull result (XmlDoc)
   *
   * Used for server-side plugin extensions
   * call-seq:
   *    enumerate_info.pull_result = xml_doc
   *
   */
  void set_pull_result(WsXmlDocH result) {
    $self->pullResultPtr = (void *)result;
  }
}

index = 42 click to toggle source

Set a specific index (used to skip ahead)

void set_index(int i) {
    $self->index = i;
  }
  /*
   * The total number of items in this enumeration
   *
   * index is the number already returned, this is the total number
   * call-seq:
   *    enumerate_info.total_items -> Integer
   *
   */
  int total_items() {
    return $self->totalItems;
  }

  %rename("total_items=") set_total_items(int i);

  /*
   * Set the total number of items in this enumeration
   * call-seq:
   *    enumerate_info.total_items = 10
   *
   */
  void set_total_items(int i) {
    $self->totalItems = i;
  }

  /*
   * XmlDoc representing the result pulled last
   * call-seq:
   *    enumerate_info.pull_result -> Openwsman::XmlDoc
   *
   */
  WsXmlDocH pull_result() {
    return (WsXmlDocH)$self->pullResultPtr;
  }

  %rename("pull_result=") set_pull_result(WsXmlDocH result);

  /*
   * Set the pull result (XmlDoc)
   *
   * Used for server-side plugin extensions
   * call-seq:
   *    enumerate_info.pull_result = xml_doc
   *
   */
  void set_pull_result(WsXmlDocH result) {
    $self->pullResultPtr = (void *)result;
  }
}

max_items → Integer click to toggle source

Return the maximum number of items that will be returned by this enumeration

int max_items() { return $self->maxItems; }

  %rename("max_items=") set_max_items(int mi);

  /*
   * Set the maximum number of items returned by this enumeration
   * call-seq:
   *    enumerate_info.max_items = 100
   *
   */
  void set_max_items(int mi) { $self->maxItems = mi; }

  /*
   * enumeration flags
   * call-seq:
   *    enumerate_info.flags -> Integer
   *
   */
  int flags() {
    return $self->flags;
  }
  
  /*
   * The URL of the endpoint receiving the enumeration
   * call-seq:
   *    enumerate_info.epr_to -> String
   *
   */
  const char *epr_to() {
    return $self->epr_to;
  }
  /*
   * The URI of the end point reference
   * call-seq:
   *    enumerate_info.epr_uri -> String
   *
   */
  const char *epr_uri() {
    return $self->epr_uri;
  }
  /*
   * The current encoding (defaults to 'utf-8')
   * call-seq:
   *    enumerate_info.encoding -> String
   *
   */
  const char *encoding() {
    return $self->encoding;
  }
  /*
   * The Filter for this enumeration
   * call-seq:
   *    enumerate_info.filter -> Openwsman::Filter
   *
   */
  const filter_t *filter() {
    return $self->filter;
  }
  /*
   * The current index (number of the last returned item)
   * call-seq:
   *    enumerate_info.index -> Integer
   *
   */
  int index() {
    return $self->index;
  }

  %rename("index=") set_index(int i);

  /*
   * Set a specific index (used to skip ahead)
   * call-seq:
   *    enumerate_info.index = 42
   *
   */
  void set_index(int i) {
    $self->index = i;
  }
  /*
   * The total number of items in this enumeration
   *
   * index is the number already returned, this is the total number
   * call-seq:
   *    enumerate_info.total_items -> Integer
   *
   */
  int total_items() {
    return $self->totalItems;
  }

  %rename("total_items=") set_total_items(int i);

  /*
   * Set the total number of items in this enumeration
   * call-seq:
   *    enumerate_info.total_items = 10
   *
   */
  void set_total_items(int i) {
    $self->totalItems = i;
  }

  /*
   * XmlDoc representing the result pulled last
   * call-seq:
   *    enumerate_info.pull_result -> Openwsman::XmlDoc
   *
   */
  WsXmlDocH pull_result() {
    return (WsXmlDocH)$self->pullResultPtr;
  }

  %rename("pull_result=") set_pull_result(WsXmlDocH result);

  /*
   * Set the pull result (XmlDoc)
   *
   * Used for server-side plugin extensions
   * call-seq:
   *    enumerate_info.pull_result = xml_doc
   *
   */
  void set_pull_result(WsXmlDocH result) {
    $self->pullResultPtr = (void *)result;
  }
}

max_items = 100 click to toggle source

Set the maximum number of items returned by this enumeration

void set_max_items(int mi) { $self->maxItems = mi; }

  /*
   * enumeration flags
   * call-seq:
   *    enumerate_info.flags -> Integer
   *
   */
  int flags() {
    return $self->flags;
  }
  
  /*
   * The URL of the endpoint receiving the enumeration
   * call-seq:
   *    enumerate_info.epr_to -> String
   *
   */
  const char *epr_to() {
    return $self->epr_to;
  }
  /*
   * The URI of the end point reference
   * call-seq:
   *    enumerate_info.epr_uri -> String
   *
   */
  const char *epr_uri() {
    return $self->epr_uri;
  }
  /*
   * The current encoding (defaults to 'utf-8')
   * call-seq:
   *    enumerate_info.encoding -> String
   *
   */
  const char *encoding() {
    return $self->encoding;
  }
  /*
   * The Filter for this enumeration
   * call-seq:
   *    enumerate_info.filter -> Openwsman::Filter
   *
   */
  const filter_t *filter() {
    return $self->filter;
  }
  /*
   * The current index (number of the last returned item)
   * call-seq:
   *    enumerate_info.index -> Integer
   *
   */
  int index() {
    return $self->index;
  }

  %rename("index=") set_index(int i);

  /*
   * Set a specific index (used to skip ahead)
   * call-seq:
   *    enumerate_info.index = 42
   *
   */
  void set_index(int i) {
    $self->index = i;
  }
  /*
   * The total number of items in this enumeration
   *
   * index is the number already returned, this is the total number
   * call-seq:
   *    enumerate_info.total_items -> Integer
   *
   */
  int total_items() {
    return $self->totalItems;
  }

  %rename("total_items=") set_total_items(int i);

  /*
   * Set the total number of items in this enumeration
   * call-seq:
   *    enumerate_info.total_items = 10
   *
   */
  void set_total_items(int i) {
    $self->totalItems = i;
  }

  /*
   * XmlDoc representing the result pulled last
   * call-seq:
   *    enumerate_info.pull_result -> Openwsman::XmlDoc
   *
   */
  WsXmlDocH pull_result() {
    return (WsXmlDocH)$self->pullResultPtr;
  }

  %rename("pull_result=") set_pull_result(WsXmlDocH result);

  /*
   * Set the pull result (XmlDoc)
   *
   * Used for server-side plugin extensions
   * call-seq:
   *    enumerate_info.pull_result = xml_doc
   *
   */
  void set_pull_result(WsXmlDocH result) {
    $self->pullResultPtr = (void *)result;
  }
}

pull_result → Openwsman::XmlDoc click to toggle source

XmlDoc representing the result pulled last

WsXmlDocH pull_result() {
    return (WsXmlDocH)$self->pullResultPtr;
  }

  %rename("pull_result=") set_pull_result(WsXmlDocH result);

  /*
   * Set the pull result (XmlDoc)
   *
   * Used for server-side plugin extensions
   * call-seq:
   *    enumerate_info.pull_result = xml_doc
   *
   */
  void set_pull_result(WsXmlDocH result) {
    $self->pullResultPtr = (void *)result;
  }
}

pull_result = xml_doc click to toggle source

Set the pull result (XmlDoc)

Used for server-side plugin extensions

void set_pull_result(WsXmlDocH result) {
    $self->pullResultPtr = (void *)result;
  }
}

total_items → Integer click to toggle source

The total number of items in this enumeration

index is the number already returned, this is the total number

int total_items() {
    return $self->totalItems;
  }

  %rename("total_items=") set_total_items(int i);

  /*
   * Set the total number of items in this enumeration
   * call-seq:
   *    enumerate_info.total_items = 10
   *
   */
  void set_total_items(int i) {
    $self->totalItems = i;
  }

  /*
   * XmlDoc representing the result pulled last
   * call-seq:
   *    enumerate_info.pull_result -> Openwsman::XmlDoc
   *
   */
  WsXmlDocH pull_result() {
    return (WsXmlDocH)$self->pullResultPtr;
  }

  %rename("pull_result=") set_pull_result(WsXmlDocH result);

  /*
   * Set the pull result (XmlDoc)
   *
   * Used for server-side plugin extensions
   * call-seq:
   *    enumerate_info.pull_result = xml_doc
   *
   */
  void set_pull_result(WsXmlDocH result) {
    $self->pullResultPtr = (void *)result;
  }
}

total_items = 10 click to toggle source

Set the total number of items in this enumeration

void set_total_items(int i) {
    $self->totalItems = i;
  }

  /*
   * XmlDoc representing the result pulled last
   * call-seq:
   *    enumerate_info.pull_result -> Openwsman::XmlDoc
   *
   */
  WsXmlDocH pull_result() {
    return (WsXmlDocH)$self->pullResultPtr;
  }

  %rename("pull_result=") set_pull_result(WsXmlDocH result);

  /*
   * Set the pull result (XmlDoc)
   *
   * Used for server-side plugin extensions
   * call-seq:
   *    enumerate_info.pull_result = xml_doc
   *
   */
  void set_pull_result(WsXmlDocH result) {
    $self->pullResultPtr = (void *)result;
  }
}