com.tsgrp.opencontent.core.event.events

Class AutoNumberEvent

java.lang.Object

com.tsgrp.opencontent.core.event.events.AbstractEvent

com.tsgrp.opencontent.core.event.events.AutoNumberEvent

All Implemented Interfaces:

OCEvent, OCEvent.BulkCreateObjectsEvent, OCEvent.CreateObjectEvent

public class AutoNumberEvent
extends AbstractEvent
implements OCEvent.CreateObjectEvent, OCEvent.BulkCreateObjectsEvent

Nested Class Summary

Nested classes/interfaces inherited from interface com.tsgrp.opencontent.core.event.OCEvent

OCEvent.BulkCreateObjectsEvent, OCEvent.CreateObjectEvent, OCEvent.DeleteObjectEvent, OCEvent.UpdateObjectEvent

Field Summary

Fields inherited from class com.tsgrp.opencontent.core.event.events.AbstractEvent

ocPolicyComponent

Constructor Summary

Constructors

Constructor and Description
AutoNumberEvent()

Method Summary

Modifier and Type	Method and Description
OpenContentObject	doAutoNumQuery(java.lang.String ticket) Do an OCQuery for the auto_number objects.
java.lang.String	doPropertyLookup(java.util.List<PicklistItem> picklist, java.lang.String token, java.lang.String currTokenVal) Replaces the token value with the mapped value of the given item.
java.lang.String	getAutoNumberFormat()
java.lang.String	getAutoNumberType()
java.util.Map<java.lang.String,java.lang.String>	getQueryProperties()
java.lang.String	getSeparator() Parses the separator String out of the found autoNumberFormat.
java.lang.String[]	getTokens() Parses the tokens Strings out of the found autoNumberFormat.
void	init()
void	onBulkCreateObjects(java.util.List<ContentResult> crs, java.lang.String ticket, java.util.HashMap<java.lang.String,java.lang.Object> additionalEventParams)
void	onCreateObject(ContentResult cr, java.lang.String ticket, java.util.HashMap<java.lang.String,java.lang.Object> additionalEventParams)
java.lang.String[]	replaceTokenVals(java.lang.String[] tokens, java.lang.String ticket, OpenContentObject newFileOCO) Replaces the token values found in autoNumberFormat with the auto_number property value or values from the new file's properties.
java.lang.String	replaceTokenWithAutoNumVal(java.lang.String token, java.lang.String ticket, OpenContentObject queryResult) If the token is "auto_number", get the value of the auto_number object's "number" property.
java.lang.String	replaceTokenWithPropertyVal(java.lang.String token, java.lang.String ticket, java.util.Map<java.lang.String,java.lang.Object> newFileOCOProps, OpenContentObject newFileOCO) If the token String is a property found on the new file's OCO, fetch the value of that property, do a lookup to see if it has a corresponding value in the given picklist, and replace the token value if so.
void	setAutoNumberFormat(java.lang.String autoNumberFormat)
void	setAutoNumberType(java.lang.String autoNumberType)
void	setQueryProperties(java.util.Map<java.lang.String,java.lang.String> queryProperties)
void	updateAttrVal(java.lang.String[] tokens, java.lang.String separator, OpenContentObject newFileOCO, java.lang.String ticket, ContentResult cr) Saves the final concatenated autoNumberFormat given attribute's value.

Methods inherited from class com.tsgrp.opencontent.core.event.events.AbstractEvent

getEnabled, getEventFilters, getEventType, getOcPolicyComponent, getPriority, setEnabled, setEventFilters, setEventType, setOcPolicyComponent, setPriority

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.tsgrp.opencontent.core.event.OCEvent

getEnabled, getEventFilters, getEventType, getPriority, setEnabled, setEventFilters, setEventType, setPriority

Constructor Detail

AutoNumberEvent

public AutoNumberEvent()

Method Detail

init

public void init()

Specified by:

init in interface OCEvent

getAutoNumberType

public java.lang.String getAutoNumberType()

setAutoNumberType

public void setAutoNumberType(java.lang.String autoNumberType)

getAutoNumberFormat

public java.lang.String getAutoNumberFormat()

setAutoNumberFormat

public void setAutoNumberFormat(java.lang.String autoNumberFormat)

getQueryProperties

