Changeset 735

Show
Ignore:
Timestamp:
07/10/06 22:31:52
Author:
douglm
Message:

Aggregator javadoc fixes

Files:

Legend:

Unmodified
Added
Removed
Modified
Copied
Moved

  • freebusy/trunk/fbclient/src/org/bedework/fbclient/IcalTrans.java

    r727 r735  
    5656  } 
    5757 
     58  /** 
     59   * @throws CalFacadeException 
     60   */ 
    5861  public void open() throws CalFacadeException { 
    5962    getSvci(); 
    …… 
    6972  } 
    7073 
     74  /** 
     75   * @return CalTimezones 
     76   * @throws CalFacadeException 
     77   */ 
    7178  public CalTimezones getTimezones() throws CalFacadeException { 
    7279    return svci.getTimezones(); 

  • freebusy/trunk/webclient/src/org/bedework/fbaggregator/FBAttendeeInfo.java

    r730 r735  
    5151  } 
    5252 
     53  /** 
     54   * @param val 
     55   */ 
    5356  public void setAttendee(FBUserInfo val) { 
    5457    attendee = val; 
    5558  } 
    5659 
     60  /** 
     61   * @return FBUserInfo 
     62   */ 
    5763  public FBUserInfo getAttendee() { 
    5864    return attendee; 

  • freebusy/trunk/webclient/src/org/bedework/fbaggregator/FBAttendeeSet.java

    r730 r735  
    5252  } 
    5353 
     54  /** 
     55   * @param val 
     56   */ 
    5457  public void setName(String val) { 
    5558    name = val; 
    5659  } 
    5760 
     61  /** 
     62   * @return String 
     63   */ 
    5864  public String getName() { 
    5965    return name; 
    …… 
    6975  } 
    7076 
     77  /** 
     78   * @return Iterator 
     79   */ 
    7180  public Iterator iterator() { 
    7281    return attendeeSet.iterator(); 
    …… 
    9099  } 
    91100 
     101  /** 
     102   * @param prefix 
     103   * @return Collection 
     104   */ 
    92105  public Collection startsWith(String prefix) { 
    93106    ArrayList atts = new ArrayList(); 
    …… 
    104117  } 
    105118 
     119  /** 
     120   * @param suffix 
     121   * @return Collection 
     122   */ 
    106123  public Collection endsWith(String suffix) { 
    107124    ArrayList atts = new ArrayList(); 

  • freebusy/trunk/webclient/src/org/bedework/fbaggregator/FbAggForm.java

    r732 r735  
    3737 * 
    3838 */ 
     39/** 
     40 * @author douglm 
     41 * 
     42 */ 
    3943public class FbAggForm extends UtilActionForm { 
    4044  private FBAggConfig config; 
    …… 
    128132  } 
    129133 
     134  /** 
     135   * @param val 
     136   */ 
    130137  public void assignResponses(FbResponses val) { 
    131138    resps = val; 
    132139  } 
    133140 
     141  /** 
     142   * @return FbResponses 
     143   */ 
    134144  public FbResponses getResponses() { 
    135145    return resps; 
    136146  } 
    137147 
     148  /** 
     149   * @param val 
     150   */ 
    138151  public void setShowIndividual(boolean val) { 
    139152    showIndividual = val; 
    140153  } 
    141154 
     155  /** 
     156   * @return boolean 
     157   */ 
    142158  public boolean getShowIndividual() { 
    143159    return showIndividual; 
    144160  } 
    145161 
     162  /** 
     163   * @param val 
     164   */ 
    146165  public void assignFormattedFreeBusy(FormattedFreeBusy val) { 
    147166    ffb = val; 
    148167  } 
    149168 
     169  /** 
     170   * @return FormattedFreeBusy 
     171   */ 
    150172  public FormattedFreeBusy getFormattedFreeBusy() { 
    151173    return ffb; 
    152174  } 
    153175 
     176  /** 
     177   * @param val 
     178   */ 
    154179  public void assignIndividualFreeBusy(Collection val) { 
    155180    individualFreeBusy = val; 
    156181  } 
    157182 
     183  /** 
     184   * @return Collection 
     185   */ 
    158186  public Collection getIndividualFreeBusy() { 
    159187    return individualFreeBusy; 
    160188  } 
    161189 
     190  /** 
     191   * @param val 
     192   */ 
    162193  public void assignFailedResponses(Collection val) { 
    163194    failedResponses = val; 
    164195  } 
    165196 
     197  /** 
     198   * @return Collection 
     199   */ 
    166200  public Collection getFailedResponses() { 
    167201    return failedResponses; 
    168202  } 
    169203 
     204  /** 
     205   * @param val 
     206   */ 
    170207  public void setTimeZoneIds(List val) { 
    171208    timeZoneIds = val; 
    172209  } 
    173210 
     211  /** 
     212   * @return List 
     213   */ 
    174214  public List getTimeZoneIds() { 
    175215    return timeZoneIds; 
    176216  } 
    177217 
     218  /** 
     219   * @param val 
     220   */ 
    178221  public void setCurrentTimeZoneId(String val) { 
    179222    currentTimeZoneId = val; 
    180223  } 
    181224 
     225  /** 
     226   * @return String 
     227   */ 
    182228  public String getCurrentTimeZoneId() { 
    183229    return currentTimeZoneId; 
    …… 
    214260  } 
    215261 
     262  /** 
     263   * @param val 
     264   */ 
    216265  public void setGroupNames(String[] val) { 
    217266    groupNames = val; 
    218267  } 
    219268 
     269  /** 
     270   * @return String[] 
     271   */ 
    220272  public String[] getGroupNames() { 
    221273    return groupNames; 
    222274  } 
    223275 
     276  /** 
     277   * @param val 
     278   */ 
    224279  public void setCurrentGroup(String val) { 
    225280    currentGroup = val; 
    226281  } 
    227282 
     283  /** 
     284   * @return String 
     285   */ 
    228286  public String getCurrentGroup() { 
    229287    return currentGroup; 

  • freebusy/trunk/webclient/src/org/bedework/fbaggregator/FbAggSession.java

    r727 r735  
    144144  } 
    145145 
     146  /** 
     147   * @throws Throwable 
     148   */ 
    146149  public void init() throws Throwable { 
    147150    fba = new FreeBusyAggregator(); 
    …… 
    152155   * ====================================================================== */ 
    153156 
    154   /* (non-Javadoc) 
    155    * @see org.bedework.webcommon.BwSession#getSessionNum() 
     157  /** 
     158   * @return long 
    156159   */ 
    157160  public long getSessionNum() { 
    …… 
    230233  } 
    231234 
     235  /** 
     236   * @param val 
     237   */ 
    232238  public void assignAllUsers(FBAttendeeSet val) { 
    233239    allUsers = val; 
    234240  } 
    235241 
     242  /** 
     243   * @return FBAttendeeSet 
     244   */ 
    236245  public FBAttendeeSet getAllUsers() { 
    237246    return allUsers; 
    238247  } 
    239248 
     249  /** 
     250   * @param val 
     251   */ 
    240252  public void assignCurAttendees(FBAttendeeSet val) { 
    241253    curAttendees = val; 
    242254  } 
    243255 
     256  /** 
     257   * @return FBAttendeeSet 
     258   */ 
    244259  public FBAttendeeSet getCurAttendees() { 
    245260    return curAttendees; 
    246261  } 
    247262 
     263  /** 
     264   * @return FreeBusyAggregator 
     265   */ 
    248266  public FreeBusyAggregator getFba() { 
    249267    return fba; 
    250268  } 
    251269 
     270  /** 
     271   * @return Collection 
     272   */ 
    252273  public Collection getGroups() { 
    253274    if (groups == null) { 
    …… 
    258279  } 
    259280 
     281  /** 
     282   * @param val 
     283   */ 
    260284  public void addGroup(FBAttendeeSet val) { 
    261285    getGroups().add(val); 
    262286  } 
    263287 
     288  /** 
     289   * @return Iterator 
     290   */ 
    264291  public Iterator iterateGroups() { 
    265292    return getGroups().iterator(); 
    266293  } 
    267294 
     295  /** 
     296   * @return String[] 
     297   */ 
    268298  public String[] getGroupNames() { 
    269299    Collection names = new ArrayList(); 
    …… 
    277307  } 
    278308 
     309  /** 
     310   * @param name 
     311   * @return FBAttendeeSet 
     312   */ 
    279313  public FBAttendeeSet findGroup(String name) { 
    280314    Iterator it = iterateGroups(); 

  • freebusy/trunk/webclient/src/org/bedework/fbaggregator/FormattedFreeBusy.java

    r727 r735  
    7878    } 
    7979 
     80    /** 
     81     * @return String 
     82     */ 
    8083    public String getDateString() { 
    8184      return dateString; 

  • freebusy/trunk/webclient/src/org/bedework/fbaggregator/ForwardDefs.java

    r730 r735  
    4545  public static final int forwardNoAccess = 4; 
    4646 
     47  /** */ 
    4748  public static final int forwardBadDate = 5; 
    4849 
     50  /** */ 
    4951  public static final int forwardNotFound = 6; 
    5052 
     53  /** */ 
    5154  public static final int forwardNoAction = 7; 
    5255 
     56  /** */ 
    5357  public static final int forwardNoDate = 8; 
    5458 
     59  /** */ 
    5560  public static final int forwardAlreadyExists = 9; 
    5661 

  • freebusy/trunk/webclient/src/org/bedework/fbaggregator/FreeBusyAggregator.java

    r732 r735  
    5353import javax.servlet.http.HttpServletResponse; 
    5454 
    55 /** Currently more a proof of concept. Takes a date range and does free/busy 
    56  * queries for a list of users, then generates an aggregated free busy display. 
     55/** Takes a date range and does free/busy queries for a list of users, then 
     56 * generates an aggregated free busy display. 
    5757 * 
    5858 * @author douglm 
    …… 
    7575  }; 
    7676 
     77  /** 
     78   * @author douglm 
     79   * 
     80   */ 
    7781  public static class FbResponse implements Serializable { 
    7882    private BwDateTime start; 
    …… 
    116120    } 
    117121 
     122    /** 
     123     * @return int 
     124     */ 
    118125    public int getRespCode() { 
    119126      return respCode; 
    120127    } 
    121128 
     129    /** 
     130     * @return FBUserInfo 
     131     */ 
    122132    public FBUserInfo getUi() { 
    123133      return ui; 
    124134    } 
    125135 
     136    /** 
     137     * @return boolean 
     138     */ 
    126139    public boolean okResponse() { 
    127140      return respCode == HttpServletResponse.SC_OK; 
    …… 
    129142  } 
    130143 
     144  /** 
     145   * @author douglm 
     146   * 
     147   */ 
    131148  public static class FbResponses implements Serializable { 
    132149    private Collection responses; 

  • freebusy/trunk/webclient/src/org/bedework/fbaggregator/RenderAction.java

    r672 r735  
    7474  } 
    7575 
    76   /* (non-Javadoc) 
    77    * @see edu.rpi.sss.util.jsp.UtilAbstractAction#getContentName(edu.rpi.sss.util.jsp.UtilActionForm) 
     76  /** 
     77   * @param form 
     78   * @return String 
    7879   */ 
    7980  public String getContentName(FbAggForm form) {