DomainObject

Package com.matrixone.apps.domain

Class DomainObject

Class Hierarchy

java.lang.Object
  |
  +-matrix.db.ErrorObject
        |
        +-matrix.db.BusinessObject
              |
              +-com.matrixone.apps.domain.DomainObject

Class Location

Framework : ENOFramework

Module : ENOAEFframework

Class Description

public class DomainObject

The DomainObject class represents the top level class for the AEF java classes. Each class represents an instantiated type in the AEF.

   All Implemented Interfaces:
DomainConstants
DomainSymbolicConstants
ImageHolder

Version:: AEF 9.5.1.0 - Copyright (c) 2002, MatrixOne, Inc.

Field Summary

protected static boolean	_debug true if debugging info should be sent to System.out.
public static final String	ATTRIBUTE_PRIMARY_IMAGE
public static final boolean	CHECK_HIDDEN
public static short	FILTER_ITEM
public static short	FILTER_STR_AND_ITEM
public static short	FILTER_STRUCTURE
public static final String	FORMAT_MX_IMAGE
public static final String	FORMAT_MX_LARGE_IMAGE
public static final String	FORMAT_MX_MEDIUM_IMAGE
public static final String	FORMAT_MX_SMALL_IMAGE
public static final String	FORMAT_MX_THUMBNAIL_IMAGE
public String[]	LICENSE_RESERVED_APPS
public static final boolean	LIST
public static final short	PAGE_SIZE
public static final String	POLICY_IMAGE_HOLDER
public static final boolean	PREVENT_DUPLICATES
public static final String	PROPERTY_DEBUG
public static final String	PROPERTY_SERVER_HOST
public static final String	PROPERTY_SERVER_NAME
public static final String	RELATIONSHIP_IMAGE_HOLDER
public static final String	SELECT_IMAGE_FILE_NAMES
public static final String	SELECT_IMAGE_FORMAT_NAMES
public static final String	SELECT_IMAGE_HOLDER_FILE_NAMES
public static final String	SELECT_IMAGE_HOLDER_FORMAT_NAMES
public static final String	SELECT_IMAGE_HOLDER_ID
public static final String	SELECT_IMAGE_HOLDER_MX_IMAGE_FILE_NAMES
public static final String	SELECT_IMAGE_HOLDER_MX_LARGE_IMAGE_FILE_NAMES
public static final String	SELECT_IMAGE_HOLDER_MX_MEDIUM_IMAGE_FILE_NAMES
public static final String	SELECT_IMAGE_HOLDER_MX_SMALL_IMAGE_FILE_NAMES
public static final String	SELECT_IMAGE_HOLDER_MX_THUMBNAIL_IMAGE_FILE_NAMES
public static final String	SELECT_IMAGE_HOLDER_PRIMARY_IMAGE_NAME
public static final String	SELECT_IMAGE_ID
public static final String	SELECT_IMAGE_PRIMARY_IMAGE_NAME
public static final String	SELECT_MX_IMAGE_FILE_NAMES
public static final String	SELECT_MX_LARGE_IMAGE_FILE_NAMES
public static final String	SELECT_MX_SMALL_IMAGE_FILE_NAMES
public static final String	SELECT_MX_THUMBNAIL_IMAGE_FILE_NAMES
public static final String	SELECT_PRIMARY_IMAGE
public static final String	SELECT_PRIMARY_IMAGE_ID
public static final String	TYPE_IMAGE_HOLDER

Constructor Summary

DomainObject()
Construct a new DomainObject.

DomainObject(String objectId)
Construct a new DomainObject.

DomainObject(DecoratedOid objectId)
Construct a new DomainObject.

DomainObject(BusinessObject object)
Construct a new DomainObject.

Method Summary

