|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object
Thor.API.Base.tcBaseUtility
public abstract class tcBaseUtility
Base utility server-side class. All server-side Utility/API classes must extend from this class. It provides all the base functionality necessary for a server-side object.
Nested Class Summary | |
---|---|
static class |
tcBaseUtility.Entities The following enum serves two purposes: 1. |
Field Summary | |
---|---|
static java.lang.String |
ALL_ATTR_OB |
static java.lang.String |
DATE_FORMAT_SYS_PROP |
static java.lang.String |
DEFAULT_DATE_PATTERN |
static java.lang.String |
DEFAULT_LOCALE |
static java.lang.String |
DISPLAYNAME |
static java.lang.String |
FIRSTNAME |
static java.lang.String |
LASTNAME |
static java.lang.String |
LKU_GROUP |
static java.lang.String |
MANAGERKEY |
static java.lang.String |
OBJECTCLASS_COL_CODE |
static java.lang.String |
ORG_NAME |
static java.lang.String |
ORGANIZATION_KEY_COL_CODE |
static java.lang.String |
ORGANIZATION_NAME_COL_CODE |
static java.lang.String |
ORGANIZATION_PARENT_KEY_COL_CODE |
static java.lang.String |
ORGANIZATION_PARENT_NAME_COL_CODE |
static java.lang.String |
ORGKEY |
static java.lang.String |
ORGNAME |
static java.lang.String |
PARENTORGNAME |
static java.lang.String |
ROLE_KEY_COL_CODE |
static java.lang.String |
ROLE_NAME_COL_CODE |
static java.lang.String |
STATUS |
static java.lang.String |
USER_ENTITY |
static java.lang.String |
USER_MANAGEMENT |
static java.lang.String |
USERID |
static java.lang.String |
USERKEY |
static java.lang.String |
USR_DEFINED_COLUMN_CONSTANT Added constants for the backward compatibility |
static java.lang.String |
USR_KEY_COL_CODE |
static java.lang.String |
USR_MANAGER_DISPLAY_NAME_COL_CODE |
static java.lang.String |
USR_MANAGER_DISPLAY_NAME_LABEL |
static java.lang.String |
USR_MANAGER_FIRST_NAME_COL_CODE |
static java.lang.String |
USR_MANAGER_FIRST_NAME_COLUMN |
static java.lang.String |
USR_MANAGER_FIRST_NAME_LABEL |
static java.lang.String |
USR_MANAGER_KEY_COL_CODE |
static java.lang.String |
USR_MANAGER_LAST_NAME_COL_CODE |
static java.lang.String |
USR_MANAGER_LAST_NAME_COLUMN |
static java.lang.String |
USR_MANAGER_LAST_NAME_LABEL |
static java.lang.String |
USR_MANAGER_LOGIN_COL_CODE |
static java.lang.String |
USR_MANAGER_LOGIN_COLUMN |
static java.lang.String |
USR_MANAGER_LOGIN_LABEL |
Constructor Summary | |
---|---|
tcBaseUtility() Constructor. |
|
tcBaseUtility(java.lang.String psName) Base Utility class. |
Method Summary | |
---|---|
void |
addError(com.thortech.xl.orb.dataaccess.tcError poError) Adds the error to this object's error list, and sets the state to ERROR. |
void |
addErrorReceiver(com.thortech.xl.dataobj.tcErrorReceiver poErrorReceiver) Adds another error receiver to the object's error list. |
void |
addReject(com.thortech.xl.orb.dataaccess.tcError poReject) Adds the rejection to this object's rejection list. |
void |
checkStatusAndCallbackProvisioningHandler(long orcKey) This method checks for the Object Status corresponding to a Process Instance and calls back the Orchestation Engine in case the Object Status is Provisioned/Enabled/Disabled/Revoked based on the Request Model |
void |
clearErrors() Clears all errors and exceptions that are stored in the utility class. |
void |
close() This method will clean up all resources associated with this object. |
void |
ejbActivate() The ejbActivate() method as required by the EJB specification.The activate method is called when the instance is activated from its passive" state. |
void |
ejbPassivate() The ejbPassivate() method as required by the EJB specification.The activate method is called when the instance is activated from its "passive" state. |
void |
ejbRemove() The ejbRemove() method as required by the EJB specification.A container invokes this method before it ends the life of the session object. |
com.thortech.xl.dataaccess.tcDataProvider |
getDataBase() Returns the database. |
static java.lang.String |
getDefaultLocaleCode() This method will return default locale stored in DB as <user.language>_<user.region> |
EJBContext |
getEJBContext() |
com.thortech.xl.orb.dataaccess.tcError[] |
getErrors() Returns errors that occurred over the course of usage of the class. |
static java.util.Map |
getMap(com.thortech.xl.orb.api.tcMapping[] paoMapping) Creates a Map object from the provided array of tcMapping objects. |
static com.thortech.xl.orb.api.tcMapping[] |
getMapping(java.util.Map poMap) Creates a tcMapping array from the provided Map . |
java.lang.String |
getName() Returns the name of the client. |
java.lang.String |
getQueryFilter(java.util.Map moAttributeMap, java.util.Vector prepStmtParams) |
com.thortech.xl.orb.dataaccess.tcError[] |
getRejections() Returns rejections that occurred over the course of usage of the class. |
SessionContext |
getSessionContext() Get the associated session context |
java.util.Set |
getUnAuthorizedTargetFieldSet(java.util.Map attributeMap, java.util.Set retColumnSet) |
void |
removeErrorReceiver(com.thortech.xl.dataobj.tcErrorReceiver poErrorReceiver) Removes the error receiver from the object's error list. |
void |
removeInstance() Releases the object resources. |
void |
setCountry(java.lang.String psCountry) Sets the country. |
void |
setLanguage(java.lang.String psLanguage) Sets the language. |
void |
setSessionContext(SessionContext newContext) Set the associated session context. |
void |
setVariant(java.lang.String psVariant) Sets the variant. |
Methods inherited from class java.lang.Object |
---|
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
public static final java.lang.String USR_DEFINED_COLUMN_CONSTANT
public static final java.lang.String USR_KEY_COL_CODE
public static final java.lang.String USR_MANAGER_KEY_COL_CODE
public static final java.lang.String USR_MANAGER_LOGIN_COL_CODE
public static final java.lang.String USR_MANAGER_LOGIN_LABEL
public static final java.lang.String USR_MANAGER_FIRST_NAME_COL_CODE
public static final java.lang.String USR_MANAGER_LAST_NAME_COL_CODE
public static final java.lang.String USR_MANAGER_DISPLAY_NAME_COL_CODE
public static final java.lang.String USR_MANAGER_DISPLAY_NAME_LABEL
public static final java.lang.String USR_MANAGER_FIRST_NAME_LABEL
public static final java.lang.String USR_MANAGER_LAST_NAME_LABEL
public static final java.lang.String OBJECTCLASS_COL_CODE
public static final java.lang.String ORGANIZATION_KEY_COL_CODE
public static final java.lang.String ORGANIZATION_PARENT_KEY_COL_CODE
public static final java.lang.String ORGANIZATION_NAME_COL_CODE
public static final java.lang.String ORGANIZATION_PARENT_NAME_COL_CODE
public static final java.lang.String PARENTORGNAME
public static final java.lang.String ROLE_KEY_COL_CODE
public static final java.lang.String ROLE_NAME_COL_CODE
public static final java.lang.String USR_MANAGER_FIRST_NAME_COLUMN
public static final java.lang.String USR_MANAGER_LAST_NAME_COLUMN
public static final java.lang.String USR_MANAGER_LOGIN_COLUMN
public static final java.lang.String USERID
public static final java.lang.String ORGKEY
public static final java.lang.String MANAGERKEY
public static final java.lang.String STATUS
public static final java.lang.String LKU_GROUP
public static final java.lang.String USERKEY
public static final java.lang.String ORGNAME
public static final java.lang.String ORG_NAME
public static final java.lang.String FIRSTNAME
public static final java.lang.String LASTNAME
public static final java.lang.String DISPLAYNAME
public static final java.lang.String USER_ENTITY
public static final java.lang.String ALL_ATTR_OB
public static final java.lang.String USER_MANAGEMENT
public static final java.lang.String DATE_FORMAT_SYS_PROP
public static final java.lang.String DEFAULT_DATE_PATTERN
public static final java.lang.String DEFAULT_LOCALE
Constructor Detail |
---|
public tcBaseUtility()
public tcBaseUtility(java.lang.String psName)
psName
- A descriptive name.Method Detail |
---|
public void ejbActivate() throws EJBException, java.rmi.RemoteException
ejbActivate()
method as required by the EJB specification.ejbPassivate()
method.EJBException
- Thrown if the instance could not perform the function requested by the container because of an system-level error.java.rmi.RemoteException
public void ejbPassivate() throws EJBException, java.rmi.RemoteException
ejbPassivate()
method as required by the EJB specification.ejbActivate()
method.EJBException
- Thrown if the instance could not perform the function requested by the container because of an system-level error.java.rmi.RemoteException
public void ejbRemove() throws EJBException, java.rmi.RemoteException
ejbRemove()
method as required by the EJB specification.EJBException
- Thrown if the instance could not perform the function requested by the container because of an system-level error.java.rmi.RemoteException
public void setSessionContext(SessionContext newContext) throws EJBException
newContext
-EJBException
- Thrown if the instance could not perform the function requested by the container because of an system-level error.public SessionContext getSessionContext()
public EJBContext getEJBContext()
public com.thortech.xl.dataaccess.tcDataProvider getDataBase()
getDataBase
in interface com.thortech.xl.server.tcOrbServerObject
public void close()
close
in interface tcUtilityOperationsIntf
public void removeInstance()
removeInstance
in interface com.thortech.xl.orb.api.operations._tcUtilityIntfOperations
removeInstance
in interface com.thortech.xl.server.tcOrbServerObject
public java.lang.String getName()
getName
in interface com.thortech.xl.orb.api.operations._tcUtilityIntfOperations
getName
in interface tcUtilityOperationsIntf
public void setLanguage(java.lang.String psLanguage)
tcUtilityIntf
.setLanguage
in interface com.thortech.xl.orb.api.operations._tcUtilityIntfOperations
setLanguage
in interface tcUtilityOperationsIntf
psLanguage
- The language.public void setCountry(java.lang.String psCountry)
tcUtilityIntf
.setCountry
in interface com.thortech.xl.orb.api.operations._tcUtilityIntfOperations
setCountry
in interface tcUtilityOperationsIntf
psCountry
- The country.public void setVariant(java.lang.String psVariant)
tcUtilityIntf
.setVariant
in interface com.thortech.xl.orb.api.operations._tcUtilityIntfOperations
setVariant
in interface tcUtilityOperationsIntf
psVariant
- The locality variant.public void addError(com.thortech.xl.orb.dataaccess.tcError poError)
addError
in interface com.thortech.xl.dataobj.tcErrorReceiver
poError
- The error to add.public void addReject(com.thortech.xl.orb.dataaccess.tcError poReject)
addReject
in interface com.thortech.xl.dataobj.tcErrorReceiver
poReject
- The rejection to add.public void addErrorReceiver(com.thortech.xl.dataobj.tcErrorReceiver poErrorReceiver)
addErrorReceiver
in interface com.thortech.xl.dataobj.tcErrorReceiver
poErrorReceiver
- The error receiver to add.public void removeErrorReceiver(com.thortech.xl.dataobj.tcErrorReceiver poErrorReceiver)
removeErrorReceiver
in interface com.thortech.xl.dataobj.tcErrorReceiver
poErrorReceiver
- The error receiver to remove.public com.thortech.xl.orb.dataaccess.tcError[] getErrors()
getErrors
in interface com.thortech.xl.orb.api.operations._tcUtilityIntfOperations
public com.thortech.xl.orb.dataaccess.tcError[] getRejections()
getRejections
in interface com.thortech.xl.orb.api.operations._tcUtilityIntfOperations
public void clearErrors()
clearErrors
in interface com.thortech.xl.orb.api.operations._tcUtilityIntfOperations
public static java.util.Map getMap(com.thortech.xl.orb.api.tcMapping[] paoMapping)
Map
object from the provided array of tcMapping
objects. Useful for the utility classes in executing queries where they need to provide qualifiers.paoMapping
- An array of tcMapping objects, each of which represents a name-value pair.public static com.thortech.xl.orb.api.tcMapping[] getMapping(java.util.Map poMap)
tcMapping
array from the provided Map
. Useful for the utility classes in executing queries where they need to provide qualifiers.poMap
- An array of tcMapping objects, each of which represents a name-value pair.public java.lang.String getQueryFilter(java.util.Map moAttributeMap, java.util.Vector prepStmtParams) throws tcAPIException
tcAPIException
public static java.lang.String getDefaultLocaleCode() throws java.lang.Exception
java.lang.Exception
public void checkStatusAndCallbackProvisioningHandler(long orcKey) throws tcAPIException
orcKey
- Process Instance KeytcAPIException
public java.util.Set getUnAuthorizedTargetFieldSet(java.util.Map attributeMap, java.util.Set retColumnSet) throws tcAPIException
attributeMap
- identifies A map containing a search criteria pertianing to UserretColumnSet
- identifies a set of db columns that are required in select clause of API and need to check if they are authorizedtcAPIException
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |