psdi.app.swcatalog

Class SoftwareCatalog

java.lang.Object

psdi.mbo.Mbo

psdi.app.swcatalog.SoftwareCatalog

All Implemented Interfaces:

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

public class SoftwareCatalog
extends Mbo
implements SoftwareCatalogRemote

The implementation of the Software Catalog business object. Provides services to generate a quasi-unique ID, manage write access to the attributes, and allow the business object to service both the software catalog entries and their variants. fields

Since:

7.2

Author:

Petko Popov

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	FILTER_TYPE_CHILDRELATION make the selected records product parents of the current main record
static java.lang.String	FILTER_TYPE_CHILDRELEASE make the selected records hierarchical release children of the current main record (which must be a version)
static java.lang.String	FILTER_TYPE_CHILDVERSION make the selected records hierarchical version children of the current main record (which must be a release)
static java.lang.String	FILTER_TYPE_CONVERSIONVARIANT make the selected records conversion variants of the current main record
static java.lang.String	FILTER_TYPE_PARENTRELATION make the selected records product children of the current main record

Fields inherited from class psdi.mbo.Mbo

MULTILANGCOPY, phantomList, phantomQueue

Fields inherited from interface psdi.app.swcatalog.SoftwareCatalogRemote

UNIQUE_ID_COMPONENTS, UNIQUE_ID_SEPARATOR, VER_REL_SEPARATOR

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
SoftwareCatalog(MboSet ms) The boilerplate constructor

Method Summary

Modifier and Type	Method and Description
void	add() Set isreviewed and make it Read-Only.
void	canDelete() Do not allow the entry to be deleted if there is any reference to it
static java.lang.String	combineSubClauses(java.lang.String[] subClauses) Utility method to combine sub-clauses into one clause, joining them with the operator "and"
void	delete(long accessModifier) If this is a variant then disassociate it.
java.lang.String	generateUniqueId() Generate a "unique" ID for this MBO.
static java.lang.String	generateUniqueId(java.lang.String swname, java.lang.String version, java.lang.String release, java.lang.String manufacturer, java.lang.String unknownString) Generate a "unique" ID based on four parameters: For SWNAME, VERSION, RELEASE, MANUFACTURER, Replace nulls parameters with with empty strings Set SWNAME := TRIM(SWNAME); Set VERSION := TRIM(VERSION); Set RELEASE := TRIM(RELEASE); Set MANUFACTURER := TRIM(MANUFACTURER); If (RELEASE is empty) then {Set VERREL := VERSION} else {Set VERREL := VERSION + '.' + RELEASE}; // note that if version is empty there will be two adjacent | characters If (SWNAME is empty) then SWNAME := [dpa_unknown property value]; If (VERREL is empty) then VERREL := [dpa_unknown property value]; // Note that if version is empty but release is not, there will not be UNKKNOWN in the place of version If (MANUFACTURER is empty) then MANUFACTURER := [dpa_unknown property value]; Set uniqueid := UPPERCASE(SWNAME + '|' + VERREL + '|' + MANUFACTURER);
static MboRemote	getCatalogRecord(long tloamsoftwareid, UserInfo userInfo) Retrieve from the database the catalog record based on its unique TLOAMSOFTWAREID
static java.lang.String	getFilterClause(java.lang.String requestedType)
SoftwareCatalogRemote	getParent() Get Parent in the Product-Version-Release hierarchy
java.lang.String	getVuiExhibitID() Get the Value Unit Exhibit List ID.
void	init() Manage read-only attributes based on if this is a new object, or an imported one.
void	modify() Set the hidden unique key as many times as needed
void	save() Always force the reviewed flag on manual save.
void	setNameAndTypeReadOnly() Make the fields SWNAME and TYPE of this MBO read-only if this MBO is a main record
boolean	toBeSaved() If disassociating a variant or breaking the hierarchy, always save; otherwise return base implementation
void	undelete() If this is a variant then reassociate it.

Methods inherited from class psdi.mbo.Mbo