public static void	abortSavePoint(Context context, String savePoint) Aborts a database transaction to a save point. Deprecated. AEF 9.5.1.0, use ContextUtil.abortSavePoint
public void	abortTransaction(Context context) Abort an existing database transaction. Deprecated. AEF 9.5.1.0, use ContextUtil.abortTransaction
public DomainRelationship	addFromObject(Context context, RelationshipType relationshipType, String fromObjectId) Connects this object from the given object.
public Map	addFromObjects(Context context, RelationshipType relationshipType, String[] fromObjectIds) Connects this object from the given objects.
public DomainRelationship	addFromObjects(Context context, String relationshipType, DomainObject fromBO) Connects this object from the given object. Deprecated. use addFromObject
public DomainRelationship	addRelatedObject(Context context, RelationshipType relationshipType, boolean isFrom, String relatedObjectId) Connects two business object instances.
public Map	addRelatedObjects(Context context, RelationshipType relationshipType, boolean isFrom, String[] relatedObjectIds) Connects this object with the given objects.
public DomainRelationship	addRelatedObjects(Context context, String relationshipType, DomainObject bo, boolean isFrom) Connects a business object instance linked to a parent. Deprecated. use addRelatedObject
public DomainRelationship	addToObject(Context context, RelationshipType relationshipType, String toObjectId) Connects this object to the given object.
protected Map	addToObjects(Context context, RelationshipType relationshipType, String[] toObjectIds) Connects this object to the given object.
public DomainRelationship	addToObjects(Context context, String relationshipType, DomainObject toBO) Connects this object to the given object. Deprecated. use addToObject
protected void	backupFile(Context context, DomainObject toObject, String store) Copies the current document checked in file to the version document
public void	changeOwner(Context context, String owner) Change the business object owner for this object. Deprecated. AEF 9.5.1.0, use setOwner
public void	changePolicy(Context context, String policy) Change the business object policy for this object. Deprecated. AEF 9.5.1.0, use setPolicy
public void	changeVault(Context context, String vault) Change the business object vault for this object. Deprecated. AEF 9.5.1.0, use setVault
public void	checkinFromServer(Context context, boolean unlock, boolean append, String format, StringList fileList) Checkin a files of the given format from server this method will checkin document into the Company specific store To checkin in policy defined store call another checkinFromServer method with store parameter as null
public void	checkinFromServer(Context context, boolean unlock, boolean append, String format, String store, StringList fileList) Checkin a file of the given format from server This method checkin document into given store if store is null it is going to use policy default store for checkin file.
public void	clear() Clear the bean object information as well as anything that has been cached.
public BusinessObject	cloneObject(Context context, String name) Clone an object in the database.
public BusinessObject	cloneObject(Context context, String name, String revision, String vault) Clone an object in the database.
public BusinessObject	cloneObject(Context context, String name, String revision, String vault, boolean copyFiles) Clone an object in the database.
public BusinessObject	cloneObject(Context context, String name, String revision, String vault, boolean copyFiles, boolean useAutoNamer) Clone an object in the database.
public DomainObject	cloneWithFileMove(Context context, String type, String name, String revision, String policy, String vault, String store, Map attributesMap) Clone and move file(s) from the current object(parent) to the new created object given information passed in.
public void	closeObject(Context context, boolean close) Close the object if the close parameter is true.
public void	commitTransaction(Context context) Commit and complete an existing database transaction. Deprecated. AEF 9.5.1.0, use ContextUtil.commitTransaction
public void	confirmDelete(Context context, boolean force, BusinessObjectList objects) Get a list of objects to be deleted. Deprecated. AEF 9.5.1.0, use delete trigger
public DomainRelationship	connect(Context context, String relationshipType, DomainObject bo, boolean isFrom) Connects a business object instance linked to a parent. Deprecated. AEF 9.5.1.0, use addRelatedObjects
public DomainRelationship	connectFrom(Context context, String relationshipType, DomainObject fromBO) Connects this object from the given object. Deprecated. AEF 9.5.1.0, use addFromObjects
public DomainRelationship	connectTo(Context context, String relationshipType, DomainObject toBO) Connects this object to the given object. Deprecated. AEF 9.5.1.0, use addToObjects
public DomainRelationship	createAndConnect(Context context, String type, String relationshipType, DomainObject parentBO, boolean isFrom) Creates an business object instance linked to a parent.
public DomainRelationship	createAndConnect(Context context, String type, String name, String relationshipType, DomainObject parentBO, boolean isFrom) Creates an business object instance linked to a parent.
public DomainRelationship	createAndConnect(Context context, String type, String name, String revision, String policy, String vault, String relationshipType, DomainObject connectedBO, boolean isFrom) Creates an business object instance linked to a parent.
public void	createObject(Context context, String type, String name, String revision, String policy, String vault) Add an object to the database.
public void	createObject(Context context, String type, String name, String revision, String policy, String vault, Map requestMap) Add an object to the database.
public Map	createRevision(Context context) Create a new revision of an object in the database based on it's last revision. Deprecated. AEF 9.5.1.0, use Part.createRevision
protected void	debug(String message) Send debug message to output stream. Deprecated. AEF 9.5.1.0, use DebugUtil.debug
protected void	debug(String message1, String message2) Send debug message to output stream. Deprecated. AEF 9.5.1.0, use DebugUtil.debug
protected void	debug(String message1, String message2, String message3) Send debug message to output stream. Deprecated. use DebugUtil.debug
public void	delete(Context context) Delete the current object - permanently removed. Deprecated. AEF 9.5.1.0, use deleteObject
public void	delete(Context context, boolean force) Delete the current object - permanently removed. Deprecated. AEF 9.5.1.0, use deleteObject
public void	deleteObject(Context context) Delete the current object - permanently removed.
public void	deleteObject(Context context, boolean force) Delete the current object - permanently removed.
public static void	deleteObjects(Context context, String[] objectIds) Deletes the objects specified by the ids.
public void	editBasicInfo(Context context, Map map) Edit the basic info for an object. Deprecated. AEF 9.5.1.0
public MapList	expandSelect(Context context, String relationshipPattern, String typePattern, StringList objectSelects, StringList relationshipSelects, boolean getTo, boolean getFrom, short recurseToLevel, String objectWhere, String relationshipWhere, MapList cachedList, boolean useCache) Do an expand and select on a BusinessObject. Deprecated. as of AEF 9.5.1.0, use getRelatedObjects.
public MapList	expandSelect(Context context, String relationshipPattern, String typePattern, StringList objectSelects, StringList relationshipSelects, boolean getTo, boolean getFrom, short recurseToLevel, String objectWhere, String relationshipWhere, MapList cachedList, boolean useCache, String relKeyPrefix) Do an expand and select on a BusinessObject. Deprecated. AEF 9.5.1.0 - shouldn't be needed since relationship selects are appended with ".value" to keep them different. Still used by ECR, Part Definition, and Drawing Print.
public MapList	expandSelect(Context context, String relationshipPattern, String typePattern, StringList objectSelects, StringList relationshipSelects, boolean getTo, boolean getFrom, short recurseToLevel, String objectWhere, String relationshipWhere, Pattern includeType, Pattern includeRelationship, Map includeMap, MapList cachedList, boolean useCache) Do an expand and select on a BusinessObject. Deprecated. AEF 9.5.1.0, use getRelatedObjects
public static MapList	findObjects(Context context, String typePattern, String vaultPattern, String whereExpression, StringList objectSelects) Queries on the given criteria into a map list containing a mapping of selectable names to values.
public static MapList	findObjects(Context context, String typePattern, String namePattern, String revPattern, String ownerPattern, String vaultPattern, String whereExpression, boolean expandType, StringList objectSelects) Queries on the given criteria into a map list containing a mapping of selectable names to values.
public static MapList	findObjects(Context context, String typePattern, String namePattern, String revPattern, String ownerPattern, String vaultPattern, String whereExpression, String queryName, boolean expandType, StringList objectSelects, short objectLimit) Queries on the given criteria into a map list containing a mapping of selectable names to values.
public static MapList	findObjects(Context context, String typePattern, String namePattern, String revPattern, String ownerPattern, String vaultPattern, String whereExpression, String queryName, boolean expandType, StringList objectSelects, short objectLimit, String searchFormat, String searchText) Queries on the given criteria into a map list containing a mapping of selectable names to values. Deprecated. AEF V6R2012
public static MapList	findObjects(Context context, String typePattern, String namePattern, String revPattern, String ownerPattern, String vaultPattern, String whereExpression, String queryName, boolean expandType, StringList objectSelects, short objectLimit, String searchFormat, String searchText, Collection multiValueList) Queries on the given criteria into a map list containing a mapping of selectable names to values.
public static String	getAliasForName(Context context, String name, boolean useCache) Get the schema alias for the given schema name. Deprecated. AEF 9.5.1.0, use FrameworkUtil.getAliasForAdmin
public MapList	getAllFiles(Context context) Get a list of Files in a MapList.
public MapList	getAllFormatFiles(Context context) Get a list of Files in a MapList.
public MapList	getApprovalsInfo(Context context) Get the approvals info for an object along with select data Deprecated. AEF 9.5.1.0, use Route.getApprovalsInfo
public Attribute	getAttribute(Context context, String attributeName) Get an `Attribute` for the attribute with the passed `attributeName`. Deprecated. AEF 9.5.1.0, use getInfo (hidden attrs do not appear)
public Map	getAttributeDetails(Context context) Returns all the business object attribute details in a Map of Maps.
public Map	getAttributeMap(Context context) Returns all the business object attribute values in a form of a map of attribute name and attribute value.
public Map	getAttributeMap(Context context, boolean getHidden) Returns all the business object attribute values in a form of a map of attribute name and attribute value.
protected StringList	getAttributeNames(Context context) Get the attribute names for this business object.
public static String	getAttributeSelect(String attribute) Defines the proper way to define attribute selectables for print and expand.
public String	getAttributeValue(Context context, String attributeName) Get the attribute value for the attribute with the passed `attributeName`.
public static String	getAutoGeneratedName(Context context, String sObjectGeneratorName, String sObjectGeneratorRevision) Generate a name based on Object Generator's name and revision
public MapList	getBasicInfo(Context context) Get the basic info for an object. Deprecated. AEF 9.5.1.0, see Ray
public Hashtable	getBusinessObjectData(Context context, StringList busSelects) Gets the businessobject selectable data
public SelectList	getBusSelectList(int size) Return the SelectList object for this instance. Deprecated. AEF 9.5.1.0, use getObjectSelectList
protected Object	getCachedData(Object key) Get the selected cached data. Deprecated. AEF 9.5.1.0, caching being removed
public State	getCurrentState(Context context) Return the current state for this object. Deprecated. AEF 9.5.1.0, use getInfo
public DecoratedOid	getDecoratedOid(Context context) Returns the DecoratedOid for this DomainObject
protected String	getDefaultName(Context context) Get the default name for new objects.
public String	getDefaultPolicy(Context context, String type) Get the default policy for new objects.
public String	getDefaultRevision(Context context, String policyName) Return the default revision for new objects.
public String	getDefaultVault(Context context, BusinessObject bo) Get the default vault for new objects.
protected BusinessObject	getFirstRevision(Context context) Get the first revision for this object.
public String	getId() Get the business object id for this object. Deprecated. use overloaded getId(Context) method
public String	getId(Context context) Get the business object id for this object.
public Image	getImageObject(Context context)
public String	getInfo(Context context, String select) Get information regarding this business object.
public static MapList	getInfo(Context context, String[] objectIds, StringList objectSelects) Get information regarding many business objects.
public Map	getInfo(Context context, StringList objectSelects) Get information regarding this business object.
protected Map	getInfo(Context context, StringList objectSelects, Collection multiValueList) Get information regarding this business object.
public StringList	getInfoList(Context context, String select) Get information regarding this business object.
public BusinessObject	getLastRevision(Context context) Get the last revision for this object.
public String[]	getLicenseReservedAPPS()
public String	getName(Context context) Return the name for this object. Deprecated. AEF 9.5.1.0, use getInfo
public static DomainObject	getObject(Context context, BusinessObject bo) Returns a fully contstructed DomainObject derivative given the Object ID. Deprecated. AEF 9.5.1.0, use newInstance
public static DomainObject	getObject(Context context, DecoratedOid oid) Returns a fully contstructed DomainObject derivative given the DecoaretdObject ID. Deprecated. AEF 9.5.1.0, use newInstance
public static DomainObject	getObject(Context context, String oid) Returns a fully contstructed DomainObject derivative given the Object ID. Deprecated. AEF 9.5.1.0, use newInstance
public MapList	getObjects(Context context, String relPattern, String typePattern, boolean getTo, boolean getFrom, int recursionLevel, StringList objectSelects, StringList relationshipSelects, String busWhereClause, String relWhereClause, String postRelPattern, String postTypePattern, Map postPatterns, MapList cacheList, boolean useCache) Expand business objects based on App Lib Expand function. Deprecated. AEF 9.5.1.0, use getRelatedObjects
public SelectList	getObjectSelectList(int size) Return the SelectList object for this instance.
protected MapList	getParentInfo(Context context, int level, StringList objectSelects, String relationship) Get the parent for this business object. Deprecated. AEF 9.5.1.0, use getRelatedObjects
public MapList	getPolicies(Context context) Get the policies for this object. Deprecated. AEF 9.5.1.0 use TypeUtils.getPolicies
public BusinessObject	getPreviousRevision(Context context) Get the Previous revision for this object.
public Map	getRelatedObject(Context context, String relationship, boolean from, StringList busSelects, StringList relSelects) Retrieves information by traversing one level on a given reationship.
public MapList	getRelatedObjects(Context context, String relationshipPattern, String typePattern, boolean getTo, boolean getFrom, int recurseToLevel, StringList objectSelects, StringList relationshipSelects, String objectWhereClause, String relationshipWhereClause, int limit, String postRelPattern, String postTypePattern, Map postPatterns) Expand business objects based on App Lib Expand function.
public MapList	getRelatedObjects(Context context, String relationshipPattern, String typePattern, boolean getTo, boolean getFrom, int recurseToLevel, StringList objectSelects, StringList relationshipSelects, String objectWhereClause, String relationshipWhereClause, String postRelPattern, String postTypePattern, Map postPatterns) Expand business objects based on App Lib Expand function. Deprecated. Use getRelatedObjects with limit
public MapList	getRelatedObjects(Context context, String relationshipPattern, String typePattern, StringList objectSelects, StringList relationshipSelects, boolean getTo, boolean getFrom, short recurseToLevel, String objectWhere, String relationshipWhere) Do an expand and select on a BusinessObject. Deprecated. Use getRelatedObjects with limit
public MapList	getRelatedObjects(Context context, String relationshipPattern, String typePattern, StringList objectSelects, StringList relationshipSelects, boolean getTo, boolean getFrom, short recurseToLevel, String objectWhere, String relationshipWhere, int limit) Do an expand and select on a BusinessObject.
public MapList	getRelatedObjects(Context context, String relationshipPattern, String typePattern, StringList objectSelects, StringList relationshipSelects, boolean getTo, boolean getFrom, short recurseToLevel, String objectWhere, String relationshipWhere, int limit, Pattern includeType, Pattern includeRelationship, Map includeMap) Do an expand and select on a BusinessObject.
public MapList	getRelatedObjects(Context context, String relationshipPattern, String typePattern, StringList objectSelects, StringList relationshipSelects, boolean getTo, boolean getFrom, short recurseToLevel, String objectWhere, String relationshipWhere, Pattern includeType, Pattern includeRelationship, Map includeMap) Do an expand and select on a BusinessObject. Deprecated. Use getRelatedObjects with limit
public MapList	getRelatedObjects(Context context, String relationshipPattern, String typePattern, StringList objectSelects, StringList relationshipSelects, boolean getTo, boolean getFrom, short recurseToLevel, String objectWhereClause, String relationshipWhereClause, short limit, boolean checkHidden, boolean preventDuplicates, short pageSize, Pattern includeType, Pattern includeRelationship, Map includeMap, String relKeyPrefix)
public MapList	getRelatedObjects(Context context, String relationshipPattern, String typePattern, StringList objectSelects, StringList relationshipSelects, boolean getTo, boolean getFrom, short recurseToLevel, String objectWhereClause, String relationshipWhereClause, short limit, boolean checkHidden, boolean preventDuplicates, short pageSize, Pattern includeType, Pattern includeRelationship, Map includeMap, String relKeyPrefix, String filterExpression) Do an expand and select on a BusinessObject.
public MapList	getRelatedObjects(Context context, String relationshipPattern, String typePattern, StringList objectSelects, StringList relationshipSelects, boolean getTo, boolean getFrom, short recurseToLevel, String objectWhereClause, String relationshipWhereClause, short limit, boolean checkHidden, boolean preventDuplicates, short pageSize, Pattern includeType, Pattern includeRelationship, Map includeMap, String relKeyPrefix, String filterExpression, short filterFlag) Do an expand and select on a BusinessObject.
protected Map	getRelationship(Context context, String relationship, boolean from, StringList busSelects, StringList relSelects) Retrieves information by traversing one level on a given reationship. Deprecated. AEF 9.5.1.0, use getRelatedObject
public SelectList	getRelationshipSelectList(int size) Return the relationship SelectList object for this instance.
public String	getRevision(Context context) Get the business object revision for this object. Deprecated. AEF 9.5.1.0, use getInfo
public MapList	getRevisions(Context context, StringList objectSelects, boolean useCache) Get selectables from each revision of this object. Deprecated. AEF 9.5.1.0, use getRevisionsInfo
public MapList	getRevisionsInfo(Context context, StringList singleValueSelects, StringList multiValueSelects) Get the revisions for an object along with select data
public Map	getRouteInfoForStates(Context context, String sAdHoc) Get map of State/Route info Deprecated. AEF 9.5.1.0, use Route.getRouteInfoForStates
public String	getSchemaProperty(Context context, String type, String name, String property) Get the schema property of an administrative object. Deprecated. AEF 9.5.1.0, use PropertyUtil.getSchemaProperty
public static String	getSchemaProperty(String property) Get the AEF schema property reference through this property, actual schema names are returned. Deprecated. AEF 9.5.1.0, use PropertyUtil.getSchemaProperty
protected static String	getSchemaProperty(String type, String name, String property) Get the schema property of an administrative object. Deprecated. AEF 9.5.1.0, use PropertyUtil.getSchemaProperty
public String	getShortUniqueName() Generate a unique name for an object.
public String	getShortUniqueName(String prefix) Generate a unique name for an object.
public MapList	getSignaturesDetails(Context context, State fromState, State toState) Get the Signatures details info for an object between the states
public MapList	getSignaturesDetails(Context context, String fromState, String toState) Get the Signatures details info for an object between the states
protected State	getState(Context context, String name) Get the named state for this object. Deprecated. AEF 9.5.1.0, use getInfo
public String	getType(Context context) Return the business object type for this object. Deprecated. AEF 9.5.1.0, use getInfo
protected static StringList	getTypeAttributeNames(Context context, String typeName) Get the attribute names for the specified type.
protected static MapList	getTypeAttributes(Context context, String type) Get the business type attributes - type specific attributes.
public String	getUniqueName() Generate a unique name for an object. Deprecated. since V6R2011 - Always use this method with Context
public String	getUniqueName(Context context) Generate a unique name for an object.
public String	getUniqueName(String prefix) Generate a unique name for an object.
public synchronized String	getUniqueName(String prefix, int noOfDigits) Generate a unique name for an object.
public void	gotoState(Context context, String stateName) Set the state of the object to the given state. Deprecated. AEF 9.5.1.0, use setState
protected boolean	hasObjects(Context context, String relationshipType, boolean from) Checks whether the current object has relationships of a certain type. Deprecated. AEF 9.5.1.0, use hasRelatedObjects
public boolean	hasRelatedObjects(Context context, String relationshipType, boolean from) Checks whether the current object has relationships of a certain type.
public boolean	isKindOf(Context context, String type) Returns true if this object's type inherits from the type passed in.
public boolean	isLastRevision(Context context) Check to see if this is the last revision of the object.
public static String	mqlCommand(Context context, MQLCommand mql, String command) Executes an mql command. Deprecated. AEF 9.5.1.0, use MqlUtil.mqlCommand
protected static String	mqlCommand(Context context, MQLCommand mql, String command, boolean runAsSuperUser) Executes an mql command. Deprecated. AEF 9.5.1.0, use MqlUtil.mqlCommand
protected String	mqlCommand(Context context, String command) Executes an mql command. Deprecated. AEF 9.5.1.0, use MqlUtil.mqlCommand
protected String	mqlCommand(Context context, String command, boolean runAsSuperUser) Executes an mql command. Deprecated. AEF 9.5.1.0, use MqlUtil.mqlCommand
public static boolean	multiLevelRecursionCheck(Context context, String fromObjectId, String toObjectId, String relType, boolean includeRevisionsCheck)
public static DomainObject	newInstance(Context context) Returns DomainObject given context this is prefered method to call instead of newing up DomainObject
public static DomainObject	newInstance(Context context, BusinessObject bo) Returns a fully contstructed DomainObject derivative given the BusinessObject.
public static DomainObject	newInstance(Context context, BusinessObject bo, String applicationName) Returns a fully contstructed DomainObject derivative given the BusinessObject.
public static DomainObject	newInstance(Context context, DecoratedOid oid) Returns a fully contstructed DomainObject derivative given the DecoaretdObject ID.
public static DomainObject	newInstance(Context context, DecoratedOid oid, String applicationName) Returns a fully contstructed DomainObject derivative given the DecoaretdObject ID.
public static DomainObject	newInstance(Context context, String idORtype) Returns a fully contstructed DomainObject derivative given the object ID or object Type.
public static DomainObject	newInstance(Context context, String idORtype, String applicationName) Returns a fully contstructed DomainObject derivative given the object ID or object Type.
public static DomainObject	newInstance(Context context, String idORtype, String applicationName, String interfaceName) Returns a fully contstructed DomainObject derivative given the object ID or object Type/interface.
public boolean	openObject(Context context) Assure the object is open.
protected static void	popContext(Context context) Restore the original context, can only be called after the call to a corresponding push. Deprecated. AEF 9.5.1.0, use ContextUtil.popContext
protected static void	pushContext(Context context) Get the super user context. Deprecated. AEF 9.5.1.0, use ContextUtil.pushContext
protected static void	pushContext(Context context, String name, String password, String vault) Get the super user context. Deprecated. AEF 9.5.1.0, use ContextUtil.pushContext
public static MapList	querySelect(Context context, String typePattern, String vaultPattern, String whereExpression, StringList objectSelects, MapList cachedList, boolean useCache) Queries on the given criteria into a map list containing a mapping of selectable names to values. Deprecated. AEF 9.5.1.0, use findObjects
public static MapList	querySelect(Context context, String typePattern, String namePattern, String revPattern, String ownerPattern, String vaultPattern, String whereExpression, boolean expandType, StringList objectSelects, MapList cachedList, boolean useCache) Queries on the given criteria into a map list containing a mapping of selectable names to values. Deprecated. AEF 9.5.1.0, use findObjects
public void	resetAttributes(Context context) Reset all attribute values for this object.
public BusinessObject	reviseObject(Context context, boolean copyFiles) Create a new revision of an object in the database based on it's last revision.
public BusinessObject	reviseObject(Context context, String nextRev, boolean copyFiles) Create a new revision of an object in the database based on it's last revision.
public void	revokeAccess(Context context, String grantor, String grantee) Revoke access rights for a grantor and grantee combination.
public void	setAttributeValue(Context context, String name, String value) Set an attribute value for this object.
public void	setAttributeValues(Context context, Map map) Set the business object attributes for this object.
protected void	setCachedData(Object key, Object value) Set the selected cached data. Deprecated. AEF 9.5.1.0, caching is being removed.
public static void	setDebug(boolean mode) Sets the debug mode for this bean. Deprecated. use DebugUtil.setDebug
public void	setDescription(Context context, String description) Modifies the business object description for this object.
public void	setId(String id) Sets the id for this object.
public void	setLicenseReservedAPPS(String[] lICENSE_RESERVED_APPS)
public void	setName(Context context, String name) Set the business object name for this object.
public void	setOwner(Context context, String owner) Set the business object owner for this object.
public void	setPolicy(Context context, String policy) Change the business object policy for this object.
public DomainRelationship	setRelatedObject(Context context, String relationshipType, boolean isFrom, String newTargetId) Connects the current object to/from the id specified using the relationship type provided.
protected DomainRelationship	setRelationship(Context context, String relationship, boolean from, String newId) Connects the current object to/from the id specified using the relationship type provided. Deprecated. AEF 9.5.1.0, use setRelatedObject
public static void	setSavePoint(Context context, String savePoint) Updates an existing database transaction with a database save point. Deprecated. AEF 9.5.1.0, use ContextUtil.setSavePoint
public int	setState(Context context, String stateName) Set the state of the object to the given state.
public void	setVault(Context context, String vault) Change the business object vault for this object.
public boolean	startTransaction(Context context, boolean update) Starts a database transaction. Deprecated. AEF 9.5.1.0, use ContextUtil.startTransaction
public List	validateSelectedAttributes(Context context, List currentAttributeList, String attributeToSaveName, String typeName) Returns a StringList of valid attributes.
public StringList	validateSelectedAttributes(Context context, StringList currentAttributeList, String attributeToSaveName, String typeName) Returns a StringList of valid attributes.

Field Detail

_debug

    protected static boolean _debug

true if debugging info should be sent to System.out.

ATTRIBUTE_PRIMARY_IMAGE

    public static final String ATTRIBUTE_PRIMARY_IMAGE

CHECK_HIDDEN

    public static final boolean CHECK_HIDDEN

FILTER_ITEM

    public static short FILTER_ITEM

FILTER_STR_AND_ITEM

    public static short FILTER_STR_AND_ITEM

FILTER_STRUCTURE

    public static short FILTER_STRUCTURE

