org.tigris.scarab.da
Class AttributeAccess

java.lang.Object
  org.tigris.scarab.da.AttributeAccess

public class AttributeAccess

extends java.lang.Object

Access to data relating to attributes.

Since:

Scarab 0.17

Author:

John McNally, Daniel Rall

See Also:

AttributeAccess

Constructor Summary

AttributeAccess()
Constructor used by DAFactory.

Method Summary

void	deleteQueryColumnIDs(java.lang.String userID, java.lang.String listID, java.lang.String moduleID, java.lang.String artifactTypeID) Deletes the persisted choice of issue list display columns for the given user and artifact type(s).
java.util.Collection	retrieveActiveAttributeOMs(java.lang.String moduleID, java.lang.String artifactTypeID, boolean isOrdered) Torque Attributes which are active within the given module for the given issue type and whose attribute group's are also active.
java.lang.String	retrieveDefaultTextAttributeID(java.lang.String moduleID, java.lang.String artifactTypeID) Retrieves the attribute ID which is active and marked as the default text attribute within the given module for the given issue type and whose attribute group is also active.
java.lang.String	retrieveFirstActiveTextAttributeID(java.lang.String moduleID, java.lang.String artifactTypeID) Retrieves the attribute ID which is active and is the first id returned when results are ordered based on numerical preferred order and/or alphabetical by name within the given module for the given issue type and whose attribute group is also active.
java.util.List	retrieveQueryColumnIDs(java.lang.String userID, java.lang.String listID, java.lang.String moduleID, java.lang.String artifactTypeID) Retrieves a list of attribute identifiers for use in determining which columns to display for a user's query results.
java.util.Set	retrieveQuickSearchAttributeIDs(java.lang.String moduleID, java.lang.String artifactTypeID) Set of attributeIDs which are active and marked for custom search within the given module for the given issue type and whose attribute group's are also active.
java.util.Set	retrieveRequiredAttributeIDs(java.lang.String moduleID, java.lang.String artifactTypeID) Set of attributeIDs which are active and required within the given module for the given issue type and whose attribute group's are also active.

Methods inherited from class java.lang.Object

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

Constructor Detail

AttributeAccess

public AttributeAccess()

Constructor used by DAFactory.

Method Detail

retrieveQueryColumnIDs

public java.util.List retrieveQueryColumnIDs(java.lang.String userID,
                                             java.lang.String listID,
                                             java.lang.String moduleID,
                                             java.lang.String artifactTypeID)
                                      throws DAException

Retrieves a list of attribute identifiers for use in determining which columns to display for a user's query results.

Parameters:

userID - The associated user (must be non-null).

listID - The associated artifact type list (can be null).

moduleID - The associated module (ignored if null).

artifactTypeID - The associated artifact type (ignored if null).

Returns:

A list of attribute identifiers.

Throws:

DAException - If any problems are encountered.

deleteQueryColumnIDs

public void deleteQueryColumnIDs(java.lang.String userID,
                                 java.lang.String listID,
                                 java.lang.String moduleID,
                                 java.lang.String artifactTypeID)
                          throws DAException

Deletes the persisted choice of issue list display columns for the given user and artifact type(s).

Parameters:

userID - The associated user (must be non-null).

listID - The associated artifact type list (can be null).

moduleID - The associated module (ignored if null).

artifactTypeID - The associated artifact type (ignored if null).

Throws:

DAException - If any problems are encountered.

retrieveRequiredAttributeIDs

public java.util.Set retrieveRequiredAttributeIDs(java.lang.String moduleID,
                                                  java.lang.String artifactTypeID)
                                           throws DAException

Set of attributeIDs which are active and required within the given module for the given issue type and whose attribute group's are also active.

Parameters:

moduleID - The associated module (must be non-null).

artifactTypeID - The associated artifact type (must be non-null).

Returns:

an String of String attribute ids

Throws:

DAException

retrieveQuickSearchAttributeIDs

public java.util.Set retrieveQuickSearchAttributeIDs(java.lang.String moduleID,
                                                     java.lang.String artifactTypeID)
                                              throws DAException

Set of attributeIDs which are active and marked for custom search within the given module for the given issue type and whose attribute group's are also active.

Parameters:

moduleID - The associated module (must be non-null).

artifactTypeID - The associated artifact type (must be non-null).

Returns:

an Set of String attribute ids

Throws:

DAException

retrieveActiveAttributeOMs

public java.util.Collection retrieveActiveAttributeOMs(java.lang.String moduleID,
                                                       java.lang.String artifactTypeID,
                                                       boolean isOrdered)
                                                throws DAException

Torque Attributes which are active within the given module for the given issue type and whose attribute group's are also active.

Parameters:

moduleID - The associated module (must be non-null).

artifactTypeID - The associated artifact type (must be non-null).

isOrdered - indication whether an iterator over the Attributes should return them in their natural order.

Returns:

an Collection of torque Attribute objects. The collection will be a List if isOrdered is true, otherwise a Set is returned.

Throws:

DAException

retrieveDefaultTextAttributeID

public java.lang.String retrieveDefaultTextAttributeID(java.lang.String moduleID,
                                                       java.lang.String artifactTypeID)
                                                throws DAException

Retrieves the attribute ID which is active and marked as the default text attribute within the given module for the given issue type and whose attribute group is also active.

Parameters:

moduleID - The associated module (must be non-null).

artifactTypeID - The associated artifact type (must be non-null).

Returns:

an String attribute ID

Throws:

DAException

retrieveFirstActiveTextAttributeID

public java.lang.String retrieveFirstActiveTextAttributeID(java.lang.String moduleID,
                                                           java.lang.String artifactTypeID)
                                                    throws DAException

Retrieves the attribute ID which is active and is the first id returned when results are ordered based on numerical preferred order and/or alphabetical by name within the given module for the given issue type and whose attribute group is also active.

Parameters:

moduleID - The associated module (must be non-null).

artifactTypeID - The associated artifact type (must be non-null).

Returns:

An String attribute ID.

Throws:

DAException