Docs For Class AdminRequestResult

Description

A AdminRequestResult can be used as Generic Result Type for Admin requests.

Currently it is used in the ItemAdminService.

version: $Id: AdminRequestResult.php,v 1.4 2006/11/26 22:04:13 kpapst Exp $
copyright: Copyright (C) 2002-2006 Kevin Papst
author: Kevin Papst
license: GNU Public License

Method Summary

AdminRequestResult AdminRequestResult ( $success, [ $msg = ''])

void getID ()

void getMessage ()

void getName ()

void getValue ( $key)

void isSuccessful ()

void setID ( $id)

void setIsSuccessful ( $success)

void setMessage ( $msg)

void setName ( $name)

void setValue ( $key, $value)

Methods

Constructor AdminRequestResult (line 51)

AdminRequestResult AdminRequestResult ( $success, [ $msg = ''])

$success
$msg

getID (line 72)

void getID ()

getMessage (line 56)

void getMessage ()

getName (line 80)

void getName ()

getValue (line 99)

Gets any result value.

void getValue ( $key)

$key

isSuccessful (line 64)

void isSuccessful ()

setID (line 76)

void setID ( $id)

$id

setIsSuccessful (line 68)

void setIsSuccessful ( $success)

$success

setMessage (line 60)

void setMessage ( $msg)

$msg

setName (line 84)

void setName ( $name)

$name

setValue (line 92)

Sets any result value.

Used for settings that may be passed and do not match any given Method like Name or ID.

void setValue ( $key, $value)

$key
$value