FORMAT_MX_IMAGE

    public static final String FORMAT_MX_IMAGE

FORMAT_MX_LARGE_IMAGE

    public static final String FORMAT_MX_LARGE_IMAGE

FORMAT_MX_MEDIUM_IMAGE

    public static final String FORMAT_MX_MEDIUM_IMAGE

FORMAT_MX_SMALL_IMAGE

    public static final String FORMAT_MX_SMALL_IMAGE

FORMAT_MX_THUMBNAIL_IMAGE

    public static final String FORMAT_MX_THUMBNAIL_IMAGE

LICENSE_RESERVED_APPS

    public String[] LICENSE_RESERVED_APPS

LIST

    public static final boolean LIST

PAGE_SIZE

    public static final short PAGE_SIZE

POLICY_IMAGE_HOLDER

    public static final String POLICY_IMAGE_HOLDER

PREVENT_DUPLICATES

    public static final boolean PREVENT_DUPLICATES

PROPERTY_DEBUG

    public static final String PROPERTY_DEBUG

PROPERTY_SERVER_HOST

    public static final String PROPERTY_SERVER_HOST

PROPERTY_SERVER_NAME

    public static final String PROPERTY_SERVER_NAME

RELATIONSHIP_IMAGE_HOLDER

    public static final String RELATIONSHIP_IMAGE_HOLDER

SELECT_IMAGE_FILE_NAMES

    public static final String SELECT_IMAGE_FILE_NAMES

SELECT_IMAGE_FORMAT_NAMES

    public static final String SELECT_IMAGE_FORMAT_NAMES

SELECT_IMAGE_HOLDER_FILE_NAMES

    public static final String SELECT_IMAGE_HOLDER_FILE_NAMES

SELECT_IMAGE_HOLDER_FORMAT_NAMES

    public static final String SELECT_IMAGE_HOLDER_FORMAT_NAMES

SELECT_IMAGE_HOLDER_ID

    public static final String SELECT_IMAGE_HOLDER_ID

SELECT_IMAGE_HOLDER_MX_IMAGE_FILE_NAMES

    public static final String SELECT_IMAGE_HOLDER_MX_IMAGE_FILE_NAMES

SELECT_IMAGE_HOLDER_MX_LARGE_IMAGE_FILE_NAMES

    public static final String SELECT_IMAGE_HOLDER_MX_LARGE_IMAGE_FILE_NAMES

SELECT_IMAGE_HOLDER_MX_MEDIUM_IMAGE_FILE_NAMES

    public static final String SELECT_IMAGE_HOLDER_MX_MEDIUM_IMAGE_FILE_NAMES

SELECT_IMAGE_HOLDER_MX_SMALL_IMAGE_FILE_NAMES

    public static final String SELECT_IMAGE_HOLDER_MX_SMALL_IMAGE_FILE_NAMES

SELECT_IMAGE_HOLDER_MX_THUMBNAIL_IMAGE_FILE_NAMES

    public static final String SELECT_IMAGE_HOLDER_MX_THUMBNAIL_IMAGE_FILE_NAMES

SELECT_IMAGE_HOLDER_PRIMARY_IMAGE_NAME

    public static final String SELECT_IMAGE_HOLDER_PRIMARY_IMAGE_NAME

SELECT_IMAGE_ID

    public static final String SELECT_IMAGE_ID

SELECT_IMAGE_PRIMARY_IMAGE_NAME

    public static final String SELECT_IMAGE_PRIMARY_IMAGE_NAME

SELECT_MX_IMAGE_FILE_NAMES

    public static final String SELECT_MX_IMAGE_FILE_NAMES

SELECT_MX_LARGE_IMAGE_FILE_NAMES

    public static final String SELECT_MX_LARGE_IMAGE_FILE_NAMES

SELECT_MX_SMALL_IMAGE_FILE_NAMES

    public static final String SELECT_MX_SMALL_IMAGE_FILE_NAMES

SELECT_MX_THUMBNAIL_IMAGE_FILE_NAMES

    public static final String SELECT_MX_THUMBNAIL_IMAGE_FILE_NAMES

SELECT_PRIMARY_IMAGE

    public static final String SELECT_PRIMARY_IMAGE

SELECT_PRIMARY_IMAGE_ID

    public static final String SELECT_PRIMARY_IMAGE_ID

TYPE_IMAGE_HOLDER

    public static final String TYPE_IMAGE_HOLDER

Constructor Detail

DomainObject

    DomainObject()

Construct a new DomainObject.

Since:: AEF 9.1.0.0

DomainObject

    DomainObject(String objectId)

Construct a new DomainObject.

Parameters:

objectId: id of the business object

Throws:

: Exception - if the operation fails

Since:: AEF 9.1.0.0

DomainObject

    DomainObject(DecoratedOid objectId)

Construct a new DomainObject.

Parameters:

objectId: decorated id of the business object

Throws:

: Exception - if the operation fails

Since:: AEF 9.1.0.0

DomainObject

    DomainObject(BusinessObject object)

Construct a new DomainObject.

Parameters:

object: the business object to clone

Since:: AEF 9.1.0.0

Method Detail

abortSavePoint

    public static void abortSavePoint(Context context, String savePoint)

Aborts a database transaction to a save point.

Deprecated. AEF 9.5.1.0, use ContextUtil.abortSavePoint

Parameters:

context: the eMatrix Context object
savePoint: the savepoint to rollback to

Throws:

: FrameworkException - if operation fails.

Since:: AEF 9.1.0.0

abortTransaction

    public void abortTransaction(Context context)

Abort an existing database transaction.

Deprecated. AEF 9.5.1.0, use ContextUtil.abortTransaction

Parameters:

context: the eMatrix Context object

Since:: AEF 9.1.0.0

addFromObject

    public DomainRelationship addFromObject(Context context, RelationshipType relationshipType, String fromObjectId)

Connects this object from the given object.

Parameters:

context: the eMatrix Context object
relationshipType: The relationship type to use for the connection
fromObjectId: The object id to connect "from"

Return:: the new relationship

Throws:

: FrameworkException - if the operation fails

Since:: AEF 9.5.1.3

addFromObjects

    public Map addFromObjects(Context context, RelationshipType relationshipType, String[] fromObjectIds)

Connects this object from the given objects.

Parameters:

context: the eMatrix Context object
relationshipType: the relationship type to use for the connection
fromObjectIds: the object ids to connect "from"

Return:: a map of from object ids as keys and connection ids as values

Throws:

: FrameworkException - if the operation fails

Since:: AEF 9.5.1.3

addFromObjects

    public DomainRelationship addFromObjects(Context context, String relationshipType, DomainObject fromBO)

Connects this object from the given object.

Deprecated. use addFromObject

Parameters:

context: the eMatrix Context object
relationshipType: The relationship type to use for the connection.
fromBO: The object to use on the "from" side of the connection.

Return:: the new relationship

Throws:

: FrameworkException - if the operation fails

Since:: AEF 9.5.1.0

addRelatedObject

    public DomainRelationship addRelatedObject(Context context, RelationshipType relationshipType, boolean isFrom, String relatedObjectId)

Connects two business object instances.

Parameters:

context: the eMatrix Context object
relationshipType: the relationship type to use for the connection
isFrom: this connection is from the related object (true) or to the related object (false)
relatedObjectId: the object to connect with this object

Return:: the new relationship

Throws:

: FrameworkException - if the operation fails

Since:: AEF 9.5.1.3

addRelatedObjects

    public Map addRelatedObjects(Context context, RelationshipType relationshipType, boolean isFrom, String[] relatedObjectIds)

Connects this object with the given objects.

Parameters:

context: the eMatrix Context object
relationshipType: The relationship type to use for the connection
isFrom: this connection is from the related objects (true) or to the related objects (false)
relatedObjectIds: The object ids to connect with this object

Return:: a map of object ids as keys and connection ids as values

Throws:

: FrameworkException - if the operation fails

Since:: AEF 9.5.1.3

addRelatedObjects

    public DomainRelationship addRelatedObjects(Context context, String relationshipType, DomainObject bo, boolean isFrom)

Connects a business object instance linked to a parent.

Deprecated. use addRelatedObject

Parameters:

context: the eMatrix Context object
relationshipType: The relationship type to the parent connection - may be null. If this is null, no object will be connected.
bo: The parent object for the new object - may be null. If this is null, no object will be connected.
isFrom: true, if this is a connection from the object defined by the previous parameter to the object that this method is executed against. false, if this is a connection to the object defined by the previous parameter from the object that this method is executed against.

Return:: the new relationship

Throws:

: FrameworkException - if operation fails.

Since:: AEF 9.5.1.0

addToObject

    public DomainRelationship addToObject(Context context, RelationshipType relationshipType, String toObjectId)

Connects this object to the given object.

Parameters:

context: the eMatrix Context object
relationshipType: The relationship type to use for the connection
toObjectId: The object id to connect "to"

Return:: the new relationship

Throws:

: FrameworkException - if the operation fails

Since:: AEF 9.5.1.3

addToObjects

    protected Map addToObjects(Context context, RelationshipType relationshipType, String[] toObjectIds)

Connects this object to the given object.

Parameters:

context: the eMatrix Context object
relationshipType: the relationship type to use for the connection
toObjectIds: the object ids to connect "to"

Return:: a map of to object ids as keys and connection ids as values

Throws:

: FrameworkException - if the operation fails

Since:: AEF 9.5.1.3

addToObjects

    public DomainRelationship addToObjects(Context context, String relationshipType, DomainObject toBO)

Connects this object to the given object.

Deprecated. use addToObject

Parameters:

context: the eMatrix Context object
relationshipType: The relationship type to use for the connection.
toBO: The object to use on the "to" side of the connection.

Return:: the new relationship

Throws:

: FrameworkException - if the operation fails

Since:: AEF 9.5.1.0

backupFile

    protected void backupFile(Context context, DomainObject toObject, String store)

Copies the current document checked in file to the version document

Parameters:

context: the eMatrix Context object
toObject: the object to copy the file to
store: optional store name for the filecopy; if null, store based on policy store definition

Throws:

: Exception - if the operation fails

Since:: AEF 10.0.0.0

changeOwner

    public void changeOwner(Context context, String owner)

Change the business object owner for this object. This must be a valid Matrix User.

Deprecated. AEF 9.5.1.0, use setOwner

Parameters:

context: the eMatrix Context object
owner: the new owner - Matrix User.

Throws:

: FrameworkException - if the operation fails

Since:: AEF ?.?.?.?

changePolicy

    public void changePolicy(Context context, String policy)

Change the business object policy for this object. This must be a valid policy in Matrix, that can govern the type of this object.

Deprecated. AEF 9.5.1.0, use setPolicy

Parameters:

context: the eMatrix Context object
policy: the new policy

Throws:

: FrameworkException - if the operation fails

Since:: AEF 9.1.0.0

changeVault

    public void changeVault(Context context, String vault)

Change the business object vault for this object. This must be a valid vault in Matrix.

Deprecated. AEF 9.5.1.0, use setVault

Parameters:

context: the eMatrix Context object
vault: the new vault

Throws:

: FrameworkException - if the operation fails

Since:: AEF 9.1.0.0

checkinFromServer

    public void checkinFromServer(Context context, boolean unlock, boolean append, String format, StringList fileList)

Checkin a files of the given format from server this method will checkin document into the Company specific store To checkin in policy defined store call another checkinFromServer method with store parameter as null

Parameters:

context: the eMatrix Context object
unlock: true to unlock the BusinessObject
append: true to append, false to replace
format: format of the file
fileList: the eMatrix StringList object that holds the list of files to checkin

Throws:

: FrameworkException - if the operation fails

See Also:

: #checkinFromServer

Since:: AEF 9.5.0.0

checkinFromServer

    public void checkinFromServer(Context context, boolean unlock, boolean append, String format, String store, StringList fileList)

Checkin a file of the given format from server This method checkin document into given store if store is null it is going to use policy default store for checkin file.

Parameters:

context: the eMatrix Context object
unlock: true to unlock the BusinessObject
append: true to append, false to replace
format: format of the file
store: in which file need to checkin
fileList: the eMatrix StringList object that holds the list of files to checkin

Throws:

: FrameworkException - if the operation fails

Since:: AEF 9.5.0.0

clear

    public void clear()

Clear the bean object information as well as anything that has been cached. This is only necessary and recommended when switching to a different id while using the same bean instance.

Throws:

: FrameworkException - if the operation fails

Since:: AEF 9.1.0.0

cloneObject

    public BusinessObject cloneObject(Context context, String name)

Clone an object in the database.

Parameters:

context: the eMatrix Context object
name: The name of the object - may be null. If this is null, then a unique name will be assigned.

Return:: a clone of the object

Throws:

: FrameworkException - if the operation fails

Since:: AEF 9.1.0.0

cloneObject

    public BusinessObject cloneObject(Context context, String name, String revision, String vault)

Clone an object in the database.

Parameters:

context: the eMatrix Context object
name: The name of the object - may be null. If this is null, then a unique name will be assigned.
revision: The revision of the object - may be null. If this is null, then the first revision of the given policy is assigned.
vault: The vault of the object - may be null. If this is null, then the vault will be set to the current users vault

Return:: a clone of the object

Throws:

: FrameworkException - if the operation fails

Since:: AEF 9.1.0.0

cloneObject

    public BusinessObject cloneObject(Context context, String name, String revision, String vault, boolean copyFiles)

Clone an object in the database.

Parameters:

context: the eMatrix Context object
name: The name of the object - may be null. If this is null, then a unique name will be assigned.
revision: The revision of the object - may be null. If this is null, then the first revision of the given policy is assigned.
vault: The vault of the object - may be null. If this is null, then the vault will be set to the current users vault.
copyFiles: The boolean value to copy files from current object or not

Return:: a clone of the object

Throws:

: FrameworkException - if the operation fails

Since:: AEF 9.1.0.0

cloneObject

    public BusinessObject cloneObject(Context context, String name, String revision, String vault, boolean copyFiles, boolean useAutoNamer)

Clone an object in the database.

Parameters:

context: the eMatrix Context object
name: The name of the object - may be null. If this is null, then a unique name will be assigned.
revision: The revision of the object - may be null. If this is null, then the first revision of the given policy is assigned.
vault: The vault of the object - may be null. If this is null, then the vault will be set to the current users vault.
copyFiles: The boolean value to copy files from current object or not
useAutoNamer: The boolean value to whether to use ObjectGeneratorAutoNamer

Return:: a clone of the object

Throws:

: FrameworkException - if the operation fails

Since:: AEF 9.1.0.0

cloneWithFileMove

    public DomainObject cloneWithFileMove(Context context, String type, String name, String revision, String policy, String vault, String store, Map attributesMap)

Clone and move file(s) from the current object(parent) to the new created object given information passed in.

Parameters:

