com.ibm.ram.client
Class RAMCommunity

java.lang.Object
  extended by com.ibm.ram.common.data.CommunityInformation
      extended by com.ibm.ram.client.RAMCommunity

public class RAMCommunity
extends CommunityInformation

Represents a Rational Asset Manager community

Since:
7.1
Author:
kbauer

Method Summary
 RAMAction getAction()
          Set the action to be performed on the session object.
 RAMUser[] getAdministrators()
          Return the administrators of this community
 java.lang.String getDescription()
           
 RAMHomepageViewlet getHomepageViewlet(java.lang.String id)
          Returns a modifiable viewlet from the community home page.
 int getId()
           
 java.lang.String getName()
           
 RAMSession getSession()
          Return the session this type was fetched from.
 boolean isDirty()
          Returns true if the Object has been modified from the copy on the server
 void refresh()
          Refresh this communiy with the information on the server.
 void setAction(RAMAction action)
          Set the action to be performed when passed to RAMSession#put(IRAMSessionObject, org.eclipse.core.runtime.IProgressMonitor) Accepts RAMAction.CREATE RAMAction.UPDATE RAMAction.DELETE
 void setAdministrators(RAMUser[] administrators)
          Set the list of administrator for this community.
 void setDescription(java.lang.String description)
           
 void setId(int id)
           
 void setName(java.lang.String name)
           
 java.lang.String toString()
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Method Detail

getId

public int getId()
          throws RAMRuntimeException
Overrides:
getId in class CommunityInformation
Returns:
The database id of the community.
Throws:
RAMRuntimeException

setId

public void setId(int id)
Overrides:
setId in class CommunityInformation
Parameters:
id - The database id of the community.

getName

public java.lang.String getName()
                         throws RAMRuntimeException
Overrides:
getName in class CommunityInformation
Returns:
The name of the community.
Throws:
RAMRuntimeException

setName

public void setName(java.lang.String name)
Overrides:
setName in class CommunityInformation
Parameters:
name - The name of the community.

getDescription

public java.lang.String getDescription()
                                throws RAMRuntimeException
Overrides:
getDescription in class CommunityInformation
Returns:
The description of the community
Throws:
RAMRuntimeException

getHomepageViewlet

public RAMHomepageViewlet getHomepageViewlet(java.lang.String id)
Returns a modifiable viewlet from the community home page.

Parameters:
id -
Since:
7.1

setDescription

public void setDescription(java.lang.String description)
Overrides:
setDescription in class CommunityInformation
Parameters:
description - The description for the community.

getAdministrators

public RAMUser[] getAdministrators()
Return the administrators of this community

Returns:
Since:
7.1

setAdministrators

public void setAdministrators(RAMUser[] administrators)
Set the list of administrator for this community.

Parameters:
administrators -
Since:
7.1

refresh

public void refresh()
             throws RAMRuntimeException
Refresh this communiy with the information on the server.

Throws:
RAMRuntimeException
Since:
7.1

toString

public java.lang.String toString()
Overrides:
toString in class java.lang.Object

getSession

public RAMSession getSession()
Return the session this type was fetched from.

Since:
7.1

isDirty

public boolean isDirty()
Returns true if the Object has been modified from the copy on the server

Returns:

getAction

public RAMAction getAction()
Set the action to be performed on the session object. Each object will have it's own set of actions it will accept

Returns:

setAction

public void setAction(RAMAction action)
Set the action to be performed when passed to RAMSession#put(IRAMSessionObject, org.eclipse.core.runtime.IProgressMonitor) Accepts RAMAction.CREATE RAMAction.UPDATE RAMAction.DELETE

Parameters:
action -
Since:
7.1