Class: AdminRequestResult

Source Location: /CORE/system/classes/administration/AdminRequestResult.php

Class AdminRequestResult

Class Overview

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

Currently it is used in the ItemAdminService.

Located in /CORE/system/classes/administration/AdminRequestResult.php [line 36]



		
				Author(s):
		
  • Kevin Papst
Information Tags:
Version:  $Id: AdminRequestResult.php,v 1.4 2006/11/26 22:04:13 kpapst Exp $
Copyright:  Copyright (C) 2002-2006 Kevin Papst
License:  GNU Public License

Methods

[ Top ]
Method Summary
AdminRequestResult   AdminRequestResult()  
void   getID()  
void   getMessage()  
void   getName()  
void   getValue()   Gets any result value.
void   isSuccessful()  
void   setID()  
void   setIsSuccessful()  
void   setMessage()  
void   setName()  
void   setValue()   Sets any result value.

[ Top ]
Methods
Constructor AdminRequestResult  [line 51]

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

Parameters:
   $success: 
   $msg: 


[ Top ]
getID  [line 72]

  void getID( )



[ Top ]
getMessage  [line 56]

  void getMessage( )



[ Top ]
getName  [line 80]

  void getName( )



[ Top ]
getValue  [line 99]

  void getValue( $key  )

Gets any result value.

Parameters:
   $key: 


[ Top ]
isSuccessful  [line 64]

  void isSuccessful( )



[ Top ]
setID  [line 76]

  void setID( $id  )

Parameters:
   $id: 


[ Top ]
setIsSuccessful  [line 68]

  void setIsSuccessful( $success  )

Parameters:
   $success: 


[ Top ]
setMessage  [line 60]

  void setMessage( $msg  )

Parameters:
   $msg: 


[ Top ]
setName  [line 84]

  void setName( $name  )

Parameters:
   $name: 


[ Top ]
setValue  [line 92]

  void setValue( $key, $value  )

Sets any result value.

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

Parameters:
   $key: 
   $value: 


[ Top ]