psdi.app.report

Class Report

java.lang.Object

psdi.mbo.Mbo

psdi.app.report.Report

All Implemented Interfaces:

java.rmi.Remote, ReportRemote, MboConstants, MboRemote, MaxRemoteProxy

public class Report
extends Mbo
implements ReportRemote

Field Summary

Fields inherited from class psdi.mbo.Mbo

MULTILANGCOPY, phantomList, phantomQueue

Fields inherited from interface psdi.mbo.MboConstants

ALLROWS, CHANGEDBY_USER, COUNT_ADDITIONS, COUNT_AFTERSAVE, COUNT_DATABASE, COUNT_DELETED, COUNT_EXISTING, DBCONFIG, DELAYVALIDATION, DELAYVALIDATIONONLY, DISCARDABLE, GOTCOMPLETEWHERE, HIDDEN, NO_RELATEDMBOS_OF_OWNERSCHILDREN_FETCH, NOACCESSCHECK, NOACTION, NOADD, NOCOMMIT, NODELETE, NONE, NOOVERWRITE, NOSAVE, NOSETVALUE, NOUPDATE, NOVALIDATION, NOVALIDATION_AND_NOACTION, NOVALIDATION_AND_NOACTION_ALLOWCROSSOVER, READONLY, REBUILD, REQUIRED, SAMEVALUEVALIDATION, SETBYPARENT, USER

Constructor Summary

Constructors

Constructor and Description
Report(MboSet ms) Construct the Report object

Method Summary

Modifier and Type	Method and Description
void	add() This is called when a new Mbo is added to the Mboset collection.
void	appValidate() Pre-save validation method.
java.lang.String	assembleDOVRequestPage()
java.lang.String	assembleFolderDialog(java.lang.String appName)
java.lang.String	assembleRequestPage(MboRemote report, MboSetRemote lookupset, int reportnum, java.lang.String reporttype)
boolean	canLimitRecords() Does this report type support the Limit Records functionality?
void	checkSiteOrgAccessForSave() Extended this method so that REPORT record can be deleted for QBE reports if the user have DELETEREPT sigoption.
void	delete(long accessModifier) Mark the object to be deleted depending on the access modifier.
MboRemote	duplicate() Duplicates a Report record.
java.lang.String	generateAndReplaceAllXML() Builds the replibrary presentation XML from scratch, ignoring the existing content.
java.lang.String	generateXML(MboRemote appfolder, MboSetRemote lookupset, java.lang.String presentationXML)
java.lang.String	getBaseReportXML()
void	init() Called by the framework when the Mbo has been constructed and the MboValues have been initialized.
java.lang.String	insertDialog(java.lang.String presentationXML, java.lang.String dialogXML, java.lang.String dialogID)
boolean	isLimitedType(java.lang.String runType) Does this report type disable fields due to unsupported functionality?
boolean	isQuickPrintable() Check if the report is Birt for QuickPrinting
void	save() Save the object and other linked objects.
void	setFieldsReadOnly(boolean state) Disable fields that are not used for this report type.
boolean	sigopGranted(java.lang.String app, java.lang.String optionname) Extended this method so that REPORT record can be deleted for QBR reports if the user is the owner, and to evaluate the EDITREPT option for QBRs.
protected boolean	skipCopyField(MboValueInfo mvi) Overrides the skipCopyField() in the Mbo.

Methods inherited from class psdi.mbo.Mbo

