Serialized Form (stumps 1.0-SNAPSHOT API)

Package com.neurosys.amorphous.domain
- Class com.neurosys.amorphous.domain.GenericObject extends HierarchialDomainObject implements Serializable
 
 serialVersionUID:
 
 660922258818765734L
 - Serialized Fields
 - id
```
Long id
```
 - name
```
String name
```
 - type
```
String type
```
 Categorization by type
 - displayName
```
String displayName
```
 - bitmask
```
Integer bitmask
```
 - properties
```
String properties
```
 JSON String
 - children
```
List<E> children
```
 Ordered list of Children
 - value
```
String value
```
 Its own Content
 - created
```
Date created
```
 - modified
```
Date modified
```
 - tags
```
String tags
```
 Comma separated list of tags
 - references
```
Set<E> references
```
 References this Object has.
- Class com.neurosys.amorphous.domain.Response extends ResultRow<T> implements Serializable
 
 serialVersionUID:
 
 6901992021271928290L
 - Serialized Fields
 - status
```
boolean status
```
- Class com.neurosys.amorphous.domain.ResultRow extends DomainObject implements Serializable
 
 serialVersionUID:
 
 6901992021271928290L
 - Serialized Fields
 - refId
```
String refId
```
 - value
```
Object value
```
Package com.neurosys.aws.sns.push.domain
- Class com.neurosys.aws.sns.push.domain.PlatformMessageDeliveryAttributes extends ModelObject implements Serializable
 - Serialized Fields
 - successFeedbackRoleArn
```
String successFeedbackRoleArn
```
 Stores the IAM Role which would receive Feedback in case of a successful Message Delivery
 - failureFeedbackRoleArn
```
String failureFeedbackRoleArn
```
 Stores the IAM Role which would receive Feedback in case of a failed Message Delivery
 - successFeedbackSampleRate
```
String successFeedbackSampleRate
```
 Stores the percentage of successful SMS deliveries for which Amazon SNS will write logs in CloudWatch Logs. If value = 0, writes logs only for failed deliveries If value = 10, writes logs for 10% of your successful deliveries If value not specified , writes logs for all successful deliveries
 - arn
```
String arn
```
 ARN of the Platform for which the Attributes will be set
 - snsClient
```
com.amazonaws.services.sns.AmazonSNS snsClient
```
 Client for accessing Amazon SNS. All service calls made using this client are blocking, and will not return until the service call completes.
 
 See Also:
 
 Amazon SNS Client
- Class com.neurosys.aws.sns.push.domain.PushNotificationMessage extends DisposableMessage<String,String> implements Serializable
Package com.neurosys.aws.sns.sms.domain
- Class com.neurosys.aws.sns.sms.domain.AmazonMessageSettings extends ModelObject implements Serializable
 - Serialized Fields
 - regions
```
com.amazonaws.regions.Regions regions
```
 Enumeration of region names
 
 See Also:
 
 Amazon SNS Client
 - type
```
String type
```
 The type of message to be sent
 Used String datatype inspite of having only 2 possible values since AWS supports only the following datatypes : String, Number and Binary
 
 See Also:
 
 Message Details
 
 Default value:
 
 Promotional
 - monthlySpendLimit
```
String monthlySpendLimit
```
 The maximum amount in USD that you are willing to spend to send the SMS message. Amazon SNS will not send the message if it determines that doing so would incur a cost that exceeds the maximum price.
 
 See Also:
 
 Message Details
 - senderId
```
String senderId
```
 A custom ID that contains up to 11 alphanumeric characters, including at least one letter and no spaces. The sender ID is displayed as the message sender on the receiving device.
 
 See Also:
 
 Message Details, Sender Id support
- Class com.neurosys.aws.sns.sms.domain.AsynchronousSMS extends SMS implements Serializable
 - Serialized Fields
 - consumer
```
Consumer<T> consumer
```
- Class com.neurosys.aws.sns.sms.domain.MessageDeliveryAttributes extends ModelObject implements Serializable
 - Serialized Fields
 - successFeedbackRoleArn
```
String successFeedbackRoleArn
```
 Stores the IAM Role which would receive Feedback in case of a successful Message Delivery
 - failureFeedbackRoleArn
```
String failureFeedbackRoleArn
```
 Stores the IAM Role which would receive Feedback in case of a failed Message Delivery
 - successFeedbackSampleRate
```
String successFeedbackSampleRate
```
 Stores the percentage of successful SMS deliveries for which Amazon SNS will write logs in CloudWatch Logs. If value = 0, writes logs only for failed deliveries If value = 10, writes logs for 10% of your successful deliveries If value not specified , writes logs for all successful deliveries
 - arn
```
String arn
```
 ARN of the Topic or Platform for which the Attributes will be set
 - snsClient
```
com.amazonaws.services.sns.AmazonSNSClient snsClient
```
 Client for accessing Amazon SNS. All service calls made using this client are blocking, and will not return until the service call completes.
 
 See Also:
 
 Amazon SNS Client
- Class com.neurosys.aws.sns.sms.domain.SMS extends SMS implements Serializable
 - Serialized Fields
 - settings
```
AmazonMessageSettings settings
```
Package com.neurosys.bi.reporting
- Class com.neurosys.bi.reporting.AbstractProcessBasedReporter extends BaseIterativeProcessor<TUPLE_IN,RECORD_OUT,STATE> implements Serializable
 
 serialVersionUID:
 
 1L
 - Serialized Fields
 - columnNames
```
List<E> columnNames
```
 Display names of the Columns in the report for each field in T
- Class com.neurosys.bi.reporting.AbstractReporter extends Object implements Serializable
 
 serialVersionUID:
 
 1L
 - Serialized Fields
 - params
```
Object[] params
```
 Deprecated. use real arguments instead where possible. Only provided if we want to pre-configure some params or test
 
 Context supplied param
 - columnNames
```
List<E> columnNames
```
 Display names of the Columns in the report for each field in T
- Class com.neurosys.bi.reporting.AuthorizableReporterMeta extends ReporterMeta<PARAM_META> implements Serializable
 
 serialVersionUID:
 
 1L
 - Serialized Fields
 - authorizations
```
Collection<E> authorizations
```
 Authorizations that can access this item
 - authorizableId
```
String authorizableId
```
 - authorizableIdAssignable
```
Boolean authorizableIdAssignable
```
- Class com.neurosys.bi.reporting.DataSourceReporter extends AbstractReporter<T> implements Serializable
 
 serialVersionUID:
 
 1L
 - Serialized Fields
 - reporterMeta
```
ReporterMeta<PARAM_META> reporterMeta
```
 Reference to ReporterMeta
 Can be used to refer to original details about various columns in the Report.
 
 Can be null:
 
 true
 - dataGenerator
```
org.apache.commons.collections.Transformer dataGenerator
```
 Generate the Source tuples from the Data Source; the Transformer should return a List of objects (see JPAQueryTransformer)
 
 Can be null:
 
 false
 - countQuery
```
org.apache.commons.collections.Transformer countQuery
```
 Run a count query for the DataSourceReporter.dataGenerator
 
 Can be null:
 
 true; will use the DataSourceReporter.dataGenerator to count if null
 - noParamsDataGenerator
```
org.apache.commons.collections.Transformer noParamsDataGenerator
```
 An optional no param based data generator. This is used to produce a default report; for reports that requires filters but on first load still want to show results.
 - noParamsCountQuery
```
org.apache.commons.collections.Transformer noParamsCountQuery
```
 A DataSourceReporter.countQuery for DataSourceReporter.noParamsDataGenerator
- Class com.neurosys.bi.reporting.ExportMeta extends Object implements Serializable
 
 serialVersionUID:
 
 1L
 - Serialized Fields
 - columnNames
```
List<E> columnNames
```
 The Exporter may change the original columns, or names etc. If not null then this would be used. If null then Reporter.getColumnNames() is default One can define additional and different column names for an export process.
 - reportWriter