context: the eMatrix Context object
type: The type of the object
name: The name of the object - may be null. If this is null, then a unique name will be assigned.
revision: The revision of the object - may be null. If this is null, then the first revision of the given policy is assigned.
policy: The policy of the object - may be null. If this is null, then the default policy for the type will be assigned.
vault: The vault of the object - may be null. If this is null, then the vault will be set to the vault of the parent object. If there is no parent object, then the vault is set to the current users vault.
store: optional store name for the filecopy; if null, store based on policy store definition
attributesMap: The map of attributes being set for the cloned object.

Return:: the new DomainObject to which files are cloned and moved

Throws:

: FrameworkException - if the operation fails

Since:: AEF 10.0.0.0

closeObject

    public void closeObject(Context context, boolean close)

Close the object if the close parameter is true. Use this method is used in conjunction with openObject. This method is used as a wrapper so that we can change the functionality when objects don't need to be opened and closed any more.

 boolean closeBO = openObject(context);

 try
 {
     ....
 }
 finally
 {
    closeObject(context, closeBO);
 }

Parameters:

context: the eMatrix Context object
close: true if openObject opened the object

See Also:

: #openObject

Since:: AEF 9.1.0.0

commitTransaction

    public void commitTransaction(Context context)

Commit and complete an existing database transaction.

Deprecated. AEF 9.5.1.0, use ContextUtil.commitTransaction

Parameters:

context: the eMatrix Context object

Throws:

: FrameworkException - if the operation fails

Since:: AEF 9.1.0.0

confirmDelete

    public void confirmDelete(Context context, boolean force, BusinessObjectList objects)

Get a list of objects to be deleted.

Deprecated. AEF 9.5.1.0, use delete trigger

Parameters:

context: the eMatrix Context object.
force: forces the delete process; if there are references, then they are identified as well.
objects: a list of objects to extend with additional ids for deletion.

Throws:

: FrameworkException - if the operation fails

Since:: AEF 9.1.0.0

connect

    public DomainRelationship connect(Context context, String relationshipType, DomainObject bo, boolean isFrom)

Connects a business object instance linked to a parent.

Deprecated. AEF 9.5.1.0, use addRelatedObjects

Parameters:

context: the eMatrix Context object
relationshipType: The relationship type to the parent connection - may be null. If this is null, no object will be connected.
bo: The parent object for the new object - may be null. If this is null, no object will be connected.
isFrom: true, if this is a connection from the object defined by the previous parameter to the object that this method is executed against. false, if this is a connection to the object defined by the previous parameter from the object that this method is executed against.

Return:: the new relationship

Throws:

: FrameworkException - if operation fails.

Since:: AEF 9.1.0.0

connectFrom

    public DomainRelationship connectFrom(Context context, String relationshipType, DomainObject fromBO)

Connects this object from the given object.

Deprecated. AEF 9.5.1.0, use addFromObjects

Parameters:

context: the eMatrix Context object
relationshipType: The relationship type to use for the connection.
fromBO: The object to use on the "from" side of the connection.

Return:: the new relationship

Throws:

: FrameworkException - if the operation fails

Since:: AEF 9.1.0.0

connectTo

    public DomainRelationship connectTo(Context context, String relationshipType, DomainObject toBO)

Connects this object to the given object.

Deprecated. AEF 9.5.1.0, use addToObjects

Parameters:

context: the eMatrix Context object
relationshipType: The relationship type to use for the connection.
toBO: The object to use on the "to" side of the connection.

Return:: the new relationship

Throws:

: FrameworkException - if the operation fails

Since:: AEF 9.1.0.0

createAndConnect

    public DomainRelationship createAndConnect(Context context, String type, String relationshipType, DomainObject parentBO, boolean isFrom)

Creates an business object instance linked to a parent.

Parameters:

context: the eMatrix Context object
type: The type of the object.
relationshipType: The relationship type to the parent connection - may be null
parentBO: The parent object for the new object - may be null
isFrom: this is a from connection of the given object (true) or to the given object (false)

Return:: the new relationship

Throws:

: FrameworkException - if the operation fails

Since:: AEF 9.1.0.0

createAndConnect

    public DomainRelationship createAndConnect(Context context, String type, String name, String relationshipType, DomainObject parentBO, boolean isFrom)

Creates an business object instance linked to a parent.

Parameters:

context: the eMatrix Context object
type: The type of the object.
name: The name of the object.
relationshipType: The relationship type to the parent connection - may be null
parentBO: The parent object for the new object - may be null
isFrom: this is a from connection of the given object (true) or to the given object (false)

Return:: the new relationship

Throws:

: FrameworkException - if the operation fails

Since:: AEF 9.1.0.0

createAndConnect

    public DomainRelationship createAndConnect(Context context, String type, String name, String revision, String policy, String vault, String relationshipType, DomainObject connectedBO, boolean isFrom)

Creates an business object instance linked to a parent.

Parameters:

context: the eMatrix Context object
type: The type of the object.
name: The name of the object - may be null. If this is null, then a unique name will be assigned.
revision: The revision of the object - may be null. If this is null, then the first revision of the given policy is assigned.
policy: The policy of the object - may be null. If this is null, then the default policy for the type will be assigned.
vault: The vault of the object - may be null. If this is null, then the vault will be set to the vault of the parent object. If there is no parent object, then the vault is set to the current users vault.
relationshipType: The relationship type to the parent connection - may be null. If this is null, no object will be connected.
connectedBO: The object to connect to this new object - may be null. If this is null, no object will be connected.
isFrom: this is a from connection of the given object (true) or to the given object (false)

Return:: the new relationship

Throws:

: FrameworkException - if the operation fails

Since:: AEF 9.1.0.0

createObject

    public void createObject(Context context, String type, String name, String revision, String policy, String vault)

Add an object to the database.

Parameters:

context: the eMatrix Context object
type: The type of the object
name: The name of the object - may be null. If this is null, then a unique name will be assigned.
revision: The revision of the object - may be null. If this is null, then the first revision of the given policy is assigned.
policy: The policy of the object - may be null. If this is null, then the default policy for the type will be assigned.
vault: The vault of the object - may be null. If this is null, then the vault will be set to the vault of the parent object. If there is no parent object, then the vault is set to the current users vault.

Throws:

: FrameworkException - if the operation fails

Since:: AEF 9.1.0.0

createObject

    public void createObject(Context context, String type, String name, String revision, String policy, String vault, Map requestMap)

Add an object to the database.

Parameters:

context: the eMatrix Context object
type: The type of the object
name: The name of the object - may be null. If this is null, then a unique name will be assigned.
revision: The revision of the object - may be null. If this is null, then the first revision of the given policy is assigned.
policy: The policy of the object - may be null. If this is null, then the default policy for the type will be assigned.
vault: The vault of the object - may be null. If this is null, then the vault will be set to the vault of the parent object. If there is no parent object, then the vault is set to the current users vault.
requestMap: This is the name value map of request parameter from create form With field values Maplist as fields. The default implemetation will not use this parameter Any derived classes can orverride to implement/set more data from create form

Throws:

: FrameworkException - if the operation fails

Since:: AEF V6R2012

createRevision

    public Map createRevision(Context context)

Create a new revision of an object in the database based on it's last revision.

Deprecated. AEF 9.5.1.0, use Part.createRevision

Parameters:

context: the eMatrix Context object

Return:: a Map with info about the revised object

Throws:

: FrameworkException - if the operation fails

Since:: AEF ?.?.?.?

debug

    protected void debug(String message)

Send debug message to output stream.

Deprecated. AEF 9.5.1.0, use DebugUtil.debug

Parameters:

message: message to send to ouput stream

Since:: AEF 9.1.0.0

debug

    protected void debug(String message1, String message2)

Send debug message to output stream.

Deprecated. AEF 9.5.1.0, use DebugUtil.debug

Parameters:

message1: message to send to ouput stream
message2: message to send to ouput stream

Since:: AEF 9.1.0.0

debug

    protected void debug(String message1, String message2, String message3)

Send debug message to output stream.

Deprecated. use DebugUtil.debug

Parameters:

message1: message to send to ouput stream
message2: message to send to ouput stream
message3: message to send to ouput stream

Since:: AEF 9.1.0.0

delete

    public void delete(Context context)

Delete the current object - permanently removed. Object should have no references

Deprecated. AEF 9.5.1.0, use deleteObject

Parameters:

context: the eMatrix Context object

Throws:

: Exception - if the operation fails

Since:: AEF 9.1.0.0

delete

    public void delete(Context context, boolean force)

Delete the current object - permanently removed.

Deprecated. AEF 9.5.1.0, use deleteObject

Parameters:

context: the eMatrix Context object
force: forces delete of all references

Throws:

: Exception - if the operation fails

Since:: AEF 9.1.0.0

deleteObject

    public void deleteObject(Context context)

Delete the current object - permanently removed. Object should have no references

Parameters:

context: the eMatrix Context object

Throws:

: Exception - if the operation fails

Since:: AEF 9.5.1.0

deleteObject

    public void deleteObject(Context context, boolean force)

Delete the current object - permanently removed.

Parameters:

context: the eMatrix Context object
force: forces delete of all references

Throws:

: Exception - if the operation fails

Since:: AEF 9.5.1.0

deleteObjects

    public static void deleteObjects(Context context, String[] objectIds)

Deletes the objects specified by the ids.

Parameters:

context: the eMatrix Context object
objectIds: the ids of the objects to delete

Throws:

: Exception - if the operation fails

Since:: AEF 9.5.1.3

editBasicInfo

    public void editBasicInfo(Context context, Map map)

Edit the basic info for an object. Description All attributes

Deprecated. AEF 9.5.1.0

Parameters:

context: the eMatrix Context object
map: a Map of the attribute values and description to change.

Throws:

: FrameworkException - if the operation fails

Since:: AEF 9.5.0.0

expandSelect

    public MapList expandSelect(Context context, String relationshipPattern, String typePattern, StringList objectSelects, StringList relationshipSelects, boolean getTo, boolean getFrom, short recurseToLevel, String objectWhere, String relationshipWhere, MapList cachedList, boolean useCache)

Do an expand and select on a BusinessObject.

Deprecated. as of AEF 9.5.1.0, use getRelatedObjects.

Parameters:

context: the eMatrix Context object
relationshipPattern: - pattern to match relationships
typePattern: - pattern to match types
objectSelects: the eMatrix StringList object that holds the list of select statement pertaining to Business Obejcts.
relationshipSelects: the eMatrix StringList object that holds the list of select statement pertaining to Relationships.
getTo: - get To relationships
getFrom: - get From relationships
recurseToLevel: - the number of levels to expand, 0 equals expand all.
objectWhere: - where clause to apply to objects, can be empty ""
relationshipWhere: - where clause to apply to relationship, can be empty ""
cachedList: the eMatrix MapList object that holds the list to return if useCache is true
useCache: true to return cachedList otherwise do the expand

Return:: the result of the expand in map list form

Throws:

: FrameworkException - when unable to retrieve data from the BOS

Since:: AEF 9.1.0.0

expandSelect

    public MapList expandSelect(Context context, String relationshipPattern, String typePattern, StringList objectSelects, StringList relationshipSelects, boolean getTo, boolean getFrom, short recurseToLevel, String objectWhere, String relationshipWhere, MapList cachedList, boolean useCache, String relKeyPrefix)

Do an expand and select on a BusinessObject.

Deprecated. AEF 9.5.1.0 - shouldn't be needed since relationship selects are appended with ".value" to keep them different. Still used by ECR, Part Definition, and Drawing Print.

Parameters:

context: the eMatrix Context object
relationshipPattern: - pattern to match relationships
typePattern: - pattern to match types
objectSelects: the eMatrix StringList object that holds the list of select statement pertaining to Business Obejcts.
relationshipSelects: the eMatrix StringList object that holds the list of select statement pertaining to Relationships.
getTo: - get To relationships
getFrom: - get From relationships
recurseToLevel: - the number of levels to expand, 0 equals expand all.
objectWhere: - where clause to apply to objects, can be empty ""
relationshipWhere: - where clause to apply to relationship, can be empty ""
cachedList: the eMatrix MapList object that holds the list to return if useCache is true
useCache: true to return cachedList otherwise do the expand
relKeyPrefix: - the prefix added to relationship keys to prevent key name collision with object keys.

Return:: the result of the expand in map list form

Throws:

: FrameworkException - when unable to retrieve data from the BOS

Since:: AEF 9.1.0.0

expandSelect

    public MapList expandSelect(Context context, String relationshipPattern, String typePattern, StringList objectSelects, StringList relationshipSelects, boolean getTo, boolean getFrom, short recurseToLevel, String objectWhere, String relationshipWhere, Pattern includeType, Pattern includeRelationship, Map includeMap, MapList cachedList, boolean useCache)

Do an expand and select on a BusinessObject.

Deprecated. AEF 9.5.1.0, use getRelatedObjects

Parameters:

context: the eMatrix Context object
relationshipPattern: the eMatrix StringList object that holds the list of pattern to match relationships
typePattern: - pattern to match types
objectSelects: the eMatrix StringList object that holds the list of select statement pertaining to Business Obejcts.
relationshipSelects: - list of select statement pertaining to Relationships.
getTo: - get To relationships
getFrom: - get From relationships
recurseToLevel: - the number of levels to expand, 0 equals expand all.
objectWhere: - where clause to apply to objects, can be empty ""
relationshipWhere: - where clause to apply to relationship, can be empty ""
includeType: filter for businees types we want returned. If the type of the object is not found in this list then it will not be returned in the MapList. If null all types will be returned.
includeRelationship: filter for relationships we want returned. If the relationship of the object does not match one in this list then it will not be returned in the MapList. If null all relationship types will be returned
includeMap: a name/value pair that is used to filter data. If the name matches and the values match each other than they will be returned in the MapList. If null the value checking is ignored
cachedList: the eMatrix MapList object that holds the list to return if useCache is true
useCache: true to return cachedList otherwise do the expand

Return:: the result of the expand in map list form

Throws:

: FrameworkException - when unable to retrieve data from the BOS

Since:: AEF 9.1.0.0

findObjects

    public static MapList findObjects(Context context, String typePattern, String vaultPattern, String whereExpression, StringList objectSelects)

Queries on the given criteria into a map list containing a mapping of selectable names to values.

Parameters:

context: the eMatrix Context object
typePattern: The query type pattern.
vaultPattern: The query vault pattern.
whereExpression: The query where expression.
objectSelects: the eMatrix StringList object that holds the list of query select clause.

Return:: the result of the query in map list form

Throws:

: FrameworkException - when unable to retrieve data from the BOS

Since:: AEF 9.5.1.0

findObjects

    public static MapList findObjects(Context context, String typePattern, String namePattern, String revPattern, String ownerPattern, String vaultPattern, String whereExpression, boolean expandType, StringList objectSelects)

Queries on the given criteria into a map list containing a mapping of selectable names to values.

Parameters:

context: the eMatrix Context object
typePattern: The query type pattern.
namePattern: The query name pattern.
revPattern: The query revision pattern.
ownerPattern: The query owner pattern.
vaultPattern: The query vault pattern.
whereExpression: The query where expression.
expandType: true, if the query should find subtypes of the given types.
objectSelects: the eMatrix StringList object that holds the list of query select clause.

Return:: the result of the query in map list form

Throws:

: FrameworkException - when unable to retrieve data from the BOS

Since:: AEF 9.5.1.0

findObjects

    public static MapList findObjects(Context context, String typePattern, String namePattern, String revPattern, String ownerPattern, String vaultPattern, String whereExpression, String queryName, boolean expandType, StringList objectSelects, short objectLimit)

Queries on the given criteria into a map list containing a mapping of selectable names to values.

Parameters:

context: the eMatrix Context object
typePattern: The query type pattern
namePattern: The query name pattern
revPattern: The query revision pattern
ownerPattern: The query owner pattern
vaultPattern: The query vault pattern
whereExpression: The query where expression
queryName: The query name to save results
expandType: true, if the query should find subtypes of the given types
objectSelects: the eMatrix StringList object that holds the list of query select clauses
objectLimit: The limit on number of objects found

Return:: the result of the query in map list form

Throws:

: FrameworkException - when unable to retrieve data from the BOS

Since:: AEF 9.5.1.0

findObjects

    public static MapList findObjects(Context context, String typePattern, String namePattern, String revPattern, String ownerPattern, String vaultPattern, String whereExpression, String queryName, boolean expandType, StringList objectSelects, short objectLimit, String searchFormat, String searchText)

Queries on the given criteria into a map list containing a mapping of selectable names to values.

Deprecated. AEF V6R2012

Parameters:

context: the eMatrix Context object
typePattern: The query type pattern
namePattern: The query name pattern
revPattern: The query revision pattern
ownerPattern: The query owner pattern
vaultPattern: The query vault pattern
whereExpression: The query where expression
queryName: The query name to save results
expandType: true, if the query should find subtypes of the given types
objectSelects: the eMatrix StringList object that holds the list query select clauses
objectLimit: The limit on number of objects found
searchFormat: File Format Search
searchText: Keyword Search

Return:: the result of the query in map list form

Throws:

: FrameworkException - when unable to retrieve data from the BOS

findObjects

    public static MapList findObjects(Context context, String typePattern, String namePattern, String revPattern, String ownerPattern, String vaultPattern, String whereExpression, String queryName, boolean expandType, StringList objectSelects, short objectLimit, String searchFormat, String searchText, Collection multiValueList)

Queries on the given criteria into a map list containing a mapping of selectable names to values.

Parameters:

context: the eMatrix Context object
typePattern: The query type pattern
namePattern: The query name pattern
revPattern: The query revision pattern
ownerPattern: The query owner pattern
vaultPattern: The query vault pattern
whereExpression: The query where expression
queryName: The query name to save results
expandType: true, if the query should find subtypes of the given types
objectSelects: the eMatrix StringList object that holds the list query select clauses
objectLimit: The limit on number of objects found
searchFormat: File Format Search
searchText: Keyword Search

Return:: the result of the query in map list form

Throws:

: FrameworkException - when unable to retrieve data from the BOS

Since:: AEF V6R2012

getAliasForName

    public static String getAliasForName(Context context, String name, boolean useCache)

Get the schema alias for the given schema name.

Deprecated. AEF 9.5.1.0, use FrameworkUtil.getAliasForAdmin

Parameters:

context: the eMatrix Context object
name: The name of the schema object.
useCache: Use previously loaded data or refresh list from database.

Return:: The alias for the schema object.

Throws:

: FrameworkException - if the operation fails

Since:: AEF 9.1.0.0

getAllFiles

    public MapList getAllFiles(Context context)

Get a list of Files in a MapList. Map format key value "format" file format "1" first file name "2" second file name : :

Parameters:

context: the context for this request

Return:: a Maplist of Files

Throws:

: MatrixException - when unable to retrieve data from the BOS

Since:: AEF 9.x

getAllFormatFiles

    public MapList getAllFormatFiles(Context context)

Get a list of Files in a MapList. Map format key value "format" format "filename" file name

Parameters:

context: the context for this request

Return:: a Maplist of Files

Throws:

: MatrixException - when unable to retrieve data from the BOS

Since:: AEF 10.0.0.0

getApprovalsInfo

    public MapList getApprovalsInfo(Context context)

Get the approvals info for an object along with select data

Deprecated. AEF 9.5.1.0, use Route.getApprovalsInfo

Parameters:

context: the eMatrix Context object

Return:: a Map

Throws:

: FrameworkException - if the operation fails

Since:: AEF 9.5.0.0

getAttribute

    public Attribute getAttribute(Context context, String attributeName)

Get an Attribute for the attribute with the passed attributeName.

Deprecated. AEF 9.5.1.0, use getInfo (hidden attrs do not appear)

Parameters:

context: the eMatrix Context object
attributeName: the attribute name to be retrieved.

Return:: the Attribute with the passed name

Throws:

: FrameworkException - if the operation fails

Since:: AEF 9.1.0.0

getAttributeDetails

    public Map getAttributeDetails(Context context)

Returns all the business object attribute details in a Map of Maps.

Parameters:

context: the eMatrix Context object

Return:: a Map that maps attribute names to a Map of the attribute details. The attribute details Map contains the following keys: ATTRIBUTE_DETAILS_TYPE, ATTRIBUTE_DETAILS_NAME, ATTRIBUTE_DETAILS_CHOICES, ATTRIBUTE_DETAILS_MULTILINE, ATTRIBUTE_DETAILS_VALUE; e.g. map.get(ATTRIBUTE_DETAILS_TYPE);

Throws:

: FrameworkException - if the operation fails

Since:: AEF 9.1.0.0

getAttributeMap

    public Map getAttributeMap(Context context)

Returns all the business object attribute values in a form of a map of attribute name and attribute value.

Parameters:

context: the eMatrix Context object

Return:: The attribute name value pair of an object in a form of a map.

Throws:

: FrameworkException - if operation fails.

Since:: AEF 9.1.0.0

getAttributeMap

    public Map getAttributeMap(Context context, boolean getHidden)

Returns all the business object attribute values in a form of a map of attribute name and attribute value.

Parameters:

context: the eMatrix Context object
getHidden: true - to return hidden & non-hidden attributes false - to retun only non-hidden attributes

Return:: The attribute name value pair of an object in a form of a map.

Throws:

: FrameworkException - if operation fails.

Since:: AEF 10-5-0-1

getAttributeNames

    protected StringList getAttributeNames(Context context)

Get the attribute names for this business object.

Parameters:

context: the eMatrix Context object

Return:: a list of the attribute names for this business object.

Throws:

: FrameworkException - if the operation fails

Since:: AEF 9.1.0.0

getAttributeSelect

    public static String getAttributeSelect(String attribute)

Defines the proper way to define attribute selectables for print and expand.

Parameters:

attribute: the attribute that needs to be selected

Return:: the proper way to format the selectable

Since:: AEF 9.1.0.0

getAttributeValue

    public String getAttributeValue(Context context, String attributeName)

Get the attribute value for the attribute with the passed attributeName.

Parameters:

context: the eMatrix Context object
attributeName: name of the attribute whose current value needs to be fetched.

Return:: the attribute value

Throws:

: FrameworkException - if the operation fails

See Also:

: #setAttributeValue

Since:: AEF 9.1.0.0

getAutoGeneratedName

    public static String getAutoGeneratedName(Context context, String sObjectGeneratorName, String sObjectGeneratorRevision)

Generate a name based on Object Generator's name and revision

Parameters:

context: the eMatrix Context object
sObjectGeneratorName: the object generator name
sObjectGeneratorRevision: the object generator revision

Return:: an auto generated name

Since:: AEF 10.5.HF11

getBasicInfo

    public MapList getBasicInfo(Context context)

Get the basic info for an object. Type, Name, Revision - for use in printer friendly page. Owner, Description All attributes

Deprecated. AEF 9.5.1.0, see Ray

Parameters:

context: the eMatrix Context object

Return:: a MapList

Throws:

: FrameworkException - if the operation fails

Since:: AEF 9.5.0.0

getBusinessObjectData

    public Hashtable getBusinessObjectData(Context context, StringList busSelects)

Gets the businessobject selectable data

Parameters:

context: the eMatrix Context object
busSelects: the businessobject selects using which data has to be fetched

Return:: Hashtable with key value pairs of selectable data

Throws:

: Exception - if the operation fails

Since:: AEF 11.0.0.0

getBusSelectList

    public SelectList getBusSelectList(int size)

Return the SelectList object for this instance. These objects may need to be used across multiple functions; this allows reuse

Deprecated. AEF 9.5.1.0, use getObjectSelectList

Parameters:

size: ensure the size of the list

Return:: the list object for this instance

Since:: AEF 9.1.0.0

getCachedData

    protected Object getCachedData(Object key)

Get the selected cached data.

Deprecated. AEF 9.5.1.0, caching being removed

Parameters:

key: the key to the cached data

Return:: the value of the cached data

Since:: AEF 9.1.0.0

getCurrentState

    public State getCurrentState(Context context)

Return the current state for this object.

Deprecated. AEF 9.5.1.0, use getInfo

Parameters:

context: the eMatrix Context object

Return:: a State object representing the current state

Throws:

: FrameworkException - if the operation fails

Since:: AEF 9.1.0.0

getDecoratedOid

    public DecoratedOid getDecoratedOid(Context context)

Returns the DecoratedOid for this DomainObject

Parameters:

context: the eMatrix Context object

Return:: a Decorated Object Id.

Throws:

: FrameworkException - if the operation fails

Since:: AEF 9.1.0.0

getDefaultName

    protected String getDefaultName(Context context)

Get the default name for new objects.

Parameters:

context: the eMatrix Context object

Return:: The default name.

Throws:

: FrameworkException - if the operation fails

Since:: AEF 9.1.0.0

getDefaultPolicy

    public String getDefaultPolicy(Context context, String type)

Get the default policy for new objects.

Parameters:

context: the eMatrix Context object
type: The object type to get the default policy from.

Return:: The name of the default policy.

Throws:

: FrameworkException - if the operation fails

Since:: AEF 9.1.0.0

getDefaultRevision

    public String getDefaultRevision(Context context, String policyName)

Return the default revision for new objects.

Parameters:

context: the eMatrix Context object
policyName: the policy name to get the default revision from.

Return:: The name of the default revision.

Throws:

: FrameworkException - if the operation fails

Since:: AEF 9.1.0.0

getDefaultVault

    public String getDefaultVault(Context context, BusinessObject bo)

Get the default vault for new objects. If a business object is given, the default vault is the same vault as the business object. Otherwise, the default vault is the default of the current user.

Parameters:

context: the eMatrix Context object
bo: The object to get the default vault from - may be null.

Return:: The name of the default vault.

Throws:

: FrameworkException - if the operation fails

Since:: AEF 9.1.0.0

getFirstRevision

    protected BusinessObject getFirstRevision(Context context)

Get the first revision for this object.

Parameters:

context: the eMatrix Context object

Return:: a business object representing the first revision

Throws:

: FrameworkException - if the operation fails

Since:: AEF 9.1.0.0

getId

    public String getId()

Get the business object id for this object.

Deprecated. use overloaded getId(Context) method

Return:: the business object id

Throws:

: FrameworkException - if the operation fails

See Also:

: #setId

Since:: AEF 9.1.0.0

getId

    public String getId(Context context)

Get the business object id for this object.

Return:: the business object id

Throws:

: FrameworkException - if the operation fails

See Also:

: #setId

Since:: AEF R210

getImageObject

    public Image getImageObject(Context context)

getInfo

    public String getInfo(Context context, String select)

Get information regarding this business object.

Parameters:

context: the eMatrix Context object
select: list of selectables

Return:: Map containing information about the object based on selectables

Throws:

: FrameworkException - if the operation fails

Since:: AEF 9.1.0.0

getInfo

    public static MapList getInfo(Context context, String[] objectIds, StringList objectSelects)

Get information regarding many business objects.

Parameters:

context: the eMatrix Context object
objectIds: list of object ids to retrieve information against
objectSelects: the eMatrix StringList object that holds the optional list of selectables - can be null

Return:: MapList containing the objects information based on selectables

Throws:

: FrameworkException - if the operation fails

Since:: AEF 9.5.0.0

getInfo

    public Map getInfo(Context context, StringList objectSelects)

Get information regarding this business object.

Parameters:

context: the eMatrix Context object
objectSelects: the eMatrix StringList object that holds the list of object selectables

Return:: Map containing information about the object based on selectables

Throws:

: FrameworkException - if the operation fails

Since:: AEF 9.1.0.0

getInfo

    protected Map getInfo(Context context, StringList objectSelects, Collection multiValueList)

Get information regarding this business object.

Parameters:

context: the eMatrix Context object
objectSelects: the eMatrix StringList object that holds the optional list of selectables - can be null.
multiValueList: a list of selects that expect multiple values

Return:: Map containing information about the object based on selectables Default Map Keys: SEL_ID, SEL_TYPE Additional Keys: Class Selectables

Throws:

: FrameworkException - if the operation fails

Since:: AEF 9.1.0.0

getInfoList

    public StringList getInfoList(Context context, String select)

Get information regarding this business object.

Parameters:

context: the eMatrix Context object
select: optional list of selectables - can be null

Return:: Map containing information about the object based on selectables

Throws:

: FrameworkException - if the operation fails

Since:: AEF 9.1.0.0

getLastRevision

    public BusinessObject getLastRevision(Context context)

Get the last revision for this object.

Parameters:

context: the eMatrix Context object

Return:: a business object representing the last revision

Throws:

: FrameworkException - if the operation fails

Since:: AEF 9.1.0.0

getLicenseReservedAPPS

    public String[] getLicenseReservedAPPS()

getName

    public String getName(Context context)

Return the name for this object.

Deprecated. AEF 9.5.1.0, use getInfo

Parameters:

context: the eMatrix Context object

Return:: the name for this object

Throws:

: FrameworkException - if the operation fails

See Also:

: #setName

Since:: AEF 9.1.0.0

getObject

    public static DomainObject getObject(Context context, BusinessObject bo)

Returns a fully contstructed DomainObject derivative given the Object ID. The method lookups up and constructs the appropriate bean given the type.

Deprecated. AEF 9.5.1.0, use newInstance

Parameters:

context: the eMatrix Context object
bo: The BusinessObject

Return:: a class derived from DomainObject that the given oid represents

Throws:

: FrameworkException - if the operation fails

Since:: AEF 9.5.0.0

getObject

    public static DomainObject getObject(Context context, DecoratedOid oid)

Returns a fully contstructed DomainObject derivative given the DecoaretdObject ID. The method lookups up and constructs the appropriate bean given the type. This is the prefered flavor of the methods since it avoids the lookup of the type in the DataBase.