addMboSetForRequiredCheck, addToDeleteForInsertList, andEvaluateConditions, blindCopy, canDelete, checkFieldAccess, checkMethodAccess, checkMethodAccess, checkQualifiedRestriction, checkRecordLock, clear, clearRelatedSets, clearRelatedSets, commit, copy, copy, copy, copyFake, copyValue, copyValue, createComm, delete, deleteDoclinks, determineRequiredFieldsFromERM, enableMethod, evaluateCondition, evaluateCondition, evaluateCtrlConditions, evaluateCtrlConditions, evaluateRestriction, excludeObjectForPropagate, findAllNullRequiredFields, fireEvent, generateAutoKey, generateContentUID, getAlwaysFlags, getAttrRestrictionFlag, getAttrRestrictions, getBoolean, getByte, getBytes, getCheckpoint, getClientLocale, getClientTimeZone, getCommLogOwnerNameAndUniqueId, getCondition, getDatabaseValue, getDate, getDeleteForInsertList, getDocLinksCount, getDomainFilterWhere, getDomainIDs, getDouble, getESId, getExistingMboSet, getFetchIndex, getFieldExceptions, getFlags, getFloat, getIgnoreLockCheck, getInitialValue, getInsertCompanySetId, getInsertItemSetId, getInsertOrganization, getInsertOrgForSite, getInsertSite, getInstanciatedMboSet, getInstanciatedMboValue, getInt, getIntegrationService, getKeyValue, getLanguageRecordRowStamp, getLinesRelationship, getList, getLockedByDisplayName, getLockedByUserID, getLong, getMatchingAttr, getMatchingAttr, getMatchingAttrs, getMaxMessage, getMboCtx, getMboData, getMboDataSet, getMboForAttribute, getMboForAttributeStatic, getMboInitialValue, getMboList, getMboLogger, getMboRecordData, getMboServer, getMboSet, getMboSet, getMboSet, getMboSetInfo, getMboSetInfo, getMboValue, getMboValueData, getMboValueData, getMboValueData, getMboValueDataForDownload, getMboValueInfoStatic, getMboValueInfoStatic, getMessage, getMessage, getMessage, getMessage, getMXTransaction, getName, getOrgForGL, getOrgSiteForMaxvar, getOwner, getProfile, getPropagateKeyFlag, getProxy, getRecordIdentifer, getRecordMboName, getRecordType, getRelatedSets, getRelatedWhere, getRelatedWhere, getRelationshipNameToLangTable, getResourceName, getRowRestrictionFlag, getRowStamp, getRowStampObject, getSecurityLogger, getSiteOrg, getSqlLogger, getString, getString, getStringInBaseLanguage, getStringInSpecificLocale, getStringTransparent, getSynonymValueWhere, getTenantId, getTenantIdForNoMboRecordData, getThisMboSet, getTranslator, getUniqueIdentifer, getUniqueIDName, getUniqueIDValue, getUniqueLanguageIDRecord, getUserInfo, getUserName, getValidateOrder, hasFieldAccess, hasHierarchyLink, hasLockSaveRights, hasRelatedQbe, hasUniqueID, initFieldFlagsOnMbo, initRelationship, isApiBatchError, isAppLockEnabled, isAutoKeyed, isBasedOn, isChangeByUserWhenSetFromLookup, isDuringInit, isEAuditFieldModified, isESigFieldModified, isFlagSet, isForDM, isLocked, isLocked, isLockedByMe, isMasterTenant, isMboLockedByMe, isModified, isModified, isNew, isNoSql, isNull, isOptionGranted, isSelected, isSkipCopyField, isValid, isZombie, lock, modify, moveFieldFlagsToMboValue, needCallInitFieldFlag, orEvaluateConditions, propagateKeyValue, removeCtx, removeRelatedSet, resolveNoSqlWhere, rollbackToCheckpoint, select, setAppDefaultValue, setApplicationError, setApplicationRequired, setAutokeyFields, setCopyDefaults, setDatabaseDefaultValues, setDatabaseDefaultValues, setDefaultValue, setDefaultValues, setDeleted, setDuringInit, setEAuditFieldModified, setESId, setESigFieldModified, setFetchIndex, setFieldFlag, setFieldFlag, setFieldFlag, setFieldFlag, setFieldFlag, setFieldFlag, setFieldFlags, setFlag, setFlag, setFlags, setForDM, setHierarchyLink, setIgnoreRecordLockCheck, setLangCodeDefault, setMboCtx, setMLValue, setModified, setModifiedForIntegrationOnly, setNewMbo, setNoSql, setPropagateKeyFlag, setPropagateKeyFlag, setProxy, setReadonlyWhenParentIsReadonly, setRecordType, setReferencedMbo, setReferencedMbo, setResolveNoSqlWhere, setResourceName, setTenantIdForNoMboRecordData, setUniqueIDValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValueFromSequence, setValueNull, setValueNull, sigopGranted, sigopGranted, sigopGranted, sigOptionAccessAuthorized, smartFill, smartFind, smartFind, smartFind, smartFindByObjectName, smartFindByObjectName, smartFindByObjectNameDirect, startCheckpoint, thisToBeUpdated, throwRequiredException, toBeAdded, toBeDeleted, toBeSaved, toBeUpdated, toBeValidated, undelete, undeleteDoclinks, unlock, unselect, useDataSecurity, validate, validateAttributes, validateKeyUniqueness, valueChanged