addMboSetForRequiredCheck, addToDeleteForInsertList, andEvaluateConditions, appValidate, blindCopy, checkFieldAccess, checkMethodAccess, checkMethodAccess, checkQualifiedRestriction, checkSiteOrgAccessForSave, clear, copy, copy, copy, copyFake, copyValue, copyValue, createComm, delete, determineRequiredFieldsFromERM, duplicate, 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, getMboValue, getMboValueData, getMboValueData, getMboValueData, getMboValueDataForDownload, getMboValueInfoStatic, getMboValueInfoStatic, getMessage, getMessage, getMessage, getMessage, getMXTransaction, getName, getOrgForGL, getOrgSiteForMaxvar, getOwner, getProfile, getPropagateKeyFlag, getProxy, getRecordIdentifer, getRecordMboName, getRelatedWhere, getRelatedWhere, getRelationshipNameToLangTable, getResourceName, getRowRestrictionFlag, getRowStamp, getRowStampObject, getSecurityLogger, getSiteOrg, getSqlLogger, getString, getString, getStringInBaseLanguage, getStringInSpecificLocale, getStringTransparent, getSynonymValueWhere, getTenantId, getThisMboSet, getTranslator, getUniqueIdentifer, getUniqueIDName, getUniqueIDValue, getUniqueLanguageIDRecord, getUserInfo, getUserName, getValidateOrder, hasFieldAccess, hasHierarchyLink, hasLockSaveRights, hasRelatedQbe, hasUniqueID, initFieldFlagsOnMbo, initRelationship, isApiBatchError, isAutoKeyed, isBasedOn, isChangeByUserWhenSetFromLookup, isEAuditFieldModified, isESigFieldModified, isFlagSet, isForDM, isLocked, isLocked, isLockedByMe, isMasterTenant, isMboLockedByMe, isModified, isModified, isNew, isNoSql, isNull, isOptionGranted, isSelected, isSkipCopyField, isValid, isZombie, lock, moveFieldFlagsToMboValue, needCallInitFieldFlag, orEvaluateConditions, propagateKeyValue, removeCtx, removeRelatedSet, resolveNoSqlWhere, rollbackToCheckpoint, select, setAppDefaultValue, setApplicationError, setApplicationRequired, setAutokeyFields, setCopyDefaults, setDefaultValue, setDefaultValues, setDeleted, 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, setReferencedMbo, setReferencedMbo, setResolveNoSqlWhere, setResourceName, 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, smartFindByObjectName, smartFindByObjectName, smartFindByObjectNameDirect, startCheckpoint, thisToBeUpdated, toBeAdded, toBeDeleted, toBeUpdated, toBeValidated, unlock, unselect, useDataSecurity, validate, validateAttributes, validateKeyUniqueness, valueChanged

Methods inherited from class java.lang.Object

equals, 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, duplicate, 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, sigopGranted, sigOptionAccessAuthorized, smartFill, smartFind, smartFind, smartFindByObjectName, smartFindByObjectName, smartFindByObjectNameDirect, startCheckpoint, thisToBeUpdated, toBeAdded, toBeDeleted, toBeUpdated, toBeValidated, unlock, unselect, validate, validateAttributes

Field Detail

FILTER_TYPE_CHILDVERSION

public static final java.lang.String FILTER_TYPE_CHILDVERSION

make the selected records hierarchical version children of the current main record (which must be a release)

See Also:

Constant Field Values

FILTER_TYPE_CHILDRELEASE

public static final java.lang.String FILTER_TYPE_CHILDRELEASE

make the selected records hierarchical release children of the current main record (which must be a version)

See Also:

Constant Field Values

FILTER_TYPE_PARENTRELATION

public static final java.lang.String FILTER_TYPE_PARENTRELATION

make the selected records product children of the current main record

See Also:

Constant Field Values

FILTER_TYPE_CHILDRELATION

public static final java.lang.String FILTER_TYPE_CHILDRELATION

make the selected records product parents of the current main record

See Also:

Constant Field Values

FILTER_TYPE_CONVERSIONVARIANT

public static final java.lang.String FILTER_TYPE_CONVERSIONVARIANT

make the selected records conversion variants of the current main record

See Also:

Constant Field Values

Constructor Detail

SoftwareCatalog

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

The boilerplate constructor

Parameters:

ms -

Throws:

MXException

java.rmi.RemoteException

Method Detail

init

public void init()
          throws MXException

Manage read-only attributes based on if this is a new object, or an imported one. If it is a new object, all attributes editable. If it is an imported entry, check if the catalog source is marked as editable (SwKBT and TAD/z does not allow editing, all 3rd party catalogs do).

Restrict the editability of TYPE if conditions are met

Make ISREVIEWED field Read-Only if its value is TRUE

Overrides:

init in class Mbo

Throws:

MXException

setNameAndTypeReadOnly

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

Make the fields SWNAME and TYPE of this MBO read-only if this MBO is a main record

Specified by:

setNameAndTypeReadOnly in interface SoftwareCatalogRemote

Throws:

MXException

java.rmi.RemoteException

add

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

Set isreviewed and make it Read-Only. Set invisible fields if necessary

Specified by:

add in interface MboRemote

Overrides:

add in class Mbo

Throws:

MXException

