org.tigris.scarab.om
Class AttributeGroup

java.lang.Object
  org.apache.torque.om.BaseObject
      org.tigris.scarab.om.BaseAttributeGroup
          org.tigris.scarab.om.AttributeGroup

All Implemented Interfaces:

org.apache.torque.om.Persistent, org.apache.fulcrum.intake.Retrievable, java.io.Serializable

public class AttributeGroup

extends BaseAttributeGroup

implements org.apache.torque.om.Persistent

You should add additional methods to this class to meet the application requirements. This class will only be generated as long as it does not already exist in the output directory.

See Also:

Serialized Form

Field Summary

static java.lang.String

GET_ATTRIBUTES

Fields inherited from class org.tigris.scarab.om.BaseAttributeGroup

collRAttributeAttributeGroups

Fields inherited from class org.apache.torque.om.BaseObject

NEW_ID

Constructor Summary

AttributeGroup()

Method Summary

void	addAttribute(Attribute attribute)
AttributeGroup	copyGroup()
void	delete()
void	deleteAttribute(Attribute attribute, ScarabUser user, Module module)
java.util.List	getAttributes() List of Attributes in this group.
int	getHighestOrderedAttribute() Retrieves the attribute in this group with the highest preferred order.
Module	getModule() Module getter.
RAttributeAttributeGroup	getRAttributeAttributeGroup(Attribute attribute) Retrieves R_ATTRIBUTE_ATTRIBUTEGROUP mapping object for this group And the given attribute.
java.util.List	getRIssueTypeAttributes() List of global issuetype-attribute mappings in this group.
java.util.List	getRModuleAttributes() List of module-attribute mappings in this group.
ScarabModule	getScarabModule() Throws UnsupportedOperationException.
boolean	hasAnyOptionAttributes()
boolean	hasAttribute(Attribute attribute)
boolean	isGlobal()
void	setModule(Module me) Use this instead of setScarabModule.
void	setScarabModule(ScarabModule module) Throws UnsupportedOperationException.

Methods inherited from class org.tigris.scarab.om.BaseAttributeGroup

addRAttributeAttributeGroup, copy, copyInto, getActive, getAttributeGroupId, getByName, getByPeerName, getByPosition, getDedupe, getDescription, getFieldNames, getIssueType, getIssueType, getIssueTypeId, getModule, getModuleId, getName, getOrder, getPeer, getPrimaryKey, getQueryKey, getRAttributeAttributeGroups, getRAttributeAttributeGroups, getRAttributeAttributeGroups, getRAttributeAttributeGroups, getRAttributeAttributeGroupsJoinAttribute, getRAttributeAttributeGroupsJoinAttributeGroup, initRAttributeAttributeGroups, isCacheOnSave, save, save, save, setActive, setAttributeGroupId, setDedupe, setDescription, setIssueType, setIssueTypeId, setIssueTypeKey, setModuleId, setModuleKey, setName, setOrder, setPrimaryKey, setPrimaryKey, setQueryKey, toString

Methods inherited from class org.apache.torque.om.BaseObject

equals, equals, getLog, hashCode, isModified, isNew, resetModified, setModified, setNew, setPrimaryKey

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.apache.torque.om.Persistent

getPrimaryKey, isModified, isNew, save, save, save, setModified, setNew, setPrimaryKey, setPrimaryKey

Field Detail

GET_ATTRIBUTES

public static final java.lang.String GET_ATTRIBUTES

See Also:

Constant Field Values

Constructor Detail

AttributeGroup

public AttributeGroup()

Method Detail

isGlobal

public boolean isGlobal()
                 throws org.apache.torque.TorqueException

Throws:

org.apache.torque.TorqueException

getScarabModule

public ScarabModule getScarabModule()

Throws UnsupportedOperationException. Use getModule() instead.

Returns:

a ScarabModule value

setScarabModule

public void setScarabModule(ScarabModule module)

Throws UnsupportedOperationException. Use setModule(Module) instead.

setModule

public void setModule(Module me)
               throws org.apache.torque.TorqueException

Use this instead of setScarabModule. Note: module cannot be new.

Overrides:

setModule in class BaseAttributeGroup

Parameters:

me - Module

Throws:

org.apache.torque.TorqueException

getModule

public Module getModule()
                 throws org.apache.torque.TorqueException

Module getter. Use this method instead of getScarabModule().

Overrides:

getModule in class BaseAttributeGroup

Returns:

a Module value

Throws:

org.apache.torque.TorqueException

hasAnyOptionAttributes

public boolean hasAnyOptionAttributes()
                               throws org.apache.torque.TorqueException

Throws:

org.apache.torque.TorqueException

getAttributes

public java.util.List getAttributes()
                             throws org.apache.torque.TorqueException

List of Attributes in this group.

Throws:

org.apache.torque.TorqueException

hasAttribute

public boolean hasAttribute(Attribute attribute)
                     throws org.apache.torque.TorqueException

Parameters:

attribute - The attribute to check for the existance of in this group.

Returns:

Whether this attribute group has attribute as an attribute.

Throws:

org.apache.torque.TorqueException

getHighestOrderedAttribute

public int getHighestOrderedAttribute()
                               throws org.apache.torque.TorqueException

Retrieves the attribute in this group with the highest preferred order.

Throws:

org.apache.torque.TorqueException

getRAttributeAttributeGroup

public RAttributeAttributeGroup getRAttributeAttributeGroup(Attribute attribute)
                                                     throws org.apache.torque.TorqueException

Retrieves R_ATTRIBUTE_ATTRIBUTEGROUP mapping object for this group And the given attribute.

Throws:

org.apache.torque.TorqueException

getRModuleAttributes

public java.util.List getRModuleAttributes()
                                    throws org.apache.torque.TorqueException

List of module-attribute mappings in this group. If there are no attributes, this method returns an empty list.

Throws:

org.apache.torque.TorqueException

getRIssueTypeAttributes

public java.util.List getRIssueTypeAttributes()
                                       throws org.apache.torque.TorqueException

List of global issuetype-attribute mappings in this group. If there are no attributes in this group, then this returns an empty list.

Throws:

org.apache.torque.TorqueException

delete

public void delete()
            throws org.apache.torque.TorqueException,
                   ScarabException

Throws:

org.apache.torque.TorqueException

ScarabException

addAttribute

public void addAttribute(Attribute attribute)
                  throws org.apache.torque.TorqueException,
                         ScarabException

Throws:

org.apache.torque.TorqueException

ScarabException

deleteAttribute

public void deleteAttribute(Attribute attribute,
                            ScarabUser user,
                            Module module)
                     throws org.apache.torque.TorqueException,
                            ScarabException

Throws:

org.apache.torque.TorqueException

ScarabException

copyGroup

public AttributeGroup copyGroup()
                         throws org.apache.torque.TorqueException

Throws:

org.apache.torque.TorqueException