public class RecommendMembershipAction extends RecommendAction
Modifier and Type | Field and Description |
---|---|
static String |
DEFAULT_ACTIONSPECIFICATION_NAME
The name of the default ActionSpecification for this type of action.
|
static AuditEventTypeDefinition |
EVENTTYPE_COMMUNITYMEMBER_RECOMMENDATION_ADDED
The AuditEventTypeDefinition for the COMMUNITYMEMBER_RECOMMENDATION_ADDED action.
|
static AuditEventTypeDefinition |
EVENTTYPE_COMMUNITYMEMBER_RECOMMENDATION_REMOVED
The AuditEventTypeDefinition for the COMMUNITYMEMBER_RECOMMENDATION_REMOVED action.
|
EVENTTYPE_RECOMMENDATION_ADDED, EVENTTYPE_RECOMMENDATION_REMOVED
Constructor and Description |
---|
RecommendMembershipAction()
Constructs a RecommendMembershipAction to be used as an ActionFactory.
|
RecommendMembershipAction(ActionFactory factory)
Constructs a "pending" RecommendMembershipAction, to be used to execute a
new Action.
|
RecommendMembershipAction(ActionFactory factory,
AuditEvent event)
Constructs an "executed" RecommendMembershipAction, reflecting a
previously executed Action.
|
Modifier and Type | Method and Description |
---|---|
void |
addRecommendation(Actor actor,
String comment)
Adds a recommendation, prior to execution.
|
Action |
constructExecutedAction(AuditEvent event)
Construct an instance reflecting a previously executed Action.
|
Action |
constructPendingAction()
Construct an instance of an Action that is not yet executed.
|
AuditEventTypeDefinition |
getAuditEventTypeDefinitionForAdd()
Gets the AuditEventTypeDefinition that should be used when executing a
"recommendation added" action.
|
AuditEventTypeDefinition |
getAuditEventTypeDefinitionForRemove()
Gets the AuditEventTypeDefinition that should be used when executing a
"recommendation removed" action.
|
AuditEventTypeDefinition[] |
getAuditEventTypeDefinitions()
Gets the set of AuditEventTypeDefinitions for events
that can be posted by this Action associated with this type of Action.
|
String |
getComment()
Gets the comment.
|
AttributeValue[] |
getEventProperties()
Gets any event properties to post with the AuditEvents.
|
addRecommendation, clearAllSettings, execute, getRecommendedActor, isRecommendationAdded, isRecommendationRemoved, removeRecommendation
calculateOperationType, dispatchEvent, dispatchEvent, dispatchEvent, dispatchEvent, execute, execute, getActionSpecification, getActionSpecificationId, getActivityRecord, getActor, getAuditEventId, getAuditOperationType, getAuditOperationTypeKey, getAuxiliaryObjects, getAuxiliaryString, getExecutingUserId, getExecutionDate, getFirstAuxiliaryObject, getInstance, getInstance, getPerformedActivityRecord, getProperties, getPropertyTable, getSecondAuxiliaryObject, getSession, getTrackedActivityRecord, isActivityRecordFreed, isActivityRecordUndiscoverable, isActorFreed, isActorUndiscoverable, isFactory, isPendingExecution, isPreviouslyExecuted, postExecute, preExecute, setExecutingActionType
constructActivityEventTypeDefinition, initialize, isInitialized
public static final String DEFAULT_ACTIONSPECIFICATION_NAME
public static final AuditEventTypeDefinition EVENTTYPE_COMMUNITYMEMBER_RECOMMENDATION_ADDED
public static final AuditEventTypeDefinition EVENTTYPE_COMMUNITYMEMBER_RECOMMENDATION_REMOVED
public RecommendMembershipAction()
Called from ActionSpecification when initializing the ActionFactory to use for that specific ActionSpecification.
public RecommendMembershipAction(ActionFactory factory) throws IfsException
factory
- the ActionFactory used to construct this instanceIfsException
- if operation failspublic RecommendMembershipAction(ActionFactory factory, AuditEvent event) throws IfsException
factory
- the ActionFactory used to construct this instanceevent
- The event that was posted as part of the
previously executed Action.IfsException
- if operation failspublic Action constructPendingAction() throws IfsException
constructPendingAction
in class RecommendAction
IfsException
- if the operation fails.public Action constructExecutedAction(AuditEvent event) throws IfsException
constructExecutedAction
in class RecommendAction
event
- The event that was posted as part of the
previously executed Action.IfsException
- if the operation fails.public void addRecommendation(Actor actor, String comment) throws IfsException
actor
- the recommended Actorcomment
- the comment that should accompany the recommendationIfsException
- if operation failspublic String getComment() throws IfsException
IfsException
- if operation failspublic AuditEventTypeDefinition[] getAuditEventTypeDefinitions()
getAuditEventTypeDefinitions
in class RecommendAction
public AuditEventTypeDefinition getAuditEventTypeDefinitionForAdd()
getAuditEventTypeDefinitionForAdd
in class RecommendAction
public AuditEventTypeDefinition getAuditEventTypeDefinitionForRemove()
getAuditEventTypeDefinitionForRemove
in class RecommendAction
public AttributeValue[] getEventProperties() throws IfsException
getEventProperties
in class RecommendAction
IfsException
Copyright © 2023. All rights reserved.