Include related conditions in your asset purge function if you need to determine whether to delete a repository item based on information that is not stored in the properties of the item itself. See Related Conditions and Actions.

To configure a related condition component:

Property Configuration for Related Condition Components

Include the properties described in the following table for a related condition component:

The following example configuration file sets the property values for a related condition component.

$class=atg.purge.condition.SimpleRelatedCondition

# A user-interface label that describes the related condition
defaultName=Skip if there are more than $X member orders

# The key for the parameter associated with this condition in the
# Map of parameters for the PurgeItem
parameterName=maxorders
# The value for the parameter in the Map of parameters
parameterValue=2

# Determines whether the end user can alter the parameter value
editable=true

# Determines whether the related condition is selected by default
enabled=true

Overriding the canPurge Method

The basic components of the asset purge development framework include a pipeline processor that controls whether each selected repository item is deleted or skipped. By default, this component is based on the atg.purge.pipeline.processor.CanPurgeProcessor class and it deletes all of the items that it handles. See information about the default processor component in CanPurgeProcessor Component.

The CanPurgeProcessor class includes a canPurge method that returns a Boolean value. If you include a related condition in your asset purge function, create a subclass of CanPurgeProcessor and override its canPurge method. Include the logic that determines whether an item is deleted or skipped in this method.

The following example shows a Java class that overrides the canPurge method. It uses two properties to hold Nucleus paths:

These two properties are only used in this example. They are not directly related to overriding the canPurge method.

package mycompany;
import java.util.ArrayList;
import java.util.Set;
import atg.commerce.order.OrderQueries;
import atg.purge.PurgeItem;
import atg.purge.pipeline.processor.CanPurgeProcessor;
import atg.repository.Repository;
import atg.repository.RepositoryItem;

public class MyNewCanPurgeProcessor extends CanPurgeProcessor {

  // The repository and orderQueries properties are used in
  // the example code shown here and are not directly related
  // to overriding the canPurge method.
  // Set the repository from the configuration file.

  Repository mRepository;
  public void setRepository(Repository pRepository)
  {mRepository = pRepository;}
  public Repository getRepository()
  {return mRepository;}
  // Set the OrderQueries path from the configuration file.
  OrderQueries mOrderQueries;
  public void setOrderQueries(OrderQueries pOrderQueries)
  {mOrderQueries = pOrderQueries;}
  public OrderQueries getOrderQueries()
  {return mOrderQueries;}

  // Override the canPurge method with logic based on your related conditions.
  @Override
  protected boolean canPurge(PurgeItem pPurgeItem) throws Exception {
    // Get the repository item that is currently being handled.
    RepositoryItem organization = getRepository().getItem(pPurgeItem.getId(),
      pPurgeItem.getItemType());

    // For example, you could determine how many orders are associated with the
    // users in this organization.

    int ordersforthisorg = 0;
    // Get the user profiles from the members property of the organization.
    Set memberset = (Set) organization.getPropertyValue("members");
    ArrayList<RepositoryItem> members = new ArrayList<RepositoryItem>(memberset);
    for (RepositoryItem member : members) {
      // get the number of orders associated with the profile
      int memberorders =
        getOrderqueries().getOrderCountForProfile(member.getRepositoryId());
      // and add it to the total orders for the organization
      ordersforthisorg = ordersforthisorg + memberorders;
    }

    // This example compares the maximum number of orders from the related
    // condition to the number of orders for the members of the organization.
    // Return true (delete) or false (skip) based on what you find.
    // If the parameter is not present in the PurgeItem, return true.
    // If the user does not select this related condition, the parameter
    // will not be present.

    // Get the maximum number of orders from the PurgeItem parameter with
    // the key "maxorders."
    int maxordersfromassociatedcondition = Integer.parseInt((String)
      pPurgeItem.getParameters().get("maxorders"));
    // Compare the numbers.
    if (pPurgeItem.getParameters().get("maxorders") != null &&
      ordersforthisorg > maxordersfromassociatedcondition) {
      // Do not delete the organization.
      return false;
    } else {
      // Delete the organization.
      return true;
    }
  }
}