Deprecated. AEF 9.5.1.0, use newInstance

Parameters:

context: the eMatrix Context object
oid: The decorated object id

Return:: a class derived from DomainObject that the given oid represents

Throws:

: FrameworkException - if the operation fails

Since:: AEF 9.1.0.0

getObject

    public static DomainObject getObject(Context context, String oid)

Returns a fully contstructed DomainObject derivative given the Object ID. The method lookups up and constructs the appropriate bean given the type.

Deprecated. AEF 9.5.1.0, use newInstance

Parameters:

context: the eMatrix Context object
oid: The object id or type

Return:: a class derived from DomainObject that the given oid represents

Throws:

: FrameworkException - if the operation fails

Since:: AEF 9.1.0.0

getObjects

    public MapList getObjects(Context context, String relPattern, String typePattern, boolean getTo, boolean getFrom, int recursionLevel, StringList objectSelects, StringList relationshipSelects, String busWhereClause, String relWhereClause, String postRelPattern, String postTypePattern, Map postPatterns, MapList cacheList, boolean useCache)

Expand business objects based on App Lib Expand function.

Deprecated. AEF 9.5.1.0, use getRelatedObjects

Parameters:

context: the eMatrix Context object
relPattern: The relationship pattern to expand along.
typePattern: The type pattern to expand along.
getTo: Define whether the expand should go in the "to" dir.
getFrom: Define whether the expand should go in the "from" dir.
recursionLevel: The number of levels to expand - 0 for all
objectSelects: the eMatrix StringList object that holds the list of expand select clause - may be null or empty.
relationshipSelects: the eMatrix StringList object that holds the list of expand select clause - may be null or empty.
busWhereClause: The where clause on the business object selectables - may be null or empty
relWhereClause: The where clause on the relationship object selectables - may be null or empty
postRelPattern: The relationships to include following the expand. This may be be empty, null or a comma separated list.
postTypePattern: The types to include following the expand. This may be be empty, null or a comma separated list.
postPatterns: The patterns to include following the expand This may be be null. Each key should match a selectable. Each map value is the pattern to match against the result set (may be comma separated).
cacheList: the eMatrix MapList object that holds the list of private class cache list variable.
useCache: Use previously loaded data or refresh list from database

Return:: The list of object selectables

Throws:

: FrameworkException - if the operation fails

Since:: AEF 9.1.0.0

getObjectSelectList

    public SelectList getObjectSelectList(int size)

Return the SelectList object for this instance. These objects may need to be used across multiple functions; this allows reuse

Parameters:

size: ensure the size of the list

Return:: the list object for this instance

Since:: AEF 9.1.0.0

getParentInfo

    protected MapList getParentInfo(Context context, int level, StringList objectSelects, String relationship)

Get the parent for this business object.

Deprecated. AEF 9.5.1.0, use getRelatedObjects

Parameters:

context: the eMatrix Context object
level: the level to expand up from the Business Object
objectSelects: the eMatrix StringList object that holds the optional list of selectables - can be null
relationship: the parent relationship for traversing

Return:: the list of parents - should be one unless multi-level

Throws:

: FrameworkException - if the operation fails

Since:: AEF 9.1.0.0

getPolicies

    public MapList getPolicies(Context context)

Get the policies for this object.

Deprecated. AEF 9.5.1.0 use TypeUtils.getPolicies

Parameters:

context: the eMatrix Context object

Return:: The list of policies in a format of a MapList. Map Keys: name (name of policy), description (description of policy), revision (initial revision in sequence). an empty list is returned when there are no policies.

Throws:

: FrameworkException - if the operation fails

Since:: AEF ?.?.?.?

getPreviousRevision

    public BusinessObject getPreviousRevision(Context context)

Get the Previous revision for this object.

Parameters:

context: the eMatrix Context object

Return:: a business object representing the last revision

Throws:

: FrameworkException - if the operation fails

Since:: AEF 9.1.0.0

getRelatedObject

    public Map getRelatedObject(Context context, String relationship, boolean from, StringList busSelects, StringList relSelects)

Retrieves information by traversing one level on a given reationship. The name getRelationship implies only object would exist at most.

Parameters:

context: the eMatrix Context object
relationship: The relationship type to traverse.
from: this is a from connection of the given object (true) or to the given object (false).
busSelects: the eMatrix StringList object that holds the list of selectables to retrieve; only one object at most is expected (cardinality one).
relSelects: the eMatrix StringList object that holds the list of selectables to retrieve;

Return:: Map based on selectables - null if relationship does not exist.

Throws:

: FrameworkException - if operation fails

Since:: AEF 9.5.1.0

getRelatedObjects

    public MapList getRelatedObjects(Context context, String relationshipPattern, String typePattern, boolean getTo, boolean getFrom, int recurseToLevel, StringList objectSelects, StringList relationshipSelects, String objectWhereClause, String relationshipWhereClause, int limit, String postRelPattern, String postTypePattern, Map postPatterns)

Expand business objects based on App Lib Expand function.

Parameters:

context: the eMatrix Context object
relPattern: The relationship pattern to expand along.
typePattern: The type pattern to expand along.
getTo: Define whether the expand should go in the "to" dir.
getFrom: Define whether the expand should go in the "from" dir.
recursionLevel: The number of levels to expand - 0 for all
objectSelects: the eMatrix StringList object that holds the list of expand select clause - may be null or empty.
relationshipSelects: the eMatrix StringList object that holds the list of expand select clause - may be null or empty.
busWhereClause: The where clause on the business object selectables - may be null or empty
relWhereClause: The where clause on the relationship object selectables - may be null or empty
limit: The max number of Objects to get in the exapnd. 0 to return all the data available.
postRelPattern: The relationships to include following the expand. This may be be empty, null or a comma separated list.
postTypePattern: The types to include following the expand. This may be be empty, null or a comma separated list.
postPatterns: The patterns to include following the expand This may be be null. Each key should match a selectable. Each map value is the pattern to match against the result set (may be comma separated).

Return:: The list of object selectables

Throws:

: FrameworkException - if the operation fails

Since:: AEF 9.5.1.0

getRelatedObjects

    public MapList getRelatedObjects(Context context, String relationshipPattern, String typePattern, boolean getTo, boolean getFrom, int recurseToLevel, StringList objectSelects, StringList relationshipSelects, String objectWhereClause, String relationshipWhereClause, String postRelPattern, String postTypePattern, Map postPatterns)

Expand business objects based on App Lib Expand function.

Deprecated. Use getRelatedObjects with limit

Parameters:

context: the eMatrix Context object
relPattern: The relationship pattern to expand along.
typePattern: The type pattern to expand along.
getTo: Define whether the expand should go in the "to" dir.
getFrom: Define whether the expand should go in the "from" dir.
recursionLevel: The number of levels to expand - 0 for all
objectSelects: the eMatrix StringList object that holds the list of expand select clause - may be null or empty.
relationshipSelects: the eMatrix StringList object that holds the list of expand select clause - may be null or empty.
busWhereClause: The where clause on the business object selectables - may be null or empty
relWhereClause: The where clause on the relationship object selectables - may be null or empty
postRelPattern: The relationships to include following the expand. This may be be empty, null or a comma separated list.
postTypePattern: The types to include following the expand. This may be be empty, null or a comma separated list.
postPatterns: The patterns to include following the expand This may be be null. Each key should match a selectable. Each map value is the pattern to match against the result set (may be comma separated).

Return:: The list of object selectables

Throws:

: FrameworkException - if the operation fails

Since:: AEF 9.5.1.0

getRelatedObjects

    public MapList getRelatedObjects(Context context, String relationshipPattern, String typePattern, StringList objectSelects, StringList relationshipSelects, boolean getTo, boolean getFrom, short recurseToLevel, String objectWhere, String relationshipWhere)

Do an expand and select on a BusinessObject.

Deprecated. Use getRelatedObjects with limit

Parameters:

context: the eMatrix Context object
relationshipPattern: - pattern to match relationships
typePattern: - pattern to match types
objectSelects: the eMatrix StringList object that holds the list of select statement pertaining to Business Obejcts.
relationshipSelects: the eMatrix StringList object that holds the list of select statement pertaining to Relationships.
getTo: - get To relationships
getFrom: - get From relationships
recurseToLevel: - the number of levels to expand, 0 equals expand all.
objectWhere: - where clause to apply to objects, can be empty ""
relationshipWhere: - where clause to apply to relationship, can be empty ""

Return:: the result of the expand in map list form

Throws:

: FrameworkException - when unable to retrieve data from the BOS

Since:: AEF 9.5.1.0

getRelatedObjects

    public MapList getRelatedObjects(Context context, String relationshipPattern, String typePattern, StringList objectSelects, StringList relationshipSelects, boolean getTo, boolean getFrom, short recurseToLevel, String objectWhere, String relationshipWhere, int limit)

Do an expand and select on a BusinessObject.

Parameters:

context: the eMatrix Context object
relationshipPattern: - pattern to match relationships
typePattern: - pattern to match types
objectSelects: the eMatrix StringList object that holds the list of select statement pertaining to Business Obejcts.
relationshipSelects: the eMatrix StringList object that holds the list of select statement pertaining to Relationships.
getTo: - get To relationships
getFrom: - get From relationships
recurseToLevel: - the number of levels to expand, 0 equals expand all.
objectWhere: - where clause to apply to objects, can be empty ""
relationshipWhere: - where clause to apply to relationship, can be empty ""
limit: The max number of Objects to get in the exapnd. 0 to return all the data available.

Return:: the result of the expand in map list form

Throws:

: FrameworkException - when unable to retrieve data from the BOS

Since:: AEF V6R2009x

getRelatedObjects

    public MapList getRelatedObjects(Context context, String relationshipPattern, String typePattern, StringList objectSelects, StringList relationshipSelects, boolean getTo, boolean getFrom, short recurseToLevel, String objectWhere, String relationshipWhere, int limit, Pattern includeType, Pattern includeRelationship, Map includeMap)

Do an expand and select on a BusinessObject.

Parameters:

context: the eMatrix Context object
relationshipPattern: - pattern to match relationships
typePattern: - pattern to match types
objectSelects: the eMatrix StringList object that holds the list of select statement pertaining to Business Obejcts.
relationshipSelects: the eMatrix StringList object that holds the list of select statement pertaining to Relationships.
getTo: - get To relationships
getFrom: - get From relationships
recurseToLevel: - the number of levels to expand, 0 equals expand all.
objectWhere: - where clause to apply to objects, can be empty ""
relationshipWhere: - where clause to apply to relationship, can be empty ""
limit: The max number of Objects to get in the exapnd. 0 to return all the data available.
includeType: filter for businees types we want returned. If the type of the object is not found in this list then it will not be returned in the MapList. If null all types will be returned.
includeRelationship: filter for relationships we want returned. If the relationship of the object does not match one in this list then it will not be returned in the MapList. If null all relationship types will be returned
includeMap: a name/value pair that is used to filter data. If the name matches and the values match each other than they will be returned in the MapList. If null the value checking is ignored

Return:: the result of the expand in map list form

Throws:

: FrameworkException - when unable to retrieve data from the BOS

Since:: AEF V6R2009x

getRelatedObjects

    public MapList getRelatedObjects(Context context, String relationshipPattern, String typePattern, StringList objectSelects, StringList relationshipSelects, boolean getTo, boolean getFrom, short recurseToLevel, String objectWhere, String relationshipWhere, Pattern includeType, Pattern includeRelationship, Map includeMap)

Do an expand and select on a BusinessObject.

Deprecated. Use getRelatedObjects with limit

Parameters:

context: the eMatrix Context object
relationshipPattern: - pattern to match relationships
typePattern: - pattern to match types
objectSelects: the eMatrix StringList object that holds the list of select statement pertaining to Business Obejcts.
relationshipSelects: the eMatrix StringList object that holds the list of select statement pertaining to Relationships.
getTo: - get To relationships
getFrom: - get From relationships
recurseToLevel: - the number of levels to expand, 0 equals expand all.
objectWhere: - where clause to apply to objects, can be empty ""
relationshipWhere: - where clause to apply to relationship, can be empty ""
includeType: filter for businees types we want returned. If the type of the object is not found in this list then it will not be returned in the MapList. If null all types will be returned.
includeRelationship: filter for relationships we want returned. If the relationship of the object does not match one in this list then it will not be returned in the MapList. If null all relationship types will be returned
includeMap: a name/value pair that is used to filter data. If the name matches and the values match each other than they will be returned in the MapList. If null the value checking is ignored

Return:: the result of the expand in map list form

Throws:

: FrameworkException - when unable to retrieve data from the BOS

Since:: AEF 9.5.1.0

getRelatedObjects

    public MapList getRelatedObjects(Context context, String relationshipPattern, String typePattern, StringList objectSelects, StringList relationshipSelects, boolean getTo, boolean getFrom, short recurseToLevel, String objectWhereClause, String relationshipWhereClause, short limit, boolean checkHidden, boolean preventDuplicates, short pageSize, Pattern includeType, Pattern includeRelationship, Map includeMap, String relKeyPrefix)

Parameters:

context
relationshipPattern
typePattern
objectSelects
relationshipSelects
getTo
getFrom
recurseToLevel
objectWhereClause
relationshipWhereClause
limit
checkHidden
preventDuplicates
pageSize
includeType
includeRelationship
includeMap
relKeyPrefix

Return:

Throws:

: FrameworkException -

getRelatedObjects

    public MapList getRelatedObjects(Context context, String relationshipPattern, String typePattern, StringList objectSelects, StringList relationshipSelects, boolean getTo, boolean getFrom, short recurseToLevel, String objectWhereClause, String relationshipWhereClause, short limit, boolean checkHidden, boolean preventDuplicates, short pageSize, Pattern includeType, Pattern includeRelationship, Map includeMap, String relKeyPrefix, String filterExpression)

Do an expand and select on a BusinessObject.

Parameters:

context: the eMatrix Context object
relationshipPattern: - pattern to match relationships
typePattern: - pattern to match types
objectSelects: the eMatrix StringList object that holds the list of select statement pertaining to Business Obejcts.
relationshipSelects: the eMatrix StringList object that holds the list of select statement pertaining to Relationships.
getTo: - get To relationships
getFrom: - get From relationships
recurseToLevel: - the number of levels to expand, 0 equals expand all.
objectWhere: - where clause to apply to objects, can be empty ""
relationshipWhere: - where clause to apply to relationship, can be empty ""
limit: The max number of Objects to get in the exapnd. 0 to return all the data available.
checkHidden
preventDuplicates
pageSize
includeType: filter for businees types we want returned. If the type of the object is not found in this list then it will not be returned in the MapList. If null all types will be returned.
includeRelationship: filter for relationships we want returned. If the relationship of the object does not match one in this list then it will not be returned in the MapList. If null all relationship types will be returned
includeMap: a name/value pair that is used to filter data. If the name matches and the values match each other than they will be returned in the MapList. If null the value checking is ignored
relKeyPrefix: prefix added to relationship keys to prevent key name collision with object keys.
filterExpression: String of the compiled binary effectivity filter