public java.util.Map<java.lang.String,java.lang.String> getQueryProperties()

setQueryProperties

public void setQueryProperties(java.util.Map<java.lang.String,java.lang.String> queryProperties)

onCreateObject

public void onCreateObject(ContentResult cr,
                           java.lang.String ticket,
                           java.util.HashMap<java.lang.String,java.lang.Object> additionalEventParams)

Specified by:

onCreateObject in interface OCEvent.CreateObjectEvent

onBulkCreateObjects

public void onBulkCreateObjects(java.util.List<ContentResult> crs,
                                java.lang.String ticket,
                                java.util.HashMap<java.lang.String,java.lang.Object> additionalEventParams)

Specified by:

onBulkCreateObjects in interface OCEvent.BulkCreateObjectsEvent

replaceTokenVals

public java.lang.String[] replaceTokenVals(java.lang.String[] tokens,
                                           java.lang.String ticket,
                                           OpenContentObject newFileOCO)

Replaces the token values found in autoNumberFormat with the auto_number property value or values from the new file's properties. Synchronized to make sure all new files get a unique #.

Parameters:

tokens - - A String array of all the tokens.

ticket - - A valid OC ticket.

newFileOCO - - The OCO of the new file being created.

Returns:

getTokens

public java.lang.String[] getTokens()

Parses the tokens Strings out of the found autoNumberFormat.

Parameters:

autoNumberFormatFound - - The value of the autoNumberFormat property found in the bean defined in project-bean-config.xml.

Returns:

tokens - A String array of all of the tokens.

getSeparator

public java.lang.String getSeparator()

Parses the separator String out of the found autoNumberFormat. The separator is the string found b/w each token String, and they should all be the same.

Parameters:

autoNumberFormatFound - - The value of the autoNumberFormat property found in the bean defined in project-bean-config.xml.

Returns:

tokens - A String array of all of the tokens.

doPropertyLookup

public java.lang.String doPropertyLookup(java.util.List<PicklistItem> picklist,
                                         java.lang.String token,
                                         java.lang.String currTokenVal)

Replaces the token value with the mapped value of the given item.

Parameters:

picklist - - The picklist we want to get values from.

token - - The current token.

currTokenVal - - The new file's value of the property.

Returns:

replaceTokenWithPropertyVal

public java.lang.String replaceTokenWithPropertyVal(java.lang.String token,
                                                    java.lang.String ticket,
                                                    java.util.Map<java.lang.String,java.lang.Object> newFileOCOProps,
                                                    OpenContentObject newFileOCO)

If the token String is a property found on the new file's OCO, fetch the value of that property, do a lookup to see if it has a corresponding value in the given picklist, and replace the token value if so.

Parameters:

token - - The current token.

newFileOCO - - The OCO of the new file being created.

newFileOCOProps - - The properties of the new file being created.

ticket - - A valid OC ticket.

Returns:

doAutoNumQuery

public OpenContentObject doAutoNumQuery(java.lang.String ticket)

Do an OCQuery for the auto_number objects. Return the auto_number object we want based on what's wired up in project-bean-config.xml.

Parameters:

ticket - - A valid OC ticket.

Returns:

query.getResults().get(0) - The auto_number object found in the OC query's results.

replaceTokenWithAutoNumVal

public java.lang.String replaceTokenWithAutoNumVal(java.lang.String token,
                                                   java.lang.String ticket,
                                                   OpenContentObject queryResult)

If the token is "auto_number", get the value of the auto_number object's "number" property. Replaces the token value with the number value and update the number value w/ the currAutoNum.

Parameters:

queryResult - - The auto_number object found in the OC query's results.

token - - The current token.

ticket - - A valid OC ticket.

Returns:

updateAttrVal

public void updateAttrVal(java.lang.String[] tokens,
                          java.lang.String separator,
                          OpenContentObject newFileOCO,
                          java.lang.String ticket,
                          ContentResult cr)

Saves the final concatenated autoNumberFormat given attribute's value.

Parameters:

tokens - - The updated list of tokens w/ values replaced as necessary [for OCO properties and auto_number].

separator - - The String that will separate the tokens.

newFileOCO - - The new file to be created's OCO.

ticket - - A valid OC ticket.

cr - - The ContentResult of the new file to be created.