prophet::changeset(3pm) [debian man page]
Prophet::ChangeSet(3pm) User Contributed Perl Documentation Prophet::ChangeSet(3pm) NAME
Prophet::ChangeSet DESCRIPTION
This class represents a single, atomic Prophet database update. It tracks some metadata about the changeset itself and contains a list of Prophet::Change entries which describe the actual records created, updated and deleted. METHODS
new Instantiate a new, empty Prophet::ChangeSet object. creator A string representing who created this changeset. created A string representing the ISO 8601 date and time when this changeset was created (UTC). sequence_no The changeset's sequence number (in subversion terms, revision #) on the replica sending us the changeset. source_uuid The uuid of the replica sending us the change. original_source_uuid The uuid of the replica where the change was authored. original_sequence_no The changeset's sequence number (in subversion terms, revision #) on the replica where the change was originally created. is_nullification A boolean value specifying whether this is a nullification changeset or not. is_resolution A boolean value specifying whether this is a conflict resolution changeset or not. changes Returns an array of all the changes in the current changeset. has_changes Returns true if this changeset has any changes. add_change { change => Prophet::Change } Adds a new change to this changeset. as_hash Returns a reference to a representation of this changeset as a hash, containing all the properties in the package variable @SERIALIZE_PROPS, as well as a "changes" key containing hash representations of each change in the changeset, keyed on UUID. new_from_hashref HASHREF Takes a reference to a hash representation of a changeset (such as is returned by "as_hash" or serialized json) and returns a new Prophet::ChangeSet representation of it. Should be invoked as a class method, not an object method. For example: "Prophet::ChangeSet->new_from_hashref($ref_to_changeset_hash)" as_string ARGS Returns a single string representing the changes in this changeset. If $args{header_callback} is defined, the string returned from passing $self to the callback is prepended to the changeset string before it is returned (instead of "description_as_string"). If $args{skip_empty} is defined, an empty string is returned if the changeset contains no changes. The argument "change_filter" can be used to filter certain changes from the string representation; the function is passed a change and should return false if that change should be skipped. The "change_header" argument, if present, is passed to "$change->to_string" when individual changes are converted to strings. description_as_string Returns a string representing a description of this changeset. perl v5.10.1 2009-12-22 Prophet::ChangeSet(3pm)
Check Out this Related Man Page
Gnome2::GConf::Client(3pm) User Contributed Perl Documentation Gnome2::GConf::Client(3pm) NAME
Gnome2::GConf::Client - client module for GConf DESCRIPTION
Gnome2::GConf::Client is a commodity class based on "GObject" used to access the default "GConfEngine" provided by the GConf daemon. It has a cache, finer-grained notification of changes and a default error handling mechanism. ERROR HANDLING
In C, each fallible function has a "GError" optional argument: by setting it to a valid "GError" structure, the function will fill it in case of error; by passing a NULL value, the function will silently fail. In Perl, each fallible method has a boolean "check_error" argument; by setting this argument to "TRUE", the method will croak con failure, otherwise it will silently fail. NOTE: To retain backward compatibility, the default behaviour is to check each error; that is, the "check_error" argument silently is set to TRUE. In order to catch an error, you might use eval as a try...catch equivalent: eval { $s = $client->get_string($some_key); 1; }; if (Glib::Error::matches($@, 'Gnome2::GConf::Error', 'bad-key')) { # recover from a bad-key error. } On failure, if the error is unchecked, the "unreturned_error" signal will be fired by the Gnome2::GConf::Client object; the "error" signal will always be fired, whether the error is checked or not. If you want to let the global error handler function catch just the unchecked error, use the "Gnome2::GConf::Client::set_error_handling" method, and attach a callback to the "unreturned_error" signal: $client->set_error_handling('handle-unreturned'); $client->signal_connect(unreturned_error => sub { my ($client, $error) = @_; warn $error; # is a Glib::Error }); HIERARCHY
Glib::Object +----Gnome2::GConf::Client METHODS
$client->add_dir ($dir, $preload, $check_error=TRUE) o $dir (string) o $preload (Gnome2::GConf::ClientPreloadType) o $check_error (boolean) list = $client->all_dirs($dir, $check_error=TRUE) o $dir (string) o $check_error (boolean) This method returns an array containing all the directories in a given directory. list = $client->all_entries($dir, $check_error=TRUE) o $dir (string) o $check_error (boolean) This method returns an array containing all the entries (as Gnome2::GConf::Entry) of a given directory. boolean = $client->get_bool ($key, $check_error=TRUE) o $key (string) o $check_error (boolean) boolean = $client->set_bool ($key, $val, $check_error=TRUE) o $key (string) o $val (boolean) o $check_error (boolean) Returns FALSE on failure. changeset = $client->change_set_from_current ($check_error=TRUE, $key, ...) o $check_error (boolean) o ... (list) list of keys to add to the changeset Create a Gnome2::GConf::ChangeSet from a list of keys inside the GConf database. $client->clear_cache boolean = $client->commit_change_set ($cs, $remove_committed, $check_error=TRUE) (boolean, changeset) = $client->commit_change_set ($cs, $remove_committed, $check_error=TRUE) o $cs (changeset) o $remove_committed (boolean) o $check_error (boolean) Commit a given Gnome2::GConf::ChangeSet. In scalar context, or if $remove_committed is FALSE, return a boolean value; otherwise, return the boolean value and the Gnome2::GConf::ChangeSet $cs, pruned of the successfully committed changes. value = $client->get_default_from_schema ($key, $check_error=TRUE) o $key (string) o $check_error (boolean) client = Gnome2::GConf::Client->get_default boolean = $client->dir_exists ($dir, $check_error=TRUE) o $dir (string) o $check_error (boolean) entry = $client->get_entry ($key, $locale, $use_schema_default, $check_error=TRUE) o $key (string) o $locale (string) o $use_schema_default (boolean) o $check_error (boolean) list = $client->error ($error) o $error (scalar) a Glib::Error You should not use this method. This method emits the "error" signal. $client->set_error_handling ($mode) o $mode (Gnome2::GConf::ClientErrorHandlingMode) double = $client->get_float ($key, $check_error=TRUE) o $key (string) o $check_error (boolean) boolean = $client->set_float ($key, $val, $check_error=TRUE) o $key (string) o $val (double) o $check_error (boolean) Returns FALSE on failure. client = Gnome2::GConf::Client->get_for_engine ($engine) o $engine (engine) value = $client->get ($key, $check_error=TRUE) o $key (string) o $check_error (boolean) Fetch the "GConfValue" bound to the give $key. $client->set ($key, $value, $check_error=TRUE) o $key (string) o $value (value) o $check_error (boolean) Set the "GConfValue" $val bound to the given $key. integer = $client->get_int ($key, $check_error=TRUE) o $key (string) o $check_error (boolean) boolean = $client->set_int ($key, $val, $check_error=TRUE) o $key (string) o $val (integer) o $check_error (boolean) Returns FALSE on failure. boolean = $client->key_is_writable ($key, $check_error=TRUE) o $key (string) o $check_error (boolean) $client->get_list ($key, $check_error=TRUE) o $key (string) o $check_error (boolean) boolean = $client->set_list ($key, $list_type, $list, $check_error=TRUE) o $key (string) o $list_type (string) o $list (scalar) o $check_error (boolean) integer = $client->notify_add ($namespace_section, $func, $data=undef, $check_error=TRUE) o $namespace_section (string) o $func (scalar) o $data (scalar) o $check_error (boolean) $client->notify_remove ($cnxn_id) o $cnxn_id (integer) $client->get_pair ($key, $check_error=TRUE) o $key (string) o $check_error (boolean) boolean = $client->set_pair ($key, $car, $cdr, $check_error=TRUE) o $key (string) o $car (value) o $cdr (value) o $check_error (boolean) $client->preload ($dirname, $type, $check_error=TRUE) o $dirname (string) o $type (Gnome2::GConf::ClientPreloadType) o $check_error (boolean) boolean = $client->recursive_unset ($key, $flags=0, $check_error=TRUE) o $key (string) o $flags (Gnome2::GConf::UnsetFlags) o $check_error (boolean) Since: gconf 2.3 $client->remove_dir ($dir, $check_error=TRUE) o $dir (string) o $check_error (boolean) changeset = $client->reverse_change_set ($cs, $check_error=TRUE) o $cs (changeset) o $check_error (boolean) Reverse the given Gnome2::GConf::ChangeSet. schema = $client->get_schema ($key) o $key (string) boolean = $client->set_schema ($key, $schema, $check_error=TRUE) o $key (string) o $schema (schema) o $check_error (boolean) string = $client->get_string ($key, $check_error=TRUE) o $key (string) o $check_error (boolean) boolean = $client->set_string ($key, $val, $check_error=TRUE) o $key (string) o $val (string) o $check_error (boolean) Returns FALSE on failure $client->suggest_sync ($check_error=TRUE) o $check_error (boolean) list = $client->unreturned_error ($error) o $error (scalar) a Glib::Error You should not use this method. This method emits the "unreturned-error" signal. boolean = $client->unset ($key, $check_error=TRUE) o $key (string) o $check_error (boolean) list = $client->value_changed ($key, $value) o $key (string) o $value (value) You should not use this method. This method emits the "value-changed" signal. value = $client->get_without_default ($key, $check_error=TRUE) o $key (string) o $check_error (boolean) SIGNALS
value-changed (Gnome2::GConf::Client, string, gpointer) unreturned-error (Gnome2::GConf::Client, gpointer) error (Gnome2::GConf::Client, gpointer) ENUMS AND FLAGS
enum Gnome2::GConf::ClientErrorHandlingMode o 'handle-none' / 'GCONF_CLIENT_HANDLE_NONE' o 'handle-unreturned' / 'GCONF_CLIENT_HANDLE_UNRETURNED' o 'handle-all' / 'GCONF_CLIENT_HANDLE_ALL' enum Gnome2::GConf::ClientPreloadType o 'preload-none' / 'GCONF_CLIENT_PRELOAD_NONE' o 'preload-onelevel' / 'GCONF_CLIENT_PRELOAD_ONELEVEL' o 'preload-recursive' / 'GCONF_CLIENT_PRELOAD_RECURSIVE' flags Gnome2::GConf::UnsetFlags o 'names' / 'GCONF_UNSET_INCLUDING_SCHEMA_NAMES' SEE ALSO
Gnome2::GConf, Glib::Object COPYRIGHT
Copyright (C) 2003-2006 by the gtk2-perl team. This software is licensed under the LGPL. See Gnome2::GConf for a full notice. perl v5.14.2 2011-11-17 Gnome2::GConf::Client(3pm)