java.rmi.RemoteException

toBeSaved

public boolean toBeSaved()
                  throws java.rmi.RemoteException

If disassociating a variant or breaking the hierarchy, always save; otherwise return base implementation

Specified by:

toBeSaved in interface MboRemote

Overrides:

toBeSaved in class Mbo

Throws:

java.rmi.RemoteException

generateUniqueId

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

Generate a "unique" ID for this MBO. Read SWNAME, VERSION, RELEASE, MANUFACTURER from the record and pass them to a static method to obtain that produces a quasi-unique ID

Specified by:

generateUniqueId in interface SoftwareCatalogRemote

Returns:

String

Throws:

java.rmi.RemoteException

MXException

generateUniqueId

public static java.lang.String generateUniqueId(java.lang.String swname,
                                                java.lang.String version,
                                                java.lang.String release,
                                                java.lang.String manufacturer,
                                                java.lang.String unknownString)
                                         throws java.rmi.RemoteException,
                                                MXException

Generate a "unique" ID based on four parameters: For SWNAME, VERSION, RELEASE, MANUFACTURER, Replace nulls parameters with with empty strings Set SWNAME := TRIM(SWNAME); Set VERSION := TRIM(VERSION); Set RELEASE := TRIM(RELEASE); Set MANUFACTURER := TRIM(MANUFACTURER); If (RELEASE is empty) then {Set VERREL := VERSION} else {Set VERREL := VERSION + '.' + RELEASE}; // note that if version is empty there will be two adjacent | characters If (SWNAME is empty) then SWNAME := [dpa_unknown property value]; If (VERREL is empty) then VERREL := [dpa_unknown property value]; // Note that if version is empty but release is not, there will not be UNKKNOWN in the place of version If (MANUFACTURER is empty) then MANUFACTURER := [dpa_unknown property value]; Set uniqueid := UPPERCASE(SWNAME + '|' + VERREL + '|' + MANUFACTURER);

Returns:

String

Throws:

java.rmi.RemoteException

MXException

modify

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

Set the hidden unique key as many times as needed

Overrides:

modify in class Mbo

Throws:

MXException

java.rmi.RemoteException

See Also:

Mbo.modify()

save

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

Always force the reviewed flag on manual save. If disassociating a variant, do not delete the record.

Throws:

java.rmi.RemoteException

MXException

delete

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

If this is a variant then disassociate it. Always mark as deleted - this will ensure the proper visual display of the "pending delete" status

Specified by:

delete in interface MboRemote

Overrides:

delete in class Mbo

Parameters:

long -

Throws:

MXException

java.rmi.RemoteException

See Also:

Mbo.delete(long)

undelete

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

If this is a variant then reassociate it. Always do the base undelete - this will ensure the proper visual display of the "pending delete" status

Specified by:

undelete in interface MboRemote

Overrides:

undelete in class Mbo

Parameters:

long -

Throws:

MXException

java.rmi.RemoteException

canDelete

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

Do not allow the entry to be deleted if there is any reference to it

Overrides:

canDelete in class Mbo

Throws:

MXException

java.rmi.RemoteException

getVuiExhibitID

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

Get the Value Unit Exhibit List ID. If value of the current node is null or empty retrieve the value from the parent. recursive call.

Specified by:

getVuiExhibitID in interface SoftwareCatalogRemote

Returns:

String vulExhibitID or null if none is set

Throws:

MXException

java.rmi.RemoteException

getParent

public SoftwareCatalogRemote getParent()
                                throws MXException,
                                       java.rmi.RemoteException

Get Parent in the Product-Version-Release hierarchy

Specified by:

getParent in interface SoftwareCatalogRemote

Returns:

Parent ID

Throws:

MXException

java.rmi.RemoteException

getFilterClause

public static java.lang.String getFilterClause(java.lang.String requestedType)

combineSubClauses

public static java.lang.String combineSubClauses(java.lang.String[] subClauses)

Utility method to combine sub-clauses into one clause, joining them with the operator "and"

Parameters:

subClauses - an array of sub-clauses to be combined

Returns:

the clauses and-ed

getCatalogRecord

public static MboRemote getCatalogRecord(long tloamsoftwareid,
                                         UserInfo userInfo)
                                  throws java.rmi.RemoteException,
                                         MXException

Retrieve from the database the catalog record based on its unique TLOAMSOFTWAREID

Parameters:

tloamsoftwareid - - the key value for TLOAMSOFTWARE.TLOAMSOFTWAREID

userInfo - - the user credentials to retrieve the MBO

Returns:

the record, or null if the ID is not found

Throws:

MXException

java.rmi.RemoteException