org.omus.core
Class GroupCreationData

java.lang.Object
  |
  +--org.omus.core.GroupCreationData

public class GroupCreationData

extends java.lang.Object

Contains information about a group that is going to be created. Gets passed to the prepareGroupCreation method in org.omus.ext.GroupExtension.

Method Summary

java.lang.String	getConfigID() Returns the configID of the group.
java.lang.String	getErrorCode() Returns the error code or null if none was specified yet.
java.lang.String	getName() Returns the name of the group.
void	setErrorCode(java.lang.String newCode) Sets the error code to the specified string.

Methods inherited from class java.lang.Object

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

Method Detail

getConfigID

public java.lang.String getConfigID()

Returns the configID of the group. It identifies the <group>-node in config.xml that was used to configure this group. You can have an unlimited number of groups with the same configID but different names. See the Configuration chapter for more details.

getName

public java.lang.String getName()

Returns the name of the group.

getErrorCode

public java.lang.String getErrorCode()

Returns the error code or null if none was specified yet.

setErrorCode

public void setErrorCode(java.lang.String newCode)

Sets the error code to the specified string. The code will be prefixed with "cld-" automatically to avoid confusion with built-in error codes. It will be sent to the client if the prepareGroupCreation method in org.omus.ext.GroupExtension returns false so that the creation of the group will be aborted.