Return:: the result of the expand in map list form

Throws:

: FrameworkException - when unable to retrieve data from the BOS

Since:: AEF R209

getRelatedObjects

    public MapList getRelatedObjects(Context context, String relationshipPattern, String typePattern, StringList objectSelects, StringList relationshipSelects, boolean getTo, boolean getFrom, short recurseToLevel, String objectWhereClause, String relationshipWhereClause, short limit, boolean checkHidden, boolean preventDuplicates, short pageSize, Pattern includeType, Pattern includeRelationship, Map includeMap, String relKeyPrefix, String filterExpression, short filterFlag)

Do an expand and select on a BusinessObject.

Parameters:

context: the eMatrix Context object
relationshipPattern: - pattern to match relationships
typePattern: - pattern to match types
objectSelects: the eMatrix StringList object that holds the list of select statement pertaining to Business Obejcts.
relationshipSelects: the eMatrix StringList object that holds the list of select statement pertaining to Relationships.
getTo: - get To relationships
getFrom: - get From relationships
recurseToLevel: - the number of levels to expand, 0 equals expand all.
objectWhere: - where clause to apply to objects, can be empty ""
relationshipWhere: - where clause to apply to relationship, can be empty ""
limit: The max number of Objects to get in the exapnd. 0 to return all the data available.
checkHidden
preventDuplicates
pageSize
includeType: filter for businees types we want returned. If the type of the object is not found in this list then it will not be returned in the MapList. If null all types will be returned.
includeRelationship: filter for relationships we want returned. If the relationship of the object does not match one in this list then it will not be returned in the MapList. If null all relationship types will be returned
includeMap: a name/value pair that is used to filter data. If the name matches and the values match each other than they will be returned in the MapList. If null the value checking is ignored
relKeyPrefix: prefix added to relationship keys to prevent key name collision with object keys.
filterExpression: String of the compiled binary effectivity filter
filterflag: short FILTER_STR_AND_ITEM to filter on both structure and item effectivity expression FILTER_STRUCTURE to filter on only structure effectivity exrression FILTER_ITEM to filter on only item effectivity expression

Return:: the result of the expand in map list form

Throws:

: FrameworkException - when unable to retrieve data from the BOS

Since:: AEF R210

getRelationship

    protected Map getRelationship(Context context, String relationship, boolean from, StringList busSelects, StringList relSelects)

Retrieves information by traversing one level on a given reationship. The name getRelationship implies only object would exist at most.

Deprecated. AEF 9.5.1.0, use getRelatedObject

Parameters:

context: the eMatrix Context object
relationship: The relationship type to traverse.
from: this is a from connection of the given object (true) or to the given object (false).
busSelects: the eMatrix StringList object that holds the list of selectables to retrieve; only one object at most is expected (cardinality one).
relSelects: the eMatrix StringList object that holds the list of selectables to retrieve;

Return:: Map based on selectables - null if relationship does not exist.

Throws:

: FrameworkException - if operation fails

Since:: AEF 10.0.0.0

getRelationshipSelectList

    public SelectList getRelationshipSelectList(int size)

Return the relationship SelectList object for this instance. These objects may need to be used across multiple functions. This allows reuse.

Parameters:

size: ensure the size of the list

Return:: the relationship select list object for this instance

Since:: AEF 9.1.0.0

getRevision

    public String getRevision(Context context)

Get the business object revision for this object.

Deprecated. AEF 9.5.1.0, use getInfo

Parameters:

context: the eMatrix Context object

Return:: the business object type

Throws:

: FrameworkException - if the operation fails

Since:: AEF 9.1.0.0

getRevisions

    public MapList getRevisions(Context context, StringList objectSelects, boolean useCache)

Get selectables from each revision of this object. The given selectables are extracted from each revision of this business object and returned as a MapList.

Deprecated. AEF 9.5.1.0, use getRevisionsInfo

Parameters:

context: the eMatrix Context object
objectSelects: the eMatrix StringList object that holds the list of selectables for each revision - may be null
useCache: use previously loaded data or refresh from database

Return:: list of document revisions of the current document

Throws:

: FrameworkException - if operation fails

Since:: AEF 9.1.0.0

getRevisionsInfo

    public MapList getRevisionsInfo(Context context, StringList singleValueSelects, StringList multiValueSelects)

Get the revisions for an object along with select data

Parameters:

context: the eMatrix Context object
singleValueSelects: the eMatrix StringList object that holds the list of selects that return a single value, for example owner
multiValueSelects: the eMatrix StringList object that holds the list of selects that return multiple values, for example revisions[]

Return:: a MapList

Throws:

: FrameworkException - if the operation fails

Since:: AEF 9.5.0.0

getRouteInfoForStates

    public Map getRouteInfoForStates(Context context, String sAdHoc)

Get map of State/Route info

Deprecated. AEF 9.5.1.0, use Route.getRouteInfoForStates

Parameters:

context: the eMatrix Context object
sAdHoc: the string value of the AdHoc property

Return:: a Map with info about the revised object

Throws:

: FrameworkException - if the operation fails

Since:: AEF ?.?.?.?

getSchemaProperty

    public String getSchemaProperty(Context context, String type, String name, String property)

Get the schema property of an administrative object. The property must be on the admin object.

Deprecated. AEF 9.5.1.0, use PropertyUtil.getSchemaProperty

Parameters:

context: the eMatrix Context object
type: the business administrative type; e.g. policy, type, etc.
name: the business administrative name.
property: the property alias name to retrieve.

Return:: the administrative object property value.

Throws:

: FrameworkException - if the operation fails

Since:: AEF 9.1.0.0

getSchemaProperty

    public static String getSchemaProperty(String property)

Get the AEF schema property reference through this property, actual schema names are returned.

Deprecated. AEF 9.5.1.0, use PropertyUtil.getSchemaProperty

Parameters:

property: the property alias name in the format type_schemaname

Return:: the business object schema name

Since:: AEF 9.1.0.0

getSchemaProperty

    protected static String getSchemaProperty(String type, String name, String property)

Get the schema property of an administrative object. The property must be on the admin object.

Deprecated. AEF 9.5.1.0, use PropertyUtil.getSchemaProperty

Parameters:

type: the business administrative type; e.g. policy, type, etc.
name: the business administrative name.
property: the property alias name to retrieve.

Return:: the administrative object property value.

Since:: AEF 9.1.0.0

getShortUniqueName

    public String getShortUniqueName()

Generate a unique name for an object. Many application objects allow their names to be auto generated. This method is typically called from object create methods. The name is generated using a prefix plus the number of milliseconds since 1/1/1970.

Return:: a name that is prefix + counter + last 10 digits of unique number

Since:: AEF 10.5

getShortUniqueName

    public String getShortUniqueName(String prefix)

Parameters:

prefix: the prefix to the generated name

Return:: a name that is prefix + counter + last 10 digits of unique number

Since:: AEF 10.5

getSignaturesDetails

    public MapList getSignaturesDetails(Context context, State fromState, State toState)

Get the Signatures details info for an object between the states

Parameters:

context: the eMatrix Context object
fromState: the from state of the signature
toState: the to state of the signature

Return:: a MapList of signature information maps - see the method with fromState and toState parameters of String type for details

Throws:

: Exception - if the operation fails

Since:: AEF 10-5-0-1

getSignaturesDetails

    public MapList getSignaturesDetails(Context context, String fromState, String toState)

Get the Signatures details info for an object between the states

Parameters:

context: the eMatrix Context object
fromState: the from state of the signature
toState: the to state of the signature

Return:: a MapList of signature information maps with key/value pairs KEY Value name signature's name signer signature's signer comment signature's comment approved "TRUE" or "FALSE" rejected "TRUE" or "FALSE" ignored "TRUE" or "FALSE" signed "TRUE" or "FALSE" hasapprove "TRUE" or "FALSE" hasreject "TRUE" or "FALSE" hasignore "TRUE" or "FALSE"

Throws:

: Exception - if the operation fails

Since:: AEF 10-5-0-1

getState

    protected State getState(Context context, String name)

Get the named state for this object.

Deprecated. AEF 9.5.1.0, use getInfo

Parameters:

context: the eMatrix Context object
name: name of the state to retrieve

Return:: a State object for the named state

Throws:

: FrameworkException - if the operation fails

Since:: AEF 9.1.0.0

getType

    public String getType(Context context)

Return the business object type for this object.

Deprecated. AEF 9.5.1.0, use getInfo

Parameters:

context: the eMatrix Context object

Return:: the business object type

Throws:

: FrameworkException - if the operation fails

Since:: AEF 9.1.0.0

getTypeAttributeNames

    protected static StringList getTypeAttributeNames(Context context, String typeName)

Get the attribute names for the specified type.

Parameters:

context: the eMatrix Context object
typeName: the business type to retrieve attributes for

Return:: a list of the attribute names for the business type

Throws:

: FrameworkException - if operation the fails

Since:: AEF 9.1.0.0

getTypeAttributes

    protected static MapList getTypeAttributes(Context context, String type)

Get the business type attributes - type specific attributes. This function returns extra attribute information that describes each attribute in terms of: name, type, multiline, default, and range

Parameters:

context: the eMatrix Context object
type: the business type to retrieve attributes for

Return:: MapList of hashmaps of attribute information; map keys: see app lib

Throws:

: FrameworkException - if the operation fails

Since:: AEF 9.1.0.0

getUniqueName

    public String getUniqueName()

Deprecated. since V6R2011 - Always use this method with Context

Return:: a name that will be unique

Since:: AEF 9.1.0.0

getUniqueName

    public String getUniqueName(Context context)

Return:: a name that will be unique

Since:: AEF 9.1.0.0

getUniqueName

    public String getUniqueName(String prefix)

Parameters:

prefix: the prefix to the generated name

Return:: a name that will be unique

Since:: AEF 10.5

getUniqueName

    public synchronized String getUniqueName(String prefix, int noOfDigits)

Parameters:

prefix: the prefix to the generated name
noOfDigits: the number of digits to keep in the unique number generated from the end

Return:: a name that will be unique

Since:: AEF 10.5

gotoState

    public void gotoState(Context context, String stateName)

Set the state of the object to the given state. Promote or demote the object until the request state is obtained.

Deprecated. AEF 9.5.1.0, use setState

Parameters:

context: the eMatrix Context object
stateName: the state to achieve

Throws:

: FrameworkException - if the operation fails

Since:: AEF 9.1.0.0

hasObjects

    protected boolean hasObjects(Context context, String relationshipType, boolean from)

Checks whether the current object has relationships of a certain type.

Deprecated. AEF 9.5.1.0, use hasRelatedObjects

Parameters:

context: the eMatrix Context object
relationshipType: The relationship type to filter against
from: The direction to check - true is from; false is to direction

Return:: boolean true if the object contains relationships

Throws:

: FrameworkException - if the operation fails

Since:: AEF 9.1.0.0

hasRelatedObjects

    public boolean hasRelatedObjects(Context context, String relationshipType, boolean from)

Checks whether the current object has relationships of a certain type.

Parameters:

context: the eMatrix Context object
relationshipType: The relationship type to filter against
from: The direction to check - true is from; false is to direction

Return:: boolean true if the object contains relationships

Throws:

: FrameworkException - if the operation fails

Since:: AEF 9.5.1.0

isKindOf

    public boolean isKindOf(Context context, String type)

Returns true if this object's type inherits from the type passed in.

Parameters:

context: the eMatrix Context object
type: the object type to see if this object's type inherits from

Return:: true if this object inherits from the type passed in, else false

Throws:

: FrameworkException - if operation fails.

Since:: AEF 10-5-0-1

isLastRevision

    public boolean isLastRevision(Context context)

Check to see if this is the last revision of the object.

Parameters:

context: the eMatrix Context object

Return:: a boolean indicating whether it is true or false

Throws:

: FrameworkException - if the operation fails

Since:: AEF 10.0.0.0

mqlCommand

    public static String mqlCommand(Context context, MQLCommand mql, String command)

Executes an mql command.

Deprecated. AEF 9.5.1.0, use MqlUtil.mqlCommand

Parameters:

context: the eMatrix Context object
mql: the mql command object to execute the command in.
command: mql command to be executed.

Return:: Results of mql command.

Throws:

: FrameworkException - if operation fails.

Since:: AEF 9.1.0.0

mqlCommand

    protected static String mqlCommand(Context context, MQLCommand mql, String command, boolean runAsSuperUser)

Executes an mql command.

Deprecated. AEF 9.5.1.0, use MqlUtil.mqlCommand

Parameters:

context: the eMatrix Context object
mql: the mql command object to execute the command in.
command: mql command to be executed.
runAsSuperUser: Whether the command should run as Super User.

Return:: Results of mql command.

Throws:

: FrameworkException - if the operation fails

Since:: AEF 9.1.0.0

mqlCommand

    protected String mqlCommand(Context context, String command)

Executes an mql command.

Deprecated. AEF 9.5.1.0, use MqlUtil.mqlCommand

Parameters:

context: the eMatrix Context object
command: mql command to be executed.

Return:: Results of mql command.

Throws:

: FrameworkException - if the operation fails

Since:: AEF 9.1.0.0

mqlCommand

    protected String mqlCommand(Context context, String command, boolean runAsSuperUser)

Executes an mql command.

Deprecated. AEF 9.5.1.0, use MqlUtil.mqlCommand

Parameters:

context: the eMatrix Context object
command: mql command to be executed.
runAsSuperUser: Whether the command should run as Super User.

Return:: Results of mql command.

Throws:

: FrameworkException - if operation fails.

Since:: AEF 9.1.0.0

multiLevelRecursionCheck

    public static boolean multiLevelRecursionCheck(Context context, String fromObjectId, String toObjectId, String relType, boolean includeRevisionsCheck)

newInstance

    public static DomainObject newInstance(Context context)

Returns DomainObject given context this is prefered method to call instead of newing up DomainObject

Parameters:

context: the eMatrix Context object

Return:: DomainObject instance

Throws:

: FrameworkException - if the operation fails

Since:: AEF Rossini

newInstance

    public static DomainObject newInstance(Context context, BusinessObject bo)

Returns a fully contstructed DomainObject derivative given the BusinessObject. The method lookups up and constructs the appropriate bean given the BusinessObject.

Parameters:

context: the eMatrix Context object
bo: The BusinessObject

Return:: a class derived from DomainObject that the given bo represents

Throws:

: FrameworkException - if the operation fails

Since:: AEF 9.5.1.0

newInstance

    public static DomainObject newInstance(Context context, BusinessObject bo, String applicationName)