Methods inherited from class java.lang.Object

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

Methods inherited from interface psdi.mbo.MboRemote

addMboSetForRequiredCheck, addToDeleteForInsertList, blindCopy, checkMethodAccess, clear, copy, copy, copy, copyFake, copyValue, copyValue, createComm, delete, evaluateCondition, evaluateCtrlConditions, evaluateCtrlConditions, excludeObjectForPropagate, generateAutoKey, getBoolean, getByte, getBytes, getCommLogOwnerNameAndUniqueId, getDatabaseValue, getDate, getDeleteForInsertList, getDocLinksCount, getDomainIDs, getDouble, getExistingMboSet, getFlags, getFloat, getIgnoreLockCheck, getInitialValue, getInsertCompanySetId, getInsertItemSetId, getInsertOrganization, getInsertSite, getInt, getKeyValue, getLinesRelationship, getList, getLockedByDisplayName, getLong, getMatchingAttr, getMatchingAttr, getMatchingAttrs, getMaxMessage, getMboData, getMboDataSet, getMboInitialValue, getMboList, getMboSet, getMboSet, getMboSet, getMboValueData, getMboValueData, getMboValueData, getMboValueDataForDownload, getMboValueInfoStatic, getMboValueInfoStatic, getMessage, getMessage, getMessage, getMessage, getMXTransaction, getName, getOrgForGL, getOrgSiteForMaxvar, getOwner, getPropagateKeyFlag, getRecordIdentifer, getSiteOrg, getString, getString, getStringInBaseLanguage, getStringInSpecificLocale, getStringTransparent, getThisMboSet, getUniqueIDName, getUniqueIDValue, getUserInfo, getUserName, hasHierarchyLink, hasLockSaveRights, isAutoKeyed, isBasedOn, isFlagSet, isForDM, isLocked, isLocked, isMasterTenant, isMboLockedByMe, isModified, isModified, isNew, isNull, isOptionGranted, isSelected, isZombie, lock, propagateKeyValue, rollbackToCheckpoint, select, setApplicationError, setApplicationRequired, setAutokeyFields, setCopyDefaults, setDeleted, setESigFieldModified, setFieldFlag, setFieldFlag, setFieldFlag, setFieldFlag, setFieldFlag, setFieldFlag, setFieldFlags, setFlag, setFlag, setFlags, setForDM, setIgnoreRecordLockCheck, setMLValue, setModified, setNewMbo, setPropagateKeyFlag, setPropagateKeyFlag, setReferencedMbo, setReferencedMbo, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValueNull, setValueNull, sigopGranted, sigopGranted, sigOptionAccessAuthorized, smartFill, smartFind, smartFind, smartFind, smartFindByObjectName, smartFindByObjectName, smartFindByObjectNameDirect, startCheckpoint, thisToBeUpdated, toBeAdded, toBeDeleted, toBeSaved, toBeUpdated, toBeValidated, undelete, unlock, unselect, validate, validateAttributes

Constructor Detail

Report

public Report(MboSet ms)
       throws MXException,
              java.rmi.RemoteException

Construct the Report object

Parameters:

ms - Mbo set

Throws:

MXException

java.rmi.RemoteException

Method Detail

add

public void add()
         throws MXException,
                java.rmi.RemoteException

