api.basecamp
Class Category

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

public class Category
extends java.lang.Object


Field Summary
static boolean ATTACH
           
static boolean POST
           
 
Constructor Summary
Category(BCAuth auth, int categoryId)
          Get Category By ID
Category(BCAuth auth, int projectId, boolean categoryType, java.lang.String categoryName)
          Create new category
 
Method Summary
 int getId()
           
 int getItemCount()
           
 java.lang.String getName()
           
 int getProjectId()
           
 boolean isType()
           
 boolean save()
          Update the Category in its current state (only Name editable)
 void setName(java.lang.String name)
           
 boolean trash()
          Delete this Category from the BaseCamp System
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

POST

public static final boolean POST
See Also:
Constant Field Values

ATTACH

public static final boolean ATTACH
See Also:
Constant Field Values
Constructor Detail

Category

public Category(BCAuth auth,
                int categoryId)
Get Category By ID

Parameters:
auth - BCAuth Object
categoryId - ID of desired Category

Category

public Category(BCAuth auth,
                int projectId,
                boolean categoryType,
                java.lang.String categoryName)
Create new category

Parameters:
auth - BCAuth Object
projectId - Project ID you want category to be attached to
categoryType - Category Type [ Category.POST || Category.ATTACH ]
categoryName - Name of Category
Method Detail

save

public boolean save()
Update the Category in its current state (only Name editable)

Returns:
Boolean depending on success of operation

trash

public boolean trash()
Delete this Category from the BaseCamp System

Returns:
Boolean depending on operation success

getId

public int getId()
Returns:
the id

getName

public java.lang.String getName()
Returns:
the name

getProjectId

public int getProjectId()
Returns:
the projectId

getItemCount

public int getItemCount()
Returns:
the itemCount

isType

public boolean isType()
Returns:
the type

setName

public void setName(java.lang.String name)
Parameters:
name - the name to set