Returns a fully contstructed DomainObject derivative given the BusinessObject. The method lookups up and constructs the appropriate bean given the BusinessObject.

Parameters:

context: the eMatrix Context object
bo: The BusinessObject
applicationName,: the name of application to determine the mapping file to look in first

Return:: a class derived from DomainObject that the given bo represents

Throws:

: FrameworkException - if the operation fails

Since:: AEF Rossini

newInstance

    public static DomainObject newInstance(Context context, DecoratedOid oid)

Returns a fully contstructed DomainObject derivative given the DecoaretdObject ID. The method lookups up and constructs the appropriate bean given the object type. This is the prefered flavor of the methods since it avoids the lookup of the type in the DataBase.

Parameters:

context: the eMatrix Context object
oid: The decorated object id

Return:: a class derived from DomainObject that the given oid represents

Throws:

: FrameworkException - if the operation fails

Since:: AEF 9.5.1.0

newInstance

    public static DomainObject newInstance(Context context, DecoratedOid oid, String applicationName)

Parameters:

context: the eMatrix Context object
oid: The decorated object id
applicationName,: the name of application to determine the mapping file to look in first

Return:: a class derived from DomainObject that the given oid represents

Throws:

: FrameworkException - if the operation fails

Since:: AEF Rossini

newInstance

    public static DomainObject newInstance(Context context, String idORtype)

Returns a fully contstructed DomainObject derivative given the object ID or object Type. The method lookups up and constructs the appropriate bean given the object ID or object Type.

Parameters:

context: the eMatrix Context object
idORtype: The object ID or type that the DomainObject represents

Return:: a class derived from DomainObject that the given idORtype represents

Throws:

: FrameworkException - if the operation fails

Since:: AEF 9.5.1.0

newInstance

    public static DomainObject newInstance(Context context, String idORtype, String applicationName)

Returns a fully contstructed DomainObject derivative given the object ID or object Type. The method lookups up and constructs the appropriate bean given the object ID or object Type.

Parameters:

context: the eMatrix Context object
idORtype: The object ID or type that the DomainObject represents
applicationName,: the name of application to determine the mapping file to look in first

Return:: a class derived from DomainObject that the given idORtype represents

Throws:

: FrameworkException - if the operation fails

Since:: AEF Rossini

newInstance

    public static DomainObject newInstance(Context context, String idORtype, String applicationName, String interfaceName)

Returns a fully contstructed DomainObject derivative given the object ID or object Type/interface. The method lookups up and constructs the appropriate bean given the object ID or object Type.

Parameters:

context: the eMatrix Context object
idORtype: The object ID or type that the DomainObject represents
applicationName,: the name of application to determine the mapping file to look in first
interfaceName,: the name of interface defined in the mapping file so that this new instance will return the object of the interface instance.

Return:: a class derived from DomainObject that the given idORtype represents

Throws:

: FrameworkException - if the operation fails

Since:: AEF Rossini

openObject

    public boolean openObject(Context context)

Assure the object is open. If the object is already open then return false. If the object is not open then open it and return true. This method is used as a wrapper so that we can change the functionality when objects don't need to be opened and closed anymore.

 boolean closeBO = openObject(context);

 try
 {
     ....
 }
 finally
 {
    closeObject(context, closeBO);
 }

Parameters:

context: the eMatrix Context object

Return:: true if this method opened the object

Throws:

: FrameworkException - if the object can not be opened

Since:: AEF 9.1.0.0

popContext

    protected static void popContext(Context context)

Restore the original context, can only be called after the call to a corresponding push.

Deprecated. AEF 9.5.1.0, use ContextUtil.popContext

Parameters:

context: the eMatrix Context object

Throws:

: FrameworkException - if the operation fails

Since:: AEF 9.1.0.0

pushContext

    protected static void pushContext(Context context)

Get the super user context. The context must be poped to go back to the original context.

Deprecated. AEF 9.5.1.0, use ContextUtil.pushContext

Parameters:

context: the eMatrix Context object

Throws:

: FrameworkException - if the operation fails

Since:: AEF 9.1.0.0

pushContext

    protected static void pushContext(Context context, String name, String password, String vault)

Get the super user context. Package protected to prevent missues by non inherrited classes. The context must be poped to go back to the original context.

Deprecated. AEF 9.5.1.0, use ContextUtil.pushContext

Parameters:

context: the eMatrix Context object
name: The new user name
password: The new password
vault: The new vault

Throws:

: FrameworkException - if the operation fails

Since:: AEF 9.1.0.0

querySelect

    public static MapList querySelect(Context context, String typePattern, String vaultPattern, String whereExpression, StringList objectSelects, MapList cachedList, boolean useCache)

Queries on the given criteria into a map list containing a mapping of selectable names to values.

Deprecated. AEF 9.5.1.0, use findObjects

Parameters:

context: the eMatrix Context object
typePattern: The query type pattern.
vaultPattern: The query vault pattern.
whereExpression: The query where expression.
objectSelects: the eMatrix StringList object that holds the list query select clause.
cachedList: the eMatrix MapList object that holds the list to return if useCache is true
useCache: true to return cachedList otherwise do the expand

Return:: the result of the query in map list form

Throws:

: FrameworkException - when unable to retrieve data from the BOS

Since:: AEF 9.1.0.0

querySelect

    public static MapList querySelect(Context context, String typePattern, String namePattern, String revPattern, String ownerPattern, String vaultPattern, String whereExpression, boolean expandType, StringList objectSelects, MapList cachedList, boolean useCache)

Queries on the given criteria into a map list containing a mapping of selectable names to values.

Deprecated. AEF 9.5.1.0, use findObjects

Parameters:

context: the eMatrix Context object
typePattern: The query type pattern.
namePattern: The query name pattern.
revPattern: The query revision pattern.
ownerPattern: The query owner pattern.
vaultPattern: The query vault pattern.
whereExpression: The query where expression.
expandType: true, if the query should find subtypes of the given types.
objectSelects: the eMatrix StringList object that holds the list of query select clause.
cachedList: the eMatrix MapList object that holds the list to return if useCache is true
useCache: true to return cachedList otherwise do the expand

Return:: the result of the query in map list form

Throws:

: FrameworkException - when unable to retrieve data from the BOS

Since:: AEF 9.1.0.0

resetAttributes

    public void resetAttributes(Context context)

Reset all attribute values for this object. Set all attributes with its default value.

Parameters:

context: the eMatrix Context object

Throws:

: FrameworkException - if the operation fails

Since:: AEF 9.5.1.1.0.1

reviseObject

    public BusinessObject reviseObject(Context context, boolean copyFiles)

Create a new revision of an object in the database based on it's last revision.

Parameters:

context: the eMatrix Context object
copyFiles: The boolean value to copy files from current object or not.

Return:: a BusinessObject of the revised object

Throws:

: FrameworkException - if the operation fails

Since:: AEF 10.5

reviseObject

    public BusinessObject reviseObject(Context context, String nextRev, boolean copyFiles)

Create a new revision of an object in the database based on it's last revision.

Parameters:

context: the eMatrix Context object
nextRev: String containing the next Revision of the business object
copyFiles: The boolean value to copy files from current object or not.

Return:: a BusinessObject of the revised object

Throws:

: FrameworkException - if the operation fails

Since:: AEF 10.5

revokeAccess

    public void revokeAccess(Context context, String grantor, String grantee)

Revoke access rights for a grantor and grantee combination. If both grantee and grantor are specified, then only the grants from the grantor to the grantee are revoked. If only the grantor is specified, then all the grants from the grantor are revoked. If only the grantee is specified, then all the grants to the grantee are revoked. If neither is specified, then all grants are revoked.

Parameters:

context: the eMatrix Context object
grantor: the grantor
grantee: the grantee

Throws:

: FrameworkException - if the operation fails

Since:: AEF 9.5.0.0

setAttributeValue

    public void setAttributeValue(Context context, String name, String value)

Set an attribute value for this object. Set the attribute with the given name to the passed value.

Parameters:

context: the eMatrix Context object
name: the attribute name to be modified.
value: the attribute value to set.

Throws:

: FrameworkException - if the operation fails

See Also:

: #getAttributeValue

Since:: AEF 9.1.0.0

setAttributeValues

    public void setAttributeValues(Context context, Map map)

Set the business object attributes for this object.

Parameters:

context: the eMatrix Context object
map: identifies a pair of attribute keys and values to be saved on the object.

Throws:

: FrameworkException - if the operation fails

Since:: AEF 9.1.0.0

setCachedData

    protected void setCachedData(Object key, Object value)

Set the selected cached data.

Deprecated. AEF 9.5.1.0, caching is being removed.

Parameters:

key: the key to the cached data
value: the value of the cached data

Since:: AEF 9.1.0.0

setDebug

    public static void setDebug(boolean mode)

Sets the debug mode for this bean.

Deprecated. use DebugUtil.setDebug

Parameters:

mode: the mode to override the debug preference (true/false). This can be set globally for all bean through the following setting in the framework.properties file: ematrix.debug = true/false

Since:: AEF 9.1.0.0

setDescription

    public void setDescription(Context context, String description)

Modifies the business object description for this object.

Parameters:

context: the eMatrix Context object
description: the new description for this object

Throws:

: FrameworkException - if the operation fails

Since:: AEF 9.1.0.0

setId

    public void setId(String id)

Sets the id for this object.

Parameters:

id: The business object id

Throws:

: FrameworkException - if the operation fails

See Also:

: #getId

Since:: AEF 9.1.0.0

setLicenseReservedAPPS

    public void setLicenseReservedAPPS(String[] lICENSE_RESERVED_APPS)

setName

    public void setName(Context context, String name)

Set the business object name for this object.

Parameters:

context: the eMatrix Context object
name: the new name for this object

Throws:

: FrameworkException - if the operation fails

See Also:

: #getName

Since:: AEF 9.1.0.0

setOwner

    public void setOwner(Context context, String owner)

Set the business object owner for this object. This must be a valid Matrix User.

Parameters:

context: the eMatrix Context object
owner: the new owner - Matrix User.

Throws:

: FrameworkException - if the operation fails

Since:: AEF 9.1.0.0

setPolicy

    public void setPolicy(Context context, String policy)

Change the business object policy for this object. This must be a valid policy in Matrix, that can govern the type of this object.

Parameters:

context: the eMatrix Context object
policy: the new policy

Throws:

: FrameworkException - if the operation fails

Since:: AEF 9.5.1.0

setRelatedObject

    public DomainRelationship setRelatedObject(Context context, String relationshipType, boolean isFrom, String newTargetId)

Connects the current object to/from the id specified using the relationship type provided. If a relationship does not exist yet between the two objects, one is created if newId is not null. If one is already there, then the current target object is comapred to the newId and upated as needed. Use this function only if relationship can constantly change to another object.

Parameters:

context: the eMatrix Context object
relationshipType: The relationship type for connection
isFrom: true, if this is a connection "from" the object defined by the class. false, if this is a connection "to" the object defined by the class.
newTargetId: The object id for the given object. The given object should support only one instance of type id (cardinality one). Null will disconnect the relationship.

Return:: the current connection or null if removed.

Throws:

: FrameworkException - if operation fails

Since:: AEF 9.5.1.0

setRelationship

    protected DomainRelationship setRelationship(Context context, String relationship, boolean from, String newId)

Connects the current object to/from the id specified using the relationship type provided. If a relationship does not exist yet between the two objects, one is created. If one is already there, then the other end is comapred to the new id and upated as needed. If multiple connections exist, an exception is returned as this function assumes only one end of type id.

Deprecated. AEF 9.5.1.0, use setRelatedObject

Parameters:

context: the eMatrix Context object
relationship: The relationship type for connection
from: true, if this is a "from" connection of the given object or false, if this is a "to" connection of the given object.
newId: The object id for the given object. The given object should support only one instance of type id (cardinality one).

Return:: the current connection or null

Throws:

: FrameworkException - if operation fails

Since:: AEF 9.1.0.0

setSavePoint

    public static void setSavePoint(Context context, String savePoint)

Updates an existing database transaction with a database save point.

Deprecated. AEF 9.5.1.0, use ContextUtil.setSavePoint

Parameters:

context: the eMatrix Context object
savePoint: the name of the save point to add to the transaction. Note: save point is limited to 30 characters of letters, numbers, and underscores. Spaces and punctuation characters are not allowed.

Throws:

: FrameworkException - if the operation fails

Since:: AEF 9.1.0.0

setState

    public int setState(Context context, String stateName)

Set the state of the object to the given state. Promote or demote the object until the request state is obtained.

Parameters:

context: the eMatrix Context object
stateName: the state to achieve

Return:: An integer representing the number of states promoted or demoted. A zero indicates the object is already at that state, a positive number indicates the number of states promoted, a negative number indicates the number of states demoted.

Throws:

: FrameworkException - if the operation fails

Since:: AEF 9.5.0.0

setVault

    public void setVault(Context context, String vault)

Change the business object vault for this object. This must be a valid vault in Matrix.

Parameters:

context: the eMatrix Context object
vault: the new vault

Throws:

: FrameworkException - if the operation fails

Since:: AEF 9.5.1.0

startTransaction

    public boolean startTransaction(Context context, boolean update)

Starts a database transaction.

Deprecated. AEF 9.5.1.0, use ContextUtil.startTransaction

Parameters:

context: the eMatrix Context object
update: determines whether the transaction is opened as write (true) or read (false).

Return:: true if the transaction started; false if started already.

Throws:

: FrameworkException - if the operation fails

Since:: AEF 9.1.0.0

validateSelectedAttributes

    public List validateSelectedAttributes(Context context, List currentAttributeList, String attributeToSaveName, String typeName)

Returns a StringList of valid attributes. An object can have an attribute that is a list of attributes. This function takes the Stringlist of attributes for the object, the name of the attribute and what Type it is. We then get the list of attributes that are now valid for the given Type passed in. We then check the Types list against the list passed in, creating a new list of attributes. If we find the list passed in differs from the new list we created, then we need to save the attribute using the new list we created. The list being returned will now be a list of attributes that are valid for the given Type.

Parameters:

context: the eMatrix Context object
currentAttributeList: a list of attributes for a given attribute
attributeToSaveName: the attribute name that we are trying to validate
typeName: the name of the Type that we want to get the attributes for

Return:: a list of valid attributes based on the Type passed in

Throws:

: FrameworkException - if the operation fails

Since:: AEF 9.2.0.0

validateSelectedAttributes

    public StringList validateSelectedAttributes(Context context, StringList currentAttributeList, String attributeToSaveName, String typeName)

Parameters:

context: the eMatrix Context object
currentAttributeList: the eMatrix StringList object that holds the list of attributes for a given attribute
attributeToSaveName: the attribute name that we are trying to validate
typeName: the name of the Type that we want to get the attributes for

Return:: a list of valid attributes based on the Type passed in

Throws:

: FrameworkException - if the operation fails

Since:: AEF 9.2.0.0