|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface tcUserOperationsIntf
Method Summary | |
---|---|
boolean |
canResourceBeProvisioned(long userKey, long objectKey) Determines if a resource can be provisioned to a user or not. |
void |
changeCredForSelf(java.lang.String psOldPwd, java.lang.String psNewPwd, java.lang.String psConfirmPwd) Changes the password of the current user. |
void |
changeFromServiceAccount(long plObjectInstanceForUserKey) Changes a service account to a regular account. |
void |
changePasswordforSelf(java.lang.String psOldPwd, java.lang.String psNewPwd, java.lang.String psConfirmPwd) Changes the password of the current user. |
void |
changeToServiceAccount(long plObjectInstanceForUserKey) Changes a regular account to a service account. |
boolean |
compareChallengeValuesForSelf(java.util.Map phQuestionAnswer) Compares the questions/answers entered by the user against the ones stored in the database |
long |
createUser(java.util.Map phMapping) Creates a user in Xellerate with the specified attributes. |
void |
deleteProxies(long userKey) This method deletes all the proxies setup for the given user. |
void |
deleteProxy(long userKey, long proxyKey) This method delete a proxy with a proxyKey for given user. |
void |
deleteUser(long plUserKey) Delete a user in Xellerate. |
void |
deleteUsers(long[] paUserKeys) Deletes users in Xellerate. |
void |
disableAppForUser(long plUserKey, long plObjectInstanceForUserKey) Disables the object instance for the specified user. |
void |
disableAppsForUser(long plUserKey, long[] paObjectInstancesForUserKey) Disables the object instances for the specified user. |
void |
disableUser(long plUserKey) Disable a user in Xellerate. |
void |
disableUsers(long[] paUserKeys) Disable users in Xellerate. |
void |
enableAppForUser(long plUserKey, long plObjectInstanceForUserKey) Enables the object instance for the specified user. |
void |
enableAppsForUser(long plUserKey, long[] paObjectInstancesForUserKey) Enables the object instances for the specified user. |
void |
enableUser(long plUserKey) Enable a user in Xellerate. |
void |
enableUsers(long[] paUserKeys) Enable users in Xellerate. |
Thor.API.tcResultSet |
findAllUsers(java.util.Map phAttributeList) Returns a list of users that match the provided attribute list. |
Thor.API.tcResultSet |
findAllUsersFiltered(java.util.Map phAttributeList, java.lang.String[] pasFieldList) Returns a list of users that match the provided attribute list. |
Thor.API.tcResultSet |
findUsers(java.util.Map phAttributeList) Returns a list of users that match the provided attribute list. |
Thor.API.tcResultSet |
findUsers(java.util.Map phAttributeList, java.lang.String permission) Returns a list of users that match the provided attribute list. |
Thor.API.tcResultSet |
findUsers(java.util.Map phAttributeList, java.lang.String permission, java.lang.String[] status) Returns a list of users that match the provided attribute list and status. |
Thor.API.tcResultSet |
findUsersFiltered(java.util.Map phAttributeList, java.lang.String[] pasFieldList) Returns a list of users that match the provided attribute list. |
Thor.API.tcResultSet |
findUsersFiltered(java.util.Map phAttributeList, java.lang.String[] pasFieldList, int startRow, int pageSize, java.lang.String[] order, boolean ascendingOrder) Returns a list of users that match the provided attribute list. |
int |
findUsersFilteredCount(java.util.Map phAttributeList, java.lang.String[] pasFieldList) Returns a count of users that match the provided attribute list. |
Thor.API.tcResultSet |
getActiveUsers(java.util.Map attributes) Returns a list of active users in the system. |
Thor.API.tcResultSet |
getAvailableObjects(long[] palUserKeys) Returns a list of resource objects that can be provisioned to a specified list of users |
Thor.API.tcResultSet |
getAvailableObjects(long[] palUserKeys, java.util.Map attributes) Returns a list of resource objects that can be provisioned to a specified list of users |
Thor.API.tcResultSet |
getAvailableObjectsForSelf() This object returns a resultset of the objects available for the current login user. |
Thor.API.tcResultSet |
getAvailableObjectsForSelf(java.util.Map attributes) This object returns a resultset of the objects available for the current login user. |
Thor.API.tcResultSet |
getAvailableObjectsForUser(long[] palUserKeys) This object returns a resultset of the objects available for the given array of users. |
Thor.API.tcResultSet |
getChallengeValuesForSelf() Returns a resultset of the questions and answers |
Thor.API.tcResultSet |
getChallengeValuesForUser(long userKey) Returns a resultset of the questions and answers |
Thor.API.tcResultSet |
getEncodedValue(java.lang.String strDecodeVal, java.lang.String strFieldName) This object returns a resultset of the object available for the given encoded value. |
Thor.API.tcResultSet |
getGroups(long plUserKey) Gets a list of all the groups the user is a member of. |
Thor.API.tcResultSet |
getGroups(java.util.Map searchCriteria) Gets a list of all the groups the user is a member of. |
Thor.API.tcResultSet |
getMenuList(long plUserKey) Retrieves a list of web application menu items that users have access to based on their group membership. |
Thor.API.tcResultSet |
getMenuListForSelf() Retrieves a list of web application menu items for the logged in user. |
Thor.API.tcResultSet |
getObjectAuthorizationPermissions(long plUserKey) Returns a list of Objects the user has authorization control over, based on the group membership of the user. |
Thor.API.tcResultSet |
getObjects(long plUserKey) Gets a list of all the objects that have been provisioned for a user. |
Thor.API.tcResultSet |
getObjectsByType(long plUserKey, java.lang.String psObjectType) Gets a list of all the objects of the specified type that have been provisioned for a user. |
Thor.API.tcResultSet |
getObjectsByTypeStatus(long plUserKey, java.lang.String psObjectType, java.lang.String psStatus) Gets a list of all the objects of the specified type that have been provisioned for a user and are in the specified status. |
Thor.API.tcResultSet |
getProxiedUser(long userKey) This method will return the detail information of only the current proxied user by the specified user. |
Thor.API.tcResultSet |
getProxyDetails(long userKey) This method will return the detail information of the proxy assigned to the specified user. |
Thor.API.tcResultSet |
getProxyList(java.util.Map attributeMap, java.lang.String[] fieldList) Method that returns a resultset of the proxy users for the user whose key is passed in. |
Thor.API.tcResultSet |
getSelfProfile() Returns the current logon user's profile. |
Thor.API.tcResultSet |
getSelfProfileFiltered(java.lang.String[] pasFieldList) Returns the current logon user's profile. |
Thor.API.tcResultSet |
getUnAssignedGroups(long plUserKey) Gets a list of all the groups the user is not a member of. |
java.lang.String[] |
getUserFromObjectInfo(java.lang.String psObjName, java.lang.String psColumnName, java.lang.String psColumnValue) Locates User Record(s) in Xellerate based on data for a provisioned object. |
boolean |
isChallengeQuestionsSetForSelf() Check if challenge questions are set for the current user. |
void |
lockSelf(java.lang.String username) Locks the self user with a signature login. |
void |
moveServiceAccount(long plObjectInstanceForUserKey, long plTargetUserKey) Moves the service account from its current owner to a new owner. |
long |
provisionObject(long plUserKey, long plObjectKey) Provision an object for a user directly without going through a request. |
long |
provisionObject(long plUserKey, long plObjectKey, boolean pbServiceAccount) Provision an object for a user directly without going through a request. |
ResourceData |
provisionResource(long plUserKey, long plObjectKey) Provision an object for a user directly without going through a request. |
ResourceData |
provisionResource(long plUserKey, long plObjectKey, boolean pbServiceAccount) Provision an object for a user directly without going through a request. |
void |
relinkAccount(long plObjectInstanceForUserKey, long plTargetUserKey, boolean updateParentDataFlag) |
void |
revokeObject(long plUserKey, long plObjectInstanceForUserKey) Revokes the provisioning of an object for a user directly without going through a request. |
void |
revokeObjects(long plUserKey, long[] paObjectInstancesForUserKey) Revokes the provisioning of an object for a user directly without going through a request. |
void |
setChallengeValuesForSelf(java.util.Map phQuestionAnswer) Set the challenge questions and answers for the logged in user. |
long |
setProxyForUser(long userKey, long proxyUserKey, java.util.Date startDate, java.util.Date endDate) This new method will set the specified user as a proxy for the specified user. |
void |
unlockUsers(long[] paUserKeys) Enable users in Xellerate by unlocking their accounts if they are locked. |
void |
updateProxyForUser(long pxdKey, java.util.Map attribute) This new method will update the specified user as a proxy for the specified user. |
void |
updateUser(Thor.API.tcResultSet poUserResultSet, java.util.Map phAttributeList) Update a user in Xellerate. |
void |
updateUser(Thor.API.tcResultSet poUserResultSet, java.util.Map phAttributeList, boolean changePassword) Update a user in Xellerate. |
Methods inherited from interface Thor.API.Base.tcUtilityOperationsIntf |
---|
close, getName, setCountry, setLanguage, setVariant |
Method Detail |
---|
long createUser(java.util.Map phMapping) throws tcAPIException, tcDuplicateUserException, tcAttributeMissingException, tcInvalidAttributeException, tcAPIException
phMapping
- An array of mapping objects, each representing an attribute to set in the user. Please note that if the same attribute is specified twice in the array, the later instance found will be used.tcAPIException
tcDuplicateUserException
tcAttributeMissingException
tcInvalidAttributeException
void deleteUser(long plUserKey) throws tcAPIException, tcUserNotFoundException, tcAPIException
plUserKey
- The key of the user to delete.tcAPIException
tcUserNotFoundException
void deleteUsers(long[] paUserKeys) throws tcAPIException, tcUserNotFoundException, tcBulkException, tcAPIException
paUserKeys
- The array key of the users to delete.tcAPIException
tcUserNotFoundException
tcBulkException
void disableUser(long plUserKey) throws tcAPIException, tcUserNotFoundException, tcAPIException
plUserKey
- The key of the user to disable.tcAPIException
tcUserNotFoundException
void disableUsers(long[] paUserKeys) throws tcAPIException, tcUserNotFoundException, tcBulkException, tcAPIException
paUserKeys
- The key array of the users to disable.tcAPIException
tcUserNotFoundException
tcBulkException
void enableUser(long plUserKey) throws tcAPIException, tcUserNotFoundException, tcAPIException
plUserKey
- The key of the user to enable.tcAPIException
tcUserNotFoundException
void enableUsers(long[] paUserKeys) throws tcAPIException, tcUserNotFoundException, tcBulkException, tcAPIException
paUserKeys
- The key array of users to enable.tcAPIException
tcUserNotFoundException
tcBulkException
void changePasswordforSelf(java.lang.String psOldPwd, java.lang.String psNewPwd, java.lang.String psConfirmPwd) throws tcAPIException, tcPasswordIncorrectException, tcPasswordMismatchException, tcPasswordPolicyException, tcAPIException
psOldPwd
- is current user's passwordpsNewPwd
- is the new password to assign to the userpsConfirmPwd
- is the confirmed new password. This should match the psNewPwdtcAPIException
tcPasswordIncorrectException
- error raise in case password is incorrecttcPasswordMismatchException
- error raise in case password does not matchtcPasswordPolicyException
- error if policy attached with passowrd fail.void changeCredForSelf(java.lang.String psOldPwd, java.lang.String psNewPwd, java.lang.String psConfirmPwd) throws tcAPIException, tcPasswordIncorrectException, tcPasswordMismatchException, tcPasswordPolicyException, tcAPIException
psOldPwd
- is current user's passwordpsNewPwd
- is the new password to assign to the userpsConfirmPwd
- is the confirmed new password. This should match the psNewPwdtcAPIException
tcPasswordIncorrectException
tcPasswordMismatchException
tcPasswordPolicyException
Thor.API.tcResultSet getAvailableObjectsForSelf() throws tcAPIException, tcAPIException
tcAPIException
com.thortech.xl.dataaccess.tcDataSetException
Thor.API.tcResultSet getAvailableObjectsForSelf(java.util.Map attributes) throws tcAPIException, tcAPIException
attributes
- is the attribute map to filter the result settcAPIException
com.thortech.xl.dataaccess.tcDataSetException
Thor.API.tcResultSet getAvailableObjectsForUser(long[] palUserKeys) throws tcUserNotFoundException, tcAPIException, tcAPIException
palUserKeys
- an array of user keys to get available objects. If a null or empty array is passed, this function will raise the tcAPIExceptiontcUserNotFoundException
tcAPIException
Thor.API.tcResultSet getAvailableObjects(long[] palUserKeys) throws tcUserNotFoundException, tcAPIException, tcAPIException
palUserKeys
- an array of user keystcResultSet
that contains the available objects for the given list of userstcUserNotFoundException
tcAPIException
Thor.API.tcResultSet getAvailableObjects(long[] palUserKeys, java.util.Map attributes) throws tcUserNotFoundException, tcAPIException, tcAPIException
palUserKeys
- an array of user keysattributes
- is the attribute map to filter the result settcResultSet
that contains the available objects for the given list of userstcUserNotFoundException
tcAPIException
Thor.API.tcResultSet getSelfProfile() throws tcAPIException, tcAPIException
tcResultSet
that contains user-defined columns as well as the following user-related information:
tcAPIException
Thor.API.tcResultSet getSelfProfileFiltered(java.lang.String[] pasFieldList) throws tcAPIException, tcAPIException
tcResultSet
can be specified.phAttributeList
- attribute-value pairs with each entry containing criteria to find userspasFieldList
- The list of fields that is to be returned in the tcResultSet
.tcResultSet
that contains the fields specified in pasFieldList
. Returned tcResultSet
always contains
com.thortech.xl.dataaccess.tcDataSetException
tcAPIException
Thor.API.tcResultSet findUsers(java.util.Map phAttributeList) throws tcAPIException, tcAPIException
phAttributeList
- A Map
of attribute-value pairs with each entry containing criteria to find users. The Map
key should contain a String
representation of the metadata codes and/or user-defined columns. The metadata codes are listed below in the contents of the returned tcResultSet. The Map
value can contain a String
representation of the criteria to find the desired requests. Note that the Map
values can include wild cards(%).tcResultSet
that contains user-defined columns as well as the following user-related information:
tcAPIException
Thor.API.tcResultSet findUsers(java.util.Map phAttributeList, java.lang.String permission) throws tcAPIException, tcAPIException
phAttributeList
- A Map
of attribute-value pairs with each entry containing criteria to find users. The Map
key should contain a String
representation of the metadata codes and/or user-defined columns. The metadata codes are listed below in the contents of the returned tcResultSet. The Map
value can contain a String
representation of the criteria to find the desired requests. Note that the Map
values can include wild cards(%).permission
- - the value of permission could be Write, Read, or Delete. It return groups based on the permission.tcResultSet
that contains user-defined columns as well as the following user-related information:
tcAPIException
Thor.API.tcResultSet findUsers(java.util.Map phAttributeList, java.lang.String permission, java.lang.String[] status) throws tcAPIException, tcAPIException
phAttributeList
- attribute-value pairs with each entry containing criteria to find userspermission
- - the value of permission could be Write, Read, or Delete. It return groups based on the permission.status
- an array of user statuses to filtertcResultSet
that contains user-defined columns as well as the following user-related information:
tcAPIException
Thor.API.tcResultSet findUsersFiltered(java.util.Map phAttributeList, java.lang.String[] pasFieldList, int startRow, int pageSize, java.lang.String[] order, boolean ascendingOrder) throws tcAPIException, tcAPIException
tcResultSet
can be specified.phAttributeList
- A Map
of attribute-value pairs with each entry containing criteria to find users. The Map
key should contain a String
representation of the metadata codes and/or user-defined columns. The metadata codes are listed below in the contents of the returned tcResultSet. The Map
value can contain a String
representation of the criteria to find the desired requests. Note that the Map
values can include wild cards(%).pasFieldList
- The list of fields that is to be returned in the tcResultSet
. This can include user-defined fields as well as any of the following metadata codes:
startRow
- The starting row of the resultpageSize
- The page size (how many rows to return)order
- The order in which the result set is based since only a subset of the whole matching set is returned, the caller will not be able to sort accurately with only that subset.ascendingOrder
- - a boolean value if the sorting is to be ascending or descendingtcResultSet
that contains the fields specified in pasFieldList
.tcAPIException
Thor.API.tcResultSet findUsersFiltered(java.util.Map phAttributeList, java.lang.String[] pasFieldList) throws tcAPIException, tcAPIException
tcResultSet
can be specified.phAttributeList
- A Map
of attribute-value pairs with each entry containing criteria to find users. The Map
key should contain a String
representation of the metadata codes and/or user-defined columns. The metadata codes are listed below in the contents of the returned tcResultSet. The Map
value can contain a String
representation of the criteria to find the desired requests. Note that the Map
values can include wild cards(%).pasFieldList
- The list of fields that is to be returned in the tcResultSet
. This can include user-defined fields as well as any of the following metadata codes:
tcResultSet
that contains the fields specified in pasFieldList
.tcAPIException
int findUsersFilteredCount(java.util.Map phAttributeList, java.lang.String[] pasFieldList) throws tcAPIException, tcAPIException
phAttributeList
- A Map
of attribute-value pairs with each entry containing criteria to find users. The Map
key should contain a String
representation of the metadata codes and/or user-defined columns. The metadata codes are listed below in the contents of the returned tcResultSet. The Map
value can contain a String
representation of the criteria to find the desired requests. Note that the Map
values can include wild cards(%).pasFieldList
- The list of fields that is to be returned in the tcResultSet
. This can include user-defined fields as well as any of the following metadata codes:
tcAPIException
Thor.API.tcResultSet getGroups(long plUserKey) throws tcAPIException, tcUserNotFoundException, tcAPIException
plUserKey
- Value holding the User Key (corresponds to value in the USR_KEY
column)tcResultSet
each row holding information about a group the user is a member of.tcAPIException
tcUserNotFoundException
Thor.API.tcResultSet getObjectAuthorizationPermissions(long plUserKey) throws tcAPIException, tcUserNotFoundException, tcAPIException
plUserKey
- The key of the user.tcResultSet
containing a list of Objects that the User has authorization permissions for.tcAPIException
tcUserNotFoundException
Thor.API.tcResultSet getObjects(long plUserKey) throws tcAPIException, tcUserNotFoundException, tcAPIException
plUserKey
- Value holding the User Key (corresponds to value in the USR_KEY
column)tcResultSet
, each row holding information about an object that has been provisioned for a user. The following columns are returned
Thor.API.tcResultSet getObjectsByType(long plUserKey, java.lang.String psObjectType) throws tcAPIException, tcUserNotFoundException, tcAPIException
plUserKey
- Value holding the User Key (corresponds to value in the USR_KEY
column)psObjectType
- The type of the Object to look fortcResultSet
, each row holding information about an object that has been provisioned for a user.tcAPIException
tcUserNotFoundException
Thor.API.tcResultSet getObjectsByTypeStatus(long plUserKey, java.lang.String psObjectType, java.lang.String psStatus) throws tcAPIException, tcUserNotFoundException, tcAPIException
plUserKey
- Value holding the User Key (corresponds to value in the USR_KEY
column)psObjectType
- The type of the Object to look forpsStatus
- String holding the status the objects retrieved should be intcResultSet
, each row holding information about an object that has been provisioned for a user.tcAPIException
tcUserNotFoundException
java.lang.String[] getUserFromObjectInfo(java.lang.String psObjName, java.lang.String psColumnName, java.lang.String psColumnValue) throws tcAPIException, tcAPIException
psObjName
- The name of object whose data the user is to be located based on. This corresponds to the name of an object defined in Xellerate.psColumnName
- The descriptive name of the column as specified in the Structure UtilitypsColumnValue
- The value to search fortcAPIException
long provisionObject(long plUserKey, long plObjectKey) throws tcAPIException, tcObjectNotFoundException, tcProvisioningNotAllowedException, tcUserNotFoundException, tcAPIException
plUserKey
- The key of the user.plObjectKey
- The key of the object to provision.tcAPIException
tcObjectNotFoundException
tcProvisioningNotAllowedException
tcUserNotFoundException
long provisionObject(long plUserKey, long plObjectKey, boolean pbServiceAccount) throws tcAPIException, tcObjectNotFoundException, tcProvisioningNotAllowedException, tcUserNotFoundException, tcAPIException
plUserKey
- The key of the user.plObjectKey
- The key of the object to provision.pbServiceAccount
- Whether the account is a service account or not. True if it istcAPIException
tcObjectNotFoundException
tcProvisioningNotAllowedException
tcUserNotFoundException
ResourceData provisionResource(long plUserKey, long plObjectKey) throws tcAPIException, tcObjectNotFoundException, tcProvisioningNotAllowedException, tcUserNotFoundException, tcAPIException
plUserKey
- The key of the user.plObjectKey
- The key of the object to provision.tcAPIException
tcObjectNotFoundException
tcProvisioningNotAllowedException
tcUserNotFoundException
ResourceData provisionResource(long plUserKey, long plObjectKey, boolean pbServiceAccount) throws tcAPIException, tcObjectNotFoundException, tcProvisioningNotAllowedException, tcUserNotFoundException, tcAPIException
plUserKey
- The key of the user.plObjectKey
- The key of the object to provision.pbServiceAccount
- Whether the account is a service account or not. True if it istcAPIException
tcObjectNotFoundException
tcProvisioningNotAllowedException
tcUserNotFoundException
void revokeObject(long plUserKey, long plObjectInstanceForUserKey) throws tcAPIException, tcObjectNotFoundException, tcRevocationNotAllowedException, tcUserNotFoundException, tcAPIException
plUserKey
- The key of the user.plObjectInstanceForUserKey
- The key of the object instance for a user in the system.tcAPIException
tcObjectNotFoundException
tcRevocationNotAllowedException
tcUserNotFoundException
void revokeObjects(long plUserKey, long[] paObjectInstancesForUserKey) throws tcAPIException, tcObjectNotFoundException, tcRevocationNotAllowedException, tcUserNotFoundException, tcBulkException, tcAPIException
plUserKey
- The key of the user.paObjectInstancesForUserKey
- The key of the object instance for a user in the system.tcAPIException
tcObjectNotFoundException
tcRevocationNotAllowedException
tcUserNotFoundException
tcBulkException
void updateUser(Thor.API.tcResultSet poUserResultSet, java.util.Map phAttributeList, boolean changePassword) throws tcAPIException, tcUserNotFoundException, tcStaleDataUpdateException, tcAPIException
poUserResultSet
- A result set containing at the minimum the user key and the rowver of the user record to update.phAttributeList
- A map of name-value pairs, each entry holding an attribute-value pair to set/modify for this user. The Attribute names are the String column codes (from the Xellerate metadata). The Attribute Values are the String attributes of the columns to set.changePassword
- Whether this update has been trigerred for a password changetcAPIException
tcUserNotFoundException
tcStaleDataUpdateException
void updateUser(Thor.API.tcResultSet poUserResultSet, java.util.Map phAttributeList) throws tcAPIException, tcUserNotFoundException, tcStaleDataUpdateException, tcAPIException
poUserResultSet
- A result set containing at the minimum the user key and the rowver of the user record to update.phAttributeList
- A map of name-value pairs, each entry holding an attribute-value pair to set/modify for this user. The Attribute names are the String column codes (from the Xellerate metadata). The Attribute Values are the String attributes of the columns to set.tcAPIException
tcUserNotFoundException
tcStaleDataUpdateException
void enableAppForUser(long plUserKey, long plObjectInstanceForUserKey) throws tcObjectNotFoundException, tcUserNotFoundException, tcAPIException, tcAPIException
plUserKey
- The key of the user.plObjectInstanceForUserKey
- The key of the object instance for a user in the system.tcObjectNotFoundException
tcUserNotFoundException
tcAPIException
void enableAppsForUser(long plUserKey, long[] paObjectInstancesForUserKey) throws tcObjectNotFoundException, tcUserNotFoundException, tcAPIException, tcBulkException, tcAPIException
plUserKey
- The key of the user.paObjectInstancesForUserKey
- The keys of the object instances for a user in the system.tcObjectNotFoundException
tcUserNotFoundException
tcAPIException
tcBulkException
void disableAppForUser(long plUserKey, long plObjectInstanceForUserKey) throws tcObjectNotFoundException, tcUserNotFoundException, tcAPIException, tcAPIException
plUserKey
- The key of the user.plObjectInstanceForUserKey
- The key of the object instance for a user in the system.tcObjectNotFoundException
tcUserNotFoundException
tcAPIException
void disableAppsForUser(long plUserKey, long[] paObjectInstancesForUserKey) throws tcObjectNotFoundException, tcUserNotFoundException, tcAPIException, tcBulkException, tcAPIException
plUserKey
- The key of the user.paObjectInstancesForUserKey
- The key of the object instances for a user in the system.tcObjectNotFoundException
tcUserNotFoundException
tcAPIException
tcBulkException
Thor.API.tcResultSet getMenuListForSelf() throws tcAPIException, tcAPIException
tcResultSet
containing a flat list of the user's menu items. Each menu item will have the following naming convention:<Parent Menu>.<Child Menu>.<Sub Menu(if necessary)>
tcAPIException
- if any database errors occurred while retrieving list of menu itemsThor.API.tcResultSet getMenuList(long plUserKey) throws tcUserNotFoundException, tcAPIException, tcAPIException
plUserKey
- key of the user to retrieve a list of menu items for.tcResultSet
containing a flat list of the user's menu items. Each menu item will have the following naming convention:<Parent Menu>.<Child Menu>.<Sub Menu(if necessary)>
tcUserNotFoundException
- if specified user does not existtcAPIException
- if any database errors occurred while retrieving list of menu itemsThor.API.tcResultSet findAllUsers(java.util.Map phAttributeList) throws tcAPIException, tcAPIException
phAttributeList
- A Map
of attribute-value pairs with each entry containing criteria to find users. The Map
key should contain a String
representation of the metadata codes and/or user-defined columns. The metadata codes are listed below in the contents of the returned tcResultSet. The Map
value can contain a String
representation of the criteria to find the desired requests. Note that the Map
values can include wild cards(%). This API will search through all users defined in the repository to return a result set.tcResultSet
that contains user-defined columns as well as the following user-related information:
tcAPIException
void setChallengeValuesForSelf(java.util.Map phQuestionAnswer) throws tcNumberOfChallengesMismatchException, tcAPIException, tcInvalidQuestionException, tcAPIException
phQuestionAnswer
- A map of questions and answers for the current logged in user.tcNumberOfChallengesMismatchException
tcAPIException
tcInvalidQuestionException
Thor.API.tcResultSet getChallengeValuesForSelf() throws tcAPIException, tcQuestionsNotDefinedException, tcAPIException
tcAPIException
tcQuestionsNotDefinedException
Thor.API.tcResultSet getChallengeValuesForUser(long userKey) throws tcAPIException, tcQuestionsNotDefinedException, tcUserNotFoundException, tcAPIException
userKey
- The key of the user.tcAPIException
tcQuestionsNotDefinedException
tcUserNotFoundException
boolean compareChallengeValuesForSelf(java.util.Map phQuestionAnswer) throws tcNumberOfChallengesMismatchException, tcAPIException, tcAPIException
phQuestionAnswer
- A map of questions and answers for the current logged in user.tcNumberOfChallengesMismatchException
tcAPIException
boolean isChallengeQuestionsSetForSelf() throws tcAPIException, tcAPIException
tcAPIException
void unlockUsers(long[] paUserKeys) throws tcAPIException, tcUserNotFoundException, tcBulkException, tcAPIException
paUserKeys
- The array user keys to enable.tcAPIException
tcUserNotFoundException
tcBulkException
Thor.API.tcResultSet getProxyDetails(long userKey) throws tcAPIException, tcUserNotFoundException, tcAPIException
userKey
- user that is been proxiedtcAPIException
- raised if a error occurredtcUserNotFoundException
- raised if the user key passed is not of a valid user.void deleteProxies(long userKey) throws tcAPIException, tcUserNotFoundException, tcAPIException
userKey
- the user key that is been proxiedtcAPIException
- raised if an error occurred by deleting the proxiestcUserNotFoundException
- raised if the user key is not of a valid user.void deleteProxy(long userKey, long proxyKey) throws tcAPIException, tcUserNotFoundException
userKey
- the user key that is been proxiedproxyKey
- the proxy that is to be deletedtcAPIException
tcUserNotFoundException
long setProxyForUser(long userKey, long proxyUserKey, java.util.Date startDate, java.util.Date endDate) throws tcAPIException, tcUserNotFoundException, tcRecursiveProxyException, tcAPIException
userKey
- the user been proxiedproxyUserKey
- the user to proxystartDate
- start date to proxy (can be null)endDate
- end date of the proxytcAPIException
- raised if there is an error setting the proxytcUserNotFoundException
- if any of the user do not exist in the system.tcRecursiveProxyException
- if there is a recursive proxyvoid updateProxyForUser(long pxdKey, java.util.Map attribute) throws tcAPIException, tcUserNotFoundException, tcRecursiveProxyException, tcAPIException
pxdKey
- the proxy key that references the proxy updateattribute
- an attribute map of the fields to update:tcAPIException
- raised if there is an error setting the proxytcUserNotFoundException
- if any of the user do not exist in the system.tcRecursiveProxyException
- if there is a recursive proxyThor.API.tcResultSet getProxiedUser(long userKey) throws tcAPIException, tcUserNotFoundException, tcAPIException
userKey
- user is the proxy usertcAPIException
- raised if a error occurredtcUserNotFoundException
- raised if the user key passed is not of a valid user.void relinkAccount(long plObjectInstanceForUserKey, long plTargetUserKey, boolean updateParentDataFlag) throws tcAPIException, tcAPIException
tcAPIException
void moveServiceAccount(long plObjectInstanceForUserKey, long plTargetUserKey) throws tcAPIException, tcAPIException
plObjectInstanceForUserKey
- The key of the object instance for a user in the system.plTargetUserKey
- The key of the user who shall be the new owner.tcAPIException
void changeToServiceAccount(long plObjectInstanceForUserKey) throws tcAPIException, tcAPIException
plObjectInstanceForUserKey
- The key of the object instance for a user in the system.tcAPIException
void changeFromServiceAccount(long plObjectInstanceForUserKey) throws tcAPIException, tcAPIException
plObjectInstanceForUserKey
- The key of the object instance for a user in the system.tcAPIException
Thor.API.tcResultSet getUnAssignedGroups(long plUserKey) throws tcAPIException, tcUserNotFoundException, tcAPIException
plUserKey
- Value holding the User Key (corresponds to value in the USR_KEY
column)tcResultSet
each row holding information about a group the user is not a member of.tcAPIException
tcUserNotFoundException
boolean canResourceBeProvisioned(long userKey, long objectKey) throws tcAPIException, tcUserNotFoundException, tcObjectNotFoundException, tcAPIException
userKey
- Value holding the User Key (corresponds to value in the USR_KEY
column)objectKey
- This is the resource object keytcResultSet
each row holding information about a group the user is not a member of.tcAPIException
tcUserNotFoundException
tcObjectNotFoundException
Thor.API.tcResultSet getEncodedValue(java.lang.String strDecodeVal, java.lang.String strFieldName) throws tcAPIException, tcAPIException
valDecodes.
- If a null or empty array is passed, this function will raise the tcAPIExceptiontcUserNotFoundException
tcAPIException
Thor.API.tcResultSet getActiveUsers(java.util.Map attributes) throws tcAPIException, tcAPIException
attributes
- A Map
of attribute-value pairs with each entry containing criteria to find active users. The Map
key should contain a String
representation of the metadata codes. The Map
value can contain a String
representation of the criteria to find the desired requests. Note that the Map
values can include wild cards(*).tcResultSet
that contains the following information:
tcAPIException
- If an error occurs while querying the user dataThor.API.tcResultSet getProxyList(java.util.Map attributeMap, java.lang.String[] fieldList) throws tcUserNotFoundException, tcAPIException, tcAPIException
tcResultSet
that contains list of the proxies for the given user. The columns contained in the resultset are:
tcUserNotFoundException
- If the user key passed in does not correspond to an actual user.tcAPIException
- If an error occurs while querying the user dataThor.API.tcResultSet findAllUsersFiltered(java.util.Map phAttributeList, java.lang.String[] pasFieldList) throws tcAPIException, tcAPIException
tcResultSet
can be specified.phAttributeList
- attribute-value pairs with each entry containing criteria to find userspasFieldList
- The list of fields that is to be returned in the tcResultSet
.tcResultSet
that contains the fields specified in pasFieldList
. Returned tcResultSet
always contains
tcAPIException
void lockSelf(java.lang.String username) throws tcAPIException, tcUserNotFoundException, tcAPIException
tcAPIException
tcUserNotFoundException
Thor.API.tcResultSet getGroups(java.util.Map searchCriteria) throws tcAPIException, tcUserNotFoundException, tcAPIException
searchCriteria
- Map holding the search criteria with key in Metadata form for filtering Groups. Map must contain Users.Key. Metadata Keys that can be passed are as follows: Groups.Group Name, Users.KeytcResultSet
each row holding information about a group the user is a member of.tcAPIException
tcUserNotFoundException
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |