NAME

Sakai::Nakamura::UserUtil - Methods to generate and check HTTP requests required for manipulating users.

ABSTRACT

Utility library returning strings representing Rest queries that perform user related actions in the system.

METHODS

exists_setup

Returns a textual representation of the request needed to test whether a given username exists in the system.

exists_eval

Inspects the result returned from issuing the request generated in exists_setup returning true if the result indicates the username does exist in the system, else false.

me_setup

Returns a textual representation of the request needed to return information about the current user.

me_eval

Inspects the result returned from issuing the request generated in me_setup returning true if the result indicates information was returned successfully, else false.

profile_update_setup

Returns a textual representation of the request needed to update the profile for a specified user.

profile_update_eval

Inspects the result returned from issuing the request generated in profile_setup returning true if the result indicates profile information was updated successfully, else false.

USAGE

use Sakai::Nakamura::UserUtil;

DESCRIPTION

UserUtil perl library essentially provides the request strings needed to interact with user functionality exposed over the system rest interfaces.

Each interaction has a setup and eval method. setup provides the request, whilst eval interprets the response to give further information about the result of performing the request.

REQUIRED ARGUMENTS

None required.

OPTIONS

n/a

DIAGNOSTICS

n/a

EXIT STATUS

0 on success.

CONFIGURATION

None required.

DEPENDENCIES

INCOMPATIBILITIES

None known.

BUGS AND LIMITATIONS