public class Profile extends java.lang.Object implements ProfileRemote, MaxRemoteProxy
The profile can be obtained via methods in AppService
,
Mbo
, MboSet
,
RMISession
, and MXSession
.
ALL
Constructor and Description |
---|
Profile(MXServer mxServer,
MboSetRemote maxRoleSet)
The constructor to be used when testing profiles via the Sig app.
|
Profile(MXServerRemote mxServer,
UserInfo systemUserInfo,
MboRemote maxUserMbo)
Invoked from MaxUser to evaluate passwordduration and passwordwarning.
|
Profile(MXServerRemote mxServer,
UserInfo systemUserInfo,
java.lang.String userID,
MboSetRemote groupUserSet,
boolean loadAll)
Invoked from UserProfileHierarchySet.
|
Profile(MXServerRemote mxServer,
UserInfo systemUserInfo,
UserInfo loginuserInfo,
boolean loadAll)
The usual constructor to be used when a user logs in.
|
Modifier and Type | Method and Description |
---|---|
void |
addApp(java.lang.String app,
UserInfo userInfo)
This method supports Application Designer.
|
boolean |
allCollectionsAllowed()
Identifies whether the user has access to all collections.
|
java.util.ArrayList<java.lang.String> |
dumpAppAuth()
Dump the application auth fields to an array list (for testing only!!!).
|
java.util.ArrayList<java.lang.String> |
dumpGLAuth()
Dump the GL fields to an array list (for testing only!!!).
|
java.util.ArrayList<java.lang.String> |
dumpLaborAuth(java.lang.String tempUserid)
Dump the labor authorities to an array list (for testing only!!!).
|
java.util.ArrayList<java.lang.String> |
dumpLocAuth()
Dump the location authorities to an array list (for testing only!!!).
|
java.util.ArrayList<java.lang.String> |
dumpNonStandardApps()
Dump the nonStandardApps we have in memory to an array list (for testing only!!!).
|
java.util.ArrayList<java.lang.String> |
dumpPwDays()
Dump the password duration and warning to an array list (for testing only!!!).
|
java.util.ArrayList |
dumpRoleRestrictions()
Deprecated.
|
java.util.ArrayList<java.lang.String> |
dumpSites()
Dump the sites we have in memory to an array list (for testing only!!!).
|
java.util.ArrayList<java.lang.String> |
dumpTolerances()
Dump the tolerances to an array list (for testing only!!!).
|
boolean |
getAppAuth(java.lang.String app)
Identify whether there is any authority whatsoever for the specified app.
|
java.util.Hashtable<java.lang.String,java.lang.String> |
getAppInfo(java.lang.String app,
UserInfo userInfo)
Return hashtable of attributes and values that describe the application.
|
int |
getAppLevel(java.lang.String app)
Get the level of an app (system, org, site...)
|
java.util.TreeMap |
getAppMenu(java.lang.String app,
UserInfo userInfo)
Return TreeMap of menu options for which this user has privilege.
|
boolean |
getAppOptionAuth(java.lang.String app,
java.lang.String optionname,
java.lang.String siteorg)
Identify whether there is authority for this app, optionname, and siteid.
|
java.util.HashSet<java.lang.String> |
getAppOptions(java.lang.String app)
Get all the options for which this user has some kind of privilege.
|
java.util.HashSet<java.lang.String> |
getApps()
Get the app names which exist in
apps HashMap for this user. |
java.util.HashSet<java.lang.String> |
getApps(int sysFlag)
Called by UserProfileHierarchySet to build the profile tree in the Users app.
|
java.util.TreeMap |
getAppSearch(java.lang.String app,
UserInfo userInfo)
Return TreeMap of search options for which this user has privilege.
|
java.util.HashSet<java.lang.String> |
getAppSiteOrgs(java.lang.String app)
Get all the sites/orgs for which this user has READ privilege for this app.
|
java.util.HashSet<java.lang.String> |
getAppSiteOrgs(java.lang.String app,
int forceLevel)
Get all the sites/orgs for which this user has READ privilege for this app.
|
java.util.HashMap<java.lang.String,java.util.HashMap<java.lang.String,java.util.HashMap<java.lang.String,java.util.HashSet<java.lang.String>>>> |
getAppsStructure()
Get the app structure for which this user has any form of privilege
|
java.util.TreeMap |
getAppTools(java.lang.String app,
UserInfo userInfo)
Return TreeMap of toolbar options for which this user has privilege.
|
java.util.HashSet<java.lang.String> |
getCollections()
Return the collections to which the user has access.
|
java.util.HashSet<java.lang.String> |
getCombinableSites() |
java.util.HashSet<java.lang.String> |
getConditions(java.lang.String app,
java.lang.String optionname,
java.lang.String siteorg)
Identifies any data-related conditions for the specified privilege.
|
java.lang.String |
getDefaultOrg()
Returns the organization of the default site of the user.
|
java.lang.String |
getDefaultRepairFacility()
Returns the default repair location of the user.
|
java.lang.String |
getDefaultRepairFacilitySite()
Returns the default repair site of the user.
|
java.lang.String |
getDefaultSite()
Returns the default site of the user.
|
java.lang.String |
getDefaultStoreroom()
Gets the default storeroom for the user.
|
java.lang.String |
getDefaultStoreroomSite()
Gets the default storeroom's site for the user.
|
java.util.HashMap<java.lang.String,java.lang.Boolean[]> |
getDiscreteRepFacAuthSites() |
java.lang.String |
getEveryoneCondition(java.lang.String app,
java.lang.String optionName)
Assuming Profile has been built for the specified app, get the Everyone condition (if any)
for the specified app and optionname.
|
boolean |
getGLAuth(int glFieldPos,
java.lang.String siteorg)
Identifies whether there is authority for the specified GL field at the specified site or orgid,
using
glSegs . |
boolean |
getGLAuth(java.lang.String glField,
java.lang.String siteorg)
Identifies whether there is authority for the specified GL field at the specified site or orgid,
using
glSegs . |
boolean |
getGLAuthForUserApp(int glFieldPos)
Similar to
getGLAuth , except this bypasses the orgid/siteid check. |
java.util.HashSet |
getGroupNames()
Return a HashSet containing the names of the user's security groups (groupname).
|
java.lang.String |
getGroupsString()
Return a string suitable for use in a Where clause that specifies all the security groups for
this user..
|
java.util.HashSet |
getGroupStartApps()
Return a HashSet containing the names of the user's start apps from groups.
|
java.lang.String |
getInsertCompanySet()
Returns the insert Companyset.
|
java.lang.String |
getInsertItemSet()
Returns the insert itemset.
|
java.lang.String |
getInsertOrg()
Get the insert organization.
|
java.lang.String |
getInsertSite()
Returns the insert site of the user.
|
boolean |
getLaborAuth(java.lang.String orgid,
java.lang.String laborcode)
Get the labor authority for the specified orgid and laborcode.
|
java.util.HashMap<java.lang.String,java.lang.Boolean> |
getLaborAuthFlags(java.lang.String orgid)
Get the laborauth flags for the given orgid
|
java.util.HashMap<java.lang.String,java.util.HashSet<java.lang.String>> |
getLaborAuthorities()
Returns the labor authorities structure for the current profile
|
java.lang.String |
getLaborCodes(java.lang.String orgid)
Given an orgid, return all the laborcodes within that organization for which the user
has access.
|
static java.lang.String |
getLaborCodeSubWhere(java.lang.String laborcodes) |
boolean |
getLeftNav() |
boolean |
getLocAuth(java.lang.String siteid,
java.lang.String location)
Get the location authority for the specified siteid and location.
|
boolean |
getLogout()
Return true if user has been administratively logged out.
|
java.util.TreeMap |
getModules(UserInfo userInfo)
Return the module map for this user.
|
boolean |
getNonStandardAppOptionAuth(java.lang.String app,
java.lang.String optionname,
java.lang.String orgid,
java.lang.String siteid)
Similar to
getAppOptionAuth , but for a non-standard app and siteid or orgid. |
java.util.HashMap |
getNonStandardApps()
For use by UserProfileHierarchySet in the Users application.
|
java.util.HashSet<java.lang.String> |
getNonStandardSiteOrgs(java.lang.String app,
boolean getSites)
For apps whose siteorgtype is SYSTEMORGSITE, SYSTEMORG, SYSTEMSITE, or ORGSITE,
return the readonly sites or organizations.
|
boolean |
getOrg(java.lang.String orgid)
Identify whether the user has any form of authorization for this site (SiteAuth table).
|
java.util.TreeSet<java.lang.String> |
getOrgs()
Identify organizations for which the user has any form of authorization (SiteAuth table).
|
java.lang.String |
getOrgsString()
Return a string suitable for use in a Where clause that specifies all the organizations for
which the user has any form of authorization.
|
java.lang.String |
getPrerequisite(java.lang.String app,
java.lang.String optionname)
Returns the prerequisite for the option.
|
java.rmi.Remote |
getProxy() |
int |
getPwDuration()
Return the password duration (
pwDuration ). |
int |
getPwWarning()
Return the password warning (
pwWarning ). |
java.util.TreeMap |
getQueryMap(java.lang.String app,
UserInfo userInfo)
Return TreeMap of queries for which this user has execute privilege.
|
boolean |
getQueryWithSite()
Get the querywithsite flag from the maxuser object associated with the user.
|
java.util.TreeSet<java.lang.String> |
getReadableOrgs(java.lang.String app)
Identify organizations for which the user has READ authorization in this app.
|
java.lang.String |
getReadableOrgsString(java.lang.String app)
Identify organizations for which the user has NEXT authorization in this app;
return a string suitable for use in a Where clause.
|
java.util.TreeSet<java.lang.String> |
getReadableSites(java.lang.String app)
Identify sites for which the user has READ authorization in this app.
|
java.lang.String |
getReadableSitesString(java.lang.String app)
Identify sites for which the user has NEXT authorization in this app;
return a string suitable for use in a Where clause.
|
java.lang.Integer |
getReportLimit(java.lang.String attributeName)
Returns the specified report limit for the user.
|
java.util.HashMap |
getRoleRestrictions()
Deprecated.
|
java.lang.String |
getRoleRestrictions(java.lang.String entityname)
Deprecated.
|
boolean |
getSite(java.lang.String siteid)
Identify whether the user has any form of authorization for this site (SiteAuth table).
|
java.util.HashSet<java.lang.String> |
getSiteCache(UserInfo ui)
APAR IV51241 - New method to load the list of sites that a user has access to from a cache.
|
java.util.TreeSet<java.lang.String> |
getSites()
Identify sites for which the user has any form of authorization (SiteAuth table).
|
java.lang.String |
getSitesString()
Return a string suitable for use in a Where clause that specifies all the sites for
which the user has any form of authorization.
|
java.lang.String |
getStorerooms(java.lang.String siteid)
Given a siteid, return all the storerooms (location codes with type Storeroom)
within that site for which the user has access.
|
java.util.TreeMap |
getSystemOptionMap(UserInfo userInfo)
Call
getAppMenu for STARTCNTR. |
double |
getTolerance(java.lang.String attrName,
java.lang.String siteorg)
Get the tolerance for the specified attribute name and site or orgid.
|
java.lang.String |
getUserStatus()
Return the cached Maximo user status for this user.
|
boolean |
hasAllGLAuth(java.lang.String siteorg)
Identifies whether there is authority for the all GL fields at the specified site or orgid,
using
glSegs . |
boolean |
hasAnyGLAuth(java.lang.String siteorg)
Identifies whether there is authority for any of the GL fields at the specified site or orgid,
using
glSegs . |
boolean |
hasAppOption(java.lang.String app,
java.lang.String sigOption)
Returns wheather a given option to an app is granted for this user.
|
boolean |
hasCombinableAllRepairFacilities()
Identify whether the user can access all non-null repair facilities.
|
boolean |
hasCombinableNullRepairFacilities() |
boolean |
isAllCombineableGLSegments()
Returns True if authorized all GL segments for combineable groups.
|
boolean |
isAllIndependentGLSegments()
Returns True if authorized all GL segments for independent groups.
|
boolean |
isAuthLaborCrew(java.lang.String orgid,
java.lang.String laborcode)
Checks if the given laborcode is a crew member of this user
|
boolean |
isAuthLaborGroup(java.lang.String orgid,
java.lang.String laborcode)
Checks if the given laborcode belongs in the same persongroup as this user
|
boolean |
isAuthLaborSelf(java.lang.String orgid,
java.lang.String laborcode)
Checks if current user is represented by the given laborcode
|
boolean |
isAuthLaborSuper(java.lang.String orgid,
java.lang.String laborcode)
Checks if current user is a supervisor of the given laborcode
|
boolean |
isLaborAuthAll()
Checks if labor authority is &ALL& (ProfileRemote.ALL) across the board
|
boolean |
isLocAuthAll()
Returns True if storeroom privelage is "auth all sites" + "auth all storerooms"
|
boolean |
isLocAuthAll(java.lang.String siteid)
Returns True if storeroom privelage is "auth all sites" + "auth all storerooms"
OR if privelage is not "auth all sites" but "auth all storerooms" for the given site
|
boolean |
oneGroupHasAllSites()
Return True if one or more of this user's groups has authallsites = True.
|
boolean |
orgLevelApp(java.lang.String app)
Call
orgLevelApp with second parameter True (base level only). |
boolean |
orgLevelApp(java.lang.String app,
boolean baseLevelOnly)
Returns True if this is an org-level app.
|
void |
setDefaultOrg(java.lang.String org)
Set value for default organization.
|
void |
setDefaultSite(java.lang.String site)
Set value for default site.
|
void |
setInsertCompanySet(java.lang.String setid)
It sets the insert company set id.
|
void |
setInsertItemSet(java.lang.String setid)
It sets the insert item set id.
|
void |
setInsertOrg(java.lang.String org)
Set user's insert organization.
|
void |
setInsertSite(java.lang.String site)
Set the insert site.
|
void |
setProxy(java.rmi.Remote proxy) |
void |
setQueryMap(java.lang.String app,
java.util.TreeMap newQueryMap,
UserInfo userInfo)
Replace our queryMap with the new one provided.
|
void |
setUserStatus(java.lang.String newInternalStatus)
Update the cached Maximo user status for this user.
|
boolean |
siteLevelApp(java.lang.String app)
Call
siteLevelApp with second parameter True (base level only). |
boolean |
siteLevelApp(java.lang.String app,
boolean baseLevelOnly)
Returns True if this is a site-level app.
|
boolean |
sysLevelApp(java.lang.String app)
Returns True if this is a system-level app.
|
void |
updateAppMaps(java.lang.String app,
UserInfo userInfo)
This method supports Application Designer.
|
boolean |
useDataRestriction(java.lang.String groupname,
java.lang.String app,
java.lang.String siteorg)
This method is used when a data restriction exists for the specified security group
and app, but it is unknown whether to apply this restriction for this logged-on user.
|
public Profile(MXServerRemote mxServer, UserInfo systemUserInfo, MboRemote maxUserMbo) throws MXException, java.rmi.RemoteException
mxServer
- Reference to MXServer.systemUserInfo
- UserInfo for the system, for getting MboSets.maxUserMbo
- The MaxUser mbo for this user.MXException
java.rmi.RemoteException
readRoleUserSet(psdi.mbo.MboSetRemote)
,
readRoleSet(psdi.mbo.MboSetRemote)
public Profile(MXServerRemote mxServer, UserInfo systemUserInfo, java.lang.String userID, MboSetRemote groupUserSet, boolean loadAll) throws MXException, java.rmi.RemoteException
mxServer
- Reference to MXServer.systemUserInfo
- UserInfo for the system, for getting MboSets.userID
- User ID for this profile.groupUserSet
- Set of GroupUser for this userID.loadAll
- True to load all parts of the profile from the constructor.
False to load only what's essential, and to load the rest as needed,
when the relevant "get" method is called.MXException
java.rmi.RemoteException
readRoleUserSet(psdi.mbo.MboSetRemote)
,
readRoleSet(psdi.mbo.MboSetRemote)
,
constructProfile(boolean)
public Profile(MXServerRemote mxServer, UserInfo systemUserInfo, UserInfo loginuserInfo, boolean loadAll) throws MXException, java.rmi.RemoteException
mxServer
- Reference to MXServer.systemUserInfo
- UserInfo for the system, for getting MboSets.loginuserInfo
- userinfo for login user to get default site....userID
- User ID for this profile.loadAll
- True to load all parts of the profile from the constructor.
False to load only what's essential, and to load the rest as needed,
when the relevant "get" method is called.MXException
java.rmi.RemoteException
readRoleUserSet(psdi.mbo.MboSetRemote)
,
readRoleSet(psdi.mbo.MboSetRemote)
,
constructProfile(boolean)
public Profile(MXServer mxServer, MboSetRemote maxRoleSet) throws MXException, java.rmi.RemoteException
constructProfile
with loadAll = True.mxServer
- Reference to MXServermaxRoleSet
- MboSet of MaxGroup, with the roles to be included in the profile selected.MXException
java.rmi.RemoteException
addToRoles(psdi.mbo.MboRemote)
,
constructProfile(boolean)
public java.util.ArrayList<java.lang.String> dumpSites() throws MXException, java.rmi.RemoteException
dumpSites
in interface ProfileRemote
MXException
java.rmi.RemoteException
dumpSites()
public int getPwDuration() throws MXException, java.rmi.RemoteException
pwDuration
).getPwDuration
in interface ProfileRemote
MXException
java.rmi.RemoteException
getPwDuration()
public int getPwWarning() throws MXException, java.rmi.RemoteException
pwWarning
).getPwWarning
in interface ProfileRemote
MXException
java.rmi.RemoteException
getPwWarning()
public java.util.ArrayList<java.lang.String> dumpPwDays() throws MXException, java.rmi.RemoteException
dumpPwDays
in interface ProfileRemote
MXException
java.rmi.RemoteException
dumpPwDays()
public java.util.HashSet<java.lang.String> getApps() throws MXException, java.rmi.RemoteException
apps
HashMap for this user.
An app will exist in this HashMap only if the user has READ privilege
(see constructAppAuthOneApp
.getApps
in interface ProfileRemote
MXException
java.rmi.RemoteException
getApps()
public java.util.HashSet<java.lang.String> getApps(int sysFlag) throws MXException, java.rmi.RemoteException
getApps
in interface ProfileRemote
sysFlag
- 1=System-level apps only, 2=Non-System-level apps only, 3=All apps (any level)MXException
java.rmi.RemoteException
getApps(int)
public java.util.HashMap<java.lang.String,java.util.HashMap<java.lang.String,java.util.HashMap<java.lang.String,java.util.HashSet<java.lang.String>>>> getAppsStructure() throws MXException, java.rmi.RemoteException
getAppsStructure
in interface ProfileRemote
MXException
java.rmi.RemoteException
getAppsStructure()
public int getAppLevel(java.lang.String app) throws MXException, java.rmi.RemoteException
getAppLevel
in interface ProfileRemote
app
- Application nameMboSetInfo
MXException
java.rmi.RemoteException
getAppLevel(java.lang.String)
public boolean sysLevelApp(java.lang.String app) throws MXException, java.rmi.RemoteException
sysLevelApp
in interface ProfileRemote
app
- Application nameMXException
java.rmi.RemoteException
sysLevelApp(java.lang.String)
public boolean orgLevelApp(java.lang.String app) throws MXException, java.rmi.RemoteException
orgLevelApp
with second parameter True (base level only).orgLevelApp
in interface ProfileRemote
app
- Application nameorgLevelApp
MXException
java.rmi.RemoteException
orgLevelApp(java.lang.String)
public boolean orgLevelApp(java.lang.String app, boolean baseLevelOnly) throws MXException, java.rmi.RemoteException
app
- Application namebaseLevelOnly
- Some levels can be system-level but optionally can ask for a list of orgs.
If param is True then this method checks only the base level of the app.
If param is False then this method will also return true if base level is system but
org-level is optional for this app.MXException
java.rmi.RemoteException
siteLevelApp(java.lang.String)
public boolean siteLevelApp(java.lang.String app) throws MXException, java.rmi.RemoteException
siteLevelApp
with second parameter True (base level only).siteLevelApp
in interface ProfileRemote
app
- Application namesiteLevelApp
MXException
java.rmi.RemoteException
siteLevelApp(String, boolean)
public boolean siteLevelApp(java.lang.String app, boolean baseLevelOnly) throws MXException, java.rmi.RemoteException
app
- Application namebaseLevelOnly
- Some levels can be system-level but optionally can ask for a list of orgs or sites,
or can be primarily org level but can ask for sites.
If param is True then this method checks only the base level of the app.
If param is False then this method will also return true if base level is system or org, but
site-level is optional for this app.MXException
java.rmi.RemoteException
orgLevelApp(java.lang.String)
public boolean getAppAuth(java.lang.String app) throws MXException, java.rmi.RemoteException
getAppAuth
in interface ProfileRemote
Application
- nameMXException
java.rmi.RemoteException
constructAppAuthOneApp(java.lang.String, psdi.mbo.MboRemote, psdi.mbo.MboSetRemote, psdi.mbo.MboSetRemote)
public boolean getAppOptionAuth(java.lang.String app, java.lang.String optionname, java.lang.String siteorg) throws MXException, java.rmi.RemoteException
getAppOptionAuth
in interface ProfileRemote
app
- Application nameoptionname
- The option name (see SigOption
siteorg
- The siteid or orgid.
For a site-level app, this should equal siteid; for an org-level app, this should equal orgid.
If this is a system-level app, this parameter is ignored.MXException
java.rmi.RemoteException
getAppOptionAuth(java.lang.String, java.lang.String, java.lang.String)
public java.lang.String getPrerequisite(java.lang.String app, java.lang.String optionname) throws java.rmi.RemoteException, MXException
getPrerequisite
in interface ProfileRemote
java.rmi.RemoteException
MXException
getGroupStartApps()
public java.util.HashSet<java.lang.String> getConditions(java.lang.String app, java.lang.String optionname, java.lang.String siteorg) throws MXException, java.rmi.RemoteException
getConditions
in interface ProfileRemote
app
- Application nameoptionname
- The option name (see SigOption
siteorg
- The siteid or orgid of the data to be checked.
For a site-level app, this should equal siteid; for an org-level app, this should equal orgid.
If this is a system-level app, this parameter is ignored.MXException
java.rmi.RemoteException
getConditions(java.lang.String, java.lang.String, java.lang.String)
public java.lang.String getEveryoneCondition(java.lang.String app, java.lang.String optionName) throws MXException, java.rmi.RemoteException
getEveryoneCondition
in interface ProfileRemote
app
- optionName
- MXException
java.rmi.RemoteException
getEveryoneCondition(java.lang.String, java.lang.String)
public java.util.HashSet<java.lang.String> getAppOptions(java.lang.String app) throws MXException, java.rmi.RemoteException
getAppOptions
in interface ProfileRemote
app
- Application nameMXException
java.rmi.RemoteException
hasAppOption(String, String)
public boolean hasAppOption(java.lang.String app, java.lang.String sigOption) throws MXException, java.rmi.RemoteException
hasAppOption
in interface ProfileRemote
app
- sigOption
- MXException
java.rmi.RemoteException
hasAppOption(java.lang.String, java.lang.String)
public java.util.HashSet<java.lang.String> getAppSiteOrgs(java.lang.String app) throws MXException, java.rmi.RemoteException
getAppSiteOrgs
in interface ProfileRemote
app
- Application nameMXException
java.rmi.RemoteException
getAppSiteOrgs(String, int)
public java.util.HashSet<java.lang.String> getAppSiteOrgs(java.lang.String app, int forceLevel) throws MXException, java.rmi.RemoteException
getAppSiteOrgs
in interface ProfileRemote
app
- Application nameforceLevel
- Normally this will be zero.
However, this can equal 1 = org, 2 = site.MXException
java.rmi.RemoteException
getAppSiteOrgs(String, int)
public java.util.HashSet<java.lang.String> getSiteCache(UserInfo ui) throws MXException, java.rmi.RemoteException
getSiteCache
in interface ProfileRemote
MXException
java.rmi.RemoteException
public java.util.TreeMap getAppMenu(java.lang.String app, UserInfo userInfo) throws MXException, java.rmi.RemoteException
getAppMenu
in interface ProfileRemote
app
- Application nameuserInfo
- UserInfo for the application user.
- TreeMap menuMap = session.getProfile().getAppMenu(app, userInfo);
- Iterator it = menuMap.values().iterator();
- while (it.hasNext())
- {
- Hashtable menuOption = (Hashtable) it.next();
- String imagename = (String) menuOption.get("IMAGE");
- }
Each element in the map is a Hashtable, whose key is an attribute name from the MaxMenu and relevant description table and whose value is that attribute value as String.
MXException
java.rmi.RemoteException
loadAppMaps(java.lang.String, psdi.security.UserInfo)
public java.util.TreeMap getAppTools(java.lang.String app, UserInfo userInfo) throws MXException, java.rmi.RemoteException
getAppTools
in interface ProfileRemote
app
- Application nameuserInfo
- UserInfo for the application user.
- TreeMap toolMap = session.getProfile().getAppTools(app, userInfo);
- Iterator it = toolMap.values().iterator();
- while (it.hasNext())
- {
- Hashtable toolOption = (Hashtable) it.next();
- String imageName = (String) toolOption.get("IMAGE");
- }
Each element in the map is a Hashtable, whose key is an attribute name from the MaxMenu and relevant description table and whose value is that attribute value as String.
MXException
java.rmi.RemoteException
loadAppMaps(java.lang.String, psdi.security.UserInfo)
public java.util.TreeMap getAppSearch(java.lang.String app, UserInfo userInfo) throws MXException, java.rmi.RemoteException
getAppSearch
in interface ProfileRemote
app
- Application nameuserInfo
- UserInfo for the application user.
- TreeMap searchMap = session.getProfile().getAppSearch(app, userInfo);
- Iterator it = searchMap.values().iterator();
- while (it.hasNext())
- {
- Hashtable searchOption = (Hashtable) it.next();
- String imageName = (String) searchOption.get("IMAGE");
- }
Each element in the map is a Hashtable, whose key is an attribute name from the MaxMenu and relevant description table and whose value is that attribute value as String.
MXException
java.rmi.RemoteException
loadAppMaps(java.lang.String, psdi.security.UserInfo)
public java.util.TreeMap getSystemOptionMap(UserInfo userInfo) throws MXException, java.rmi.RemoteException
getAppMenu
for STARTCNTR.getSystemOptionMap
in interface ProfileRemote
userInfo
- UserInfo for the application user.MXException
java.rmi.RemoteException
getSystemOptionMap(psdi.security.UserInfo)
public java.util.TreeMap getModules(UserInfo userInfo) throws MXException, java.rmi.RemoteException
getModules
in interface ProfileRemote
userInfo
- UserInfo for the application user.MXException
java.rmi.RemoteException
SignatureService.getModuleMap(psdi.security.UserInfo)
public java.util.TreeMap getQueryMap(java.lang.String app, UserInfo userInfo) throws MXException, java.rmi.RemoteException
getQueryMap
in interface ProfileRemote
app
- Application nameuserInfo
- UserInfo for the application user.
- TreeMap queryMap = session.getProfile().getQueryMap(app, userInfo);
- Iterator it = queryMap.values().iterator();
- while (it.hasNext())
- {
- Hashtable query = (Hashtable) it.next();
- String clause = (String) query.get("CLAUSE");
- }
Each element in the map is a Hashtable, whose key is an attribute name from
the Query table and whose value is that attribute value as String.
This key is case sensitive (the attribute name is in upper case).
This also includes the non-persistent attribute DEFAULT
,
which indicates which (if any) of these queries is the default query
for this app and user.
MXException
java.rmi.RemoteException
loadAppMaps(java.lang.String, psdi.security.UserInfo)
public java.util.Hashtable<java.lang.String,java.lang.String> getAppInfo(java.lang.String app, UserInfo userInfo) throws MXException, java.rmi.RemoteException
getAppInfo
in interface ProfileRemote
app
- Application name.userInfo
- UserInfo for this user.MXException
java.rmi.RemoteException
appInfo
public void setQueryMap(java.lang.String app, java.util.TreeMap newQueryMap, UserInfo userInfo) throws MXException, java.rmi.RemoteException
setQueryMap
in interface ProfileRemote
MXException
java.rmi.RemoteException
refreshSecurityCache(psdi.security.UserInfo)
,
queryMaps
,
QuerySet.addAndSaveQuery(java.lang.String, java.lang.String, java.lang.String, boolean, boolean, java.lang.String)
public void addApp(java.lang.String app, UserInfo userInfo) throws MXException, java.rmi.RemoteException
app
- Application name.MXException
java.rmi.RemoteException
public void updateAppMaps(java.lang.String app, UserInfo userInfo) throws MXException, java.rmi.RemoteException
app
- Application name.MXException
java.rmi.RemoteException
public java.util.ArrayList<java.lang.String> dumpAppAuth() throws MXException, java.rmi.RemoteException
dumpAppAuth
in interface ProfileRemote
MXException
java.rmi.RemoteException
dumpAppAuth()
public boolean getGLAuth(java.lang.String glField, java.lang.String siteorg) throws MXException, java.rmi.RemoteException
glSegs
.getGLAuth
in interface ProfileRemote
glField
- The name of the GL segment (from GLConfigure table).siteorg
- The siteid or orgid to be checked.MXException
java.rmi.RemoteException
getGLAuth(String, String)
public boolean getGLAuthForUserApp(int glFieldPos) throws MXException, java.rmi.RemoteException
getGLAuth
, except this bypasses the orgid/siteid check.
This method should be used ONLY for the User app.getGLAuthForUserApp
in interface ProfileRemote
glField
- MXException
java.rmi.RemoteException
getGLAuthForUserApp(int)
public boolean getGLAuth(int glFieldPos, java.lang.String siteorg) throws MXException, java.rmi.RemoteException
glSegs
.getGLAuth
in interface ProfileRemote
glFieldPos
- Position of GLConfigure component (from GLConfigure table).siteorg
- The siteid or orgid to be checked.MXException
java.rmi.RemoteException
getGLConfigure
,
getGLAuth(String, String)
public boolean hasAllGLAuth(java.lang.String siteorg) throws MXException, java.rmi.RemoteException
glSegs
.hasAllGLAuth
in interface ProfileRemote
siteorg
- The siteid or orgid to be checked.MXException
java.rmi.RemoteException
getGLConfigure
,
getGLAuth(String, String)
public boolean hasAnyGLAuth(java.lang.String siteorg) throws MXException, java.rmi.RemoteException
glSegs
.hasAnyGLAuth
in interface ProfileRemote
siteorg
- The siteid or orgid to be checked.MXException
java.rmi.RemoteException
getGLConfigure
,
getGLAuth(String, String)
public java.util.ArrayList<java.lang.String> dumpGLAuth() throws MXException, java.rmi.RemoteException
dumpGLAuth
in interface ProfileRemote
MXException
java.rmi.RemoteException
dumpGLAuth()
public double getTolerance(java.lang.String attrName, java.lang.String siteorg) throws MXException, java.rmi.RemoteException
getTolerance
in interface ProfileRemote
attrName
- Attribute name for the tolerance, amount, percent, limit, etc.
This will be an attributename from the MaxGroup table.siteorg
- The site or org to be checked.MXException
java.rmi.RemoteException
SiteService.getOrgForSite(java.lang.String, psdi.security.UserInfo)
,
throwNoToleranceDefined(java.lang.String)
public java.util.ArrayList<java.lang.String> dumpTolerances() throws MXException, java.rmi.RemoteException
dumpTolerances
in interface ProfileRemote
MXException
java.rmi.RemoteException
dumpTolerances()
public boolean isLocAuthAll() throws MXException, java.rmi.RemoteException
isLocAuthAll
in interface ProfileRemote
MXException,
- RemoteExceptionMXException
java.rmi.RemoteException
isLocAuthAll()
public boolean isLocAuthAll(java.lang.String siteid) throws MXException, java.rmi.RemoteException
isLocAuthAll
in interface ProfileRemote
MXException,
- RemoteExceptionMXException
java.rmi.RemoteException
isLocAuthAll(String siteid)
public java.lang.String getStorerooms(java.lang.String siteid) throws MXException, java.rmi.RemoteException
getStorerooms
in interface ProfileRemote
siteid
- Site identifierMXException
java.rmi.RemoteException
getStorerooms(java.lang.String)
public boolean getLocAuth(java.lang.String siteid, java.lang.String location) throws MXException, java.rmi.RemoteException
getLocAuth
in interface ProfileRemote
siteid
- The site IDlocation
- The location codeMXException
java.rmi.RemoteException
getLocAuth(java.lang.String, java.lang.String)
public java.util.ArrayList<java.lang.String> dumpLocAuth() throws MXException, java.rmi.RemoteException
dumpLocAuth
in interface ProfileRemote
MXException
java.rmi.RemoteException
constructLocAuth()
public boolean isAllCombineableGLSegments() throws MXException, java.rmi.RemoteException
isAllCombineableGLSegments
in interface ProfileRemote
MXException,
- RemoteExceptionMXException
java.rmi.RemoteException
isAllCombineableGLSegments()
public boolean isAllIndependentGLSegments() throws MXException, java.rmi.RemoteException
isAllIndependentGLSegments
in interface ProfileRemote
MXException,
- RemoteExceptionMXException
java.rmi.RemoteException
isAllIndependentGLSegments()
public java.util.HashSet getGroupNames() throws MXException, java.rmi.RemoteException
getGroupNames
in interface ProfileRemote
MXException
java.rmi.RemoteException
allRolesNames
,
getGroupsString()
public java.util.HashSet getGroupStartApps() throws MXException, java.rmi.RemoteException
getGroupStartApps
in interface ProfileRemote
MXException
java.rmi.RemoteException
getGroupStartApps()
public java.lang.String getGroupsString() throws MXException, java.rmi.RemoteException
('PLANNING', 'NESITES')
.
If the user has no security groups, the string will be null.getGroupsString
in interface ProfileRemote
MXException
java.rmi.RemoteException
allRolesString
,
getGroupNames()
public boolean getSite(java.lang.String siteid) throws MXException, java.rmi.RemoteException
getSite
in interface ProfileRemote
siteid
- The site IDMXException
java.rmi.RemoteException
getSite(java.lang.String)
public boolean getOrg(java.lang.String orgid) throws MXException, java.rmi.RemoteException
getOrg
in interface ProfileRemote
siteid
- The site IDMXException
java.rmi.RemoteException
getOrg(java.lang.String)
public boolean getLeftNav() throws MXException, java.rmi.RemoteException
getLeftNav
in interface ProfileRemote
MXException
java.rmi.RemoteException
public java.util.TreeSet<java.lang.String> getSites() throws MXException, java.rmi.RemoteException
This method should be called ONLY for lookups and drilldowns.
getSites
in interface ProfileRemote
MXException
java.rmi.RemoteException
getSites()
public java.lang.String getSitesString() throws MXException, java.rmi.RemoteException
('BEDFORD', 'NASHUA', 'TEXAS')
.
If the user has no authorized sites, the string will be null.
This method should be called ONLY for lookups and drilldowns.
getSitesString
in interface ProfileRemote
MXException
java.rmi.RemoteException
getSitesString()
public boolean oneGroupHasAllSites() throws MXException, java.rmi.RemoteException
oneGroupHasAllSites
in interface ProfileRemote
oneGroupHasAuthAllSites
MXException
java.rmi.RemoteException
oneGroupHasAllSites()
public boolean hasCombinableAllRepairFacilities() throws MXException, java.rmi.RemoteException
hasCombinableAllRepairFacilities
in interface ProfileRemote
MXException
java.rmi.RemoteException
psdi.security.Profile#hasAllRepairFacilities
public java.util.TreeSet<java.lang.String> getOrgs() throws MXException, java.rmi.RemoteException
This method should be called ONLY for lookups and drilldowns.
getOrgs
in interface ProfileRemote
MXException
java.rmi.RemoteException
getOrgs()
public java.lang.String getOrgsString() throws MXException, java.rmi.RemoteException
('EAGLENA', 'EAGLESA')
.
If the user has no authorized orgs, the string will be null.
This method should be called ONLY for lookups and drilldowns.
getOrgsString
in interface ProfileRemote
MXException
java.rmi.RemoteException
getOrgsString()
public java.util.TreeSet<java.lang.String> getReadableSites(java.lang.String app) throws MXException, java.rmi.RemoteException
If this is a system-level or org-level application, an error will be thrown.
getReadableSites
in interface ProfileRemote
app
- Application nameMXException
java.rmi.RemoteException
getReadableSites(java.lang.String)
public java.lang.String getReadableSitesString(java.lang.String app) throws MXException, java.rmi.RemoteException
('BEDFORD', 'NASHUA', 'TEXAS')
.
If the user has no authorized sites, the string will be null.
If this is a system-level or org-level application, an error will be thrown.
getReadableSitesString
in interface ProfileRemote
app
- Application nameMXException
java.rmi.RemoteException
getReadableSitesString(java.lang.String)
public java.util.TreeSet<java.lang.String> getReadableOrgs(java.lang.String app) throws MXException, java.rmi.RemoteException
If this is a system-level or site-level application, an error will be thrown.
getReadableOrgs
in interface ProfileRemote
MXException
java.rmi.RemoteException
getReadableOrgs(java.lang.String)
public java.lang.String getReadableOrgsString(java.lang.String app) throws MXException, java.rmi.RemoteException
('EAGLENA', 'EAGLESA')
.
If the user has no authorized orgs, the string will be null.
If this is a system-level or site-level application, an error will be thrown.
getReadableOrgsString
in interface ProfileRemote
app
- Application nameMXException
java.rmi.RemoteException
getReadableOrgsString(java.lang.String)
public boolean isLaborAuthAll() throws MXException, java.rmi.RemoteException
isLaborAuthAll
in interface ProfileRemote
MXException
java.rmi.RemoteException
isLaborAuthAll()
public boolean isAuthLaborSelf(java.lang.String orgid, java.lang.String laborcode) throws MXException, java.rmi.RemoteException
isAuthLaborSelf
in interface ProfileRemote
MXException
java.rmi.RemoteException
isAuthLaborSelf(String orgid, String laborcode)
public boolean isAuthLaborSuper(java.lang.String orgid, java.lang.String laborcode) throws MXException, java.rmi.RemoteException
isAuthLaborSuper
in interface ProfileRemote
MXException
java.rmi.RemoteException
isAuthLaborSuper(String orgid, String laborcode)
public boolean isAuthLaborCrew(java.lang.String orgid, java.lang.String laborcode) throws MXException, java.rmi.RemoteException
isAuthLaborCrew
in interface ProfileRemote
MXException
java.rmi.RemoteException
isAuthLaborCrew(String orgid, String laborcode)
public boolean isAuthLaborGroup(java.lang.String orgid, java.lang.String laborcode) throws MXException, java.rmi.RemoteException
isAuthLaborGroup
in interface ProfileRemote
MXException
java.rmi.RemoteException
isAuthLaborGroup(String orgid, String laborcode)
public java.util.HashMap<java.lang.String,java.lang.Boolean> getLaborAuthFlags(java.lang.String orgid) throws MXException, java.rmi.RemoteException
getLaborAuthFlags
in interface ProfileRemote
orgid
- OrganizationlaborAuthFlags
MXException
java.rmi.RemoteException
getLaborAuthFlags(String orgid)
public boolean getLaborAuth(java.lang.String orgid, java.lang.String laborcode) throws MXException, java.rmi.RemoteException
getLaborAuth
in interface ProfileRemote
orgid
- The org IDlaborcode
- The labor codeMXException
java.rmi.RemoteException
getLaborAuth(java.lang.String, java.lang.String)
public java.util.HashMap<java.lang.String,java.util.HashSet<java.lang.String>> getLaborAuthorities() throws MXException, java.rmi.RemoteException
getLaborAuthorities
in interface ProfileRemote
MXException
java.rmi.RemoteException
getLaborAuthorities()
public java.lang.String getLaborCodes(java.lang.String orgid) throws MXException, java.rmi.RemoteException
getLaborCodes
in interface ProfileRemote
orgid
- Organization identifierMXException
java.rmi.RemoteException
getLaborCodes(java.lang.String)
public static java.lang.String getLaborCodeSubWhere(java.lang.String laborcodes)
laborcodes
- The string returned from the method getLaborCodespublic java.util.ArrayList<java.lang.String> dumpLaborAuth(java.lang.String tempUserid) throws MXException, java.rmi.RemoteException
dumpLaborAuth
in interface ProfileRemote
tempUserid
- Userid to use when getting laborcodes based on crew, laborgroup, etc.
and we've constructed this Profile without userID.MXException
java.rmi.RemoteException
dumpLaborAuth(java.lang.String)
public java.lang.String getRoleRestrictions(java.lang.String entityname) throws MXException, java.rmi.RemoteException
getRoleRestrictions
in interface ProfileRemote
entityname
- MXException
java.rmi.RemoteException
getRoleRestrictions(String)
public java.util.HashMap getRoleRestrictions() throws MXException, java.rmi.RemoteException
getRoleRestrictions
in interface ProfileRemote
MXException
java.rmi.RemoteException
#roleRestrictions
public java.util.ArrayList dumpRoleRestrictions() throws MXException, java.rmi.RemoteException
dumpRoleRestrictions
in interface ProfileRemote
MXException
java.rmi.RemoteException
dumpRoleRestrictions()
public java.util.HashSet<java.lang.String> getNonStandardSiteOrgs(java.lang.String app, boolean getSites) throws MXException, java.rmi.RemoteException
getNonStandardSiteOrgs
in interface ProfileRemote
app
- Application name.getSites
- True to get readonly sites, False to get readonly organizations.MXException
java.rmi.RemoteException
nonStandardApps
public java.util.HashMap getNonStandardApps() throws MXException, java.rmi.RemoteException
getNonStandardApps
in interface ProfileRemote
MXException
java.rmi.RemoteException
nonStandardApps
public boolean getNonStandardAppOptionAuth(java.lang.String app, java.lang.String optionname, java.lang.String orgid, java.lang.String siteid) throws MXException, java.rmi.RemoteException
getAppOptionAuth
, but for a non-standard app and siteid or orgid.
Identifies whether a Mbo for the specified siteid or orgid is authorized for the specified optionname.getNonStandardAppOptionAuth
in interface ProfileRemote
app
- Application nameoptionname
- Option name to test for.orgid
- Orgid to test for. If null or empty string, the method will test for siteid.siteid
- Siteid to test for.MXException
java.rmi.RemoteException
nonStandardApps
public java.util.ArrayList<java.lang.String> dumpNonStandardApps() throws MXException, java.rmi.RemoteException
dumpNonStandardApps
in interface ProfileRemote
MXException
java.rmi.RemoteException
nonStandardApps
public java.lang.String getDefaultSite() throws MXException, java.rmi.RemoteException
getDefaultSite
in interface ProfileRemote
MXException
java.rmi.RemoteException
getDefaultSite()
public void setDefaultSite(java.lang.String site)
site
- public java.lang.String getDefaultOrg() throws MXException, java.rmi.RemoteException
getDefaultOrg
in interface ProfileRemote
MXException
java.rmi.RemoteException
getDefaultOrg()
public void setDefaultOrg(java.lang.String org)
org
- public java.lang.String getInsertSite() throws MXException, java.rmi.RemoteException
getInsertSite
in interface ProfileRemote
MXException
java.rmi.RemoteException
getInsertSite()
public java.lang.String getInsertOrg() throws MXException, java.rmi.RemoteException
getInsertOrg
in interface ProfileRemote
MXException
java.rmi.RemoteException
getInsertOrg()
public void setInsertOrg(java.lang.String org) throws MXException, java.rmi.RemoteException
org
- Insert organizationMXException
java.rmi.RemoteException
public void setInsertSite(java.lang.String site) throws MXException, java.rmi.RemoteException
setInsertSite
in interface ProfileRemote
site
- Insert siteMXException
java.rmi.RemoteException
setInsertSite(java.lang.String)
public java.lang.String getDefaultRepairFacility() throws MXException, java.rmi.RemoteException
getDefaultRepairFacility
in interface ProfileRemote
MXException
java.rmi.RemoteException
getDefaultRepairFacility()
public java.lang.String getDefaultRepairFacilitySite() throws MXException, java.rmi.RemoteException
getDefaultRepairFacilitySite
in interface ProfileRemote
MXException
java.rmi.RemoteException
psdi.security.Profile#getDefaultRepairSite
public void setInsertItemSet(java.lang.String setid) throws MXException, java.rmi.RemoteException
setInsertItemSet
in interface ProfileRemote
setid
- Insert item setMXException
java.rmi.RemoteException
setInsertItemSet(java.lang.String)
public java.lang.String getInsertItemSet() throws MXException, java.rmi.RemoteException
getInsertItemSet
in interface ProfileRemote
MXException
java.rmi.RemoteException
getInsertItemSet()
public void setInsertCompanySet(java.lang.String setid) throws MXException, java.rmi.RemoteException
setInsertCompanySet
in interface ProfileRemote
setid
- Insert company setMXException
java.rmi.RemoteException
setInsertCompanySet(java.lang.String)
public java.lang.String getInsertCompanySet() throws MXException, java.rmi.RemoteException
getInsertCompanySet
in interface ProfileRemote
MXException
java.rmi.RemoteException
getInsertCompanySet()
public boolean getQueryWithSite() throws MXException, java.rmi.RemoteException
getQueryWithSite
in interface ProfileRemote
MXException
java.rmi.RemoteException
getQueryWithSite()
public java.lang.String getDefaultStoreroom() throws MXException, java.rmi.RemoteException
getDefaultStoreroomSite
.getDefaultStoreroom
in interface ProfileRemote
MXException
java.rmi.RemoteException
getDefaultStoreroom()
public java.lang.String getDefaultStoreroomSite() throws MXException, java.rmi.RemoteException
getDefaultStoreroom
for getting the storeroom.getDefaultStoreroomSite
in interface ProfileRemote
MXException
java.rmi.RemoteException
getDefaultStoreroomSite()
public void setUserStatus(java.lang.String newInternalStatus)
newInternalStatus
- New user status (Maximo value)public boolean getLogout()
getLogout
in interface ProfileRemote
getLogout()
public java.lang.String getUserStatus() throws MXException, java.rmi.RemoteException
getUserStatus
in interface ProfileRemote
userStatus
MXException
java.rmi.RemoteException
getUserStatus()
public boolean useDataRestriction(java.lang.String groupname, java.lang.String app, java.lang.String siteorg) throws MXException, java.rmi.RemoteException
When evaluating a given Mbo and the app is site-level or org-level, then the siteorg parameter should be supplied. For example, if the app is WOTRACK and we are trying to determine whether a particular Mbo or attribute should be Hidden or Readonly, the siteid of the Mbo would be supplied.
This method is needed because other classes are generally not aware of which security groups a user belongs to, and also are not aware of any of the combining rules for the groups.
useDataRestriction
in interface ProfileRemote
groupname
- Security group name of the data restriction (securityrestriction table).
Data restrictions not having a group name do not need to be tested in Profile.
If this parameter is null, this method will return False.app
- Application name, either existing on the securityrestriction table, or existing
in the MboSet hierarchy.siteorg
- Siteid or Orgid, if the evaluation should be Mbo-based.
This can be null to bypass the site check. For example, when evaluating row restrictions
for QUALIFIED, this should be null.MXException
java.rmi.RemoteException
getUserStatus()
public boolean allCollectionsAllowed()
allCollectionsAllowed
in interface ProfileRemote
allCollectionsAllowed()
public java.util.HashSet<java.lang.String> getCollections()
getCollections
in interface ProfileRemote
getCollections()
public boolean hasCombinableNullRepairFacilities() throws MXException, java.rmi.RemoteException
hasCombinableNullRepairFacilities
in interface ProfileRemote
MXException
java.rmi.RemoteException
psdi.security.Profile#hasNullRepairFacilities
public java.util.HashMap<java.lang.String,java.lang.Boolean[]> getDiscreteRepFacAuthSites() throws MXException, java.rmi.RemoteException
getDiscreteRepFacAuthSites
in interface ProfileRemote
MXException
java.rmi.RemoteException
public java.util.HashSet<java.lang.String> getCombinableSites() throws MXException, java.rmi.RemoteException
getCombinableSites
in interface ProfileRemote
MXException
java.rmi.RemoteException
public void setProxy(java.rmi.Remote proxy)
setProxy
in interface MaxRemoteProxy
public java.rmi.Remote getProxy()
getProxy
in interface MaxRemoteProxy
public java.lang.Integer getReportLimit(java.lang.String attributeName) throws MXException, java.rmi.RemoteException
getReportLimit
in interface ProfileRemote
MXException
java.rmi.RemoteException