Description copied from class: Mbo

This is called when a new Mbo is added to the Mboset collection. It is called AFTER user defaults have been set from the data dictionary. Programmer should usually override this to set some defaults. Default behavior is to do nothing.

Specified by:

add in interface MboRemote

Overrides:

add in class Mbo

Throws:

MXException

java.rmi.RemoteException

init

public void init()
          throws MXException

Description copied from class: Mbo

Called by the framework when the Mbo has been constructed and the MboValues have been initialized. This can be overridden by the programmer to provide any custom initialization they would like to do.

Overrides:

init in class Mbo

Throws:

MXException

appValidate

public void appValidate()
                 throws MXException,
                        java.rmi.RemoteException

Description copied from class: Mbo

Pre-save validation method. Programmer can override with specific rules.

Overrides:

appValidate in class Mbo

Throws:

MXException

java.rmi.RemoteException

canLimitRecords

public boolean canLimitRecords()
                        throws MXException,
                               java.rmi.RemoteException

Does this report type support the Limit Records functionality?

Specified by:

canLimitRecords in interface ReportRemote

Throws:

MXException

java.rmi.RemoteException

isLimitedType

public boolean isLimitedType(java.lang.String runType)
                      throws MXException,
                             java.rmi.RemoteException

Does this report type disable fields due to unsupported functionality?

Specified by:

isLimitedType in interface ReportRemote

Throws:

MXException

java.rmi.RemoteException

isQuickPrintable

public boolean isQuickPrintable()
                         throws MXException,
                                java.rmi.RemoteException

Check if the report is Birt for QuickPrinting

Specified by:

isQuickPrintable in interface ReportRemote

Throws:

MXException

java.rmi.RemoteException

setFieldsReadOnly

public void setFieldsReadOnly(boolean state)
                       throws MXException,
                              java.rmi.RemoteException

Disable fields that are not used for this report type.

Specified by:

setFieldsReadOnly in interface ReportRemote

Throws:

MXException

java.rmi.RemoteException

generateAndReplaceAllXML

public java.lang.String generateAndReplaceAllXML()
                                          throws MXException,
                                                 java.rmi.RemoteException

Builds the replibrary presentation XML from scratch, ignoring the existing content. This is required when saving QBRs in multi-lang environments, since inserting an individual dialog may result in multiple languages in a single presentation. This process is different from the generateallxml() method used in Report Admin, which locates each dialog within the presentation and updates it. That method supports building dialogs for a subset of reports, but is significantly slower when building all dialogs.

Specified by:

generateAndReplaceAllXML in interface ReportRemote

Returns:

String the replibrary presentation XML.

Throws:

MXException, - RemoteException

MXException

java.rmi.RemoteException

getBaseReportXML

public java.lang.String getBaseReportXML()
                                  throws MXException,
                                         java.rmi.RemoteException

Specified by:

getBaseReportXML in interface ReportRemote

Throws:

MXException

java.rmi.RemoteException

generateXML

public java.lang.String generateXML(MboRemote appfolder,
                                    MboSetRemote lookupset,
                                    java.lang.String presentationXML)
                             throws MXException,
                                    java.rmi.RemoteException

Specified by:

generateXML in interface ReportRemote

Throws:

MXException

java.rmi.RemoteException

assembleFolderDialog

public java.lang.String assembleFolderDialog(java.lang.String appName)
                                      throws MXException,
                                             java.rmi.RemoteException

Throws:

MXException

java.rmi.RemoteException

assembleRequestPage

public java.lang.String assembleRequestPage(MboRemote report,
                                            MboSetRemote lookupset,
                                            int reportnum,
                                            java.lang.String reporttype)
                                     throws MXException,
                                            java.rmi.RemoteException

Specified by:

assembleRequestPage in interface ReportRemote

Throws:

MXException

java.rmi.RemoteException

assembleDOVRequestPage

public java.lang.String assembleDOVRequestPage()
                                        throws MXException,
                                               java.rmi.RemoteException

Throws:

MXException

java.rmi.RemoteException

insertDialog

public java.lang.String insertDialog(java.lang.String presentationXML,
                                     java.lang.String dialogXML,
                                     java.lang.String dialogID)
                              throws MXException,
                                     java.rmi.RemoteException

Throws:

MXException

java.rmi.RemoteException

delete

public void delete(long accessModifier)
            throws MXException,
                   java.rmi.RemoteException

Description copied from class: Mbo

Mark the object to be deleted depending on the access modifier. This will usually be overridden in the subclass of Mbo as there may be application specific rules as to if and when an object can be deleted. Object is not actually deleted in the database until save() is called. This method will also mark all associated Long Description and Translation Mbos for deletion.

Specified by:

delete in interface MboRemote

Overrides:

delete in class Mbo

Parameters:

accessModifier - The bitwise flag specified to determine if certain normal security checks are to be bypassed for this delete request. For example: if the accessModifer is NOACCESSCHECK, then the check for the object's NODELETE flag and the call to the object's canDelete() method will not be performed. If the accessModifer is NONE, then all the access checks are performed before this object is marked delete.

Throws:

MXException

java.rmi.RemoteException

See Also:

Mbo.delete(long)

duplicate

public MboRemote duplicate()
                    throws MXException,
                           java.rmi.RemoteException

Duplicates a Report record. Also duplicates the ReportLookup and ReportLabel for this Report.

Specified by:

duplicate in interface MboRemote

Overrides:

duplicate in class Mbo

Returns:

MboRemote The newly created Report.

Throws:

MXException

java.rmi.RemoteException

skipCopyField

protected boolean skipCopyField(MboValueInfo mvi)
                         throws MXException,
                                java.rmi.RemoteException

Overrides the skipCopyField() in the Mbo. Since this method takes the MboValueInfo as its parameter just check to see if this field needs to be copied or skipped by using the data from the static HashSet. If this field does not need to be copied return true. The following are the Report fields will be skipped without being copied to the newly duplicated Report:

1. reportnum

Overrides:

skipCopyField in class Mbo

Parameters:

mvi - The MboValueInfo object of the MboValue that needs to be copied.

Returns:

true If the field does not need to be copied return true, in all other cases return false.

Throws:

MXException

java.rmi.RemoteException

See Also:

Report.loadSkipFieldCopyHashSet()

save

public void save()
          throws MXException,
                 java.rmi.RemoteException

Description copied from class: Mbo

Save the object and other linked objects. Subclasses can code their save() logic to include any appropriate updates to other linked objects and call super.save().

Overrides:

save in class Mbo

Throws:

MXException

java.rmi.RemoteException

sigopGranted

public boolean sigopGranted(java.lang.String app,
                            java.lang.String optionname)
                     throws MXException,
                            java.rmi.RemoteException

Extended this method so that REPORT record can be deleted for QBR reports if the user is the owner, and to evaluate the EDITREPT option for QBRs.

Specified by:

sigopGranted in interface MboRemote

Overrides:

sigopGranted in class Mbo

Parameters:

app - Application name

optionname - Option name

Returns:

True if granted, else False

Throws:

MXException

java.rmi.RemoteException

See Also:

Profile.getAppLevel(java.lang.String), MboSetInfo.getSiteOrgType(), Profile.getAppOptionAuth(java.lang.String, java.lang.String, java.lang.String), Profile.getNonStandardAppOptionAuth(java.lang.String, java.lang.String, java.lang.String, java.lang.String), Profile.getConditions(java.lang.String, java.lang.String, java.lang.String), Mbo.evaluateCondition(String)

checkSiteOrgAccessForSave

public void checkSiteOrgAccessForSave()
                               throws MXException,
                                      java.rmi.RemoteException

Extended this method so that REPORT record can be deleted for QBE reports if the user have DELETEREPT sigoption.

Overrides:

checkSiteOrgAccessForSave in class Mbo

Throws:

MXException

java.rmi.RemoteException

See Also:

MboSet.getApp(), Mbo.sigopGranted(String, String)