Class ReportFormat
- All Implemented Interfaces:
Displayable
,StringFiller
,HasId
- Author:
- Syam
-
Field Summary
Fields inherited from class com.storedobject.core.StoredObject
logger
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionstatic void
Attribute list of the "data class".static ReportFormat
Get the "report format" definition for the given parameter.static ReportFormat
get
(SystemEntity entity) Get the "report format" definition for the given parameter.static ReportFormat
Get the "report format" definition for the given parameter.int
Get the default paper size.Get the paper size value name for this instance.static String
getDefaultPaperSizeValue
(int value) Get the paper size value name for the given value.static String[]
Get the supported paper size value names.Get the entityId
for which this "report format" definition is applicable.Get the entityId
for which this "report format" definition is applicable.int
Get the position of the logo in the report.Get the position value of the logo for this instance.static String
getLogoPositionValue
(int position) Get the position value of the logo for the given position.static String[]
Get the position values of the logo.Get the unique condition that determines the uniqueness of this "data class".static void
Definition of indices of the "data class".void
setDefaultPaperSize
(int defaultPaperSize) Set the default paper size.void
Set the entity.void
setEntity
(SystemEntity entity) Set the entity.void
setEntity
(BigDecimal idValue) Set the entity.void
setLogoPosition
(int logoPosition) Set the position of the logo in the report.void
This will be invoked by the system whenever the object is saved to the DB.Methods inherited from class com.storedobject.core.StoredObject
addLink, addLink, addLink, addLink, addLink, addLink, addLink, addLink, checkCurrency, checkCurrency, checkForDuplicate, checkForDuplicate, checkTimeZone, checkTransaction, clearObjectLinks, contemporary, copy, copy, count, count, count, count, count, count, countLinks, countLinks, countLinks, countLinks, countLinks, countLinks, countLinks, countLinks, countLinks, countLinks, countLinks, countLinks, countLinks, countLinks, countLinks, countLinks, countLinks, countLinks, countLinks, countLinks, countLinks, countLinks, countLinks, countLinks, countMasters, countMasters, countMasters, countMasters, countMasters, countMasters, countMasters, countMasters, countMasters, countMasters, countMasters, countMasters, countMasters, countMasters, countMasters, countMasters, countMasters, countMasters, countMasters, countMasters, countMasters, countMasters, countMasters, countMasters, create, created, delete, delete, delete, deleted, directUpdate, equals, exists, exists, exists, exists, exists, existsFileData, existsLink, existsLink, existsLink, existsLink, existsLink, existsLink, existsLink, existsLink, existsLinks, existsLinks, existsLinks, existsLinks, existsLinks, existsLinks, existsLinks, existsLinks, existsLinks, existsLinks, existsLinks, existsLinks, existsLinks, existsLinks, existsLinks, existsLinks, existsLinks, existsLinks, existsLinks, existsLinks, existsLinks, existsLinks, existsLinks, existsLinks, existsLinks, existsLinks, existsMaster, existsMaster, existsMasters, existsMasters, existsMasters, existsMasters, existsMasters, existsMasters, existsMasters, existsMasters, existsMasters, existsMasters, existsMasters, existsMasters, existsMasters, family, family, family, fill, get, get, get, get, get, get, get, get, get, get, get, get, get, get, get, get, get, get, getAttachment, getAttachmentId, getChildren, getDeleted, getDeleted, getExistsCondition, getExistsCondition, getFileData, getFileData, getHistorical, getId, getKeyIndex, getMaster, getMaster, getMaster, getMaster, getMaster, getMaster, getMaster, getMaster, getMaster, getMaster, getMaster, getMaster, getMaster, getMaster, getMaster, getMaster, getMaster, getMaster, getMaster, getMaster, getMaster, getMaster, getMaster, getMaster, getNotExistsCondition, getNotExistsCondition, getParent, getParent, getParent, getParentId, getParentId, getParentId, getRelated, getRelated, getTransaction, getTransactionId, getTransactionIP, getUnique, hashCode, inserted, isModified, isVirtual, list, list, list, list, list, list, list, list, list, list, list, list, list, listFileData, listFileData, listHistory, listLinks, listLinks, listLinks, listLinks, listLinks, listLinks, listLinks, listLinks, listLinks, listLinks, listLinks, listLinks, listLinks, listLinks, listLinks, listLinks, listLinks, listLinks, listLinks, listLinks, listLinks, listLinks, listLinks, listLinks, listLinks, listLinks, listLinks, listLinks, listLinks, listLinks, listLinks, listLinks, listLinks, listLinks, listLinks, listLinks, listLinks, listLinks, listMasters, listMasters, listMasters, listMasters, listMasters, listMasters, listMasters, listMasters, listMasters, listMasters, listMasters, listMasters, listMasters, listMasters, listMasters, listMasters, listMasters, listMasters, listMasters, listMasters, listMasters, listMasters, listMasters, listMasters, listMasters, listMasters, listMasters, listMasters, listMasters, listMasters, listMasters, listMasters, listMasters, listMasters, listMasters, listMasters, listMasters, listMasters, listTree, listTree, listTree, listTree, listViaQuery, listViaQuery, load, load, load, load, loaded, loading, makeNew, makeVirtual, migrate, moduleName, nextVersion, objectLink, objectLink, objectLink, objectLinks, objectLinks, old, person, previousVersion, previousVersion, query, query, query, query, query, query, query, query, query, query, query, queryLinks, queryLinks, queryLinks, queryLinks, queryLinks, queryLinks, queryLinks, queryLinks, queryLinks, queryLinks, queryLinks, queryLinks, queryLinks, queryLinks, queryLinks, queryLinks, queryLinks, queryLinks, queryLinks, queryLinks, queryLinks, queryLinks, queryLinks, queryLinks, queryLinks, queryLinks, queryLinks, queryLinks, queryLinks, queryLinks, queryLinks, queryLinks, queryLinks, queryLinks, queryLinks, queryLinks, queryLinks, queryLinks, queryMasters, queryMasters, queryMasters, queryMasters, queryMasters, queryMasters, queryMasters, queryMasters, queryMasters, queryMasters, queryMasters, queryMasters, queryMasters, queryMasters, queryMasters, queryMasters, queryMasters, queryMasters, queryMasters, queryMasters, queryMasters, queryMasters, queryMasters, queryMasters, queryMasters, queryMasters, queryMasters, queryMasters, queryMasters, queryMasters, queryMasters, queryMasters, queryMasters, queryMasters, queryMasters, queryMasters, queryMasters, reload, reload, reloaded, removeAllLinks, removeAllLinks, removeAllLinks, removeAllLinks, removeAllLinks, removeAllLinks, removeAllLinks, removeAllLinks, removeAllLinks, removeAllLinks, removeAllLinks, removeAllLinks, removeLink, removeLink, removeLink, removeLink, removeLink, removeLink, removeLink, removeLink, removeLink, removeLink, removeLink, removeLink, removeReverseLinks, removeReverseLinks, save, save, save, save, save, save, save, save, save, save, save, save, save, save, saved, saving, setMaster, setRawValue, setTransaction, stringify, tableName, timestamp, toCode, toDisplay, toString, transacting, undelete, undelete, undeleted, updated, user, userId, validate, validateChildAttach, validateChildDetach, validateChildUpdate, validateDelete, validateInsert, validateParentAttach, validateParentDetach, validateParentUpdate, validateUndelete, validateUpdate, valueEquals
-
Constructor Details
-
Method Details
-
columns
Attribute list of the "data class".- Parameters:
columns
- Columns to which attributes to be added.
-
indices
Definition of indices of the "data class".- Parameters:
indices
- Indices to which index definitions yo be added.
-
getUniqueCondition
Get the unique condition that determines the uniqueness of this "data class".- Overrides:
getUniqueCondition
in classStoredObject
- Returns:
- Unique condition.
-
setEntity
-
setEntity
Set the entity. (If no entity is set, the "report format" definition will be applicable to all entities for which no specific "report format" definition exists.- Parameters:
idValue
- A value from whichId
of the entity can be determined.
-
setEntity
Set the entity. (If no entity is set, the "report format" definition will be applicable to all entities for which no specific "report format" definition exists.- Parameters:
entity
- Entity.
-
getEntityId
-
getEntity
Get the entityId
for which this "report format" definition is applicable.- Returns:
- The entity or
null
if it is applicable for all entities.
-
setDefaultPaperSize
public void setDefaultPaperSize(int defaultPaperSize) Set the default paper size.- Parameters:
defaultPaperSize
- Default paper size. 0 = A4, 1 = Letter.
-
getDefaultPaperSize
-
getDefaultPaperSizeValues
Get the supported paper size value names.- Returns:
- Array of paper size value names.
-
getDefaultPaperSizeValue
Get the paper size value name for the given value.- Parameters:
value
- Value for which paper size value name needs to be obtained.- Returns:
- Paper size value name.
-
getDefaultPaperSizeValue
Get the paper size value name for this instance.- Returns:
- Paper size value name.
-
setLogoPosition
public void setLogoPosition(int logoPosition) Set the position of the logo in the report. Position values are as follows:0: Left with product logo on the right
1: Left with no product logo
2: Right with product logo on the left
3: Right with no product logo
4: Centered with no product logo
5: No logo / header image"
6: As header-image on the left with product logo on the right"
7: As header-image on the left with no product logo"
8: As header-image on the right with product logo on the left"
9: As header-image on the right with no product logo"
- Parameters:
logoPosition
- Position.
-
getLogoPosition
Get the position of the logo in the report. SeesetLogoPosition(int)
.- Returns:
- Position.
-
getLogoPositionValues
Get the position values of the logo. SeesetLogoPosition(int)
.- Returns:
- Position values.
-
getLogoPositionValue
Get the position value of the logo for the given position. SeesetLogoPosition(int)
.- Parameters:
position
- Position- Returns:
- Position value.
-
getLogoPositionValue
Get the position value of the logo for this instance. SeesetLogoPosition(int)
.- Returns:
- Position value.
-
validateData
Description copied from class:StoredObject
This will be invoked by the system whenever the object is saved to the DB. It will be invoked in all cases, while creating new objects and updating/deleting/un-deleting existing objects. If any exception is raised by this method, the process of saving to the DB will be abandoned.
Note: This method is mainly used to validate the data of all attributes of the object and it may be used by others for validating the object. For example, front-end data-entry systems can use this method for validating the object.
- Overrides:
validateData
in classStoredObject
- Parameters:
tm
- Current transaction manager.- Throws:
Exception
- If data is invalid.
-
get
Get the "report format" definition for the given parameter.- Parameters:
entity
- Instance needs to be obtained for this parameter.- Returns:
- Instance of the "report format" definition configured. If nothing is found a default one will be created.
-
get
Get the "report format" definition for the given parameter.- Parameters:
entity
- Instance needs to be obtained for this parameter.- Returns:
- Instance of the "report format" definition configured. If nothing is found a default one will be created.
-
get
Get the "report format" definition for the given parameter.- Parameters:
tm
- Instance needs to be obtained for entity of thisTransactionManager
.- Returns:
- Instance of the "report format" definition configured. If nothing is found a default one will be created.
-