gyro/modules/status/lib/interfaces/istatusholder.cls.php

Go to the documentation of this file.
00001 <?php
00002 /**
00003  * Interface for any class having status
00004  * 
00005  * @author Gerd Riesselmann
00006  * @ingroup Status
00007  */
00008 interface IStatusHolder {
00009         /**
00010          * Set status
00011          *
00012          * @param string $status
00013          */
00014         public function set_status($status);
00015         
00016         /**
00017          * Returns status
00018          * 
00019          * @return string
00020          */
00021         public function get_status();
00022         
00023         /**
00024          * Returns true, if status is active
00025          *
00026          * @return bool
00027          */
00028         public function is_active();
00029 
00030         /**
00031          * Returns true, if status is unconfirmed
00032          *
00033          * @return bool
00034          */
00035         public function is_unconfirmed();
00036         
00037         /**
00038          * Returns true, if status is deleted
00039          *
00040          * @return bool
00041          */
00042         public function is_deleted();
00043         
00044         /**
00045          * Returns true, if status is disabled
00046          *
00047          * @return bool
00048          */
00049         public function is_disabled();  
00050 }