public class MboSetInfo extends CachedObjectPointer implements java.io.Serializable
A business object aslo has relationships to other business objects. The relationships are used to construct appropriate business objects and to fetch appropriate data from database.
This class provides various methods to retrieve business object information.
Modifier and Type | Field and Description |
---|---|
static java.lang.String |
CACHE_NAME |
static int |
COMPANYSET4
Flag to indicate company set level business object
|
static int |
INTNOLIMIT |
static int |
INTNOTINITIALIZED |
static int |
ITEMSET3
Flag to indicate item set level business object
|
static int |
ORGAPPFILTER7
this type will be treated as Org level but can ask the Profile for a
list of Sites in the context of an application so that the app can
filter data
|
static int |
ORGLEVEL2
Flag to indicate organization level business object.
|
static int |
ORGSITE10
These applications will be treated like Org level applications but can
ask the Profile for Sites
|
static int |
RestrictionEvalByOrg |
static int |
RestrictionEvalBySite |
static int |
RestrictionEvalBySiteOrg |
static int |
RestrictionEvalSystem |
static int |
SITEAPPFILTER8
this type will be treated as SITE level but can ask the Profile for a
list of Sites in the context of an application so that the app can
filter data
|
static int |
SITELEVEL1
Flag to indicate site level business object.
|
static int |
SYSTEMAPPFILTER6
this type will be treated like System level applications, but can
ask the Profile for a list of sites and/or Orgs in the context of an
application so that the app can filter the data.
|
static int |
SYSTEMLEVEL0
Flag to indicate system level business object.
|
static int |
SYSTEMORG11
These applications will be treated like System level applications but can ask the
Profile for Orgs.
|
static int |
SYSTEMORGSITE9
These apps will be treated like System level applications, but can ask
the Profile for a list of orgs or Sites
|
static int |
SYSTEMSITE5
Flag to indicate system with site level business object
Here org and site can be optional
|
Modifier and Type | Method and Description |
---|---|
void |
addAttribute(MboValueInfo attributeInfo)
Adds attribute information to the cache that this object
maintains for quick lookup.
|
void |
clearAttributes()
For use by MaximoDD
cleanNonAutoViews . |
int |
evalForDataRestriction()
This method what attribute value (if any) should be passed to
Profile when determining whether a data restriction should be
applied to a Mbo.
|
java.util.HashSet<java.lang.String> |
getAllUniqueColumns()
Returns a hashset of all unique column names.
|
java.lang.String |
getAppValidateEventName() |
EventTopic[] |
getAppValidateEventTopic()
Get the event topic for the init of this kind of Mbo.
|
MboValueInfo |
getAttribute(java.lang.String attributeName)
Looks up the attrbute name in the cache to get the attribute
information.
|
int |
getAttributeCount()
Returns the number of attributes that this business object has.
|
java.util.Map |
getAttributeDetails()
For use by MaximoDD
cleanNonAutoViews . |
java.util.Iterator |
getAttributes()
Returns an Iterator to iterate over all the attributes of this
business object.
|
MboSetInfo |
getBaseMboInfo()
Returns reference to a base business object information,
if this business object is inherited from another business object.
|
java.lang.String |
getCacheName() |
java.lang.String |
getClassName()
Returns a Java class name with a fully qualified package name
that provides implementation details of the business object.
|
java.lang.String |
getContentAttrName()
Returns unique Content Attribute Name associated with the given object, if any.
|
java.lang.String |
getDescription()
Returns description of what this business object is for.
|
java.util.Iterator |
getEAuditAttributes()
Returns an array of attributes that are enabled for electronic audit
and for which the values need to be saved to the audit table.
|
java.lang.String |
getEAuditFilter()
Returns a filter (SQL where clause) to be applied to determine
whether the business object data modifications need to be
prompted for electronic signature.
|
Entity |
getEntity()
Returns an Entity object reference that can be used to find out
persistance details of this object.
|
java.lang.String |
getEntityName()
Returns name of database table or view on which this business object
is based.
|
java.lang.String |
getESigFilter()
Returns a filter (SQL where clause) to be applied to determine
whether the business object data modifications need to be
prompted for electronic signature or not.
|
int |
getExtendedAttributeCount()
Returns the number of extended attributes that this
business object has.
|
int |
getExtendedAttributeNumber() |
java.util.Iterator |
getExtendedAttributes()
Returns an Iterator to iterate over all the extended attributes
of this business object.
|
java.lang.String |
getExtendedViewName() |
java.lang.String |
getExtendsObject()
Returns base business object name from which this business
object is inherited, if the business object is inherited
from another one.
|
int |
getFetchAttributeCount()
Returns the number of fetch attributes that this
business object has.
|
int |
getFetchAttributeNumber() |
java.util.Iterator |
getFetchAttributes()
Returns an Iterator to iterate over all the fetch attributes
of this business object.
|
int |
getFetchStopLimit()
Get the fetch stop limit.
|
java.util.List<java.lang.String> |
getHierarchyList() |
java.lang.String |
getInitEventName() |
EventTopic[] |
getInitEventTopic()
Get the event topic for the init of this kind of Mbo.
|
java.util.Iterator |
getKeyAttributeIterator()
Returns an Iterator to iterate over all the key attributes
of this business object.
|
java.lang.String[] |
getKeyAttributes()
Returns an array of primary key attribute names in the
primary key sequence sort order.
|
java.lang.String |
getKeyRelationship()
Returns a SQL where clause with the appropriate key
attribute bindings.
|
java.lang.String |
getKeyRelationshipWhere() |
int |
getKeySize()
Returns the number of attributes that form a key.
|
java.util.HashMap<java.lang.String,java.lang.String> |
getLangTableNames()
Return the language table names of this object.
|
java.util.Iterator |
getLongDescriptionAttributes()
Returns an Iterator to iterate over all the attributes
of this business object that have long description.
|
MXLogger |
getMboLogger()
Returns a logger to log messages related to this business object.
|
java.lang.Class |
getMboSetClass()
Return the class of the MboSet to be used to instantiate the.
|
int |
getMboValueCount()
Returns the number of attributes associated with this
business object.
|
MboValueInfo |
getMboValueInfo(java.lang.String attributeName)
Looks up the attrbute name in the cache to get the attribute
information.
|
java.util.Enumeration |
getMboValuesInfo()
Return an Enumeration object to enumerate over all attributes
of this business object.
|
java.lang.String |
getName()
Returns the name of the business object.
|
java.lang.String |
getObjectName()
Returns the name of this Business object.
|
int |
getPersistentAttributeCount()
Returns the number of persistent attributes that this
business object has.
|
java.util.Iterator |
getPersistentAttributes()
Returns an Iterator to iterate over all the persistent attributes
of this business object.
|
int |
getPresistentAttributeNumber() |
RelationInfo |
getRelationInfo(java.lang.String relationshipName)
Returns relationship information for the given relationship name.
|
RelationInfo |
getRelationshipToChild(java.lang.String child)
Returns relationship information for the given business object name,
if the given business object name is related to this one.
|
java.util.Iterator |
getRelationsInfo()
Returns an Iterator to iterate over all the relationships that
this business object has with other business objects.
|
MXLogger |
getSecurityLogger()
Returns a logger to log SQL messages related to this business object.
|
ServiceInfo |
getServiceInfo()
Return information about the service for this MboSet.
|
java.lang.String |
getServiceName()
Returns service name that represents the business object.
|
int |
getSiteOrgType()
Level at which the business object is used
(site/organization/system/organizationWithSite).
|
java.lang.String |
getSiteOrgTypeAsString()
Returns the level at which the business object is used
(site/organization/system/organizationWithSite).
|
MXLogger |
getSqlLogger()
Returns a logger to log SQL messages related to this business object.
|
java.lang.String[] |
getTableAndColumn(java.lang.String attr)
Return the Table and column name of the entity attribute.
|
java.lang.String |
getTextdirection() |
MXLogger |
getTransactionLogger()
Get the transaction logger.
|
MboSetInfoBase |
getTypedReference() |
java.util.HashSet<java.lang.String> |
getUniqueEntityColumns() |
java.lang.String |
getUniqueIDName()
Returns unique ID Name associated with the given object, if any.
|
boolean |
hasExtendedAttrs()
Returns true if this is an original object and it has extended attributes.
|
boolean |
hasNullableKeyAttr()
Returns whether there is nullable key fields.
|
boolean |
isAsUniqueId(java.lang.String attrName)
Whether the passed in attribute corresponding to a unique id column of a
table that this object is based on.
|
boolean |
isAuditTable()
Whether this is an audit table.
|
boolean |
isBasedOn(java.lang.String name)
Returns whether this business object is based on the given
object name or not.
|
boolean |
isEAuditEnabled()
Returns whether this business object is enabled for electronic
auditing or not.
|
boolean |
isImported()
Returns whether or not the business object is created based on
a table that is imported into MAXIMO data dictionary tables.
|
boolean |
isIncludedParentRelationship() |
boolean |
isInternal()
Returns whether this business object is and internal one.
|
boolean |
isLanguageTable()
Whether this is the language table.
|
boolean |
isMainObject()
Returns whether this object is Main object.
|
boolean |
isMLInUse()
Wether the multi-language support is turned on for this mbo set.
|
boolean |
isPersistent()
Returns whether the business object is persistent or not
(whether the data is stored/retrieved from the database or not).
|
boolean |
isTenantOwned() |
boolean |
isTextSearchEnabled() |
boolean |
isUserdefined()
Returns whether the business object is default MAXIMO provided or
something that the customer has created.
|
boolean |
isView()
Returns whether the business object is based on a database view
or not.
|
void |
resolveReferences() |
void |
setBaseMboInfo(MboSetInfo info)
Sets reference to a base business object information,
if this business object is inherited from another business object.
|
void |
setEntity(Entity entity)
Set the Entity object reference that can be used to find out
persistance details of this object.
|
void |
setExtendedAttributeNumber(int extendedAttributeNumber) |
void |
setFetchAttributeNumber(int fetchAttributeNumber) |
void |
setHasExtendedAttrs(boolean hasExtendedAttrs) |
void |
setHierarchyList(java.util.List<java.lang.String> hierarchyList)
Sets list of business object names in the hierarchy order
from root to leaf node, used mainly to quickly figure out
the inheritance hierarchy and to figure out whether the
business object is inheriting from a given business object
name.
|
void |
setInternal(boolean flag)
Sets whether this business object is internal one.
|
void |
setPresistentAttributeNumber(int persistentAttributeNumber) |
void |
setRelationships(java.util.HashMap<java.lang.String,RelationInfo> relationships)
Sets the collection of relationships to be used by
this business object.
|
void |
setServiceInfo(ServiceInfo si)
Set the information about the service for this MboSet.
|
getClonedInfo, getID, getParent, getReference, getReferenceForSet, isSameTenantAsReference, setID, setParent, setReference, setTenantReference
public static final java.lang.String CACHE_NAME
public static final int SYSTEMLEVEL0
public static final int SITELEVEL1
public static final int ORGLEVEL2
public static final int ITEMSET3
public static final int COMPANYSET4
public static final int SYSTEMSITE5
public static final int SYSTEMAPPFILTER6
public static final int ORGAPPFILTER7
public static final int SITEAPPFILTER8
public static final int SYSTEMORGSITE9
public static final int ORGSITE10
public static final int SYSTEMORG11
public static final int RestrictionEvalSystem
public static final int RestrictionEvalBySite
public static final int RestrictionEvalByOrg
public static final int RestrictionEvalBySiteOrg
public static final int INTNOTINITIALIZED
public static final int INTNOLIMIT
public MboSetInfoBase getTypedReference()
public boolean isTenantOwned()
public java.lang.String getKeyRelationshipWhere()
public java.util.HashSet<java.lang.String> getUniqueEntityColumns()
public boolean isIncludedParentRelationship()
public java.lang.String getUniqueIDName()
public java.lang.String getContentAttrName()
public java.lang.String getClassName()
public java.lang.String getDescription()
public boolean isMainObject()
public boolean isEAuditEnabled()
public java.lang.String getEAuditFilter()
public java.lang.String getESigFilter()
public java.lang.String getEntityName()
public java.lang.String getExtendsObject()
public boolean isView()
public java.lang.String getObjectName()
public boolean isPersistent()
public java.lang.String getServiceName()
public int getSiteOrgType()
public java.lang.String getSiteOrgTypeAsString()
public boolean isUserdefined()
public boolean isImported()
public boolean isInternal()
public void setInternal(boolean flag)
flag
- pass true value to indicate that the business
object is internal, otherwise pass false.public java.lang.String getName()
public java.lang.String getInitEventName()
public java.lang.String getAppValidateEventName()
public int getFetchStopLimit()
public java.lang.String getTextdirection()
public void setHierarchyList(java.util.List<java.lang.String> hierarchyList)
hierarchyList
- a list of business object names in the
hierarchy order from root to leaf node.public java.util.List<java.lang.String> getHierarchyList()
public int evalForDataRestriction()
useDataRestriction
.
Profile.useDataRestriction(java.lang.String, java.lang.String, java.lang.String)
public java.util.Map getAttributeDetails()
cleanNonAutoViews
.public void clearAttributes()
cleanNonAutoViews
.public void addAttribute(MboValueInfo attributeInfo)
attributeInfo
- attribute information to be added.public MboValueInfo getAttribute(java.lang.String attributeName)
attributeName
- name of the attribute for which the attribute
information is needed.public Entity getEntity()
public void setEntity(Entity entity)
entity
- an Entity object reference that can be used to
find out persistance details of this object.public int getAttributeCount()
public int getPersistentAttributeCount()
public int getExtendedAttributeCount()
public int getFetchAttributeCount()
public java.util.Iterator getAttributes()
public java.util.Iterator getPersistentAttributes()
public java.util.Iterator getExtendedAttributes()
public java.util.Iterator getFetchAttributes()
public java.util.Iterator getKeyAttributeIterator()
public java.util.Iterator getLongDescriptionAttributes()
public int getKeySize()
public MboSetInfo getBaseMboInfo()
public void setBaseMboInfo(MboSetInfo info)
info
- a base business object information.public boolean isBasedOn(java.lang.String name)
name
- a business object name to be verified to see
whether it is based on this business object.public void setPresistentAttributeNumber(int persistentAttributeNumber)
public void setExtendedAttributeNumber(int extendedAttributeNumber)
public void setFetchAttributeNumber(int fetchAttributeNumber)
public int getPresistentAttributeNumber()
public int getExtendedAttributeNumber()
public int getFetchAttributeNumber()
public MXLogger getMboLogger()
public MXLogger getSecurityLogger()
public MXLogger getSqlLogger()
public ServiceInfo getServiceInfo()
public void setServiceInfo(ServiceInfo si)
si
- service information reference.public java.lang.Class getMboSetClass() throws java.lang.ClassNotFoundException
java.lang.ClassNotFoundException
- if fails to load the class.public int getMboValueCount()
public java.lang.String[] getKeyAttributes()
public java.lang.String getKeyRelationship()
public MboValueInfo getMboValueInfo(java.lang.String attributeName)
attributeName
- name of the attribute for which the attribute
information is needed.public java.util.Enumeration getMboValuesInfo()
public void setRelationships(java.util.HashMap<java.lang.String,RelationInfo> relationships)
relationships
- collection of relationships to be used by
this business object.public RelationInfo getRelationInfo(java.lang.String relationshipName)
relationshipName
- name of the relationship for which
additional information is needed.public RelationInfo getRelationshipToChild(java.lang.String child)
child
- name of the child for which relationship information
is needed.public java.util.Iterator getRelationsInfo()
public java.util.Iterator getEAuditAttributes()
public java.util.HashMap<java.lang.String,java.lang.String> getLangTableNames() throws java.rmi.RemoteException
java.rmi.RemoteException
public java.lang.String[] getTableAndColumn(java.lang.String attr)
attr
- public boolean isMLInUse() throws java.rmi.RemoteException
tableName
- java.rmi.RemoteException
public boolean isAuditTable()
public boolean isLanguageTable()
public boolean isTextSearchEnabled()
public EventTopic[] getInitEventTopic() throws MXException
MXException
public EventTopic[] getAppValidateEventTopic() throws MXException
MXException
public java.util.HashSet<java.lang.String> getAllUniqueColumns()
public boolean isAsUniqueId(java.lang.String attrName)
public MXLogger getTransactionLogger()
public boolean hasNullableKeyAttr()
public void resolveReferences()
public boolean hasExtendedAttrs()
public void setHasExtendedAttrs(boolean hasExtendedAttrs)
public java.lang.String getExtendedViewName()
public java.lang.String getCacheName()
getCacheName
in class CachedObjectPointer