org.kuali.rice.kim.impl.group

Class GroupBase

java.lang.Object

org.kuali.rice.krad.bo.DataObjectBase

org.kuali.rice.kim.impl.group.GroupBase

All Implemented Interfaces:

Serializable, Inactivatable, GloballyUnique, Identifiable, Versioned, ModelObjectBasic, GroupContract, GroupEbo, BusinessObject, ExternalizableBusinessObject

Direct Known Subclasses:

GroupBo

@MappedSuperclass
public abstract class GroupBase
extends DataObjectBase
implements GroupEbo

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected Map<String,String>	attributes

Fields inherited from class org.kuali.rice.krad.bo.DataObjectBase

objectId, versionNumber

Constructor Summary

Constructors

Constructor and Description
GroupBase()

Method Summary

Modifier and Type	Method and Description
Map<String,String>	getAttributes() This is a set of Attributes for a Group.
String	getDescription() This a description for the Group.
String	getKimTypeId() This a Kim Type Id for the Group.
KimTypeBo	getKimTypeInfo()
String	getName() This is the name for the Group.
String	getNamespaceCode() This is the namespace code for the Group.
boolean	isActive() The active indicator for an object.
void	refresh() Invoked to refresh business objects related to the parent based on their key field values
void	setActive(boolean active)
void	setAttributes(Map<String,String> attributes)
void	setDescription(String description)
void	setKimTypeId(String kimTypeId)
void	setName(String name)
void	setNamespaceCode(String namespaceCode)

Methods inherited from class org.kuali.rice.krad.bo.DataObjectBase

generateAndSetObjectIdIfNeeded, getExtensionObject, getObjectId, getVersionNumber, prePersist, preUpdate, setExtensionObject, setObjectId, setVersionNumber, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.kuali.rice.kim.framework.group.GroupEbo

getId, getObjectId, getVersionNumber

Methods inherited from interface org.kuali.rice.core.api.mo.ModelObjectBasic

toString

Field Detail

attributes

protected Map<String,String> attributes

Constructor Detail

GroupBase

public GroupBase()

Method Detail

getAttributes

public Map<String,String> getAttributes()

Description copied from interface: GroupEbo

This is a set of Attributes for a Group.

This is a set of attributes which are key-label pairs that are defined by the Group's Kim Type.

Specified by:

getAttributes in interface GroupContract

Specified by:

getAttributes in interface GroupEbo

Returns:

attributes

setAttributes

public void setAttributes(Map<String,String> attributes)

getName

public String getName()

Description copied from interface: GroupEbo

This is the name for the Group.

This is a name assigned to a Group. Together with NamespaceCode, it makes up another unique identifier for Group

Specified by:

getName in interface GroupContract

Specified by:

getName in interface GroupEbo

Returns:

name

setName

public void setName(String name)

getDescription

public String getDescription()

Description copied from interface: GroupEbo

This a description for the Group.

This is a description assigned to a Group.

Specified by:

getDescription in interface GroupContract

Specified by:

getDescription in interface GroupEbo

Returns:

description

setDescription

public void setDescription(String description)

isActive

public boolean isActive()

Description copied from interface: GroupEbo

The active indicator for an object.

Specified by:

isActive in interface Inactivatable

Specified by:

isActive in interface GroupEbo

Returns:

true if active false if not.

setActive

public void setActive(boolean active)

getKimTypeId

public String getKimTypeId()

Description copied from interface: GroupEbo

This a Kim Type Id for the Group.

This links a Kim Type to the Group to allow custom types of Groups.

Specified by:

getKimTypeId in interface GroupContract

Specified by:

getKimTypeId in interface GroupEbo

Returns:

description

setKimTypeId

public void setKimTypeId(String kimTypeId)

getNamespaceCode

public String getNamespaceCode()

Description copied from interface: GroupEbo

This is the namespace code for the Group.

This is a namespace code assigned to a Group. Together with name, it makes up another unique identifier for Group

Specified by:

getNamespaceCode in interface GroupContract

Specified by:

getNamespaceCode in interface GroupEbo

Returns:

namespaceCode

setNamespaceCode

public void setNamespaceCode(String namespaceCode)

getKimTypeInfo

public KimTypeBo getKimTypeInfo()

refresh

public void refresh()

Description copied from interface: BusinessObject

Invoked to refresh business objects related to the parent based on their key field values

During processing (for example accepting user input) the field values that participate in relationships can become out of sync with the related business objects (for example: suppose our business object has a property name bookId with a related object of type Book that contains the id property. If the user changes the value for the bookId property, our id property on the related book and the associated information is still pointing to the previous book id). This method is invoked to indicate the related objects should be refreshed based on their related keys. For @{link PersistableBusinessObject} implementations, most refreshes can be handled by the ORM tool

Specified by:

refresh in interface BusinessObject