api.basecamp
Class Milestone

java.lang.Object
  extended by api.basecamp.Milestone

public class Milestone
extends java.lang.Object

Comment Object for use with BaseCamp API

Author:
jondavidjohn

Constructor Summary
Milestone(BCAuth auth)
          New and Unsaved Milestone Object.
 
Method Summary
 int getCommentCount()
           
 java.util.Calendar getCommentedAt()
           
 java.util.Calendar getCompletedOn()
           
 int getCompleterId()
           
 java.lang.String getCompleterName()
           
 java.util.Calendar getCreatedOn()
           
 int getCreatorId()
           
 java.lang.String getCreatorName()
           
 java.util.Calendar getDeadline()
           
 int getId()
           
 int getProjectId()
           
 int getResponsiblePartyId()
           
 java.lang.String getResponsiblePartyName()
           
 java.lang.String getResponsiblePartyType()
           
 java.lang.String getTitle()
           
 boolean isCompleted()
           
 boolean save(boolean notify)
          Save Milestone in Current form (Rebuilds/Refreshes upon completion)
 void setCompleted(boolean completed)
           
 void setDeadline(java.util.Calendar deadline)
           
 void setProjectId(int projectId)
          Only allows if Milestone ID == 0 (unsaved)
 void setResponsiblePartyId(int responsiblePartyId)
           
 void setTitle(java.lang.String title)
           
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

Milestone

public Milestone(BCAuth auth)
New and Unsaved Milestone Object. Make sure to set the following before saving - title - deadline - responsiblePartyId - projectId

Parameters:
auth - BCAuth Object
Method Detail

save

public boolean save(boolean notify)
Save Milestone in Current form (Rebuilds/Refreshes upon completion)

Parameters:
notify - Notify people of update?
Returns:
Success/Fail

getId

public int getId()
Returns:
the id

getTitle

public java.lang.String getTitle()
Returns:
the title

getDeadline

public java.util.Calendar getDeadline()
Returns:
the deadline

isCompleted

public boolean isCompleted()
Returns:
the completed

getProjectId

public int getProjectId()
Returns:
the projectId

getCreatedOn

public java.util.Calendar getCreatedOn()
Returns:
the createdOn

getCreatorId

public int getCreatorId()
Returns:
the creatorId

getCreatorName

public java.lang.String getCreatorName()
Returns:
the creatorName

getResponsiblePartyId

public int getResponsiblePartyId()
Returns:
the responsiblePartyId

getResponsiblePartyType

public java.lang.String getResponsiblePartyType()
Returns:
the responsiblePartyType

getResponsiblePartyName

public java.lang.String getResponsiblePartyName()
Returns:
the responsiblePartyName

getCommentedAt

public java.util.Calendar getCommentedAt()
Returns:
the commentedAt

getCommentCount

public int getCommentCount()
Returns:
the commentCount

getCompletedOn

public java.util.Calendar getCompletedOn()
Returns:
the completedOn

getCompleterId

public int getCompleterId()
Returns:
the completerId

getCompleterName

public java.lang.String getCompleterName()
Returns:
the completerName

setTitle

public void setTitle(java.lang.String title)
Parameters:
title - the title to set

setDeadline

public void setDeadline(java.util.Calendar deadline)
Parameters:
deadline - the deadline to set

setResponsiblePartyId

public void setResponsiblePartyId(int responsiblePartyId)
Parameters:
responsiblePartyId - the responsiblePartyId to set

setProjectId

public void setProjectId(int projectId)
Only allows if Milestone ID == 0 (unsaved)

Parameters:
projectId - the projectId to set

setCompleted

public void setCompleted(boolean completed)
Parameters:
completed - the completed to set