```
ReportWriter reportWriter
```
 The actual Writer that will write the report
 
 Can be null:
 
 true (Will assume a App defined default ReportWriter
 - reportWriterProperties
```
Map<K,V> reportWriterProperties
```
 If a reportWriter is not defined then a default writer can be instantiated and these properties to customize settings for the report
 
 Can be null:
 
 true
- Class com.neurosys.bi.reporting.ExportType extends Object implements Serializable
 
 serialVersionUID:
 
 1L
 - Serialized Fields
 - name
```
String name
```
 This type will be referred to by this Name; should be unique
 - extension
```
String extension
```
 The export type is associated with the file extension
 - mimeTypeString
```
String mimeTypeString
```
 For export, the accurate MIME description needs to be passed in Headers for the client to verify he type of resource being exported
- Class com.neurosys.bi.reporting.ReporterMeta extends Object implements Serializable
 
 serialVersionUID:
 
 1L
 - Serialized Fields
 - displayName
```
String displayName
```
 Display Name corresponding to the Reporter
 - id
```
String id
```
 Handle to this ReporterMeta
 - recordType
```
Class<T> recordType
```
 What is the nature of the records returned. This can be useful when the core entities have to be used for some activity and the type is not knowns before the results are obtained.
 
 Can be null:
 
 true - if we don't care to do much with the generated reported results except display them or only care to use the records after they are derived from the Reporter
 - exportableFormats
```
Map<K,V> exportableFormats
```
 The export process may require some additional information supplied by ExportMeta
 
 Map of Key is ExportType and Value of type ExportMeta
 
 Can be null:
 
 true - Dont know / Dont care
 - bulkActions
```
List<E> bulkActions
```
 Any Bulk actions to perform on the Report
 - columnToEntityValueMapping
```
Map<K,V> columnToEntityValueMapping
```
 Each column position (starting @ 0) could be mapped to the entity name or a Transformer(entity) or even a FacetMeta to tell the presentation layer which Column maps to which field / value(output from the Transformer, in case on complex relations)
 - attributes
```
Map<K,V> attributes
```
 For each Column displayName in the Reporter define any specific attributes for presentation
 Key is fieldName/Column Index and value could be a String, Transformer,PARAM_META type
 
 Can be null:
 
 true
 - rowDecorators
```
List<E> rowDecorators
```
 A Row Decorator mentions the fieldName(s)/Column(s) whose value will be used to change the state of the row, like highlight etc. Depends on implementation. The model here simply indicates to the reporter that it needs to decorate the Row with information based from certain fields
 
 Can be null:
 
 true
 - reporter
```
Reporter<T> reporter
```
 The actual backend service / component responsible for Reporting
 - inputParamsMetas
```
List<E> inputParamsMetas
```
 The REPORTER may demand input parameters; we can define the input parameters and present them using additional info from PARAM_META (like FacetMeta)
 Example for a SEARCH PANEL to accept INPUT Search terms for "First Name":
 PARAM_META = com.neurosys.template.model.Template$FacetMeta
 <property name="name" value="0" /> 
 <property name="displayName" value="First Name" />
 <property name="type" value="INPUT" />
 <property name="submitTransformer"><bean class="com.neurosys.etl.common.transformers.PrefixSuffixTransformer"> 
 <property name="prefix" value="%" />
 <property name="suffix" value="%" />
 
 See Also:
 
 ReporterMeta.noParamsReporterMeta
 
 Can be null:
 
 true
 - noParamsReporterMeta
```
ReporterMeta<PARAM_META> noParamsReporterMeta
```
 If ReporterMeta.inputParamsMetas is not null; then by default to generate a Report params are needed. However by setting this optional field we can present a Default Report that requires no params on init to show an initial display.
 
 See Also:
 
 ReporterMeta.inputParamsMetas
 
 Can be null:
 
 true
Package com.neurosys.cluzo.domain
- Class com.neurosys.cluzo.domain.ContextType extends Object implements Serializable
 
 serialVersionUID:
 
 7931355311494592067L
 - Serialized Fields
 - name
```
String name
```
 Deprecated.
 - description
```
String description
```
 Deprecated.
 - adapters
```
List<E> adapters
```
 Deprecated.
- Class com.neurosys.cluzo.domain.SecurityException extends Exception implements Serializable
 
 serialVersionUID:
 
 1L
 - Serialized Fields
 - violations
```
ArrayList<E> violations
```
- Class com.neurosys.cluzo.domain.SeriousSecurityException extends SecurityException implements Serializable
 
 serialVersionUID:
 
 4349185020163354354L
- Class com.neurosys.cluzo.domain.StringData extends Object implements Serializable
 
 serialVersionUID:
 
 4809395455381872819L
 - Serialized Fields
 - data
```
String data
```
Package com.neurosys.cluzo.service
- Class com.neurosys.cluzo.service.DefaultSecurityContext extends Object implements Serializable
 
 serialVersionUID:
 
 7455935468021957778L
 - Serialized Fields
 - adapters
```
List<E> adapters
```
 - failFast
```
boolean failFast
```
 In failFast (true) mode, any failure will immediately break the chain and not look to carry on with the process.
 Use in places where validation is required but we don't care about the reason(s)
 
 Default value:
 
 true
Package com.neurosys.collection.admin.wicket.pages
- Class com.neurosys.collection.admin.wicket.pages.collectionTypesAdmin extends reportingAdmin implements Serializable
Package com.neurosys.collection.admin.wicket.pages.components
- Class com.neurosys.collection.admin.wicket.pages.components.CollectionTypesReportResult extends PoppableReportResult<T extends Serializable,ReporterMeta> implements Serializable
 
 serialVersionUID:
 
 1L
 - Serialized Fields
 - targetCollectionTypeDetailsPanel
```
CollectionTypesDetailsPanel<C extends Product> targetCollectionTypeDetailsPanel
```
 When selecting a user the action will update the target CollectionTypeDetailsPanel
Package com.neurosys.collection.admin.wicket.pages.panels
- Class com.neurosys.collection.admin.wicket.pages.panels.CollectionTypesDetailsPanel extends AdminPanel implements Serializable
 
 serialVersionUID:
 
 1L
 - Serialized Fields
 - entityTemplate
```
EntityTemplate<REF> entityTemplate
```
 - productService
```
ProductService<T extends Product> productService
```
 - productsForCollectionReporter
```
Reporter<T> productsForCollectionReporter
```
- Class com.neurosys.collection.admin.wicket.pages.panels.CollectionTypesTemplatePanel extends EntityDetailsTemplatePanel<C extends Product> implements Serializable
 
 serialVersionUID:
 
 1L
Package com.neurosys.collection.transformers
- Class com.neurosys.collection.transformers.CollectionURLGeneratorTransformer extends ProductURLGeneratorTransformer<C extends Product> implements Serializable
 
 serialVersionUID:
 
 1L
 - Serialized Fields
 - medium
```
String medium
```
 If the medium of sending the link is email, newsletter etc. This is used in analytics UTM codes
 
 Default value:
 
 email.
 - saltLength
```
int saltLength
```
 - updateMode
```
boolean updateMode
```
 If true will not modify and persist the collection, will rather read from the collection.
 Data like SALT used etc can be saved.
 - campaignPropertyName
```
String campaignPropertyName
```
 The property used from the collection to define the Campaign name in the utm_campaign
 
 Default value:
 
 Product.getName()
Package com.neurosys.comments.domain
- Class com.neurosys.comments.domain.Comment extends AbstractContent<CommentAttribute,CommentFacet> implements Serializable
 
 serialVersionUID:
 
 1L
 - Serialized Fields
 - topic
```
String topic
```
 Topic the Comment belongs to / Artifact the comment was made on
 - topicType
```
String topicType
```
 - text
```
String text
```
 The actual comment
 - attributes
```
Map<K,V> attributes
```
 - userId
```
String userId
```
 - user
```
User user
```
- Class com.neurosys.comments.domain.CommentAttribute extends AbstractContentAttribute implements Serializable
 
 serialVersionUID:
 
 1L
 - Serialized Fields
 - comment
```
Comment comment
```
- Class com.neurosys.comments.domain.CommentFacet extends AbstractContentFacet implements Serializable
 - Serialized Fields
 - comment
```
Comment comment
```
Package com.neurosys.common.admin.wicket.components
- Class com.neurosys.common.admin.wicket.components.NotificationsPanel extends org.apache.wicket.markup.html.panel.Panel implements Serializable
Package com.neurosys.common.admin.wicket.components.SimpleEditor
- Class com.neurosys.common.admin.wicket.components.SimpleEditor.SimpleEditorPanel extends AdminPanel implements Serializable
Package com.neurosys.configs
- Class com.neurosys.configs.AbstractAuthorizableConfiguration extends AbstractConfiguration implements Serializable
 
 serialVersionUID:
 
 1L
- Class com.neurosys.configs.AbstractConfiguration extends Object implements Serializable
 
 serialVersionUID:
 
 6207940062720322927L
 - Serialized Fields
 - name
```
String name
```
 - namespace
```
String namespace
```
 Typically a ConfigurationSource.NAMESPACE_DELIM separated concatination of names. Where the first delimited string represents the TOP most namespace.
 A namespace should not be blank or not contain blanks between delimiters. Example: com.neurosys.products
 - value
```
String value
```
 - bitmask
```
Integer bitmask
```
 Bitmask custom to the configuration itself
 - status
```
Integer status
```
 Status of the Configuration; a generic context (unlike bitmask)
- Class com.neurosys.configs.AbstractConfiguration.ConfigurationKey extends Object implements Serializable
 
 serialVersionUID:
 
 -3938909489380582619L
 - Serialized Fields
 - name
```
String name
```
 - namespace
```
String namespace
```
- Class com.neurosys.configs.AbstractConfigurationJPADaoImpl extends AbstractQueryableDaoImpl<C extends AbstractConfiguration> implements Serializable
 
 serialVersionUID:
 
 -534644557812422233L
- Class com.neurosys.configs.ConfigurationJPADaoImpl extends AbstractConfigurationJPADaoImpl<AbstractConfiguration> implements Serializable
- Class com.neurosys.configs.ConfigurationSourceBackedSpringResource extends org.springframework.core.env.PropertySource<ConfigurationService> implements Serializable
 
 serialVersionUID:
 
 1L
 - Serialized Fields
 - source
```
ConfigurationService<K,T,C extends AbstractConfiguration> source
```
 The ConfigurationSource to fetches the configs from
 - namespace
```
String namespace
```
 The namespace from the ConfigurationSource to fetch the property from
 - recognizeFullPathKeys
```
boolean recognizeFullPathKeys
```
 If true, it will also recognize property references that use <namespace>.<key> references.
 
 Default value:
 
 true
 - context
```
org.springframework.context.ApplicationContext context
```
- Class com.neurosys.configs.DefaultConfiguration extends AbstractConfiguration implements Serializable
 
 serialVersionUID:
 
 5546689737092555260L
- Class com.neurosys.configs.SpringStaticConfiguration extends StaticConfiguration<String,V> implements Serializable
 
 serialVersionUID:
 
 1L
 - Serialized Fields
 - nameDirty
```
boolean nameDirty
```
- Class com.neurosys.configs.StaticConfiguration extends Object implements Serializable
 
 serialVersionUID:
 
 1L
 - Serialized Fields
 - namespace
```
String namespace
```
 - name
```
Object name
```
 - value
```
Object value
```
Package com.neurosys.configs.admin.wicket.pages
- Class com.neurosys.configs.admin.wicket.pages.configsAdmin extends commonAdminTemplate implements Serializable
Package com.neurosys.content.admin.wicket.model
- Class com.neurosys.content.admin.wicket.model.ContentDetailsPageForm extends org.apache.wicket.markup.html.form.StatelessForm<C extends AbstractContent<CA,CF>> implements Serializable
 
 serialVersionUID:
 
 -3101080387669362673L
 - Serialized Fields
 - templateService
```
TemplateService templateService
```
 - refreshCallback
```
ChangeListener<T> refreshCallback
```
- Class com.neurosys.content.admin.wicket.model.ContentManagerForm extends org.apache.wicket.markup.html.form.Form<ContentDescriber> implements Serializable
 
 serialVersionUID:
 
 -3101080387669362673L
 - Serialized Fields
 - contentService
```
ContentService contentService
```
 - templateService
```
TemplateService templateService
```
 - sequenceBeforeSubmit
```
Integer sequenceBeforeSubmit
```
- Class com.neurosys.content.admin.wicket.model.ContentPageForm extends org.apache.wicket.markup.html.form.Form<ContentDescriber> implements Serializable
 
 serialVersionUID:
 
 -3101080387669362673L
- Class com.neurosys.content.admin.wicket.model.TemplateManagerForm extends org.apache.wicket.markup.html.form.Form<ContentDescriber> implements Serializable
 
 serialVersionUID:
 
 -3101080387669362673L
Package com.neurosys.content.admin.wicket.pages
- Class com.neurosys.content.admin.wicket.pages.contentAuthorAdmin extends commonAdminTemplate implements Serializable
 - Serialized Fields
 - factory
```
SpringConfiguredContainerFactory factory
```
 - contentService
```
ContentService contentService
```
- Class com.neurosys.content.admin.wicket.pages.siteManagerAdmin extends commonAdminTemplate implements Serializable
 - Serialized Fields
 - factory
```
SpringConfiguredContainerFactory factory
```
 - contentService
```
ContentService contentService
```
- Class com.neurosys.content.admin.wicket.pages.siteManagerAdmin.SiteManagerContentTreePanel extends ContentTreePanel implements Serializable
 
 serialVersionUID:
 
 -2161121624545685262L
 - Serialized Fields
 - contentHierarchy
```
List<E> contentHierarchy
```
 - contentManager
```
ContentManagerPanel contentManager
```
- Class com.neurosys.content.admin.wicket.pages.templateManagerAdmin extends commonAdminTemplate implements Serializable
 - Serialized Fields
 - contentService
```
ContentService contentService
```
 - typesToShow
```
Collection<E> typesToShow
```
 - ONLY_CONTENT_FILES_AND_FOLDERS
```
org.apache.commons.collections.Predicate ONLY_CONTENT_FILES_AND_FOLDERS
```
Package com.neurosys.content.admin.wicket.pages.panels
- Class com.neurosys.content.admin.wicket.pages.panels.ContentAuthorSearchPanel extends AdminPanel implements Serializable
 
 serialVersionUID:
 
 1L
 - Serialized Fields
 - searchQueryTransformer
```
SearchJPAQueryBuilderTransformer searchQueryTransformer
```
 - fieldTypeMapping
```
Map<K,V> fieldTypeMapping
```
- Class com.neurosys.content.admin.wicket.pages.panels.ContentDetailsPanel extends AdminPanel implements Serializable
 
 serialVersionUID:
 
 -7289470932511208846L
 - Serialized Fields
 - adminConfiguration
```
Properties adminConfiguration
```
 - templateService
```
TemplateService templateService
```
 - factory
```
SpringConfiguredContainerFactory factory
```
 - currentSelectedTemplate
```
Template<REF> currentSelectedTemplate
```
 - authorizationModule
```
AuthorizationModule<T> authorizationModule
```
 - refreshCallback
```
ChangeListener<T> refreshCallback
```
- Class com.neurosys.content.admin.wicket.pages.panels.ContentDetailsTemplatePanel extends EntityDetailsTemplatePanel<C extends AbstractContent<CA,CF>> implements Serializable
 
 serialVersionUID:
 
 1L
- Class com.neurosys.content.admin.wicket.pages.panels.ContentEditorPanel extends AdminPanel implements Serializable
 
 serialVersionUID:
 
 1L
- Class com.neurosys.content.admin.wicket.pages.panels.ContentFacetAjaxSaveBehavior extends EditorAjaxSaveBehavior implements Serializable
 
 serialVersionUID:
 
 1L
 - Serialized Fields
 - facetModel
```
org.apache.wicket.model.IModel<T> facetModel
```
 The params on the Ajax link are formed during the creation of component. However, the ContentFacet may go through some changes, which on ContentFacetAjaxSaveBehavior.save(Map) we may want to react to than just rely on the initial params in the Ajax URL.
 
 See Also:
 
 #decorateCallbackUrl(CharSequence)}
- Class com.neurosys.content.admin.wicket.pages.panels.ContentHistoryPanel extends AdminPanel implements Serializable
 
 serialVersionUID:
 
 1L
- Class com.neurosys.content.admin.wicket.pages.panels.ContentManagerPanel extends AdminPanel implements Serializable
 
 serialVersionUID:
 
 -7289470932511208846L
 - Serialized Fields
 - factory
```
SpringConfiguredContainerFactory factory
```
 - templateService
```
TemplateService templateService
```
 - contentHierarchy
```
List<E> contentHierarchy
```
- Class com.neurosys.content.admin.wicket.pages.panels.ContentTreePanel extends CategoryPanel<ContentDescriber> implements Serializable
 
 serialVersionUID:
 
 4554446651243105378L
- Class com.neurosys.content.admin.wicket.pages.panels.ContentTreePanel.ContentTree extends IndicatingAjaxLinkTree implements Serializable
 
 serialVersionUID:
 
 1L
- Class com.neurosys.content.admin.wicket.pages.panels.CustomContentEditorWrapper extends org.apache.wicket.markup.html.panel.Fragment implements Serializable
 
 serialVersionUID:
 
 1L
- Class com.neurosys.content.admin.wicket.pages.panels.TemplateDetailsPanel extends AdminPanel implements Serializable
 
 serialVersionUID:
 
 1L
 - Serialized Fields
 - authorizationModule
```
AuthorizationModule<T> authorizationModule
```
 - templateStoreService
```
TemplateStoreService<T> templateStoreService
```
Package com.neurosys.content.domain
- Class com.neurosys.content.domain.AbstractContent extends HierarchialDomainObject implements Serializable
 
 serialVersionUID:
 
 8472578656036388083L
 - Serialized Fields
 - id
```
Long id
```
 - bitmask
```
Integer bitmask
```
 See Also:
 
 AbstractContent.BIT_MASKS
 - name
```
String name
```
 Unique (for a language/locale/variant & status) Name to refer to the record Id is an Auto generated number used by the system, but is difficult for the outside world to get a handle on it.
 - displayName
```
String displayName
```
 Human readable String to represent the Content.
 The name is unique for a language and locale but not in totality.
 - created
```
Date created
```
 - updated
```
Date updated
```
 - pagePath
```
String pagePath
```
 A page path that will be applied as a Prefix.
 If null then the page name itself will be the path from the root context.
 
 Can be null:
 
 true
 - language
```
String language
```
 - country
```
String country
```
 - variant
```
String variant
```
 - status
```
Status status
```
 - statusDate
```
Date statusDate
```
 The Date when the AbstractContent.status was updated, or would be changed (incase of a scheduled change)
 - launchDate
```
Date launchDate
```
 For Search, ordering etc. We may want to set the actual Date for the Page to appear on the site. All other dates like AbstractContent.created, AbstractContent.updated, AbstractContent.statusDate are auto controlled by the system. This allows manual control of intended date of launch.
 - metaData
```
String metaData
```
 JSON Object String, that can store many content level properties in one string.
 For example Tags for content
 - facets
```
Collection<E> facets
```
 We don't want to load all Content (disable this side or OR relation) This is because, when content refers to Product, and the product fetches all AbstractContent. Just Content will not contribute to much pay-load, but ContentFacet then it will be a huge pay-load. Unnecessary in most situations.
 
 LAZY loading is problematic. Solve issue with design @ DAO layer instead.
 
 The difference between properties and facets is that properties are loaded with the Content Object, while facets are lazy and represent larger content usually. TODO: Reconsider
- Class com.neurosys.content.domain.AbstractContentAlias extends DomainObject implements Serializable
 
 serialVersionUID:
 
 1L
 - Serialized Fields
 - id
```
Long id
```
 - parent
```
ContentDescriber parent
```
 See Also:
 
 HierarchialDomainObject.getParentId()
- Class com.neurosys.content.domain.AbstractContentAttribute extends EntityAttribute<Content> implements Serializable
 
 serialVersionUID:
 
 -7890600760810285418L
- Class com.neurosys.content.domain.AbstractContentFacet extends DomainObject implements Serializable
 
 serialVersionUID:
 
 4252241841337355357L
 - Serialized Fields
 - id
```
Long id
```
 - name
```
String name
```
 The Name in facet is the same as refName
 - index
```
Integer index
```
 If this ContentFacet is part of an Array (list), then this will not be null and have the index number (starts from 0)
 - value
```
String value
```
 - authorizations
```
String authorizations
```
 JSON String to represent a Map of <String, Authorization> per module. The key is the module name.
 - metaData
```
String metaData
```
 JSON Object String, that can store many facet related properties in one string. System generated usually: Meta Data about the facet itself.
 For example Tags for Facet
 - notes
```
String notes
```
 User generated Notes about the content
 - type
```
String type
```
 Describe the kind of content as ContentType (String)
 Core type kept String for simple persistence
- Class com.neurosys.content.domain.AbstractContentTemplate extends EntityTemplate<T> implements Serializable
 
 serialVersionUID:
 
 1L
 - Serialized Fields
 - metaDataFacets
```
Collection<E> metaDataFacets
```
 Define additional ContentDescriber.setAttributes(Map) and fields on ContentDescriber
 
 Standard Template.getFacets() are reserved for the CONTENT Facets associated with the content. These are to define additional attributes that serve as meta Information to the Content.
- Class com.neurosys.content.domain.ContentAlias extends AbstractContentAlias<ContentDescriber> implements Serializable
 
 serialVersionUID:
 
 1L
 - Serialized Fields
 - content
```
ContentDescriber content
```
- Class com.neurosys.content.domain.ContentAttribute extends AbstractContentAttribute implements Serializable
 
 serialVersionUID:
 
 -7890600760810285418L
 - Serialized Fields
 - content
```
ContentDescriber content
```
- Class com.neurosys.content.domain.ContentDescriber extends AbstractContent<ContentAttribute,ContentFacet> implements Serializable
 
 serialVersionUID:
 
 8472578656036388083L
 - Serialized Fields
 - attributes
```
Map<K,V> attributes
```
 The difference between properties and facets is that properties are loaded with the Content Object, while facets are lazy and represent larger content usually.
- Class com.neurosys.content.domain.ContentFacet extends AbstractContentFacet implements Serializable
 
 serialVersionUID:
 
 4252241841337355357L
 - Serialized Fields
 - content
```
ContentDescriber content
```
 This ContentFacet belongs to which ContentDescriber
- Class com.neurosys.content.domain.ContentTemplate extends AbstractContentTemplate<T> implements Serializable
 
 serialVersionUID:
 
 1L
- Class com.neurosys.content.domain.ContentType extends Object implements Serializable
 
 serialVersionUID:
 
 7220972116443678884L
 - Serialized Fields
 - name
```
String name
```
 This type will be referred to by this Name; should be unique
 - ref
```
Class<T> ref
```
 A Reference to a Type of Object or type of Collection of Objects.
 Example: For META, if Type is Product then its some description about the product. or the exact interpretation is left to the implementation.
- Class com.neurosys.content.domain.FacetAlias extends DomainObject implements Serializable
 
 serialVersionUID:
 
 1L
 - Serialized Fields
 - id
```
Long id
```
 - facet
```
ContentFacet facet
```
 - parent
```
ContentFacet parent
```
 See Also:
 
 HierarchialDomainObject.getParentId()
Package com.neurosys.content.service
- Class com.neurosys.content.service.CategoryContentPathTransformer extends ContentPathTransformer implements Serializable
 
 serialVersionUID:
 
 1L
- Class com.neurosys.content.service.ContentContext extends Object implements Serializable
 - Serialized Fields
 - userShell
```
WebUserShell userShell
```
 The WebUserShell will be available to the script to FacetMeta.getDisplayTransformer(), while rendering of final content
 - contentDescriber
```
Content<CA extends AbstractContentAttribute,CF extends AbstractContentFacet> contentDescriber
```
 - status
```
Status status
```
- Class com.neurosys.content.service.ContentPathTransformer extends Object implements Serializable
 
 serialVersionUID:
 
 1L
 - Serialized Fields
 - pathConstructor
```
ContentPathConstructor pathConstructor
```
 - associatedTemplate
```
Template<REF> associatedTemplate
```
 Used to construct a path from PageIdentifier
 
 Can be null:
 
 true, required ContentPathTransformer.pathConstructor to be set
 - pageToTemplate
```
Function<T,R> pageToTemplate
```
 A Function that can derive the Template form the PageIdentifier.
 
 Can be null:
 
 true
Package com.neurosys.content.service.security
- Class com.neurosys.content.service.security.CleanEditorContent extends Object implements Serializable
- Class com.neurosys.content.service.security.ContentAntiSammySecurityFilter extends Object implements Serializable
 - Serialized Fields
 - context
```
org.springframework.context.ApplicationContext context
```
 - policy
```
org.owasp.validator.html.Policy policy
```
- Class com.neurosys.content.service.security.FilterException extends Exception implements Serializable
 
 serialVersionUID:
 
 1L
 - Serialized Fields
 - violations
```
List<E> violations
```
Package com.neurosys.content.wicket.model
- Class com.neurosys.content.wicket.model.ContentDescriberModel extends org.apache.wicket.model.LoadableDetachableModel<ContentDescriber> implements Serializable
 
 serialVersionUID:
 
 8313755660626427537L
 - Serialized Fields
 - content
```
ContentDescriber content
```
- Class com.neurosys.content.wicket.model.ContentFacetModel extends org.apache.wicket.model.LoadableDetachableModel<ContentFacet> implements Serializable
 
 serialVersionUID:
 
 8313755660626427537L
 - Serialized Fields
 - facet
```
ContentFacet facet
```
 Deprecated.
- Class com.neurosys.content.wicket.model.ContentModel extends org.apache.wicket.model.LoadableDetachableModel<T> implements Serializable
 
 serialVersionUID:
 
 8313755660626427537L
 - Serialized Fields
 - context
```
ContentContext<C extends Content<CA,CF>,CA extends AbstractContentAttribute,CF extends AbstractContentFacet> context
```
 - contentDescriber
```
AbstractContent<CA extends AbstractContentAttribute,CF extends AbstractContentFacet> contentDescriber
```
- Class com.neurosys.content.wicket.model.ContentSortableDataProvider extends org.apache.wicket.extensions.markup.html.repeater.util.SortableDataProvider<ContentDescriber> implements Serializable
 
 serialVersionUID:
 
 1L
 - Serialized Fields
 - contentService
```
ContentService contentService
```
 - categoryName
```
String categoryName
```
- Class com.neurosys.content.wicket.model.MarkupContentModel extends ContentModel<List<String>,C extends AbstractContent<CA,CF>,CA extends AbstractContentAttribute,CF extends AbstractContentFacet> implements Serializable
 
 serialVersionUID:
 
 -1590668297289715697L
 - Serialized Fields
 - facetMeta
```
FacetMeta facetMeta
```
- Class com.neurosys.content.wicket.model.PublishableMarkupContentModel extends MarkupContentModel<C extends AbstractContent<CA,CF>,CA extends AbstractContentAttribute,CF extends AbstractContentFacet> implements Serializable
 
 serialVersionUID:
 
 -1590668297289715697L
Package com.neurosys.content.wicket.pages
- Class com.neurosys.content.wicket.pages.CategoryTemplatePage extends PublishTemplatePage<T extends Template<TemplatePage>,ContentDescriber> implements Serializable
 - Serialized Fields
 - templateForChild
```
Template<REF> templateForChild
```
 Deprecated.
 
 For the rendering of the Child elements what template will be Used and so the Child will be defined as per the facets in this template
 - parentTemplate
```
TemplatePage<T extends Template<?>,C extends Content> parentTemplate
```
 Deprecated.
 
 Ideally one would want to extend this Class from a Custom template so that all the template properties are inherited.
 Since here we have to extend an existing TemplatePage pass the desired parent; it will decorate that (Optional)
 
 Can be null:
 
 true
- Class com.neurosys.content.wicket.pages.MockTemplatePage extends TemplatePage<T extends Template<TemplatePage>,ContentDescriber> implements Serializable
 
 serialVersionUID:
 
 7218634844104181923L
- Class com.neurosys.content.wicket.pages.PublishTemplatePage extends TemplatePage<T extends Template<?>,C extends AbstractContent<?,?>> implements Serializable
 
 serialVersionUID:
 
 1L
 - Serialized Fields
 - factory
```
SpringConfiguredContainerFactory factory
```
 - contentService
```
GenericContentService<C extends Content<CA,CF>,CA extends AbstractContentAttribute,CF extends AbstractContentFacet> contentService
```
- Class com.neurosys.content.wicket.pages.TemplatePage extends org.apache.wicket.markup.html.WebPage implements Serializable
 
 serialVersionUID:
 
 7218634844104181923L
 - Serialized Fields
 - templateService
```
TemplateService templateService
```
 - contentDesc
```
Content<CA extends AbstractContentAttribute,CF extends AbstractContentFacet> contentDesc
```
Package com.neurosys.content.wicket.pages.panel
- Class com.neurosys.content.wicket.pages.panel.ListViewTemplatePanel extends TemplatePanel<T extends Template<TemplatePanel>,M extends Serializable> implements Serializable
 
 serialVersionUID:
 
 7218634844104181923L
 - Serialized Fields
 - authorizationModule
```
AuthorizationModule<T> authorizationModule
```
- Class com.neurosys.content.wicket.pages.panel.PublishContentPanel extends org.apache.wicket.markup.html.panel.Panel implements Serializable
 
 serialVersionUID:
 
 -6701131359368938960L
- Class com.neurosys.content.wicket.pages.panel.TemplatePanel extends org.apache.wicket.markup.html.panel.Panel implements Serializable
 
 serialVersionUID:
 
 7218634844104181923L
 - Serialized Fields
 - template
```
Template<REF> template
```
Package com.neurosys.crm.billing.domain
- Class com.neurosys.crm.billing.domain.Cycle extends ModelObject implements Serializable
 - Serialized Fields
 - dateCycle
```
DateCycle dateCycle
```
 - active
```
boolean active
```
 - started
```
Date started
```
 Date the Cycle actually started or meant to start
- Class com.neurosys.crm.billing.domain.DateCycle extends ModelObject implements Serializable
 - Serialized Fields
 - dayOfMonth
```
Integer dayOfMonth
```
 Optional. If not null then the Cycle will be interrupted on that DateCycle.dayOfMonth and/or DateCycle.monthOfYear.
 If no DateCycle.monthOfYear, then every month DateCycle.dayOfMonth will be the cut date of the cycle (excluding that date)
 Example: 4th of every month means, upto 3rd 11:59 PM.
 Months Range 1 to 12.
 
 Can be null:
 
 true
 - monthOfYear
```
Integer monthOfYear
```
 Optional. If not null then the Cycle will be interrupted on that DateCycle.dayOfMonth and/or DateCycle.monthOfYear.
 If no DateCycle.monthOfYear, then every month DateCycle.dayOfMonth will be the cut date of the cycle (excluding that date)
 Example: 4th of every month means, upto 3rd 11:59 PM.
 Months Range 1 to 12.
 
 Can be null:
 
 true
 - duration
```
Integer duration
```
 Duration in Days. If null then the cycle will be monthly (DateCycle.dayOfMonth or annual (DateCycle.monthOfYear
 
 Can be null:
 
 true
- Class com.neurosys.crm.billing.domain.OrgFeature extends DomainObject implements Serializable
 - Serialized Fields
 - org
```
Organization org
```
 - feature
```
Feature feature
```
 - purchaseDate
```
Date purchaseDate
```
 - created
```
Date created
```
 - updated
```
Date updated
```
 - trialStartDate
```
Date trialStartDate
```
 - trialEndDate
```
Date trialEndDate
```
 - billingCycle
```
Cycle billingCycle
```
- Class com.neurosys.crm.billing.domain.TrackCycle extends TrackInfo<R,V extends Number> implements Serializable
 
 serialVersionUID:
 
 1L
 - Serialized Fields
 - cycle
```
Cycle cycle
```
Package com.neurosys.crm.billing.exceptions
- Class com.neurosys.crm.billing.exceptions.LimitApproachingException extends LimitException implements Serializable
- Class com.neurosys.crm.billing.exceptions.LimitExceededException extends LimitException implements Serializable
- Class com.neurosys.crm.billing.exceptions.LimitException extends RuntimeException implements Serializable
  - Serialized Fields
    - namespace
```
String namespace
```
      For what the limit is being reached: namespace or authorizableId
    - limitValue
```
Object limitValue
```
    - currentValue
```
Object currentValue
```
- Class com.neurosys.crm.billing.exceptions.LimitReachedException extends LimitException implements Serializable
Package com.neurosys.crm.pricing.domain
- Class com.neurosys.crm.pricing.domain.Feature extends DomainObject implements Serializable
 - Serialized Fields
 - authorizableId
```
String authorizableId
```
 - displayName
```
String displayName
```
 - authorizations
```
Collection<E> authorizations
```
 Deprecated. Use FeatureForOrganization
 
 Authorization or Restriction type
 - pricePerUnit
```
Number pricePerUnit
```
 See Also:
 
 Feature.unit
 
 Can be null:
 
 true
 - unit
```
String unit
```
 If not null and price is not null then it means price/unit
 
 See Also:
 
 Feature.pricePerUnit
 
 Can be null:
 
 true
 - cycle
```
Cycle cycle
```
 What is the billing Cycle for the Feature
 
 Can be null:
 
 true
- Class com.neurosys.crm.pricing.domain.FeatureForOrganization extends Feature implements Serializable
 - Serialized Fields
 - org
```
Organization org
```
 Linked to a Primary Organization
- Class com.neurosys.crm.pricing.domain.ProductPackage extends Feature implements Serializable
 - Serialized Fields
 - name
```
String name
```
 - features
```
Map<K,V> features
```
 Map of Authorizable.getAuthorizableId() and its Feature
- Class com.neurosys.crm.pricing.domain.Restriction extends Authorization implements Serializable
 
 serialVersionUID:
 
 1L
 - Serialized Fields
 - limit
```
Object limit
```
 Limitation value
 
 Can be null:
 
 true
- Class com.neurosys.crm.pricing.domain.Tier extends ProductPackage<F extends Feature> implements Serializable
 - Serialized Fields
 - addOnOverrides
```
ProductPackage<F extends Feature> addOnOverrides
```
 Add-On or Override Feature over standard ProductPackage.getFeatures()
Package com.neurosys.crm.pricing.domain.jpa
- Class com.neurosys.crm.pricing.domain.jpa.JPAFeature extends Feature implements Serializable
 - Serialized Fields
 - id
```
String id
```
- Class com.neurosys.crm.pricing.domain.jpa.JPAFeatureForOrganization extends FeatureForOrganization implements Serializable
 - Serialized Fields
 - id
```
String id
```
- Class com.neurosys.crm.pricing.domain.jpa.JPAProductPackage extends ProductPackage<JPAFeature> implements Serializable
 
 serialVersionUID:
 
 1L
 - Serialized Fields
 - id
```
String id
```
- Class com.neurosys.crm.pricing.domain.jpa.JPARestriction extends Restriction<String> implements Serializable
 
 serialVersionUID:
 
 1L
 - Serialized Fields
 - id
```
String id
```
- Class com.neurosys.crm.pricing.domain.jpa.JPATier extends Tier implements Serializable
 - Serialized Fields
 - id
```
String id
```
Package com.neurosys.dao.jpa
- Class com.neurosys.dao.jpa.DefaultSelectorPersistenceAnnotationBeanPostProcessor extends org.springframework.orm.jpa.support.PersistenceAnnotationBeanPostProcessor implements Serializable
- Class com.neurosys.dao.jpa.EntityManagerLookupAware extends Object implements Serializable
 - Serialized Fields
 - entityManagerProvider
```
org.apache.commons.collections.Transformer entityManagerProvider
```
 Since EntityManager is transient, in certain situations it may need to be re-acquired
- Class com.neurosys.dao.jpa.JPACallableStatementTransformer extends EntityManagerLookupAware implements Serializable
 
 serialVersionUID:
 
 1L
 - Serialized Fields
 - query
```
String query
```
 - execute
```
boolean execute
```
 If the Procedure is not expected to return anything and uses DML then set to true. If it is expected to return a ResultSet then set to false
 
 Default value:
 
 true
- Class com.neurosys.dao.jpa.JPAExecuteTransformer extends EntityManagerLookupAware implements Serializable
 
 serialVersionUID:
 
 1L
 - Serialized Fields
 - query
```
String query
```
 - queryIsNative
```
boolean queryIsNative
```
 If the Query is to be fired in JPA or native DB SQL language
 
 Default value:
 
 false
 - fieldMapping
```
Map<K,V> fieldMapping
```
 Map from query param name to field name or Transformer that will act on input to get param value. Used incase parameters are names and the input is not an Object[]
- Class com.neurosys.dao.jpa.JPAFlushTransformer extends EntityManagerLookupAware implements Serializable
 
 serialVersionUID:
 
 1L
 - Serialized Fields
 - flush
```
boolean flush
```
 If true will flush the EntityManager
 
 See Also:
 
 EntityManager.flush()
 
 Default value:
 
 true
 - clear
```
boolean clear
```
 If true will clear the EntityManager
 
 See Also:
 
 EntityManager.clear()
 
 Default value:
 
 true
- Class com.neurosys.dao.jpa.JPAPersistTransformer extends EntityManagerLookupAware implements Serializable
 
 serialVersionUID:
 
 1L
 - Serialized Fields
 - insert
```
boolean insert
```
 If true, will insert
 
 Default value:
 
 false
 - dontPropagateExceptions
```
boolean dontPropagateExceptions
```
 Sometimes persist is a fail safe and we dont care about subsequent failures.
 
 Default value:
 
 false
- Class com.neurosys.dao.jpa.JPAQueryTransformer extends EntityManagerLookupAware implements Serializable
 
 serialVersionUID:
 
 1L
 - Serialized Fields
 - query
```
String query
```
 - queryIsNative
```
boolean queryIsNative
```
 If the Query is to be fired in JPA or native DB SQL language
 
 Default value:
 
 false
 - expectSingleResult
```
boolean expectSingleResult
```
 If true it will attempt to return only 1 Object or null if no match to query
 
 Default value:
 
 false
 - fieldMapping
```
Map<K,V> fieldMapping
```
 Map from query param name to field name or Transformer that will act on input to get param value. Used incase parameters are names and the input is not an Object[]
 - queryOptimizer
```
QueryOptimizer queryOptimizer
```
 An optional configurable QueryOptimizer
 - queryOptimizerEntityAlias
```
String queryOptimizerEntityAlias
```
 Since the query will not change, within the Query what is the Alias of the entity/table
 - optimized
```
boolean optimized
```
 If JPAQueryTransformer.query was optimized then we need to normalize all the results.
 - paramAsSingleInput
```
boolean paramAsSingleInput
```
 If the input is a List of Collection and we wish to process it as a single parameter make this true OR wrap it in an Object Array. This is a more convenient way. TODO: Add to Unit test case
 - pageInfo
```
PageInfo pageInfo
```
 Optional. If supplied will override any dynamic PageInfo details passed
- Class com.neurosys.dao.jpa.QueryByObjectTransformer extends EntityManagerLookupAware implements Serializable
 - Serialized Fields
 - dao
```
QueryableDao<T> dao
```
 - type
```
Class<T> type
```
 If not null then, then will try to convert output row into Object type
 
 Can be null:
 
 true
 
 Default value:
 
 null
Package com.neurosys.document.admin.wicket.pages
- Class com.neurosys.document.admin.wicket.pages.documentViewerPopup extends commonAdminDialogTemplate implements Serializable
Package com.neurosys.document.admin.wicket.pages.panels
- Class com.neurosys.document.admin.wicket.pages.panels.DocumentManagerPanel extends ResourceManagerPanel<File> implements Serializable
 
 serialVersionUID:
 
 7366783763026409494L
 - Serialized Fields
 - fileListView
```
WebFileListView fileListView
```
- Class com.neurosys.document.admin.wicket.pages.panels.SubFolderViewPanel extends CategoryPanel<File> implements Serializable
 
 serialVersionUID:
 
 4554446651243105378L
 - Serialized Fields
 - resourceUploader
```
FileUploadWrapper resourceUploader
```
 - filter
```
org.apache.commons.collections.Predicate filter
```
 A Predicate, if provided will be used to filter files
 
 Default value:
 
 null
Package com.neurosys.domain
- Class com.neurosys.domain.CaseInsensitiveHashMap extends HashMap<String,T> implements Serializable
 
 serialVersionUID:
 
 6197497260647808948L
- Class com.neurosys.domain.CaseInsensitiveHashSet extends HashSet<String> implements Serializable
 
 serialVersionUID:
 
 1L
- Class com.neurosys.domain.CaseInsensitiveList extends ArrayList<String> implements Serializable
 
 serialVersionUID:
 
 1L
- Class com.neurosys.domain.DomainObject extends ModelObject implements Serializable
 
 serialVersionUID:
 
 1L
- Class com.neurosys.domain.EntityAttribute extends DomainObject implements Serializable
 
 serialVersionUID:
 
 1L
 - Serialized Fields
 - id
```
Long id
```
 - name
```
String name
```
 - value
```
String value
```
- Class com.neurosys.domain.Entry extends Object implements Serializable
 
 serialVersionUID:
 
 1L
 - Serialized Fields
 - k
```
Object k
```
 - v
```
Object v
```
- Class com.neurosys.domain.ExternalQuery extends Query<T> implements Serializable
 
 serialVersionUID:
 
 1103450960964039264L
- Class com.neurosys.domain.HierarchialDomainObject extends DomainObject implements Serializable
 
 serialVersionUID:
 
 3113593808571501944L
 - Serialized Fields
 - displayName
```
String displayName
```
 Display Name (Can contain HTML)
 If you want to display the name without HTML use MarshalUtils.regexReplace(safeDisplayName, HTMLUtils.html4Replacer)
 
 Can be null:
 
 true if null then IHierarchialReference.getName() will return name
 - parentId
```
Long parentId
```
 - hierarchy
```
String hierarchy
```
 A String like: "rootId-nodeId-subnodeId-thisId"; gives the entire picture of the hierarchy to this point.
 Ideally hierarchy code could be considered to be unique, however in some cases it may not be the case.
 Consider a content that has a Preview & Publish version. The same content shares the same hierarchy code but has 2 separate records.
 
 if any constraint is desired, its recommended to put it @ a project level, by externally running the constraint script on the Database and not binding it in the Data Model itself. This is a project specific decision.
- Class com.neurosys.domain.HierarchialDomainObjectWithAttributes extends HierarchialDomainObject implements Serializable
- Class com.neurosys.domain.ImmutableValueHashMap extends HashMap<K,V> implements Serializable
 - Serialized Fields
 - valueAsList
```
boolean valueAsList
```
 If true, the values are added into a List
 
 Default value:
 
 false
- Class com.neurosys.domain.JsonQuery extends ExternalQuery<Object> implements Serializable
 
 serialVersionUID:
 
 1103450960964039264L
- Class com.neurosys.domain.Locale extends ModelObject implements Serializable
 
 serialVersionUID:
 
 1L
 - Serialized Fields
 - language
```
String language
```
 - country
```
String country
```
 - variant
```
String variant
```
- Class com.neurosys.domain.ModelObject extends Object implements Serializable
 
 serialVersionUID:
 
 1L
- Class com.neurosys.domain.OrderByRefList extends ArrayList<O extends OrderableByRef<Number>> implements Serializable
 - Serialized Fields
 - reverseNext
```
boolean reverseNext
```
 If true will observe all {next & current as --> current & previous}
 
 Default value:
 
 false
 - positionMap
```
Map<K,V> positionMap
```
 - linkedNextRefIds
```
List<E> linkedNextRefIds
```
 - linkedPrevRefIds
```
List<E> linkedPrevRefIds
```
 - previousRefIdAdded
```
Set<E> previousRefIdAdded
```
 - reverseNextToCurrentMap
```
Map<K,V> reverseNextToCurrentMap
```
 - linkedRevNextIds
```
Set<E> linkedRevNextIds
```
- Class com.neurosys.domain.Progress extends Object implements Serializable
 
 serialVersionUID:
 
 1L
 - Serialized Fields
 - current
```
Long current
```
 - total
```
Long total
```
- Class com.neurosys.domain.Query extends Object implements Serializable
 
 serialVersionUID:
 
 1L
 - Serialized Fields
 - pageInfo
```
PageInfo pageInfo
```
 - entity
```
Object entity
```
 - relatedAttributes
```
Map<K,V> relatedAttributes
```
 Deprecated.
 
 Related attributes for Query that may carry special meaning to DAO
 - orderString
```
String orderString
```
 - whereExtension
```
String whereExtension
```
 Special Strings; if Not null is Appended after WHERE or last AND
 - fromExtension
```
String fromExtension
```
 Special Strings; if Not null is Appended after the last default entity in FROM clause
 - excludedFields
```
Set<E> excludedFields
```
 Set of names of fields whose values will not be included in ResultSet. They will be set to null
 When Using Excluded Fields, the DAO results maybe sub-optimal as they go through a filter-mapping process usually to produce the desired type of result set from the raw input set.
 Note: included and excluded fields are mutually exclusive
 - includedFields
```
List<E> includedFields
```
 List of field Names that will only be included in the Result Set.
 
 Note: included and excluded fields are mutually exclusive (Optional)
 - nullSet
```
Set<E> nullSet
```
 Set of names of fields which if null will still be compared against
 - params
```
Map<K,V> params
```
 Using Where extension we can put parameters that can be set as objects instead of hard coded strings.
 - ignoreEntityFieldsInWhere
```
boolean ignoreEntityFieldsInWhere
```
 If true will Not add the Query entity fields to the WHERE clause
 
 Default value:
 
 false
 - selectOverride
```
String selectOverride
```
 If we are using Joins via Query.whereExtension; and say we want the Select to get only data from the Join.
 This excludes the 'SELECT' statement.
 
 Can be null:
 
 true
- Class com.neurosys.domain.Status extends ModelObject implements Serializable
 
 serialVersionUID:
 
 1L
 - Serialized Fields
 - message
```
String message
```
 - level
```
int level
```
 Define the level
 see FeedbackMessage#INFO etc.
- Class com.neurosys.domain.StoreHashMap extends HashMap<K,V> implements Serializable
 
 serialVersionUID:
 
 1L
- Class com.neurosys.domain.UniqueList extends ArrayList<E> implements Serializable
 
 serialVersionUID:
 
 1L
- Class com.neurosys.domain.UserShell extends Object implements Serializable
 
 serialVersionUID:
 
 1L
 - Serialized Fields
 - authToken
```
AuthenticationToken authToken
```
 - user
```
User user
```
 - parent
```
Shell<E> parent
```
 - environment
```
Object environment
```
Package com.neurosys.domain.transformers
- Class com.neurosys.domain.transformers.SecurityTransformer extends TwoWayTransformer implements Serializable
  
  serialVersionUID:
  
  1L
  - Serialized Fields
    - hash
```
boolean hash
```
      If true will apply hashing instead of encryption
      
      Default value:
      
      false
    - cipherType
```
String cipherType
```
      Cipher Type
    - cipher
```
String cipher
```
      Cipher
    - key
```
Key key
```
Package com.neurosys.ecom.cart.domain
- Class com.neurosys.ecom.cart.domain.Cart extends ModelObject implements Serializable
 
 serialVersionUID:
 
 1L
 - Serialized Fields
 - userId
```
String userId
```
 - sessionId
```
String sessionId
```
 - origin
```
String origin
```
 Origin of the cart. Details like IPAddress, User Agent etc can be captured for the cart
 
 Can be null:
 
 true
 - currency
```
String currency
```
 The preferred currency for the user cart
 
 Can be null:
 
 true. null means default currency
 - items
```
List<E> items
```
 - properties
```
Map<K,V> properties
```
 Deprecated. It is preferred to extend CartItem than to maintain a separate mapping.
 
 Optional properties map per productName.
 Key: String as Product Name, Value: Object
 - promotions
```
List<E> promotions
```
- Class com.neurosys.ecom.cart.domain.CartItem extends ModelObject implements Serializable
 
 serialVersionUID:
 
 1L
 - Serialized Fields
 - id
```
Object id
```
 - name
```
String name
```
 - code
```
String code
```
 - comments
```
String comments
```
 - parentId
```
Object parentId
```
 - hierarchy
```
String hierarchy
```
- Class com.neurosys.ecom.cart.domain.ShoppingCart extends Cart implements Serializable
 
 serialVersionUID:
 
 1L
Package com.neurosys.ecom.cart.service
- Class com.neurosys.ecom.cart.service.CartUpdateStockChangeListener extends Object implements Serializable
 
 serialVersionUID:
 
 1L
 - Serialized Fields
 - saleStrategy
```
SaleStrategy saleStrategy
```
 - lockStrategy
```
LockStrategy lockStrategy
```
Package com.neurosys.ecom.cart.wicket.components
- Class com.neurosys.ecom.cart.wicket.components.AbstractCartForm extends org.apache.wicket.markup.html.form.StatelessForm<Cart> implements Serializable
 
 serialVersionUID:
 
 1L
Package com.neurosys.ecom.catalog.admin.wicket.pages
- Class com.neurosys.ecom.catalog.admin.wicket.pages.inventoryAdmin extends reportingAdmin implements Serializable
Package com.neurosys.ecom.catalog.admin.wicket.pages.components
- Class com.neurosys.ecom.catalog.admin.wicket.pages.components.InventoryReportResult extends PoppableReportResult<T extends Serializable,ReporterMeta> implements Serializable
 
 serialVersionUID:
 
 1L
Package com.neurosys.ecom.customers.admin.wicket.pages
- Class com.neurosys.ecom.customers.admin.wicket.pages.customerDataAdmin extends reportingAdmin implements Serializable
- Class com.neurosys.ecom.customers.admin.wicket.pages.dashboardAdmin extends commonAdminTemplate implements Serializable
- Class com.neurosys.ecom.customers.admin.wicket.pages.orderAdmin extends reportingAdmin implements Serializable
  - Serialized Fields
    - factory
```
SpringConfiguredContainerFactory factory
```
    - unlockAllOrderItems
```
JPAExecuteTransformer unlockAllOrderItems
```
    - cleanOldRequestedOrderItems
```
JPAExecuteTransformer cleanOldRequestedOrderItems
```
    - cleanOldRequestedOrders
```
JPAExecuteTransformer cleanOldRequestedOrders
```
    - relockUnfinishedOrders
```
JPAExecuteTransformer relockUnfinishedOrders
```
- Class com.neurosys.ecom.customers.admin.wicket.pages.promotionAdmin extends reportingAdmin implements Serializable
  - Serialized Fields
    - factory
```
SpringConfiguredContainerFactory factory
```
Package com.neurosys.ecom.customers.admin.wicket.pages.components
- Class com.neurosys.ecom.customers.admin.wicket.pages.components.CustomerDataReportResult extends PoppableReportResult<T extends Serializable,ReporterMeta> implements Serializable
 
 serialVersionUID:
 
 1L
 - Serialized Fields
 - targetCustomerDetailsPanel
```
CustomerDetailsPanel targetCustomerDetailsPanel
```
 When selecting a user the action will update the target CustomerDetailsPanel
- Class com.neurosys.ecom.customers.admin.wicket.pages.components.OrderReportResult extends PoppableReportResult<T extends Serializable,ReporterMeta> implements Serializable
 
 serialVersionUID:
 
 1L
 - Serialized Fields
 - targetCustomerDetailsPanel
```
CustomerDetailsPanel targetCustomerDetailsPanel
```
 When selecting a user the action will update the target CustomerDetailsPanel
 - targetOrderDetailsPanel
```
OrderDetailsPanel<O extends Order,I extends OrderItem> targetOrderDetailsPanel
```
 When selecting an Order will update Order Details
 - orderService
```
OrderService<O extends Order<? extends I>,I extends OrderItem> orderService
```
 - orderEntityIndex
```
int orderEntityIndex
```
 - idIndex
```
int idIndex
```
- Class com.neurosys.ecom.customers.admin.wicket.pages.components.PromotionReportResult extends PoppableReportResult<T extends Serializable,ReporterMeta> implements Serializable
 
 serialVersionUID:
 
 1L
Package com.neurosys.ecom.customers.admin.wicket.pages.panels
- Class com.neurosys.ecom.customers.admin.wicket.pages.panels.CustomerDetailsPanel extends AdminPanel implements Serializable
 
 serialVersionUID:
 
 1L
 - Serialized Fields
 - entityTemplate
```
EntityTemplate<REF> entityTemplate
```
 - attributesTemplate
```
EntityTemplate<REF> attributesTemplate
```
 - userAttributeDao
```
UserAttributesDao userAttributeDao
```
 - genericDao
```
GenericDaoImpl<T> genericDao
```
- Class com.neurosys.ecom.customers.admin.wicket.pages.panels.CustomerDetailsTemplatePanel extends EntityDetailsTemplatePanel<User> implements Serializable
 
 serialVersionUID:
 
 1L
- Class com.neurosys.ecom.customers.admin.wicket.pages.panels.DeliveryDetailsPanel extends AdminPanel implements Serializable
 
 serialVersionUID:
 
 1L
 - Serialized Fields
 - entityTemplate
```
EntityTemplate<REF> entityTemplate
```
 - orderService
```
OrderService<O extends Order<? extends I>,I extends OrderItem> orderService
```
- Class com.neurosys.ecom.customers.admin.wicket.pages.panels.DeliveryDetailsTemplatePanel extends EntityDetailsTemplatePanel<DeliveryDetails> implements Serializable
 
 serialVersionUID:
 
 1L
- Class com.neurosys.ecom.customers.admin.wicket.pages.panels.OrderDetailsPanel extends AdminPanel implements Serializable
 
 serialVersionUID:
 
 1L
 - Serialized Fields
 - existingEntityTemplate
```
EntityTemplate<REF> existingEntityTemplate
```
 - orderItemReporter
```
Reporter<T> orderItemReporter
```
 - transactionReporter
```
Reporter<T> transactionReporter
```
 - relatedOrdersReporter
```
Reporter<T> relatedOrdersReporter
```
 - orderService
```
OrderService<O extends Order<? extends I>,I extends OrderItem> orderService
```
 - productService
```
ProductService<T extends Product> productService
```
 - mailerService
```
MailerService mailerService
```
 - invoiceEmailSettings
```
EmailMessage<T> invoiceEmailSettings
```
 - factory
```
SpringConfiguredContainerFactory factory
```
 - authorizationModule
```
AuthorizationModule<T> authorizationModule
```
- Class com.neurosys.ecom.customers.admin.wicket.pages.panels.OrderDetailsTemplatePanel extends EntityDetailsTemplatePanel<O extends Order> implements Serializable
 
 serialVersionUID:
 
 1L
- Class com.neurosys.ecom.customers.admin.wicket.pages.panels.PromotionDetailsPanel extends AdminPanel implements Serializable
 
 serialVersionUID:
 
 1L
 - Serialized Fields
 - entityTemplate
```
EntityTemplate<REF> entityTemplate
```
 - promotionService
```
PromotionService<T extends Promotion> promotionService
```
 - promotionForUserReporter
```
Reporter<T> promotionForUserReporter
```
- Class com.neurosys.ecom.customers.admin.wicket.pages.panels.PromotionDetailsTemplatePanel extends EntityDetailsTemplatePanel<Promotion> implements Serializable
 
 serialVersionUID:
 
 1L
Package com.neurosys.ecom.etl
- Class com.neurosys.ecom.etl.AmountTransformer extends Object implements Serializable
 
 serialVersionUID:
 
 1L
 - Serialized Fields
 - nullToAmount
```
boolean nullToAmount
```
 Convert a null input to an Amount object if true
 
 Default value:
 
 true
 - amountPropertyField
```
String amountPropertyField
```
 If not null will set the property field in Amount instead of setting total (by default)
- Class com.neurosys.ecom.etl.ExcelRowToAreaTransformer extends AbstractExcelRowToEntityTransformer<A extends AreaType> implements Serializable
 
 serialVersionUID:
 
 1L
 - Serialized Fields
 - type
```
Class<T> type
```
- Class com.neurosys.ecom.etl.ExcelRowToEcomProductTransformer extends ExcelRowToProductTransformer implements Serializable
 
 serialVersionUID:
 
 1L
- Class com.neurosys.ecom.etl.FileToProductsTransformer extends FileToProductsTransformer implements Serializable
 
 serialVersionUID:
 
 1L
- Class com.neurosys.ecom.etl.OrderToMapTransformer extends EntityToMapTransformer implements Serializable
- Class com.neurosys.ecom.etl.OrderURLGeneratorTransformer extends WicketURLGeneratorTransformer implements Serializable
 
 serialVersionUID:
 
 1L
 - Serialized Fields
 - orderIdParamName
```
String orderIdParamName
```
 Default value:
 
 OrderURLGeneratorTransformer.PARAM_OID
 - userIdParamName
```
String userIdParamName
```
 Default value:
 
 OrderURLGeneratorTransformer.PARAM_UID
- Class com.neurosys.ecom.etl.ProductNameTransformer extends ProductNameTransformer<T extends Product> implements Serializable
- Class com.neurosys.ecom.etl.SequenceSubOrderTransformer extends Object implements Serializable
 - Serialized Fields
 - entityManager
```
javax.persistence.EntityManager entityManager
```
Package com.neurosys.ecom.logistics.domain
- Class com.neurosys.ecom.logistics.domain.AbstractArea extends DomainObject implements Serializable
  
  serialVersionUID:
  
  1L
  - Serialized Fields
    - code
```
String code
```
      Region Code
    - type
```
String type
```
      Area Type Country, region, PIN etc. The type will define the format of the code
    - name
```
String name
```
      Name of Area / Locality
    - language
```
String language
```
      What is the language for the Region. Useful to link content to Region
    - currency
```
String currency
```
      Currency for the region
    - active
```
boolean active
```
      Way to switch on or off area without having to update other data to turn it off
      
      Can be null:
      
      false
      
      Default value:
      
      true
    - hierarchy
```
String hierarchy
```
- Class com.neurosys.ecom.logistics.domain.Area extends AbstractArea implements Serializable
  
  serialVersionUID:
  
  1L
  - Serialized Fields
    - parent
```
String parent
```
      Name of Parent Area / Locality
    - paymentCod
```
Boolean paymentCod
```
      Is COD payment option supported for this Area Code
      
      Can be null:
      
      true (Project dependent)
    - paymentOnline
```
Boolean paymentOnline
```
      Is ONLINE payment option supported for this Area Code
      
      Can be null:
      
      true (Project dependent)
    - shipping
```
Boolean shipping
```
      Do shipments happen to this area
      
      Can be null:
      
      true (Project dependent)
    - shippingTariff
```
String shippingTariff
```
      Any additional Shipping tariff detail. Could be JSON or Number type data (Project interpretation dependent)
      
      Can be null:
      
      true
    - criteriaJSON
```
String criteriaJSON
```
      Project dependent JSON representing Deliver
      
      See Also:
      
      DeliveryCriteria
    - notes
```
String notes
```
      Additional notes for Human consumption
- Class com.neurosys.ecom.logistics.domain.Area.Key extends Object implements Serializable
  
  serialVersionUID:
  
  1L
  - Serialized Fields
    - code
```
String code
```
    - type
```
String type
```
- Class com.neurosys.ecom.logistics.domain.DeliveryCriteria extends ModelObject implements Serializable
  
  serialVersionUID:
  
  1L
  - Serialized Fields
    - min
```
Double min
```
      Minimum & maximim values
    - max
```
Double max
```
      Minimum & maximim values
- Class com.neurosys.ecom.logistics.domain.Region extends AbstractArea implements Serializable
  
  serialVersionUID:
  
  1L
  - Serialized Fields
    - id
```
String id
```
      An id to uniquely represent the region. This may or may not be same as AbstractArea.code
    - parent
```
Region parent
```
      Name of Parent Area / Locality
Package com.neurosys.ecom.model
- Class com.neurosys.ecom.model.EComUserShell extends ContextualWebUserShell implements Serializable
 
 serialVersionUID:
 
 1L
 - Serialized Fields
 - shoppingCart
```
Cart shoppingCart
```
 Shopping Cart
 - area
```
AbstractArea area
```
 Any AbstractArea (area, region) related info where this cart will will go
Package com.neurosys.ecom.orders.domain
- Class com.neurosys.ecom.orders.domain.Amount extends DomainObject implements Serializable
 
 serialVersionUID:
 
 -8310358441825557240L
 - Serialized Fields
 - base
```
Double base
```
 In the default behavior/understanding, the base price reflect the regular total of the product
 - discount
```
Double discount
```
 Should be a (-) quantity if discount is being offered. In calculations discount is deducted; hence Amount.deduct(Amount) is called. Hence this should be negative.
 - tax
```
Double tax
```
 - total
```
Double total
```
 - taxReverseCaculated
```
Boolean taxReverseCaculated
```
 In some cases the tax maybe already included in the product/item value. In those cases the baseAmount is re-calculated by subtracting the tax amount (%) from the Product amount.
 If this is done then taxReverseCaculated = true
 - currency
```
String currency
```
 - region
```
String region
```
 - precision
```
Integer precision
```
 When storing decimal numbers or fractions, recurring decimals could be rounded or truncated at some point. For the sake of accuracy, if any number was truncated (precision=0) or precise upto a given number, then that should be specified here.
 
 Can be null:
 
 true (Dont care = false, that the number as is)
 - subAmounts
```
List<E> subAmounts
```
 A Transient field, if NOT null, will also track any sub-calculations (Amount) used in cumulative operations while calculating this Amount.
 
 Can be null:
 
 true
- Class com.neurosys.ecom.orders.domain.BaseOrderItem extends DomainObject implements Serializable
 
 serialVersionUID:
 
 5089684247059154937L
 - Serialized Fields
 - updated
```
Date updated
```
 - quantity
```
Double quantity
```
 - amount
```
Amount amount
```
 Amount spent on ordering quantity items.
 If a product is purchased with N units ; then amount is for all N units.
 - shippingAmount
```
Amount shippingAmount
```
 Amount spent on shipping for ordering quantity items.
 If a product is purchased with N units ; then amount is for all N units.
 - packagingAmount
```
Amount packagingAmount
```
 Amount spent on packaging quantity items.
 If a product is purchased with N units ; then amount is for all N units.
 - status
```
OrderStatus status
```
 - lastStatusReason
```
String lastStatusReason
```
 What was the reason for the last status Update. Useful for System related cases where the order maybe cancelled etc
 
 Can be null:
 
 true
 - comments
```
String comments
```
 Customer comments, special instructions etc
 - promotionNames
```
ArrayList<E> promotionNames
```
 List of any Promotion unique Names applicable
 Maintaining the promotion names, since Promotions maybe removed from the DB and we want the relation to be weak and not require a referential integrity constraint in the data model.
 
 Can be null:
 
 true
 - finalWeight
```
Double finalWeight
```
 Final Weight (may include weight of product, Packaging etc)
 - paymentContext
```
PaymentContext paymentContext
```
- Class com.neurosys.ecom.orders.domain.ConvertedCurrencyOrder extends Order implements Serializable
 
 serialVersionUID:
 
 1L
 - Serialized Fields
 - rate
```
Double rate
```
 Rate of conversion applied to the ConvertedCurrencyOrder.fromCurrency to derive the BaseOrderItem.getAmount().currency.
 If null means no conversion was applied.
 
 Can be null:
 
 true
 - fromCurrency
```
String fromCurrency
```
 The currency from which the currency amount was derived.
 
 Can be null:
 
 true
 - fromAmountDetailsJSON
```
String fromAmountDetailsJSON
```
 The From amount details recorded in JSON format. Application specific on what details it wishes to retain.
 
 Can be null:
 
 true
- Class com.neurosys.ecom.orders.domain.DeliveryDetails extends Object implements Serializable
 
 serialVersionUID:
 
 1L
 - Serialized Fields
 - id
```
Long id
```
 - order
```
Order order
```
 - amount
```
Amount amount
```
 Amount charged for Delivery/Shipping only
 - serviceName
```
String serviceName
```
 Service used to deliver/ship
 - trackingLink
```
String trackingLink
```
 Service providers may offer a way to track the product; the details of the link
 - serviceTrackingId
```
String serviceTrackingId
```
 Tracking ID provided by the service that handles the delivery
 - dispatchDate
```
Date dispatchDate
```
 - lastStatusDate
```
Date lastStatusDate
```
 - estimatedDays
```
int estimatedDays
```
 Estimated Days to deliver
 - actualDays
```
int actualDays
```
 Actual days taken to deliver
 - address
```
String address
```
 Delivery Address
 - notes
```
String notes
```
 Notes about delivery.
 - state
```
String state
```
 Current state of Delivery
 - orderItemWiseBreakUp
```
String orderItemWiseBreakUp
```
 If we want to capture the delivery charges for all OrderItems within an Order
 JSON Array String that has <orderId>:<base amount in same currency as that of DeliveryDetails.amount>
- Class com.neurosys.ecom.orders.domain.Order extends BaseOrderItem implements Serializable
 
 serialVersionUID:
 
 17462631L
 - Serialized Fields
 - id
```
Long id
```
 - paymentMethod
```
PaymentMethod paymentMethod
```
 - steps
```
String steps
```
 In a multi-step Work Flow, the steps are captured that were performed.
 Typical use would be with PaymentMethod.WORK_FLOW, OrderStatus.CAPTURED_AUTO + OrderStatus.PLACED_MANUAL etc
 - strategiesVersion
```
String strategiesVersion
```
 Track the Strategy.getVersion() of all strategies involved that provide their version id.
 - created
```
Date created
```
 Date of creation.
 Useful if Order.purchaseDate is not same as Order.created date
 TODO: Made nullable for now to support projects where col did not exist. Over time convert to non-null.
 - purchaseDate
```
Date purchaseDate
```
 Date when the order was purchased. For a simple work-flow this is the date when its created also.
 - lastInvoiceDate
```
Date lastInvoiceDate
```
 Date the last invoice was sent for this Order
 An order amount can be changed and hence Invoices can be re-sent or for other reason Invoices can be sent multiple times. For accounting purposes in Admin we should reflect the amount of the last sent and not the one, about to be sent
 - user
```
GenericEcomUser user
```
 Orders may contain Order.userContactDetails and hence for GuestUsers in particular, user maybe optional
 
 See Also:
 
 Order.userContactDetails
 
 Can be null:
 
 true
 - userContactDetails
```
String userContactDetails
```
 In addition to the default User Address and contact details; an order may define/override default Address with its own. This also ensures if the user modifies their address or details; for audit purposes we know what the address was @ the point of placing the order.
 Stored as User Contact + Address's as JSON(preferable) String for the order
 
 Note: Order.getUser() also has IGenericEcomUser.getAddresses(); this overrides that, for standard applications. While this can be an application preference; all the Utilities (like Utils.getAddresses(Order) and Utils.getAddress(Order, String) prefer to fetch from Order.userContactDetails.
 
 See Also:
 
 Utils.getAddress(Order, String), Utils.getAddresses(Order)
 - realized
```
Boolean realized
```
 If the order was realized or not. REALIZED implies that on the website the user completed the flow without any problem.
 It does not for sure imply PAYMENT since payment is subject to credit, mode of payment etc. Like in a COD order there is no upfront payment.
 
 One can also rely on BaseOrderItem.getStatus() but typically like OrderStatus.CLOSED can override the state, hence we need a permanent indicator if at the time the Order was realized or not.
 
 Other indirect ways to determine if an order was realized or not is to check the Transaction.getSuccess() for ONLINE orders and for non-transactional orders check the BaseOrderItem.getLastStatusReason()
 - invoiceId
```
String invoiceId
```
 The Invoice ID/Number generated
 Clients maybe picky about Invoice Number formats etc, hence a special field provided so it does not HAVE TO be same as Order or Transaction Number.
 A invoiceId does not have to be unique either; since in complex situation adjustments can be made on the Same Invoice so provides a way to tie multiple transactions cross orders on the same Invoice; if required (ideally not the case but should give provision for such situations)
 
 Can be null:
 
 true
 - type
```
String type
```
 A type to specify the type of order. Like regular sale, Bulk etc
 Application dependent with a default of null
 
 Can be null:
 
 true
 - transaction
```
Transaction<O extends Order> transaction
```
 Last associated successful online Transaction that occoured to fulfill this order
 - transactionIds
```
String transactionIds
```
 An order may have multiple Transactions ; incase there are issues and failures to purchasing the same order a few times. All transaction Ids are captured as a comma separated String for reference purposes
 - actors
```
String actors
```
 - bitmask
```
Integer bitmask
```
 Optional param that allows an Application to define project specific switches (boolean flags) for an Order. The interpretation is application specific and the field just provides a compact way to represent multiple boolean flags.
 
 Can be null:
 
 true
 - statusDate
```
Date statusDate
```
 Date when BaseOrderItem.status was changed
 - params
```
String params
```
 A comma or JSON defined parameter String that allows an Application to define project specific params for an Order. The interpretation is application specific for any type of additional data we want to associate with the Order.
 - items
```
List<E> items
```
 Ordered list of OrderItem
 - deliveryDetails
```
DeliveryDetails deliveryDetails
```
- Class com.neurosys.ecom.orders.domain.OrderItem extends BaseOrderItem implements Serializable
 
 serialVersionUID:
 
 5089684247059154937L
 - Serialized Fields
 - id
```
Long id
```
 - order
```
Order order
```
 - product
```
Product product
```
 WARNING : After an Order is complete or periodically, ORDER ITEMS product should be nullified if the PRODUCT should be removed over time; since due to REF INTEGRITY it will make it difficult to remove PRODUCTS from the SYSTEM.
 
 Can be null:
 
 true
 - sku
```
String sku
```
 - hierarchy
```
String hierarchy
```
 Maintain a copy of Hierarchy code from HierarchialDomainObject.getHierarchy() incase the product is deleted
- Class com.neurosys.ecom.orders.domain.PaymentOption extends ModelObject implements Serializable
 
 serialVersionUID:
 
 1L
 - Serialized Fields
 - paymentMethod
```
PaymentMethod paymentMethod
```
 - option
```
String option
```
 Unique name of the option for that Payment Method
- Class com.neurosys.ecom.orders.domain.Promotion extends DomainObject implements Serializable
 
 serialVersionUID:
 
 1L
 - Serialized Fields
 - name
```
String name
```
 A name to identify the promotion / campaign
 
 Note: Details and rule of how the promotion impacts Quantity for any given user or type of user can be defined by the application in the form of Rules etc. Thats the job of the SaleStrategy
 
 Can be null:
 
 false
 - displayName
```
String displayName
```
 User friendly name for the promotion
 - type
```
Promotion.Type type
```
 The type, like some CAMPAIGN, DISCOUNT, USER COUPON, REFUND etc.
 
 Note: Details and rule of how the promotion impacts Quantity for any given user or type of user can be defined by the application in the form of Rules etc. Thats the job of the SaleStrategy
 
 Can be null:
 
 true
 - validityStart
```
Date validityStart
```
 The validity start Date range and end date range
 
 Can be null:
 
 true
 - validityEnd
```
Date validityEnd
```
 The validity start Date range and end date range
 
 Can be null:
 
 true
 - active
```
boolean active
```
 Is the promotion currently marked active
 Useful if we want to disable the promotion temp.
 
 Default value:
 
 true
 - criteriaJson
```
String criteriaJson
```
 Any additional Data to describe the Promotion meta-data criteria like who, how many times can the same user use it, how is a user identified, and how people are eligible for it etc.
 This JSON is intended to be App specific where the PromotionStrategy can interpret the JSON criteria
 - amountJson
```
String amountJson
```
 Details about the Discount/Promotion itself like Amount, Unit, Currency etc.
 This JSON is intended to be App specific where the PromotionStrategy can interpret the JSON criteria
 - description
```
String description
```
 Description for reference purposes
- Class com.neurosys.ecom.orders.domain.PromotionForUser extends DomainObject implements Serializable
 
 serialVersionUID:
 
 1L
 - Serialized Fields
 - id
```
Long id
```
 - code
```
String code
```
 A unique code for the Coupon / user combo
 This can be pre-generated and a user maybe expected to match this code to avail the pre-generated Coupon
 
 Can be null:
 
 false
 - userId
```
String userId
```
 Identify the user who got the promotion
 
 Can be null:
 
 false
 - promotion
```
Promotion promotion
```
 The Promotion
 
 Can be null:
 
 false
 - status
```
String status
```
 Any status for record keeping
 
 Can be null:
 
 true
 - useCount
```
Integer useCount
```
 Number of times the Promotion was used by this user
 
 Can be null:
 
 true; if user for some reason never availed of it or was granted but then revoked
 - lastAvailed
```
Date lastAvailed
```
 When the promotion was last availed by this user
 
 Can be null:
 
 true; If null not availed or dont care
- Class com.neurosys.ecom.orders.domain.RelatedOrder extends Order implements Serializable
 
 serialVersionUID:
 
 1L
 - Serialized Fields
 - root
```
Order root
```
 Parent/Root order that generates this SubOrder
 If the Parent is of SubOrder type, then the parent of it will be null.
 
 Can be null:
 
 true
 - succeded
```
Boolean succeded
```
 If another RelatedOrder is created for this one that succeeds it.
- Class com.neurosys.ecom.orders.domain.SubOrder extends RelatedOrder<O extends Order,I extends OrderItem> implements Serializable
 
 serialVersionUID:
 
 1L
 - Serialized Fields
 - previous
```
SubOrder<O extends Order,I extends OrderItem> previous
```
 In the sequence of Orders created, the previous SubOrder
 The first most element may or may not be the parent. If the parent type is SubOrder then it is likely to be the parent.
 
 Can be null:
 
 true
 - next
```
SubOrder<O extends Order,I extends OrderItem> next
```
 In the sequence of Orders created, the next SubOrder
 The first most element may or may not be the parent. If the parent type is SubOrder then it is likely to be the parent.
 
 Can be null:
 
 true
 - partialAmount
```
Amount partialAmount
```
 Amount the SubOrder is worth / Partial Payment Amount
 - hierarchy
```
String hierarchy
```
 Relative to its RelatedOrder.getRoot(); the sequence IHierarchialReferenceSubOrder.getHierarchy()
- Class com.neurosys.ecom.orders.domain.Transaction extends DomainObject implements Serializable
 
 serialVersionUID:
 
 7867701898754728047L
 - Serialized Fields
 - id
```
String id
```
 Transaction Id : Typically generated as a combination of
 - gatewayId
```
String gatewayId
```
 - gatewayTransactionId
```
String gatewayTransactionId
```
 A unique transaction Id generated by the gateway
 This is generated by the gateway and the Transaction.id is assigned by the calling API.
 
 Can be null:
 
 true, if it never got back from the Gateway
 - issuerTransactionId
```
String issuerTransactionId
```
 If multiple parties are involved, then the gateway maybe an intermediate party. In that case we may also want the reference/transaction id from the issuing/credit/debt service provider/bank.
 - order
```
Order order
```
 - success
```
Boolean success
```
 Was the transaction successful or Not
 Note: A Transaction may have two aspects.
 
 Where the REQUEST to the Payment Service is established
 
 Where the RESPONSE is validated from the Payment Service
 
 ...one should ensure Transaction.success is set true ONLY when the response is successful.
 - gatewayResultCode
```
String gatewayResultCode
```
 A response/Result mnemonic from the gateway indicating the final result of the Transaction
 - issuerResultCode
```
String issuerResultCode
```
 A response/Result mnemonic from the Issuer indicating the final result of the Transaction
 - resultDesc
```
String resultDesc
```
 Result Description if any provided by the gateway to supplement the #resultCode
 - failureGatewayResponse
```
String failureGatewayResponse
```
 Specific reason for gateway Failure
 - failureIssuerResponse
```
String failureIssuerResponse
```
 Specific reason for issuer Failure
 - actualDateTime
```
String actualDateTime
```
 Date time the transaction was conducted The String format is used to preserve in format as sent by gateway
 - dateTime
```
Date dateTime
```
 When the system got the response and recorded it
 Should be set as soon as the Transaction flow returns control to the API that called the transaction and gets the Response Code.
 - type
```
String type
```
 Transaction type details/code
 - gatewayResponseJSON
```
String gatewayResponseJSON
```
 Capture any other flags and attributes from the gateway in a JSON String
 - gatewayRequestParams
```
String gatewayRequestParams
```
 When being redirected to gateway/Service; capture the URL param details
 - amount
```
TransactionAmount amount
```
 Transaction amount
 We want to maintain the details @ the transaction level in addition to Order because Orders may be modified.
 We can tract at the point in time, what was the exact amount transacted.
 
 Can be null:
 
 false
 - fee
```
TransactionAmount fee
```
 An optional transaction fee
 
 Can be null:
 
 true
- Class com.neurosys.ecom.orders.domain.TransactionAmount extends DomainObject implements Serializable
 
 serialVersionUID:
 
 -8310358441825557240L
 - Serialized Fields
 - amount
```
Double amount
```
 The amount
 
 Can be null:
 
 true : Transactions with errors can have a null amount
 - currency
```
String currency
```
 The currency
 
 Can be null:
 
 true
 - conversionMetaData
```
String conversionMetaData
```
 Details about currency conversion (if any).
 Implementation is Application dependent.
 Preferably the rate value or in JSON format. E.g: {from:"INR", to:"USD", rate:0.0124 ..., round:true}
Package com.neurosys.ecom.orders.events
- Class com.neurosys.ecom.orders.events.InvoiceChangeListener extends Object implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.neurosys.ecom.orders.events.OrderItemProductChangeListener extends Object implements Serializable
  
  serialVersionUID:
  
  1L
  - Serialized Fields
    - em
```
javax.persistence.EntityManager em
```
Package com.neurosys.ecom.orders.exception
- Class com.neurosys.ecom.orders.exception.OrderPlacementException extends Exception implements Serializable
 
 serialVersionUID:
 
 -223977907457190780L
 - Serialized Fields
 - order
```
Order order
```
 The Order that triggered/caused the Exception
- Class com.neurosys.ecom.orders.exception.TransactionException extends Exception implements Serializable
 
 serialVersionUID:
 
 -223977907457190780L
 - Serialized Fields
 - transaction
```
Transaction<O extends Order> transaction
```
 The Order that triggered/caused the Exception
- Class com.neurosys.ecom.orders.exception.WebPageTransactionRequest extends Continue implements Serializable
 
 serialVersionUID:
 
 1L
- Class com.neurosys.ecom.orders.exception.WebURLPageTransactionRequest extends Continue implements Serializable
 
 serialVersionUID:
 
 1L
Package com.neurosys.ecom.orders.strategy
- Class com.neurosys.ecom.orders.strategy.ExceptionalOrderConversation extends Order implements Serializable
 
 serialVersionUID:
 
 1L
 - Serialized Fields
 - currentProposedOrder
```
Order currentProposedOrder
```
 The current proposed order
 - state
```
ExceptionalOrderConversation.State state
```
Package com.neurosys.ecom.products.domain
- Class com.neurosys.ecom.products.domain.Product extends Product implements Serializable
  
  serialVersionUID:
  
  -4161564817253936742L
  - Serialized Fields
    - sku
```
String sku
```
      SKU - Stock Keeping Unit, uniquely identifies a product in stock
      In face this product represents a collection then also this maybe null since business may not have defined this for a group of products.
    - regularPrice
```
Double regularPrice
```
    - salePrice
```
Double salePrice
```
    - currentInventory
```
Integer currentInventory
```
    - keywords
```
String keywords
```
    - shippingData
```
String shippingData
```
      Shipping related info. Could be a Price, String or JSON.
      Subject to custom interpretation based on project.
    - packagingData
```
String packagingData
```
      Packaging related info. Could be a Price, String or JSON.
      Subject to custom interpretation based on project.
    - taxData
```
String taxData
```
      Taxation related Info. Could be a %'age or a complex JSON meta-data rule to be interpreted by a tax specific Strategy (custom) to organization.
      Subject to custom interpretation based on project.
    - sale
```
Boolean sale
```
      Is the product on Sale; true implies it is
      If on Sale the sale price can be offered, but this depends on the service layer.
    - newItem
```
Boolean newItem
```
      Is the product a new Item
    - searchable
```
Boolean searchable
```
      Is the product searchable.
      Since multiple objects for the same model are present, we may not want to show all SKU's and only some
      We can explicitly turn this off for a particular SKU to omit from the search result. Note: This also depends on if the item was indexed, if search indices are used.
    - colors
```
String colors
```
      Comma separated values of Colors
    - size
```
Size size
```
    - added
```
Date added
```
      Keep track of product inserts & updates
    - updated
```
Date updated
```
      Keep track of product inserts & updates
    - availability
```
String availability
```
      Some products may not be available to be Sold Online or available for a specific purpose
      
      Can be null:
      
      true (null implies default or no relevance and can be ignored)
    - weight
```
Double weight
```
      Weight of a Product in a unit understood/assumed/set @ a project level.
- Class com.neurosys.ecom.products.domain.ProductReference extends ProductReference implements Serializable
  
  serialVersionUID:
  
  1L
  - Serialized Fields
    - sku
```
String sku
```
Package com.neurosys.ecom.strategy.service
- Class com.neurosys.ecom.strategy.service.LockStrategy.LockException extends Exception implements Serializable

Package com.neurosys.ecom.user.service.jaxrs

Class com.neurosys.ecom.user.service.jaxrs.StrategiesService extends SecurableService implements Serializable

Serialized Fields

shippingStrategy

CumulativeChargeStrategy<P extends Product,U extends User> shippingStrategy

taxStrategy

CumulativeChargeStrategy<P extends Product,U extends User> taxStrategy

packagingStrategy

CumulativeChargeStrategy<P extends Product,U extends User> packagingStrategy

saleStrategy

SaleStrategy<P extends Product,U extends User> saleStrategy

productService

ProductService<T extends Product> productService

promotionStrategy

PromotionStrategy<P extends Product,U extends User> promotionStrategy

contextProviderStrategy

ContextProviderStrategy<U extends User,CONTEXT> contextProviderStrategy

areaStrategy

AreaStrategy<A extends AreaType,C> areaStrategy

currencyStrategy
```
CurrencyStrategy currencyStrategy
```
adapterService
```
AdapterService<SCRIPT_OBJECT> adapterService
```
Strategies can be Adapters; that can be updated @ runtime. If the ability to modify them @ runtime is desired we can define Strategies as scripts and update then via the AdapterService

Can be null:

true

throwableToMessage

org.apache.commons.collections.Transformer throwableToMessage

Marshal errors to just their messages

cartProductTransform

CartProductTransformService<P extends Product,CI extends CartItem> cartProductTransform

Handle All conversions

See Also:: CartProductTransformService

Package com.neurosys.ecom.user.wicket.components
- Class com.neurosys.ecom.user.wicket.components.AbstractForgotPasswordForm extends org.apache.wicket.markup.html.form.StatelessForm<String> implements Serializable
 
 serialVersionUID:
 
 1L
- Class com.neurosys.ecom.user.wicket.components.AbstractUserLoginForm extends AbstractLoginForm<S extends EComSession,R extends RegisteredUser<?>> implements Serializable
 
 serialVersionUID:
 
 1L
Package com.neurosys.ecom.users.domain
- Class com.neurosys.ecom.users.domain.Address extends DomainObject implements Serializable
 
 serialVersionUID:
 
 6210058475007648023L
 - Serialized Fields
 - id
```
Long id
```
 - user
```
GenericEcomUser user
```
 - type
```
String type
```
 - address
```
String address
```
 - city
```
String city
```
 - state
```
String state
```
 - country
```
String country
```
 - code
```
String code
```
 - phone
```
String phone
```
 - mobile
```
String mobile
```
- Class com.neurosys.ecom.users.domain.AdminUser extends AdminUser implements Serializable
 
 serialVersionUID:
 
 -8405332303996328668L
- Class com.neurosys.ecom.users.domain.GenericEcomUser extends AbstractUser implements Serializable
 
 serialVersionUID:
 
 -4792018411448120656L
 - Serialized Fields
 - seq
```
Long seq
```
 - firstName
```
String firstName
```
 Can be null:
 
 false
 - middleName
```
String middleName
```
 - lastName
```
String lastName
```
 - addresses
```
Map<K,V> addresses
```
 - createDate
```
Date createDate
```
 - dob
```
Date dob
```
 - phone
```
String phone
```
 - email
```
String email
```
- Class com.neurosys.ecom.users.domain.GuestUser extends GenericEcomUser implements Serializable
 
 serialVersionUID:
 
 2560468771554227464L
 - Serialized Fields
 - ipaddress
```
String ipaddress
```
 - userAgent
```
String userAgent
```
 Type of device used by the user
 - alias
```
String alias
```
 Can be used for Login for Guest users also
 
 Can be null:
 
 false
 - userId
```
String userId
```
- Class com.neurosys.ecom.users.domain.RegisteredUser extends GenericEcomUser implements Serializable
 
 serialVersionUID:
 
 -8405332303196328668L
 - Serialized Fields
 - loginId
```
String loginId
```
 - authorizations
```
String authorizations
```
 JSON String to represent a Map of <String, Authorization> per module. The key is the module name.
 - roles
```
String roles
```
 - bitmask
```
int bitmask
```
 - visit
```
Integer visit
```
 This user has visited/logged-in how many times
 - lastLogin
```
Date lastLogin
```
- Class com.neurosys.ecom.users.domain.RegisteredUserCredentials extends BasicCredentials implements Serializable
 
 serialVersionUID:
 
 7046385327228651188L
Package com.neurosys.ecom.wicket.components
- Class com.neurosys.ecom.wicket.components.EComSession extends ContextualSession> implements Serializable
 
 serialVersionUID:
 
 1L
Package com.neurosys.etl.common
- Class com.neurosys.etl.common.ETLMeta extends Object implements Serializable
 
 serialVersionUID:
 
 1L
 - Serialized Fields
 - entityProcessor
```
org.apache.commons.collections.Transformer entityProcessor
```
 Post process an additional/optional Processor
 
 Can be null:
 
 true
 - supportsVerifyOnly
```
boolean supportsVerifyOnly
```
 Some processes may run as verification without committing or making changes. (Dry Run)
 If true this will present the option to run in Verify Only mode
 
 Default value:
 
 false
 - inputParamsMetas
```
List<E> inputParamsMetas
```
 The ETL Process may demand input parameters; we can define the input parameters and present them using additional info from PARAM_META (like FacetMeta)
 Example for a SEARCH PANEL to accept INPUT Search terms for "First Name":
 PARAM_META = com.neurosys.template.model.Template$FacetMeta
 <property name="name" value="0" /> 
 <property name="displayName" value="First Name" />
 <property name="type" value="INPUT" />
 <property name="submitTransformer"><bean class="com.neurosys.etl.common.transformers.PrefixSuffixTransformer"> 
 <property name="prefix" value="%" />
 <property name="suffix" value="%" />
 
 Can be null:
 
 true
- Class com.neurosys.etl.common.LookupChain extends TransformerChain implements Serializable
 - Serialized Fields
 - lookups
```
List<E> lookups
```
- Class com.neurosys.etl.common.SerializableTransformerChain extends Object implements Serializable
 
 serialVersionUID:
 
 1L
- Class com.neurosys.etl.common.SimpleMapLookup extends HashMap<Object,Object> implements Serializable
 
 serialVersionUID:
 
 1L
- Class com.neurosys.etl.common.TransformerChain extends Object implements Serializable
 
 serialVersionUID:
 
 1L
 - Serialized Fields
 - transformers
```
List<E> transformers
```
 - collectExceptions
```
boolean collectExceptions
```
 If true will collect ContinueProcessingExceptions and throw a WrapperException with a LinkedHashMap of the Transformer that caused and the particular Exception
 
 Default value:
 
 false
 - chainOutput
```
boolean chainOutput
```
 If true, the output from previous transformation becomes input for the next. If false, each transformer in the chain will get the input and output will be the input.
 Possible use cases of using false are parallel processing, independent event handlers to an input.
 
 See Also:
 
 TransformerParallel
 
 Default value:
 
 true
 - maintainContext
```
boolean maintainContext
```
 If true, will create a Context as a List of outputs generated by each transformer per mutually exclusive chain, including the original input as the first (0th index), element.
 So for TransformerChain.chainOutput true, the context list will contain the first input and then every subsequent output produced in the chain. A Transformer that ContextAware will be passed the context not the output of the previous step then. Similarly if TransformerChain.chainOutput is false, then logically the context can only be the original input (which is no different) from passing it directly. So it will ignore TransformerChain.maintainContext TODO: Add Unit Test Case for this scenario
 
 Default value:
 
 false
Package com.neurosys.etl.common.exceptions
- Class com.neurosys.etl.common.exceptions.BreakChainException extends RuntimeException implements Serializable
 
 serialVersionUID:
 
 1L
 - Serialized Fields
 - exceptions
```
List<E> exceptions
```
 If a Process wishes to finish before throwing the exception; all other exceptions can be trapped
 - cause
```
BreakChainException.CauseType cause
```
- Class com.neurosys.etl.common.exceptions.ContinueProcessingException extends RuntimeException implements Serializable
 
 serialVersionUID:
 
 1L
- Class com.neurosys.etl.common.exceptions.RequireLookAheadException extends ContinueProcessingException implements Serializable
 
 serialVersionUID:
 
 1L
- Class com.neurosys.etl.common.exceptions.WrapperException extends RuntimeException implements Serializable
 
 serialVersionUID:
 
 1L
 - Serialized Fields
 - object
```
Object object
```
Package com.neurosys.etl.common.mapper
- Class com.neurosys.etl.common.mapper.LookupMapper extends Mapper<Lookup> implements Serializable
- Class com.neurosys.etl.common.mapper.Mapper extends Object implements Serializable
 - Serialized Fields
 - entityClass
```
Class<T> entityClass
```
 - id
```
String id
```
 During Error handling its useful to point @ the mapper if there is no fieldName specified
 - fieldName
```
String fieldName
```
 The field the result of the mapper is intended for
 null could be of the following reasons:
 
 The Mapper value can be applied as an Intermediate variable if the Mapper.getBehavior(Class) has IntermediateResultMapperBehavior.
 
 The Mapper value can be applied over the entity itself
 Can be null:
 
 true
 - processor
```
Object processor
```
 The processor that will perform the processing activity.
 T will be of type Transformer, Predicate or Lookup Chain
 If null will return the original value as is
 
 Can be null:
 
 true
 - behaviors
```
Map<K,V> behaviors
```
- Class com.neurosys.etl.common.mapper.MapperChain extends Mapper<List<Chain>> implements Serializable
- Class com.neurosys.etl.common.mapper.MapperMutate extends Mapper implements Serializable
 - Serialized Fields
 - fieldName
```
String fieldName
```
 - fieldValue
```
Object fieldValue
```
- Class com.neurosys.etl.common.mapper.TransformerMapper extends Mapper<org.apache.commons.collections.Transformer> implements Serializable
Package com.neurosys.etl.common.transformers
- Class com.neurosys.etl.common.transformers.AbstractEntityToTupleTransformer extends AbstractEntityTransformer<ENTITY,Object,TUPLE> implements Serializable
 
 serialVersionUID:
 
 -419145197997777475L
- Class com.neurosys.etl.common.transformers.AbstractEntityTransformer extends EventAwareProcess implements Serializable
 
 serialVersionUID:
 
 1L
 - Serialized Fields
 - entityAccessTransformer
```
org.apache.commons.collections.Transformer entityAccessTransformer
```
 Allow query sub-properties etc if provided (A clone of this is used in AbstractEntityTransformer.getValue(Object, Object, Mapper))
 
 See Also:
 
 AbstractEntityTransformer.getValue(Object, Object, Mapper)
 
 Can be null:
 
 true
 - columnFieldMapping
```
Map<K,V> columnFieldMapping
```
 Mapper from Tuple Column Index/Field Name to a particular field (one to one); index # starts @ 0
 - nonAssociatedMappers
```
List<E> nonAssociatedMappers
```
 Mapper that uses the tuple/Row to extract data to map to particular column
 - nestedObjectInitMap
```
Map<K,V> nestedObjectInitMap
```
 (Optional) Map that allows to instantiate an object for a nested property in the main Entity. The key is the name of the property, value can be a Class, instance itself or a Transformer that accepts an Object array {key as field name, value of field}, and generates an instance. One can also pre-init in AbstractEntityTransformer.init(Object, Map). This is used when @ runtime we need a nested object created for a value being set.
 
 See Also:
 
 for the implementation
 - mode
```
Mode mode
```
 Mode ; defaults to Mode.INSERT. Mappers that are ModeAware will consult this field in derived implementations.
 - idempotent
```
boolean idempotent
```
 By default if run changes will propogate
 
 Default value:
 
 true
 - modesSupported
```
List<E> modesSupported
```
 What all modes does this Reader support
 Default All defined in Mode
- Class com.neurosys.etl.common.transformers.AbstractObjectToEntityTransformer extends AbstractEntityTransformer<NODE,String,ENTITY> implements Serializable
 
 serialVersionUID:
 
 1L
 - Serialized Fields
 - currentNodeIndex
```
int currentNodeIndex
```
- Class com.neurosys.etl.common.transformers.AbstractReverseTupleToEntityTransformer extends AbstractEntityToTupleTransformer<ENTITY,TUPLE> implements Serializable
 
 serialVersionUID:
 
 1L
 - Serialized Fields
 - tupleToEntityTransformer
```
AbstractTupleToEntityTransformer<TUPLE,CELL,ENTITY> tupleToEntityTransformer
```
 AbstractTupleToEntityTransformer this this Transformer will mirror
 - overridableMap
```
AbstractReverseTupleToEntityTransformer.OverridableHashMap overridableMap
```
 Override Mappers that are required to explicitly provide a Reverse Transformation process
- Class com.neurosys.etl.common.transformers.AbstractReverseTupleToEntityTransformer.OverridableHashMap extends HashMap<Integer,Mapper> implements Serializable
 - Serialized Fields
 - columnNumberToFieldNameMap
```
Map<K,V> columnNumberToFieldNameMap
```
 - fieldNameToColumnNumberMap
```
Map<K,V> fieldNameToColumnNumberMap
```
 - overrideMap
```
Map<K,V> overrideMap
```
 - nonAssociatedMappers
```
List<E> nonAssociatedMappers
```
- Class com.neurosys.etl.common.transformers.AbstractTupleToEntityTransformer extends AbstractEntityTransformer<TUPLE,CELL,ENTITY> implements Serializable
 
 serialVersionUID:
 
 1L
- Class com.neurosys.etl.common.transformers.CollectionToStringTransformer extends Object implements Serializable
 
 serialVersionUID:
 
 1L
 - Serialized Fields
 - delimiter
```
String delimiter
```
 If specified will join the elements using the delimiter.
 
 Can be null:
 
 true
 
 Default value:
 
 ,
 - elementTransformer
```
org.apache.commons.collections.Transformer elementTransformer
```
 If specified will apply the Transformer to each individual element
 
 Can be null:
 
 true
- Class com.neurosys.etl.common.transformers.CollectionTransformer extends Object implements Serializable
 
 serialVersionUID:
 
 1L
 - Serialized Fields
 - transformer
```
org.apache.commons.collections.Transformer transformer
```
 - ignoreNulls
```
boolean ignoreNulls
```
 If true, will ignore any null values in the collection type input.
 
 Default value:
 
 true
 - copy
```
boolean copy
```
 If true will make a copy of the original Collection and modify that.
 
 Default value:
 
 false
- Class com.neurosys.etl.common.transformers.ContextMapperTransformer extends HashMap implements Serializable
 - Serialized Fields
 - mappers
```
List<E> mappers
```
 List of Mappers that will act on the input to create context variables
 - threadSafe
```
boolean threadSafe
```
 If true, ten for each thread a new context is provided
 
 Default value:
 
 true
 - referenceType
```
Class<T> referenceType
```
 The Context can maintain a Strong Reference (null), WeakReference or SoftReference to the elements in it.
 Define the class if we explicitly want to dictate the type.
 
 Note: If ContextMapperTransformer.threadSafe is true, it is recommended that the either a WeakReference or a SoftReference be adopted.
 
 Default value:
 
 null
- Class com.neurosys.etl.common.transformers.DateTransformer extends Object implements Serializable
 - Serialized Fields
 - format
```
DateFormat format
```
 Expected output DateFormat
 
 Can be null:
 
 true
 - inputFormat
```
DateFormat inputFormat
```
 If input is a String type then this must be supplied else can be null DateFormat
 
 Can be null:
 
 true
 - outputType
```
Class<T> outputType
```
 By default will generate a String, but one can choose between Date, Calendar and String types
 - addSeconds
```
Number addSeconds
```
 If specified will Add/Subtract (if <0) the seconds to the output Date time
 
 Can be null:
 
 true
- Class com.neurosys.etl.common.transformers.DecimalFormatter extends Object implements Serializable
 
 serialVersionUID:
 
 1L
 - Serialized Fields
 - format
```
String format
```
 The format
 
 Default value:
 
 #,###.00
 - rawFormat
```
DecimalFormat rawFormat
```
- Class com.neurosys.etl.common.transformers.DefaultCreateEntityTransformer extends Object implements Serializable
 
 serialVersionUID:
 
 1L
 - Serialized Fields
 - type
```
Class<T> type
```
 if provided and input is null then return instance of type T
 
 Can be null:
 
 true
 - queryTransformer
```
org.apache.commons.collections.Transformer queryTransformer
```
 If defined, will fetch T from query from the input
 
 Can be null:
 
 true
 
 Default value:
 
 true
- Class com.neurosys.etl.common.transformers.DefaultValueTransformer extends Object implements Serializable
- Class com.neurosys.etl.common.transformers.EnsureAccessorExistsTransformer extends UsesIntermediateObjectImpl<Map<String,Object>> implements Serializable
 
 serialVersionUID:
 
 1L
 - Serialized Fields
 - mode
```
Mode mode
```
 - modesSupported
```
List<E> modesSupported
```
 What all modes does this Reader support
 Default All defined in Mode
 - accessor
```
String accessor
```
 A dot separated list of entities. Parent accessor first , attribute node last.
 Example: attributes.attrib1
 - accessClasses
```
Map<K,V> accessClasses
```
 For each accessor in the EnsureAccessorExistsTransformer.accessor provide a Constructor Class
 - accessValues
```
Map<K,V> accessValues
```
 For each accessor in the EnsureAccessorExistsTransformer.accessor provide a default Value.
 If it exists it will override accessClasses for same type.
- Class com.neurosys.etl.common.transformers.EntityChainAccessTransformer extends UsesIntermediateObjectImpl implements Serializable
 - Serialized Fields
 - accessor
```
String accessor
```
 A string representation in a.b.c format; where any word represents a property as an entity or a map.
 - jsonTransformer
```
org.apache.commons.collections.Transformer jsonTransformer
```
 If provided; will attempt to convert a String intermediate-input in chain; and extract the JSON property directly
 Performance Note: Using a JSON transformer for a Field maybe convenient; however it also results in a conversion cost. For scenarios; where multiple fields have to be derived from the same JSON you maybe better off caching or using a once converted JSON object and referring to it rather than transforming again and again for each access.
 - returnNullOnException
```
boolean returnNullOnException
```
 If a property or value is not found should exceptions be allowed to propagate or mute and return null
 
 Default value:
 
 false
- Class com.neurosys.etl.common.transformers.EntitySelfTransformer extends AbstractObjectToEntityTransformer<E,E> implements Serializable
 
 serialVersionUID:
 
 1L
- Class com.neurosys.etl.common.transformers.EntityToListTransformer extends AbstractEntityToTupleTransformer<ENTITY,List<T>> implements Serializable
 
 serialVersionUID:
 
 8104505316144290481L
- Class com.neurosys.etl.common.transformers.EntityToMapTransformer extends Object implements Serializable
- Class com.neurosys.etl.common.transformers.EntityToObjectArrayTransformer extends AbstractEntityToTupleTransformer<ENTITY,Object[]> implements Serializable
 
 serialVersionUID:
 
 8104505316144290481L
- Class com.neurosys.etl.common.transformers.IdentifiableTransformer extends Object implements Serializable
 
 serialVersionUID:
 
 1L
 - Serialized Fields
 - id
```
Object id
```
 - transformer
```
org.apache.commons.collections.Transformer transformer
```
- Class com.neurosys.etl.common.transformers.IterableToMapTransformer extends Object implements Serializable
 
 serialVersionUID:
 
 1L
 - Serialized Fields
 - sequence
```
String[] sequence
```
 Sequence of names to map to the variables in the order of the index of the name
 - unmappedNameTransformer
```
org.apache.commons.collections.Transformer unmappedNameTransformer
```
 Any index not in sequence; the index will be passed to this and the output will be the variable name. If this is null; then the index itself will become the key as Integer.
 
 Can be null:
 
 true

Package com.neurosys.etl.excel.readers

Class com.neurosys.etl.excel.readers.ExcelContextualReader extends ExcelRowByRowReader<T> implements Serializable

serialVersionUID:

1L

Serialized Fields

recordsForReProcessing

Queue<E> recordsForReProcessing

Whichever records require lookup of data that may not exist yet can be queued up

Class com.neurosys.etl.excel.readers.ExcelRowByRowReader extends AbstractReader<org.apache.poi.ss.usermodel.Row,T,Long> implements Serializable

serialVersionUID:

1L

Serialized Fields

TIMEOUT_LOAD_IO_SECONDS

int TIMEOUT_LOAD_IO_SECONDS

The time it should load the file in

worksheetIndex

int worksheetIndex

One reader can be assigned to one worksheet. This is the index in the workbook that corresponds to the worksheet it will read.

Default value:

0

Package com.neurosys.etl.excel.transformers

Class com.neurosys.etl.excel.transformers.AbstractExcelRowToEntityTransformer extends AbstractTupleToEntityTransformer<org.apache.poi.ss.usermodel.Row,org.apache.poi.ss.usermodel.Cell,T> implements Serializable

serialVersionUID:

1L

Serialized Fields

encoding

String encoding

convertBlankCellToNullValue

boolean convertBlankCellToNullValue

When dealing with Numbers in the tuple, if this is false then 0 is returned as per Cell.getNumericCellValue().
To avoid conversion to 0, one can set this to true.

To override @ a columns level see OutputTypeAwareMapperBehavior

See Also:

OutputTypeAwareMapperBehavior

Default value:

false

Class com.neurosys.etl.excel.transformers.ExcelRowToAbstractEntityTransformer extends AbstractExcelRowToEntityTransformer<T> implements Serializable

serialVersionUID:

1L

Package com.neurosys.etl.process

Class com.neurosys.etl.process.EventAwareProcess extends Object implements Serializable

serialVersionUID:

1L

Serialized Fields

listeners

Collection<E> listeners

processState

ProcessState processState

Class com.neurosys.etl.process.ProcessState extends Object implements Serializable

serialVersionUID:

1L

Serialized Fields

process

Process process

batch

Object batch

tuple

Object tuple

property

Object property

propertyName

String propertyName

propertyAttributes

Map<K,V> propertyAttributes

exception

Exception exception

Package com.neurosys.etl.processors.batch

Class com.neurosys.etl.processors.batch.DaemonBufferSplitter extends EventAwareProcess implements Serializable

serialVersionUID:

1L

Serialized Fields

buffer

BlockingQueue<E> buffer

batch

List<E> batch

alive

boolean alive

BUFFERED_MODE

boolean BUFFERED_MODE

MAX_BUFFER_SIZE

int MAX_BUFFER_SIZE

MIN_BUFFER_SIZE

int MIN_BUFFER_SIZE

BUFFER_HOLD_TIME

int BUFFER_HOLD_TIME

Class com.neurosys.etl.processors.batch.SerialBufferSplitter extends EventAwareProcess implements Serializable

Serialized Fields

batchSize

int batchSize

process

boolean process

Package com.neurosys.etl.readers

Class com.neurosys.etl.readers.AbstractReader extends BaseIterativeProcessor<TUPLE_IN,RECORD_OUT,STATE> implements Serializable

serialVersionUID:

1L

Class com.neurosys.etl.readers.BaseIterativeProcessor extends EventAwareProcess implements Serializable

serialVersionUID:

1L

Serialized Fields

resource

org.springframework.core.io.Resource resource

index

long index

id

Object id

An optional id to identify the Process. This is only required usually when there are multiple instances of the same Reader/Processor and we have to identify a reader of the same class from another instance.

Can be null:

true

meta

String meta

Meta Data like Description etc. Can be plain text or JSON.
Application defined.

Can be null:

true

failFast

boolean failFast

If true will exit on first exception else will collect exceptions

exceptions

Collection<E> exceptions

Used if failFast is off (false)

messages

Collection<E> messages

Messages generated during the process

params

Object[] params

Additional Params for the ETL Process

transformer

org.apache.commons.collections.Transformer transformer

Converts raw record TUPLE_IN Object to type RECORD_OUT

Can be null:

true, if null then TUPLE_IN = RECORD_OUT

filter

org.apache.commons.collections.Predicate filter

Filter lines or records that should be ignored perhaps; Records that the user may have used for formatting etc perhaps.
If the filter predicate returns false, then it will not be available in BaseIterativeProcessor.next()

The Predicate.evaluate(Object) may return false or even throw a RuntimeException.

Can be null:

true

hasNext

boolean hasNext

If turned off then hasNext wont work and processes will terminate

paused

boolean paused

Class com.neurosys.etl.readers.ChainIterativeReader extends AbstractReader<TUPLE_IN,RECORD_OUT,STATE> implements Serializable

serialVersionUID:

1L

Serialized Fields

processes

List<E> processes

size

Long size

Class com.neurosys.etl.readers.ExecuteJobReader extends AbstractReader<Void,Void,Void> implements Serializable

Serialized Fields

size

Long size

sizeTransformer

org.apache.commons.collections.Transformer sizeTransformer

Counts the size for the set Job

Class com.neurosys.etl.readers.FileReader extends AbstractReader<File,T,S> implements Serializable

serialVersionUID:

1L

Serialized Fields

recurse

boolean recurse

If true, will recurse through sub-folders and drill down

Default value:

true

fileIter

Iterator<E> fileIter

size

Long size

Package com.neurosys.etl.service

Class com.neurosys.etl.service.ETLRunnerOptions extends Object implements Serializable

Serialized Fields

verifyOnly

boolean verifyOnly

failFast

boolean failFast

mode

Mode mode

See Also:

Mode

jobParams

Object[] jobParams

Input / Job parameters

Can be null:

true

resource

org.springframework.core.io.Resource resource

Specified Resource

Package com.neurosys.etl.web.transformers

Class com.neurosys.etl.web.transformers.WebURLGeneratorTransformer extends URLGeneratorTransformer implements Serializable

serialVersionUID:

1L

Serialized Fields

prefixRequired

boolean prefixRequired

prefix

String prefix

Server host info including protocol to be used. Should end with a trailing /

baseUrlStr

String baseUrlStr

Package com.neurosys.events

Class com.neurosys.events.AbstractChainChangeListener extends Object implements Serializable

serialVersionUID:

-5543508250389129958L

Class com.neurosys.events.AsynchronousChangeListener extends AbstractChainChangeListener<T> implements Serializable

serialVersionUID:

-5543508250389129958L

Class com.neurosys.events.ChangeListenerWrapperTransformer extends Object implements Serializable

serialVersionUID:

1L

Serialized Fields

transformer

org.apache.commons.collections.Transformer transformer

On ChangeListenerWrapperTransformer.predicateed event, call this for action

Can be null:

false

predicate

org.apache.commons.collections.Predicate predicate

An optional Predicate that can filter events before they reach the ChangeListenerWrapperTransformer.transformer.
If null then no filteration will apply. If Predicate.evaluate(Object) = false then the event will be filtered hence will NOT reach the ChangeListenerWrapperTransformer.transformer
The filter acts on the input which will be passed to the Transformer.

Can be null:

true

Class com.neurosys.events.Feedback extends ModelObject implements Serializable

Serialized Fields

event

Object event

The event over which we are getting feedback

Can be null:

false

eventSenderId

String eventSenderId

The user, process or container Id that owns the event

Can be null:

false

recipientId

String recipientId

The id of the recipient of the event that is transmitting this feedback

pastStatus

FlowStatus pastStatus

The FlowStatus type ~~; before event occoured.~~

status

FlowStatus status

Present status as FlowStatus type ~~Note: incase Feedback.exception is no null then the tokenStatus may reflect the same as Feedback.pastStatus or be null.~~

Can be null:

true

lastUpdated

Date lastUpdated

The time the status was changed. The word last is important as multiple events can modify a feedback. This reflects the last one to update the Feedback object

attributes

ImmutableValueHashMap<K,V> attributes

Any optional feedback properties

Can be null:

true

exception

Exception exception

Any Exception

Can be null:

true

Class com.neurosys.events.FlowStatusChangeListenerWrapperTransformer extends ChangeListenerWrapperTransformer<SynchronousFlowStatusChange<T,List<Status>>> implements Serializable

Serialized Fields

successMessage

Object successMessage

If not null will be used to provide Feedback success message as Status, String or Transformer on int (level of error)

Can be null:

true

errorMessage

Object errorMessage

If not null will be used to provide Feedback error message as Status, String or Transformer on int (level of error).
If null, then the actual Throwable.getMessage() will be used.

Can be null:

true

Class com.neurosys.events.SynchronousChangeListener extends AbstractChainChangeListener<T> implements Serializable

serialVersionUID:

-5543508250389129958L

Package com.neurosys.events.domain

Class com.neurosys.events.domain.AbstractEvent extends DomainObject implements Serializable

serialVersionUID:

1L

Serialized Fields

name

String name

bitmask

Integer bitmask

value

String value

Its own Content

startDate

Date startDate

endDate

Date endDate

type

String type

A sub-type

timeZone

String timeZone

As optional Time Zone specifier

Class com.neurosys.events.domain.Event extends AbstractEvent implements Serializable

serialVersionUID:

660933358818765734L

Serialized Fields

id

Long id

Package com.neurosys.exception

Class com.neurosys.exception.Continue extends Exception implements Serializable

serialVersionUID:

1L

Serialized Fields

payload

Object payload

Class com.neurosys.exception.ExecutionPreventedException extends Exception implements Serializable

serialVersionUID:

1L

Class com.neurosys.exception.MetaDataException extends RuntimeException implements Serializable

serialVersionUID:

1L

Serialized Fields

metaData

Map<K,V> metaData

Class com.neurosys.exception.PartialTransactionException extends Exception implements Serializable

serialVersionUID:

1L

Serialized Fields

passed

List<E> passed

warnings

List<E> warnings

failed

List<E> failed

Class com.neurosys.exception.PayLoadException extends Exception implements Serializable

Serialized Fields

payLoad

Object payLoad

Class com.neurosys.exception.ReadOnlyException extends Exception implements Serializable

serialVersionUID:

1L

Class com.neurosys.exception.Warning extends RuntimeException implements Serializable

serialVersionUID:

1L

Serialized Fields

payload

Object payload

severe

int severe

Higher the value, the more the severe

Class com.neurosys.exception.WrappedRuntimeException extends RuntimeException implements Serializable

serialVersionUID:

1L

Package com.neurosys.feeds.domain

Class com.neurosys.feeds.domain.FeedItem extends ModelObject implements Serializable

serialVersionUID:

1L

Serialized Fields

id

String id

url

String url

source

String source

category

String category

lastModDate

Date lastModDate

publishDate

Date publishDate

attributes

Map<K,V> attributes

Package com.neurosys.feeds.etl

Class com.neurosys.feeds.etl.AbstractFeed extends Object implements Serializable

Serialized Fields

itemsSuppliers

Collection<E> itemsSuppliers

Collection of Suppliers that provide The items to be supplied for this channel

subFeedSuppliers

Collection<E> subFeedSuppliers

A sub-feed in the format. Note another Feed can be a Sub-Feed.

subFeedConsumers

Collection<E> subFeedConsumers

These consume this Feed and add to it.

consumer

Consumer<T> consumer

Consumer for items being written

Class com.neurosys.feeds.etl.ScheduledFeeds extends Object implements Serializable

Serialized Fields

feeds

List<E> feeds

Package com.neurosys.feeds.rss2.domain

Class com.neurosys.feeds.rss2.domain.RSS2Channel extends FeedItem implements Serializable

serialVersionUID:

1L

Serialized Fields

title

String title

desc

String desc

image

RSS2Channel.Image image

language

String language

copyright

String copyright

managingEditor

String managingEditor

webMaster

String webMaster

generator

String generator

docs

String docs

cloud

String cloud

ttl

String ttl

skipHours

String skipHours

skipDays

String skipDays

Class com.neurosys.feeds.rss2.domain.RSS2Item extends FeedItem implements Serializable

serialVersionUID:

1L

Serialized Fields

title

String title

description

String description

enclosure

RSS2Item.Enclosure enclosure

author

String author

comments

String comments

guid

String guid

Package com.neurosys.feeds.rss2.etl

Class com.neurosys.feeds.rss2.etl.RSS2ChannelFeed extends AbstractFeed<StringBuilder,R extends RSS2Item> implements Serializable

Serialized Fields

channel

RSS2Channel channel

Details about the channel

Package com.neurosys.feeds.sitemap.domain

Class com.neurosys.feeds.sitemap.domain.SiteMapItem extends FeedItem implements Serializable

serialVersionUID:

1L

Serialized Fields

changeFreq

SiteMapItem.ChangeFreq changeFreq

See Also:

SiteMapItem.ChangeFreq

priority

int priority

A Optional floating point; this value will be divided by 10 for actual output.

See Also:

SiteMapItem.getActualPriority()

Package com.neurosys.feeds.sitemap.etl

Class com.neurosys.feeds.sitemap.etl.SiteMapFeed extends AbstractFeed<StringBuilder,SiteMapItem> implements Serializable

Package com.neurosys.geo.domain

Class com.neurosys.geo.domain.GeoLocation extends DomainObject implements Serializable

serialVersionUID:

1L

Serialized Fields

lat

Float lat

lang

Float lang

alt

Float alt

Package com.neurosys.guid

Package com.neurosys.hazelcast.etl

Class com.neurosys.hazelcast.etl.SendOnHazelCast extends Object implements Serializable

Serialized Fields

vmInstance

Supplier<T> vmInstance

Context Supplier of HazelcastInstance.
This allows us to pass a instance via context in a more dynamic multi instance environment or one configured directly into this instance.

getKey

Function<T,R> getKey

For the input t, get the key name; if t has to be put on a Distributed Map.

Default value:

null (List)

containerName

String containerName

Name of the Distributed List or Map
Note: Dont confuse containerName for groupName

See Also:

HazelcastInstance.getMap(String), if Map or List will be used.

Package com.neurosys.idm.admin.wicket.models

Class com.neurosys.idm.admin.wicket.models.UserListDataProvider extends org.apache.wicket.extensions.markup.html.repeater.util.SortableDataProvider<User> implements Serializable

serialVersionUID:

1L

Serialized Fields

userDao

UserDao userDao

byModuleNames

List<E> byModuleNames

likeName

String likeName

Package com.neurosys.idm.admin.wicket.pages

Class com.neurosys.idm.admin.wicket.pages.userDetails extends commonAdminTemplate implements Serializable

Serialized Fields

userDao

UserDao userDao

factory

SpringConfiguredContainerFactory factory

Class com.neurosys.idm.admin.wicket.pages.userDetailsAdmin extends commonAdminTemplate implements Serializable

Serialized Fields

userDao

UserDao userDao

factory

SpringConfiguredContainerFactory factory

Class com.neurosys.idm.admin.wicket.pages.userList extends commonAdminTemplate implements Serializable

Class com.neurosys.idm.admin.wicket.pages.userListAdmin extends reportingAdmin implements Serializable

Package com.neurosys.idm.admin.wicket.pages.panels

Class com.neurosys.idm.admin.wicket.pages.panels.AdminUserAuthorizationsPanel extends AdminPanel implements Serializable

serialVersionUID:

1L

Serialized Fields

modulesMap

Map<K,V> modulesMap

userService

UserService userService

Class com.neurosys.idm.admin.wicket.pages.panels.AdminUserAuthorizationsPanel.AuthorizationRow extends org.apache.wicket.markup.html.panel.Fragment implements Serializable

serialVersionUID:

1L

Class com.neurosys.idm.admin.wicket.pages.panels.AdminUserDetailsPanel extends UserDetailsPanel<User> implements Serializable

serialVersionUID:

1L

Serialized Fields

adminConfiguration

Properties adminConfiguration

factory

SpringConfiguredContainerFactory factory

helpers

UserDetailsPanelHelpers helpers

Class com.neurosys.idm.admin.wicket.pages.panels.AdminUserEntityDetailsPanel extends UserDetailsPanel implements Serializable

serialVersionUID:

1L

Serialized Fields

adminConfiguration

Properties adminConfiguration

factory

SpringConfiguredContainerFactory factory

helpers

UserDetailsPanelHelpers helpers

Class com.neurosys.idm.admin.wicket.pages.panels.ConfigPanel extends AdminPanel implements Serializable

serialVersionUID:

1L

Serialized Fields

appConfiguration

Properties appConfiguration

environment

org.springframework.core.env.Environment environment

Class com.neurosys.idm.admin.wicket.pages.panels.SystemDetailsPanel extends AdminPanel implements Serializable

serialVersionUID:

1L

Class com.neurosys.idm.admin.wicket.pages.panels.UserListPanel extends AbstractListPanel<Query<User>,User,UserListDataProvider> implements Serializable

serialVersionUID:

5883662222997875088L

Serialized Fields

userSortableDataProvider

UserListDataProvider userSortableDataProvider

Package com.neurosys.login.wicket

Class com.neurosys.login.wicket.AbstractLoginForm extends org.apache.wicket.markup.html.form.StatelessForm implements Serializable

serialVersionUID:

-167231544281242704L

Serialized Fields

principal

Principal principal

adminConfiguration

Properties adminConfiguration

Package com.neurosys.menu.model

Class com.neurosys.menu.model.AuthorizableMenuItem extends MenuItem implements Serializable

serialVersionUID:

-9144875596844047256L

Serialized Fields

module

Module module

The module that this item is related to in terms of Authorization

enabled

Boolean enabled

Class com.neurosys.menu.model.AuthorizedRollOverMenuItem extends RollOverMenuItem implements Serializable

serialVersionUID:

-9144875596844047256L

Serialized Fields

module

Module module

Deprecated.

The module that this item is related to in terms of Authorization

enabled

Boolean enabled

Deprecated.

Class com.neurosys.menu.model.AutoGenMenuItem extends MenuItem implements Serializable

serialVersionUID:

-9144875596844047256L

Serialized Fields

menusAddedByMe

Set<E> menusAddedByMe

container

MenuItem<M extends MenuItem> container

Name of the MenuItem which is the container of this. Scan and replace the occurrence of this instance.

refMenuMapping

Map<K,V> refMenuMapping

pageMenuMap (reference to Menu) mapping needs to be also auto generated if the menu is auto-gen.
Note: this map maybe shared with other AutoGenMenuItem

Can be null:

true (if null will be ignored)

Class com.neurosys.menu.model.ContentMenuItemState extends MenuItemState implements Serializable

serialVersionUID:

1L

Serialized Fields

content

Object content

Content for the State the MenuItem is in

Class com.neurosys.menu.model.Menu extends Object implements Serializable

serialVersionUID:

-8418431662801205675L

Serialized Fields

state

MenuItemState state

Class com.neurosys.menu.model.MenuItem extends Object implements Serializable

serialVersionUID:

489635780097985513L

Serialized Fields

name

String name

Name / id

parent

MenuItem<M extends MenuItem> parent

Deprecated.

refId

String refId

A String that denotes where the item Points to. A URL, An id that the system can interpret it. The value depends on the context it is used in.

children

List<E> children

Represents the Children sub-menu items of this item

Can be null:

true

navigable

boolean navigable

true indicates that if refId is available then one can navigate using this item. If false means that irrespective of refId provided in the DataModel, on rendering the navigation link will not appear / it will be muted / disabled.
One could remove a Non navigable node from the model however in SOME cases we want to show the TREE specially if it has children, we would want it to remain as part of the path and some complex scenarios.

level

Integer level

Indicate how down in the hierarchy is this. 0 indicated Root level.
null means not defined for this Menu logic.

Can be null:

true

Default value:

null

Class com.neurosys.menu.model.MenuItemState extends State<MenuItem> implements Serializable

serialVersionUID:

6447835678290922292L

Serialized Fields

children

List<E> children

Class com.neurosys.menu.model.RollOverMenuItem extends MenuItem<M extends RollOverMenuItem> implements Serializable

serialVersionUID:

489635780097985513L

Serialized Fields

img

String img

Deprecated.

rollOverImg

String rollOverImg

Deprecated.

Package com.neurosys.menu.service

Class com.neurosys.menu.service.NavigationModule extends Module implements Serializable

Package com.neurosys.messenger.domain

Class com.neurosys.messenger.domain.AsynchronousSMS extends DisposableMessage<String,String> implements Serializable

Serialized Fields

consumer

Consumer<T> consumer

Class com.neurosys.messenger.domain.DisposableMessage extends Object implements Serializable

serialVersionUID:

6898806210511787576L

Serialized Fields

recipients

List<E> recipients

payload

Object payload

contentType

ContentType contentType

messageId

String messageId

priority

Priority priority

Class com.neurosys.messenger.domain.SMS extends DisposableMessage<String,String> implements Serializable

Package com.neurosys.messenger.domain.contenttypes

Class com.neurosys.messenger.domain.contenttypes.ContentType extends Object implements Serializable

serialVersionUID:

1L

Serialized Fields

version

String version

type

MimeType type

Package com.neurosys.messenger.domain.email

Class com.neurosys.messenger.domain.email.EmailMessage extends DisposableMessage<javax.mail.internet.InternetAddress,T> implements Serializable

serialVersionUID:

1L

Serialized Fields

sourceAddress

javax.mail.internet.InternetAddress sourceAddress

subject

String subject

headers

Map<K,V> headers

parts

Collection<E> parts

CCList

List<E> CCList

If not using bulk and want to show CC addresses, use this

BCCList

List<E> BCCList

If not using bulk and want to show BCC addresses, use this

unsubscribeAction

String unsubscribeAction

Allow the user to un subscribe from the email; usually used with Bulk mails and considered good practice to provide the user the ability to un-subscribe.

Sample:
List-Unsubscribe: ,

See Also:

2369 - http://tools.ietf.org/search/rfc2369

bulk

boolean bulk

If set to true, The message will be a Bulk blast / optimize accordingly and set appropriate RFC headers Example see https://support.google.com/mail/bin/answer.py?hl=en&answer=81126#format

Default value:

false

canReply

boolean canReply

If set to true, Ensure the mail address is valid to reply-to

Default value:

false

embedImages

boolean embedImages

All image parts will be embedded in the email

Default value:

true

attachImagesAsFiles

boolean attachImagesAsFiles

All image parts will be added as attachments.
Works in conjunction with EmailMessage.allowAttachments

Default value:

false

allowAttachments

boolean allowAttachments

Allow or filter any Attachments

Default value:

true

allowHtml

boolean allowHtml

Keep or remove any HTML content

Default value:

true

attachehmentSuffix

String attachehmentSuffix

The suffix will be added to all attachments to make it comply with standard naming contentions

Package com.neurosys.module.model

Class com.neurosys.module.model.Module extends Object implements Serializable

serialVersionUID:

-1760928418811047216L

Serialized Fields

name

String name

displayName

String displayName

enabled

Boolean enabled

controllable

Boolean controllable

subModules

Collection<E> subModules

Deprecated.

module

Module module

Any parent Module that this Module belongs to

authorizations

Collection<E> authorizations

Authorizations that can access this item

authorizableIdAssignable

Boolean authorizableIdAssignable

permissableAuths

Collection<E> permissableAuths

Class com.neurosys.module.model.ModuleUI extends Object implements Serializable

serialVersionUID:

4290102790442193516L

Serialized Fields

name

String name

Can be null:

true

reference

Object reference

Default physical Page or component reference that represents this Module UI

paths

String[] paths

Path by which the UI is referred, by the app or external world

module

Module module

The module that this item is related to in terms of Authorization

navigatable

boolean navigatable

If the UI can be/will be available on a navigation

Package com.neurosys.module.service

Class com.neurosys.module.service.CustomAutoNav.CustomHierarchicalReference extends HierarchialDomainObject implements Serializable

serialVersionUID:

1L

Serialized Fields

name

String name

displayName

String displayName

parentName

String parentName

id

Long id

Class com.neurosys.module.service.CustomAutoNav.CustomMenuItem extends MenuItem implements Serializable

Serialized Fields

contentName

String contentName

Package com.neurosys.module.wicket.model

Class com.neurosys.module.wicket.model.WicketModuleUI extends ModuleUI<Class<org.apache.wicket.markup.html.WebPage>> implements Serializable

serialVersionUID:

-3194736617505062344L

Package com.neurosys.modules.configs.admin.wicket.pages

Class com.neurosys.modules.configs.admin.wicket.pages.dynamicConfigsAdmin extends commonAdminTemplate implements Serializable

Serialized Fields

factory

SpringConfiguredContainerFactory factory

Class com.neurosys.modules.configs.admin.wicket.pages.staticConfigsAdmin extends commonAdminTemplate implements Serializable

Serialized Fields

factory

SpringConfiguredContainerFactory factory

Package com.neurosys.modules.configs.admin.wicket.pages.panels

Class com.neurosys.modules.configs.admin.wicket.pages.panels.DynamicConfigPanel extends AdminPanel implements Serializable

serialVersionUID:

1L

Serialized Fields

service

ConfigurationService<K,T,C extends AbstractConfiguration> service

authorizationModule

AuthorizationModule<T> authorizationModule

Class com.neurosys.modules.configs.admin.wicket.pages.panels.DynamicConfigsPanel extends AdminPanel implements Serializable

serialVersionUID:

1L

Serialized Fields

factory

SpringConfiguredContainerFactory factory

service

ConfigurationService<K,T,C extends AbstractConfiguration> service

Class com.neurosys.modules.configs.admin.wicket.pages.panels.DynamicConfigTemplatePanel extends EntityDetailsTemplatePanel<C extends AbstractConfiguration> implements Serializable

serialVersionUID:

1L

Package com.neurosys.modules.etl

Class com.neurosys.modules.etl.AttributesMapper extends Mapper implements Serializable

Serialized Fields

attributesSetter

AttributesSetter<A extends Attributes<A,V>,V> attributesSetter

Class com.neurosys.modules.etl.AuthorizableETLMeta extends ETLMeta<PARAM_META> implements Serializable

serialVersionUID:

1L

Serialized Fields

authorizations

Collection<E> authorizations

Authorizations that can access this item

authorizableId

String authorizableId

authorizableIdAssignable

Boolean authorizableIdAssignable

Class com.neurosys.modules.etl.EnsureAttributeExistsTransformer extends EnsureAccessorExistsTransformer implements Serializable

serialVersionUID:

1L

Class com.neurosys.modules.etl.EnsureEntityManagerSetTransformer extends Object implements Serializable

serialVersionUID:

1L

Serialized Fields

updatableContext

UpdatableContext<CONTEXT> updatableContext

Class com.neurosys.modules.etl.EntityManagerProviderTransformer extends Object implements Serializable

serialVersionUID:

1L

Class com.neurosys.modules.etl.ExcelRowToProductTransformer extends AbstractExcelRowToEntityTransformer implements Serializable

serialVersionUID:

1L

Serialized Fields

type

Class<T> type

Class com.neurosys.modules.etl.FileToProductsTransformer extends EventAwareProcess implements Serializable

serialVersionUID:

1L

Serialized Fields

mode

Mode mode

filter

org.apache.commons.collections.Predicate filter

Filter Raw input and ensure its eligible for Transformation

Can be null:

true

entitiesLookup

Lookup entitiesLookup

Uses this as to extract the entities (List) from the raw input type, that relate to the input

pathTransformer

org.apache.commons.collections.Transformer pathTransformer

For the given File/resource; derive the appropriate path to the resource

contentFacet

FacetMeta contentFacet

The FacetMeta in the Content the file will relate to

order

boolean order

If true then order the file names in case an array is used

unique

boolean unique

If true then file names are unique in case an array is used

modesSupported

List<E> modesSupported

What all modes does this Reader support
Default All defined in Mode

Class com.neurosys.modules.etl.GetNewHierarcyLookup extends UsesIntermediateObjectImpl implements Serializable

Serialized Fields

service

ProductService<T extends Product> service

Class com.neurosys.modules.etl.MultiCategoryLookup extends UsesIntermediateObjectImpl<Map<String,Object>> implements Serializable

Serialized Fields

queryTransformer

org.apache.commons.collections.Transformer queryTransformer

Accepts an Array of category names. Lower index indicates higher precendence in the category hierarchy.
Returns type T

levels

int levels

Number of levels in the hierarchy this Lookup will support

Default value:

3

cacheManager

org.springframework.cache.CacheManager cacheManager

cache

org.springframework.cache.Cache cache

cacheName

String cacheName

The name of the Cache defined in ehcache.xml for ETL category lookups.
The cache will store the Category Name to Category Object (type T); mapping

Note: This is only used if MultiCategoryLookup.cache has not been initialized. If its null then MultiCategoryLookup.init() will use this to initialize the cache.

Default value:

value is ProductService.PRODUCT_LOOKUP_CACHE_NAME

Class com.neurosys.modules.etl.ObjectToRowReverseTransformer extends AbstractReverseTupleToEntityTransformer<T,Object[]> implements Serializable

serialVersionUID:

1L

Class com.neurosys.modules.etl.PageToTemplate extends Object implements Serializable

Class com.neurosys.modules.etl.ProductMultiCategoryLookup extends MultiCategoryLookup<T extends Product> implements Serializable

serialVersionUID:

1L

Serialized Fields

em

javax.persistence.EntityManager em

Deprecated.

Class com.neurosys.modules.etl.ProductNameTransformer extends UsesIntermediateObjectImpl implements Serializable

Serialized Fields

adminConfiguration

Properties adminConfiguration

interpart_delimiter

String interpart_delimiter

A product can be identified by Name, SKU etc. So if each represents a part of the name; then this is the delimiter to separate the parts.

Default value:

- (hyphen); Many times Name is used in URL, so a - is SEO friendly as a separator compared to an "_"

intrapart_delimiter

String intrapart_delimiter

A product name or part can have several words; so what is the delimited to be used between the words of the same part.

Default value:

_ (underscore); Many times Name is used in URL, so a - is SEO friendly as a separator compared to an "_"

toLower

boolean toLower

If true will ensure all names are in lower case for consistency

Default value:

false

cleanup_regex_str

String cleanup_regex_str

Class com.neurosys.modules.etl.ProductURLGeneratorTransformer extends WicketURLGeneratorTransformer implements Serializable

serialVersionUID:

1L

Serialized Fields

productFetch

org.apache.commons.collections.Transformer productFetch

Convert a Product Id to a Product

productService

ProductService<T extends Product> productService

idParamName

String idParamName

idFieldName

String idFieldName

Class com.neurosys.modules.etl.QueryResultArrayToEntityTransformer extends ObjectArrayToEntityTransformer<ENTITY> implements Serializable

Serialized Fields

overrideFromClause

String overrideFromClause

Optional override of FROM clause over the default Query From to be optimized by specifying one. While replacing some select fields Joins maybe impacted, and may require manual re-definition of the FROM clause

Class com.neurosys.modules.etl.SearchJPAQueryBuilderTransformer extends Object implements Serializable

serialVersionUID:

1L

Serialized Fields

entityNameAliasMapping

String entityNameAliasMapping

Example "Product e" and all the FacetMeta.getName()s would use the field name directly or can use p.fieldName If defining a single entity and an alias, check SearchJPAQueryBuilderTransformer.defaultEntityAlias.

joinClauses

String joinClauses

Example: e1.name = e2.name OR e1.id = e2.id

defaultEntityAlias

String defaultEntityAlias

If the field names in FacetMeta dont contain any alias; the SearchJPAQueryBuilderTransformer.defaultEntityAlias will be prefixed.

Default value:

is e

Class com.neurosys.modules.etl.ValueToAttributeTransformer extends Object implements Serializable

serialVersionUID:

1L

Serialized Fields

attributeType

Class<T> attributeType

attributeName

String attributeName

Class com.neurosys.modules.etl.VelocityContentTransformer extends Object implements Serializable

Serialized Fields

logTag

String logTag

A log tag to report issues in the log file as this as the handle

Default value:

Object.getClass().Class.getSimpleName()

Class com.neurosys.modules.etl.VelocityTransformer extends Object implements Serializable

Serialized Fields

templatePath

String templatePath

Template Path as per velocity conventions

contextName

String contextName

If the input (context) is an Object then one can refer to this object in the Velocity context as the value of this variable.

Default value:

input

Class com.neurosys.modules.etl.WicketURLGeneratorTransformer extends URLGeneratorTransformer implements Serializable

serialVersionUID:

1L

Serialized Fields

base

Class<T> base

baseUrlStr

String baseUrlStr

absolute

boolean absolute

protocolStrict

String protocolStrict

If specified will ensure it uses this protocol (replaces default) for the generated URL. Works only if WicketURLGeneratorTransformer.absolute is true.

A use case is that when generating the link, the page generating the link is on https, however we wish the final to be http. The default will be https hence to make it strictly http we can use this attribute.

Can be null:

true, will get default

wwwStrict

Boolean wwwStrict

If specified true, will ensure it uses "www" convention is used for the link

Can be null:

true, will get default

urlFormat

String urlFormat

Whatever is set via the WicketURLGeneratorTransformer.base wrap and format that using Formatter

Default value:

%s . is the base URL

secureURLUsingSalt

boolean secureURLUsingSalt

Appends a parameter called salt. If #secureURLUsingKey is true then the value of this will also be encrypted.

Package com.neurosys.modules.etl.admin.wicket.pages

Class com.neurosys.modules.etl.admin.wicket.pages.etlAdmin extends commonAdminTemplate implements Serializable

Package com.neurosys.modules.etl.admin.wicket.pages.panels

Class com.neurosys.modules.etl.admin.wicket.pages.panels.ETLInputTemplatePanel extends EntityDetailsTemplatePanel<Object[]> implements Serializable

serialVersionUID:

1L

Class com.neurosys.modules.etl.admin.wicket.pages.panels.ETLProgressMonitor extends ProgressMonitor implements Serializable

serialVersionUID:

1L

Class com.neurosys.modules.etl.admin.wicket.pages.panels.ETLUpload extends AdminPanel implements Serializable

serialVersionUID:

1L

Serialized Fields

metas

Map<K,V> metas

authorizationModule

AuthorizationModule<T> authorizationModule

progressMonitor

ProgressMonitor progressMonitor

ProgressMonitor to monitor the upload progress

Can be null:

false

Class com.neurosys.modules.etl.admin.wicket.pages.panels.ReaderProcess extends Object implements Serializable

serialVersionUID:

1L

Package com.neurosys.modules.wicket.components

Class com.neurosys.modules.wicket.components.ConfigurableFacetMetaActionContainer extends org.apache.wicket.markup.html.WebMarkupContainer implements Serializable

serialVersionUID:

1L

Serialized Fields

authorizationModule

AuthorizationModule<T> authorizationModule

finalButtonCount

int finalButtonCount

Due to authorization etc All buttons passed maynot be rendered so keep count of of many were rendered finally

Class com.neurosys.modules.wicket.components.ScriptableFacetMetaAjaxButton extends ScriptableAjaxButton implements Serializable

serialVersionUID:

1L

Serialized Fields

facetMeta

FacetMeta facetMeta

Package com.neurosys.multiorg.domain

Class com.neurosys.multiorg.domain.Organization extends HierarchialDomainObjectWithAttributes<Organization,OrganizationAttribute> implements Serializable

serialVersionUID:

1L

Serialized Fields

id

Long id

name

String name

Unique Name to refer to the record Id is an Auto generated number used by the system, but is difficult for the outside world to get a handle on it.

attributes

Map<K,V> attributes

Any attribute that is not common for most of the entities belongs to be an Attribute rather than a field.
Attributes usually represent fluid variations within Products and product Types that are loosely defined for some products.

geoLocation

GeoLocation geoLocation

Class com.neurosys.multiorg.domain.OrganizationAttribute extends EntityAttribute<Organization> implements Serializable

serialVersionUID:

1L

Serialized Fields

entity

Organization entity

Class com.neurosys.multiorg.domain.Venue extends DomainObject implements Serializable

serialVersionUID:

1L

Serialized Fields

id

Long id

name

String name

Unique Name to refer to the record Id is an Auto generated number used by the system, but is difficult for the outside world to get a handle on it.

displayName

String displayName

attributes

Map<K,V> attributes

Any attribute that is not common for most of the entities belongs to be an Attribute rather than a field.
Attributes usually represent fluid variations within Products and product Types that are loosely defined for some products.

geoLocation

GeoLocation geoLocation

Venue.location was intended to be PointRef type. However some complications (Location has to be relation, but PlaceRef type does not guarantee a GeoLocation hence the relation was not possible) prevented it.
So Venue location = Venue.location + its Venue.geoLocation.

See Also:

Venue.location

location

PlaceRef location

The PlaceRef of the Venue itself

This also serves as the default location for the venue itself

See Also:

Venue.geoLocation, Venue.places

Can be null:

false

ownerOrganization

Organization ownerOrganization

The parent Organization that owns this Venue.

Can be null:

false

places

List<E> places

The PlaceRefs within a venue with multiple entry points. This may include Venue.location or may not.

Can be null:

true

Class com.neurosys.multiorg.domain.VenueAttribute extends EntityAttribute<Venue> implements Serializable

serialVersionUID:

1L

Serialized Fields

entity

Venue entity

Class com.neurosys.multiorg.domain.VMConnectInfo extends ModelObject implements Serializable

serialVersionUID:

1L

Serialized Fields

entityRef

Object entityRef

Reference to the entity like Organization, Venue or Event etc this VMInfo is for

vmId

String vmId

Fully qualified Id/name for the entity that defines the connection by a common name on both sides

toAddress

String toAddress

The network Address of the VM we are connecting TO; like an IP address with port#.
Example: 192.168.4.6:4589

fromAddress

String fromAddress

The network Address of the VM we are connecting TO; like an IP address with port#.

Package com.neurosys.notification.domain

Class com.neurosys.notification.domain.UserNotification extends DomainObject implements Serializable

serialVersionUID:

1L

Serialized Fields

message

Object message

A message or JSON representation of a message

count

String count

An optional COUNT to supplement the message

Can be null:

true

severity

String severity

A string that indicates the severity of the Notification. Example: urgent, low, high, info .. etc

status

String status

Optional status. Like READ, ACKNOWLEDGED, DISCARDED etc. Custom to situation

tags

String tags

Useful in grouping notifications in categories and sub-categories

recipient

String recipient

User or Page or Instance applicable intended to show t

Package com.neurosys.notification.wicket.components

Class com.neurosys.notification.wicket.components.NotificationsContainer extends org.apache.wicket.markup.html.list.ListView<T extends UserNotification<?>> implements Serializable

serialVersionUID:

1L

Package com.neurosys.odb.document.etl

Class com.neurosys.odb.document.etl.ODBExecuteTransformer extends Object implements Serializable

serialVersionUID:

1L

Serialized Fields

fieldMapping

Map<K,V> fieldMapping

Map from query param name to field name or Transformer that will act on input to get param value. Used in case parameters are names and the input is not an Object[]

query

String query

Orientdb Query to process

Class com.neurosys.odb.document.etl.ODBPersistTransformer extends Object implements Serializable

Serialized Fields

clusterName

String clusterName

Will specify cluster in which document is to be persisted

Can be null:

true

Class com.neurosys.odb.document.etl.ODBQueryTransformer extends ODBQueryTransformer<E,com.orientechnologies.orient.core.record.impl.ODocument> implements Serializable

serialVersionUID:

1L

Package com.neurosys.odb.etl

Class com.neurosys.odb.etl.ODBQueryTransformer extends Object implements Serializable

serialVersionUID:

1L

Serialized Fields

query

String query

Orientdb Query to process

expectSingleResult

boolean expectSingleResult

If true it will attempt to return only 1 Object or null if no match to query
One should use the LIMIT keyword in query when setting this to true.

paramAsSingleInput

boolean paramAsSingleInput

If true, will take whole input to transformer as a single parameter and pass it in query.

fieldMapping

Map<K,V> fieldMapping

Map from query param name to field name or Transformer that will act on input to get param value.

Package com.neurosys.odb.object.etl

Class com.neurosys.odb.object.etl.ODBPersistTransformer extends Object implements Serializable

Serialized Fields

clusterName

String clusterName

Will specify cluster in which document is to be persisted

Can be null:

true

registerClasses

List<E> registerClasses

Class com.neurosys.odb.object.etl.ODBQueryTransformer extends ODBQueryTransformer<E,E> implements Serializable

serialVersionUID:

1L

Serialized Fields

registerClasses

List<E> registerClasses

Package com.neurosys.pagination.domain

Class com.neurosys.pagination.domain.Page extends ModelObject implements Serializable

Serialized Fields

records

List<E> records

pageInfo

PageInfo pageInfo

Class com.neurosys.pagination.domain.PageInfo extends ModelObject implements Serializable

serialVersionUID:

1L

Serialized Fields

pageSize

int pageSize

totalResults

int totalResults

paginationHandler

String paginationHandler

recordNumber

int recordNumber

Package com.neurosys.posts.admin.wicket.pages

Class com.neurosys.posts.admin.wicket.pages.postsAuthorAdmin extends commonAdminTemplate implements Serializable

Serialized Fields

factory

SpringConfiguredContainerFactory factory

postService

PostService postService

Package com.neurosys.posts.admin.wicket.pages.components

Class com.neurosys.posts.admin.wicket.pages.components.PostListingReportResult extends PoppableReportResult<T extends Serializable,ReporterMeta> implements Serializable

serialVersionUID:

1L

Serialized Fields

targetPostDetailsPanel

PostDetailsPanel targetPostDetailsPanel

Package com.neurosys.posts.admin.wicket.pages.panels

Class com.neurosys.posts.admin.wicket.pages.panels.PostDetailsPanel extends ContentDetailsPanel<Post,PostAttribute,PostFacet> implements Serializable

serialVersionUID:

1L

Serialized Fields

postService

PostService postService

Class com.neurosys.posts.admin.wicket.pages.panels.PostListingPanel extends ReportingAdminPanel implements Serializable

serialVersionUID:

1L

Serialized Fields

postDetailsPanel

PostDetailsPanel postDetailsPanel

reportResultContainer

PostListingReportResult<T extends Serializable> reportResultContainer

Class com.neurosys.posts.admin.wicket.pages.panels.PostsSearchPanel extends ContentAuthorSearchPanel<Post> implements Serializable

serialVersionUID:

1L

Serialized Fields

postService

PostService postService

Package com.neurosys.posts.domain

Class com.neurosys.posts.domain.Post extends AbstractContent<PostAttribute,PostFacet> implements Serializable

serialVersionUID:

1L

Serialized Fields

attributes

Map<K,V> attributes

engagementSummary

String engagementSummary

JSON Summary of comments statistics, and other engagement Data
Note: The Post data model will not maintain references to various related data like comments etc. Any related data is expected to be uni-directional from that data item to Post.

Class com.neurosys.posts.domain.PostAttribute extends AbstractContentAttribute implements Serializable

serialVersionUID:

1L

Serialized Fields

post

Post post

Class com.neurosys.posts.domain.PostFacet extends AbstractContentFacet implements Serializable

serialVersionUID:

1L

Serialized Fields

content

Post content

Class com.neurosys.posts.domain.PostTemplate extends AbstractContentTemplate<T> implements Serializable

serialVersionUID:

1L

Package com.neurosys.products.admin.wicket.components

Class com.neurosys.products.admin.wicket.components.ParentCategoriesContainer extends org.apache.wicket.markup.html.WebMarkupContainer implements Serializable

serialVersionUID:

1L

Serialized Fields

sequenceBeforeSubmit

Integer sequenceBeforeSubmit

Package com.neurosys.products.admin.wicket.pages

Class com.neurosys.products.admin.wicket.pages.catalogAdmin extends commonAdminTemplate implements Serializable

Serialized Fields

factory

SpringConfiguredContainerFactory factory

Class com.neurosys.products.admin.wicket.pages.productDetails extends commonAdminTemplate implements Serializable

Serialized Fields

service

ProductService<T extends Product> service

factory

SpringConfiguredContainerFactory factory

Package com.neurosys.products.admin.wicket.pages.panels

Class com.neurosys.products.admin.wicket.pages.panels.ProductCategoryPanel extends CategoryPanel<ProductReference> implements Serializable

serialVersionUID:

4554446651243105378L

Serialized Fields

service

ProductService<T extends Product> service

targetUpdatePanel

ProductListingPanel targetUpdatePanel

When selecting a category the action will update the targetUpdatePanel

Class com.neurosys.products.admin.wicket.pages.panels.ProductCategoryPanel.ProductTree extends IndicatingAjaxLinkTree implements Serializable

Class com.neurosys.products.admin.wicket.pages.panels.ProductDetailsPanel extends AdminPanel implements Serializable

serialVersionUID:

-7289470932511208846L

Serialized Fields

service

ProductService<T extends Product> service

templateService

ProductTemplateServiceImpl templateService

availableProductTypes

HashMap<K,V> availableProductTypes

authorizationModule

AuthorizationModule<T> authorizationModule

factory

SpringConfiguredContainerFactory factory

operation

FlowStatus operation

parentProduct

Product parentProduct

targetUpdatePanel

ProductListingPanel targetUpdatePanel

When updating a Product refresh the Listing Panel

currentSelectedTemplate

ProductTemplate<REF> currentSelectedTemplate

updateMayImpactListing

boolean updateMayImpactListing

Class com.neurosys.products.admin.wicket.pages.panels.ProductDetailsTemplatePanel extends ListViewTemplatePanel<ProductTemplate<TemplatePanel>,P extends Product> implements Serializable

serialVersionUID:

1L

Class com.neurosys.products.admin.wicket.pages.panels.ProductListingPanel extends AdminPanel implements Serializable

serialVersionUID:

5883662222997845088L

Serialized Fields

provider

ProductSortableDataProvider provider

service

ProductService<T extends Product> service

resourceUploader

FileUploadWrapper resourceUploader

searchQueryTransformer

SearchJPAQueryBuilderTransformer searchQueryTransformer

authorizationModule

AuthorizationModule<T> authorizationModule

targetProductDetailsPanel

ProductDetailsPanel targetProductDetailsPanel

When selecting a Product the action will update the target ProductDetailsPanel

thisAndParents

List<E> thisAndParents

callerComponentId

String callerComponentId

updateMayImpactListing

Boolean updateMayImpactListing

fieldNamesForIcons

List<E> fieldNamesForIcons

List of Strings, each representing the field to be included in list of Icons

Can be null:

true

Class com.neurosys.products.admin.wicket.pages.panels.ProductMetaItemAjaxSaveBehavior extends EditorAjaxSaveBehavior implements Serializable

serialVersionUID:

1L

Class com.neurosys.products.admin.wicket.pages.panels.ProductSearchInputTemplatePanel extends EntityDetailsTemplatePanel<Object[]> implements Serializable

serialVersionUID:

1L

Package com.neurosys.products.domain

Class com.neurosys.products.domain.Product extends HierarchialDomainObjectWithAttributes<Product,ProductAttribute> implements Serializable

serialVersionUID:

-4760347880317994262L

Serialized Fields

id

Long id

Id with GeneratedValue.strategy() of GenerationType.AUTO

name

String name

Unique Name to refer to the record Id is an Auto generated number used by the system, but is difficult for the outside world to get a handle on it.

description

String description

Brief summary to represent the Product

bitmask

Integer bitmask

See Also:

Product.BIT_MASKS

tags

String tags

attributes

Map<K,V> attributes

Any attribute that is not common for most of the entities belongs to be an Attribute rather than a field.
Attributes usually represent fluid variations within Products and product Types that are loosely defined for some products.

productCode

String productCode

A code uniquely identifies a product and has a one to one mapping with SKU.
However this is optional and a more human readable way to recognize the product in the system.
In face this product represents a collection then also this maybe null since business may not have defined this for a group of products.

Can be null:

true

modelCode

String modelCode

A code that identifies a product's model. There is a One to mapping between this and Product.productCode & #sku.

Can be null:

true

relatedGroups

String relatedGroups

A JSON string of the format ["sku":[.,.,.],"modelCode":[...],"productCode":[.,.,.]]
This defines a collection/group related to this product. Sometimes, collections of objects need to be sold together as one unit but can consist of multiple units. Example: Tea Set.
This JSON string will contain the detail of that association

Class com.neurosys.products.domain.ProductAlias extends DomainObject implements Serializable

serialVersionUID:

1L

Serialized Fields

id

Long id

product

Product product

parent

Product parent

See Also:

HierarchialDomainObject.getParentId()

Class com.neurosys.products.domain.ProductAttribute extends EntityAttribute<Product> implements Serializable

serialVersionUID:

-5028198834771822857L

Serialized Fields

product

Product product

Class com.neurosys.products.domain.ProductReference extends HierarchialDomainObject implements Serializable

serialVersionUID:

-4760347880317994262L

Serialized Fields

id

Long id

name

String name

Unique Name to refer to the record Id is an Auto generated number used by the system, but is difficult for the outside world to get a handle on it.

productCode

String productCode

Product Code unique for all products

displayName

String displayName

Display name

type

Class<T> type

Type of Product

Class com.neurosys.products.domain.ProductTemplate extends Template<REF> implements Serializable

serialVersionUID:

1L

Class com.neurosys.products.domain.Size extends DomainObject implements Serializable

serialVersionUID:

7841036850051700447L

Serialized Fields

id

Long id

Id type, but manually generated. Typically one can set this the same as Product.getId() as its a OneToOne mapping

product

Product product

OneToOne JoinColumn.name() = product_id

Class com.neurosys.products.domain.SizeDimensions extends Size implements Serializable

serialVersionUID:

7349672759958660047L

Serialized Fields

length

Double length

width

Double width

height

Double height

unit

String unit

Class com.neurosys.products.domain.SizeFit extends Size implements Serializable

serialVersionUID:

-6178128887171989744L

Serialized Fields

fit

SizeFit.Fit fit

Class com.neurosys.products.domain.SizeString extends Size implements Serializable

serialVersionUID:

1L

Serialized Fields

value

String value

Package com.neurosys.products.service

Class com.neurosys.products.service.CatalogAutoNav.CatalogMenuItem extends CustomAutoNav.CustomMenuItem implements Serializable

Package com.neurosys.products.wicket.model

Class com.neurosys.products.wicket.model.ProductSortableDataProvider extends org.apache.wicket.extensions.markup.html.repeater.util.SortableDataProvider implements Serializable

serialVersionUID:

1L

Serialized Fields

productDaoClass

Class<T> productDaoClass

defaultOrderField

String defaultOrderField

lastSize

Integer lastSize

Package com.neurosys.products.wicket.panels

Class com.neurosys.products.wicket.panels.CatalogNavigatorPanel extends org.apache.wicket.markup.html.navigation.paging.PagingNavigator implements Serializable

serialVersionUID:

5784727597977717685L

Serialized Fields

pagingNavigation

org.apache.wicket.markup.html.navigation.paging.PagingNavigation pagingNavigation

Class com.neurosys.products.wicket.panels.CatalogPanel extends org.apache.wicket.markup.html.panel.Panel implements Serializable

serialVersionUID:

-5364595668422603719L

Class com.neurosys.products.wicket.panels.ProductCatalogPanel extends org.apache.wicket.markup.html.panel.Panel implements Serializable

serialVersionUID:

4799121462605425729L

Package com.neurosys.q.basic.domain

Class com.neurosys.q.basic.domain.TokenStatus extends Object implements Serializable

serialVersionUID:

1L

Serialized Fields

name

String name

ordinal

Integer ordinal

parent

TokenStatus parent

Package com.neurosys.q.domain

Class com.neurosys.q.domain.TokenPosition extends DomainObject implements Serializable

serialVersionUID:

1L

Serialized Fields

container

TokenContainer<T extends Token<T>> container

token

Token<T extends Token> token

current

Number current

Current position relative to the front most in the TokenPosition.container
TokenPosition as position (>=0)

estWaitTime

Integer estWaitTime

Estimated wait time in minutes

Class com.neurosys.q.domain.TrackToken extends Track implements Serializable

serialVersionUID:

1L

Package com.neurosys.q.domain.exceptions

Class com.neurosys.q.domain.exceptions.TokenGenerationException extends Exception implements Serializable

serialVersionUID:

1L

Class com.neurosys.q.domain.exceptions.TokenProcessingException extends RuntimeException implements Serializable

serialVersionUID:

1L

Serialized Fields

token

Token<T extends Token> token

The current token on which the Exception occoured

Class com.neurosys.q.domain.exceptions.TokenSwitchedException extends TokenProcessingException implements Serializable

serialVersionUID:

1L

Serialized Fields

newToken

Token<T extends Token> newToken

A switch occured with a new Token

Package com.neurosys.q.notification.events

Class com.neurosys.q.notification.events.BasicTokenEvent extends Status implements Serializable

serialVersionUID:

1L

Serialized Fields

token

Object token

Token or List of Tokens

Can be null:

false

flowStatus

TokenEvent.TokenEventFlowStatus flowStatus

The FlowStatus type of the event itself

See Also:

TokenEventFlowStatus

Can be null:

false

feedback

Feedback<E,S extends FlowStatus> feedback

Any SynchronousChange related Feedback

Can be null:

true

wasConsumed

boolean wasConsumed

Maintain state if token(s) were accessed or not. This is if an event is called multiple times to know if the event has already been consumed;

behaviors

Map<K,V> behaviors

Optional Behaviors for custom strategies

Can be null:

true

preEventProcess

Consumer<T> preEventProcess

Class com.neurosys.q.notification.events.MessageTokenEvent extends BasicTokenEvent<T extends Token<T>> implements Serializable

Serialized Fields

parent

TokenEvent<T extends Token<T>> parent

The parent TokenEvent that triggered this one

Class com.neurosys.q.notification.events.NextTokenEvent extends BasicTokenEvent<T extends Token<T>> implements Serializable

Serialized Fields

nextTokensAction

org.apache.commons.collections.Transformer nextTokensAction

An action that will act on the next token(s), to automate any sequence of events that result as action due to current event.

Class com.neurosys.q.notification.events.SynchronousTokenChangeEventSupplierBackedListener extends SynchronousTokenChangeListener<T extends Token<T>,TokenEvent<T extends Token<T>>> implements Serializable

serialVersionUID:

1L

Serialized Fields

tokenEventSupplier

TokenEventSupplier<T extends Token<T>> tokenEventSupplier

Class com.neurosys.q.notification.events.SynchronousTokenChangeListener extends Object implements Serializable

Package com.neurosys.q.notification.service

Class com.neurosys.q.notification.service.AbstractTokenNotificationListener extends SynchronousTokenChangeEventSupplierBackedListener<T extends Token<T>,MessageTokenEvent<T extends Token<T>>> implements Serializable

Serialized Fields

notificationHelper

AbstractNotificationHelper<T extends Token<T>> notificationHelper

Class com.neurosys.q.notification.service.DefaultTokenChangeExecuteStrategyListener extends SynchronousTokenChangeListener<T extends Token<T>,SupplierTokenEvent<T extends Token<T>>> implements Serializable

Serialized Fields

qStrategy

QStrategy<T extends Token<T>> qStrategy

Package com.neurosys.ratings.domain

Class com.neurosys.ratings.domain.Rating extends DomainObject implements Serializable

serialVersionUID:

1L

Serialized Fields

id

Long id

topic

String topic

Topic/Object being rated

topicType

String topicType

Topic/Object being rated

rating

Integer rating

max

Integer max

weight

Integer weight

bitmask

Integer bitmask

created

Date created

updated

Date updated

userId

String userId

user

User user

Package com.neurosys.refs.domain

Class com.neurosys.refs.domain.AbstractReference extends DomainObject implements Serializable

serialVersionUID:

1L

Serialized Fields

name

String name

The unique name to identify the reference.

meta

String meta

Class com.neurosys.refs.domain.ActivityRef extends Reference implements Serializable

serialVersionUID:

1L

Class com.neurosys.refs.domain.AffiliateRef extends Reference implements Serializable

serialVersionUID:

1L

Class com.neurosys.refs.domain.DataRef extends Reference implements Serializable

serialVersionUID:

1L

Class com.neurosys.refs.domain.DesignationRef extends Reference implements Serializable

serialVersionUID:

1L

Class com.neurosys.refs.domain.OrganizationRef extends PersonOrgRef implements Serializable

serialVersionUID:

1L

Class com.neurosys.refs.domain.PersonOrgRef extends Reference implements Serializable

serialVersionUID:

1L

Class com.neurosys.refs.domain.PersonRef extends PersonOrgRef implements Serializable

serialVersionUID:

1L

Class com.neurosys.refs.domain.PlaceRef extends Reference implements Serializable

serialVersionUID:

1L

Class com.neurosys.refs.domain.PointRef extends PlaceRef implements Serializable

serialVersionUID:

1L

Serialized Fields

geoLocation

GeoLocation geoLocation

Class com.neurosys.refs.domain.Reference extends AbstractReference implements Serializable

serialVersionUID:

1L

Serialized Fields

parent

AbstractReference parent

if this Reference has any parent (main) association.
Example: A.R Rahman is a "Music Director". So if this Reference represents "Music Director" then its parent is the Reference object for A.R Rahman. The authority record is one that has no parent (Reference.parent is null).

related

List<E> related

Any references this object has in ReferenceAlias.
However will not be persisted; for that use ReferenceAlias explicitly
NOTE: This is a Transient field currently, and one must explicitly populate it. TODO: Lazy load from ReferenceAlias

Class com.neurosys.refs.domain.ReferenceAlias extends DomainObject implements Serializable

serialVersionUID:

1L

Serialized Fields

key

ReferenceAliasKey key

Class com.neurosys.refs.domain.ReferenceAliasKey extends Object implements Serializable

serialVersionUID:

1L

Serialized Fields

reference

AbstractReference reference

related

AbstractReference related

Class com.neurosys.refs.domain.ThingRef extends Reference implements Serializable

serialVersionUID:

1L

Package com.neurosys.refs.transformers

Class com.neurosys.refs.transformers.ReferencePersistTransformer extends Object implements Serializable

Serialized Fields

parent

Object parent

A List of References OR a Transformer that dynamically generates a parent Reference for each String token.

Can be null:

true

related

List<E> related

A List of References OR a Transformer that dynamically generates a List of References for each String token.
The List of Reference represented by this can be related using ReferenceAlias where ReferenceAlias#setReference(Reference) refers to the reference being created and ReferenceAlias#setRelated(Reference) refers to one of the ReferencePersistTransformer.related references.

Can be null:

true

createRefIfNotExist

boolean createRefIfNotExist

If true will create Reference.getParent() or ReferenceAlias.getRelated()

Default value:

false

persistTransformer

org.apache.commons.collections.Transformer persistTransformer

The underlying Transformer to persist to data source

Class com.neurosys.refs.transformers.ReferenceToStringTransformer extends Object implements Serializable

Serialized Fields

autoConvertNonRefType

boolean autoConvertNonRefType

If true will entertain non Reference type as String using Object.toString()

This is useful when using common code for processing datasource data for Pure Reference type and non-ref alike.

Default value:

true

Class com.neurosys.refs.transformers.StringToReferenceTransformer extends ReferencePersistTransformer<R extends Reference> implements Serializable

Serialized Fields

type

Class<T> type

The Reference type

splitter

org.apache.commons.collections.Transformer splitter

A StringToListTransformer that will ensure following:

Any String input that is delimited is tokenized with the tokens processed

The output will be a List is String

Can be null:

true

Default value:

null

sanitize

org.apache.commons.collections.Transformer sanitize

The StringToReferenceTransformer.splitter is only applicable for collections, hence sanitization is a pre-process step that can be combined within this for convenience as a Lot of Reference data will need screening and sanitization before it can be entertained.

Any String level validation/sanitization will be performed by the splitter. E.g: _______ or -- or NA type data should be cleaned out to null

Serialized Form

Package com.neurosys.amorphous.domain

Class com.neurosys.amorphous.domain.GenericObject extends HierarchialDomainObject implements Serializable

Serialized Fields

id

name

type

displayName

bitmask

properties

children

value

created

modified

tags

references

Class com.neurosys.amorphous.domain.Response extends ResultRow<T> implements Serializable

Serialized Fields

status

Class com.neurosys.amorphous.domain.ResultRow extends DomainObject implements Serializable

Serialized Fields

refId

value

Package com.neurosys.aws.sns.push.domain

Class com.neurosys.aws.sns.push.domain.PlatformMessageDeliveryAttributes extends ModelObject implements Serializable

Serialized Fields

successFeedbackRoleArn

failureFeedbackRoleArn

successFeedbackSampleRate

arn

snsClient

Class com.neurosys.aws.sns.push.domain.PushNotificationMessage extends DisposableMessage<String,String> implements Serializable

Package com.neurosys.aws.sns.sms.domain

Class com.neurosys.aws.sns.sms.domain.AmazonMessageSettings extends ModelObject implements Serializable

Serialized Fields

regions

type

monthlySpendLimit

senderId

Class com.neurosys.aws.sns.sms.domain.AsynchronousSMS extends SMS implements Serializable

Serialized Fields

consumer

Class com.neurosys.aws.sns.sms.domain.MessageDeliveryAttributes extends ModelObject implements Serializable

Serialized Fields

successFeedbackRoleArn

failureFeedbackRoleArn

successFeedbackSampleRate

arn

snsClient

Class com.neurosys.aws.sns.sms.domain.SMS extends SMS implements Serializable

Serialized Fields

settings

Package com.neurosys.bi.reporting

Class com.neurosys.bi.reporting.AbstractProcessBasedReporter extends BaseIterativeProcessor<TUPLE_IN,RECORD_OUT,STATE> implements Serializable

Serialized Fields

columnNames

Class com.neurosys.bi.reporting.AbstractReporter extends Object implements Serializable

Serialized Fields

params

columnNames

Class com.neurosys.bi.reporting.AuthorizableReporterMeta extends ReporterMeta<PARAM_META> implements Serializable

Serialized Fields

authorizations

authorizableId

authorizableIdAssignable

Class com.neurosys.bi.reporting.DataSourceReporter extends AbstractReporter<T> implements Serializable

Serialized Fields

reporterMeta

dataGenerator

countQuery

noParamsDataGenerator

noParamsCountQuery

Class com.neurosys.bi.reporting.ExportMeta extends Object implements Serializable

Serialized Fields

columnNames

reportWriter

reportWriterProperties

Class com.neurosys.bi.reporting.ExportType extends Object implements Serializable

Serialized Fields

name