atg.markers.userprofiling
Class ProfileHasMarker

java.lang.Object
  atg.process.filter.Filter
      atg.process.filter.ExpressionFilter
          atg.markers.scenario.MarkerExpressionFilter
              atg.markers.scenario.ItemHasMarker
                  atg.markers.userprofiling.ProfileHasMarker

All Implemented Interfaces:

MarkerConstants

public class ProfileHasMarker
extends ItemHasMarker

The scenario hasMarker expression class for profiles This expression class returns the profile repository item in method getItemToUse.

This class was created for the following expression operator names, but could be extended for other operators. Additional operator names must be added to the configuration component's hasMarkerOperatorMap

See Also:

Operator names:
profileHasMarker
profileHasLastMarker
profileHasLastMarkerWithKey


Field Summary

static java.lang.String	CLASS_VERSION Class version string
static java.lang.String	PROFILE_HAS_LASTMARKER Scenario profileHasLastMarker condition name
static java.lang.String	PROFILE_HAS_LASTMARKER_WITHKEY Scenario profileHasLastMarkerWithKey condition name
static java.lang.String	PROFILE_HAS_MARKER Scenario profileHasMarker condition name

Fields inherited from class atg.markers.scenario.ItemHasMarker

OP_HAS_LASTMARKER, OP_HAS_LASTMARKER_WITHKEY, OP_HAS_MARKER

Fields inherited from class atg.markers.scenario.MarkerExpressionFilter

mMarkerConfiguration

Fields inherited from class atg.process.filter.Filter

FALSE, TRUE

Fields inherited from interface atg.markers.MarkerConstants

ALLOW_DUPLICATES, ANY_VALUE, DEFAULT_MARKER_ID_PROPERTY_NAME, DEFAULT_MARKER_ITEM_TYPE, DEFAULT_MARKER_PROPERTY_NAME, DEFAULT_MARKER_SORT_PROPERTY_NAME, MARKER_CREATIONDATE_PROPERTY_NAME, MARKER_DATA_PROPERTY_NAME, MARKER_DUPLICATIONMODE_PROPERTY_NAME, MARKER_KEY_PROPERTY_NAME, MARKER_OWNER_PROPERTY_NAME, MARKER_RESOURCE_NAME, MARKER_VALUE_PROPERTY_NAME, NO_DUPLICATES, PARAM_DATA, PARAM_DUPMODE, PARAM_EXTENDED_PROPERTIES, PARAM_ITEM, PARAM_ITEM_ID, PARAM_KEY, PARAM_MARKED_ITEM_TYPE, PARAM_MARKER_ITEM_TYPE, PARAM_MARKER_MANAGER, PARAM_MARKER_PROPERTY_NAME, PARAM_VALUE, REPLACE_DUPLICATES, sResourceBundle

Constructor Summary

ProfileHasMarker()

Method Summary

protected Query	createMarkerQuery() Creates a marker query object that qualifies markers based on the filter's requirements.
Query	createProcessInstanceQuery(QueryBuilder pSubjectQueryBuilder, QueryBuilder pProcessInstanceQueryBuilder) Creates a process instance query that qualifies the instances by the subject with a marker that matches the filter's requirements
Query	createSubjectQuery(QueryBuilder pSubjectQueryBuilder) Creates a subject query that qualifies the subjects with a marker that matches the filter's requirements.
protected RepositoryItem	getItemToUse(ProcessExecutionContext pContext) This method is called by the evaluate method to provide the RepositoryItem that's used in the hasMarker API calls.

Methods inherited from class atg.markers.scenario.ItemHasMarker

evaluate, getHasMarkerOperatorToPerform, initialize

Methods inherited from class atg.markers.scenario.MarkerExpressionFilter

configure, getData, getDuplicationMode, getExtendedProperties, getKey, getMarkedItemType, getMarkerConfiguration, getMarkerItemType, getMarkerPropertyName, getRepositoryMarkerManager, getValue, setMarkerConfiguration

Methods inherited from class atg.process.filter.ExpressionFilter

equals, getOperands, getOperator, operandsEquals, setOperands, setOperator, toString

Methods inherited from class atg.process.filter.Filter

andFilters, andFilters, assumeFalse, assumeTrue, getResourceBundle, getSubjectType, hashCode, implies, isCacheable, negate, orFilters, orFilters, setCacheable, test

Methods inherited from class java.lang.Object

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

Field Detail

CLASS_VERSION

public static java.lang.String CLASS_VERSION

Class version string

PROFILE_HAS_MARKER

public static final java.lang.String PROFILE_HAS_MARKER

Scenario profileHasMarker condition name

See Also:

Constant Field Values

PROFILE_HAS_LASTMARKER

public static final java.lang.String PROFILE_HAS_LASTMARKER

Scenario profileHasLastMarker condition name

See Also:

Constant Field Values

PROFILE_HAS_LASTMARKER_WITHKEY

public static final java.lang.String PROFILE_HAS_LASTMARKER_WITHKEY

Scenario profileHasLastMarkerWithKey condition name

See Also:

Constant Field Values

Constructor Detail

ProfileHasMarker

public ProfileHasMarker()

Method Detail

createMarkerQuery

protected Query createMarkerQuery()
                           throws RepositoryException,
                                  ProcessException

Creates a marker query object that qualifies markers based on the filter's requirements.

Throws:

RepositoryException

ProcessException

createProcessInstanceQuery

public Query createProcessInstanceQuery(QueryBuilder pSubjectQueryBuilder,
                                        QueryBuilder pProcessInstanceQueryBuilder)
                                 throws RepositoryException,
                                        ProcessException

Creates a process instance query that qualifies the instances by the subject with a marker that matches the filter's requirements

Overrides:

createProcessInstanceQuery in class Filter

Throws:

RepositoryException - if there is a repository problem constructing the query

ProcessException - if there is any other problem creating the query

createSubjectQuery

public Query createSubjectQuery(QueryBuilder pSubjectQueryBuilder)
                         throws RepositoryException,
                                ProcessException

Creates a subject query that qualifies the subjects with a marker that matches the filter's requirements.

Overrides:

createSubjectQuery in class Filter

Throws:

RepositoryException - if there is a repository problem constructing the query

ProcessException - if there is any other problem creating the query

getItemToUse

protected RepositoryItem getItemToUse(ProcessExecutionContext pContext)

This method is called by the evaluate method to provide the RepositoryItem that's used in the hasMarker API calls.

Specified by:

getItemToUse in class ItemHasMarker

Parameters:

pContext - the scenario execution context

Returns:

RepositoryItem the repository item that contains the markers