RIDLObject: RIDLObject abstract class

In dickoa/ridl: A Client for the UNHCR RIDL Platform API

RIDLObject abstract class

Description

RIDLObject abstract class

RIDLObject abstract class

Details

RIDLObject class containing all logic for accessing, creating, and updating RIDL objects.

Public fields

data

placeholder for RIDLObject field element

Methods

Public methods

• RIDLObject$new()

• RIDLObject$as_list()

• RIDLObject$browse_on_ridl()

• RIDLObject$get_config()

• RIDLObject$get_fields()

• RIDLObject$get_required_fields()

• RIDLObject$check_required_fields()

• RIDLObject$print()

• RIDLObject$clone()

---

Method new()

Create a new RIDLObject object

Usage

RIDLObject$new(initial_data = NULL, configuration = NULL)

Arguments

initial_data

list with required field to create a RIDLObject

configuration

a Configuration object

Returns

A RIDLObject object

---

Method as_list()

Get RIDLObject field into list

Usage

RIDLObject$as_list()

Returns

a list with RIDLObject field

---

Method browse_on_ridl()

Browse RIDL

Usage

RIDLObject$browse_on_ridl()

---

Method get_config()

Get the current configuration in use

Usage

RIDLObject$get_config()

Returns

A configuration object, the configuration in use

---

Method get_fields()

Get dataset fields

Usage

RIDLObject$get_fields()

Returns

list of fields for a dataset

---

Method get_required_fields()

Get dataset required fields

Usage

RIDLObject$get_required_fields()

Returns

list of required fields for a dataset

---

Method check_required_fields()

Check dataset required field

Usage

RIDLObject$check_required_fields()

Returns

a logical value, TRUE if the the dataset is not missing a required field and throws an error otherwise

---

Method print()

Print a Dataset object

Usage

RIDLObject$print()

---

Method clone()

The objects of this class are cloneable with this method.

Usage

RIDLObject$clone(deep = FALSE)

Arguments

deep

Whether to make a deep clone.

dickoa/ridl documentation built on April 23, 2023, 7:14 p.m.