Package Thor.API.Operations

Interface tcObjectOperationsIntf

All Superinterfaces:
tcUtilityOperationsIntf
public interface tcObjectOperationsIntf extends tcUtilityOperationsIntf

  • Method Details

    • findObjects

      Thor.API.tcResultSet findObjects(Map phAttributeList) throws tcAPIException, tcAPIException
      Returns a list of objects (in the form of a tcResultSet) that match the provided attribute list.
      Parameters:
      phAttributeList - A Map of name-value pairs, each pair holding the attribute-value pairs to match the group against. The Attribute names are the String column codes (from the Xellerate metadata). The Attribute Values are the String attributes to base the search on. The values could include wild cards (%).
      Returns:
      A tcResultSet containing multiple rows, each holding information about the object. The columns returned in the resultset are:
      • Objects.Key
      • Objects.Name
      • Objects.Trusted Source
      • Structure Utility.Key
      • Structure Utility.Table Name
      • Structure Utility.Description
      • Objects.Order For
      • Objects.Auto Prepopulate
      • Objects.Type
      • Objects.Allow Multiple
      • Objects.Self Request Allowed
      • Objects.Auto Save
      • Objects.Allow All
      • Objects.Note
      • Objects.Auto Launch
      • Objects.Admin Only
      • OBJ_INITIAL_RECON_DATE
      • Objects.Off-line Provisioning
      • Objects.Sequence Recon
      Throws:
      tcAPIException

    • getAuditObjectives

      @Deprecated Thor.API.tcResultSet getAuditObjectives(long plObjectKey) throws tcAPIException, tcObjectNotFoundException, tcAPIException
      Deprecated.
      Gets a list of all Resource Audit Objectives for the specified object.
      Parameters:
      plObjectKey - String holding the Object Key (corresponds to value in the OBJ_KEY column)
      Returns:
      A tcResultSet, each row holding information about the audit objective. The columns in the resultset are:
      • Objects.Key
      • Lookup Definition.Lookup Code Information.Key
      • Lookup Definition.Lookup Code Information.Code Key
      • Lookup Definition.Lookup Code Information.Decode
      • RAO_ROWVER
      Throws:
      tcAPIException
      tcObjectNotFoundException
      Since:
      9.1.0.0

    • getAuthorizers

      @Deprecated Thor.API.tcResultSet getAuthorizers(long plObjectKey) throws tcAPIException, tcObjectNotFoundException, tcAPIException
      Deprecated.
      Gets a list of all the groups that have authorization access over the specified object.
      Parameters:
      plObjectKey - String holding the Object Key (corresponds to value in the OBJ_KEY column)
      Returns:
      A tcResultSet, each row holding information about a group. The columns in the returned resultset are:
      • Objects.Key
      • Groups.Key
      • Groups.Group Name
      • Objects-Ordering Permissions.Priority
      Throws:
      tcAPIException
      tcObjectNotFoundException

    • addAuthorizer

      @Deprecated void addAuthorizer(long plObjectKey, long plGroupKey) throws tcAPIException, tcObjectNotFoundException, tcGroupNotFoundException, tcAPIException
      Deprecated.
      Adds a group to the list of groups that have authorization access over the specified object.
      Parameters:
      plObjectKey - String holding the Object Key (corresponds to value in the OBJ_KEY column)
      plGroupKey - String holding the Group Key (corresponds to value in the UGP_KEY column)
      Throws:
      tcAPIException
      tcObjectNotFoundException
      tcGroupNotFoundException

    • removeAuthorizer

      @Deprecated void removeAuthorizer(long plObjectKey, long plGroupKey) throws tcAPIException, tcObjectNotFoundException, tcGroupNotFoundException, tcAPIException
      Deprecated.
      Removes a group from the list of groups that have authorization access over the specified object.
      Parameters:
      plObjectKey - String holding the Object Key (corresponds to value in the OBJ_KEY column)
      plGroupKey - String holding the Group Key (corresponds to value in the UGP_KEY column)
      Throws:
      tcAPIException
      tcObjectNotFoundException
      tcGroupNotFoundException

    • getAdministrators

      @Deprecated Thor.API.tcResultSet getAdministrators(long plObjectKey) throws tcAPIException, tcObjectNotFoundException, tcAPIException
      Deprecated.
      Gets a list of all the groups that have administrative access over the specified object.
      Parameters:
      plObjectKey - String holding the Object Key (corresponds to value in the OBJ_KEY column)
      Returns:
      A tcResultSet, each row holding information about a group. The following columns are in the returning resultset:
      • Groups.Key
      • Groups.Group Name
      • Objects-Groups.Write
      • Objects-Groups.Delete
      Throws:
      tcAPIException
      tcObjectNotFoundException

    • addAdministrator

      @Deprecated void addAdministrator(long plObjectKey, long plGroupKey, boolean pbWrite, boolean pbDelete) throws tcAdminNotFoundException, tcAPIException, tcObjectNotFoundException, tcGroupNotFoundException, tcAPIException
      Deprecated.
      Adds a group to the list of groups that have administrative access over the specified object.
      Parameters:
      plObjectKey - String holding the Object Key (corresponds to value in the OBJ_KEY column)
      plGroupKey - String holding the Group Key (corresponds to value in the UGP_KEY column)
      pbWrite - Whether the group has write access to the object
      pbDelete - Whether the group has delete access to the object
      Throws:
      tcAdminNotFoundException
      tcAPIException
      tcObjectNotFoundException
      tcGroupNotFoundException

    • updateAdministrator

      @Deprecated void updateAdministrator(long plObjectKey, long plGroupKey, boolean pbWrite, boolean pbDelete) throws tcAdminNotFoundException, tcAPIException, tcObjectNotFoundException, tcGroupNotFoundException, tcAPIException
      Deprecated.
      Updates the access permissions an administrative group has over the specified object.
      Parameters:
      plObjectKey - String holding the Object Key
      plGroupKey - String holding the Group Key
      pbWrite - Whether the group has write access to the object
      pbDelete - Whether the group has delete access to the object
      Throws:
      tcAdminNotFoundException
      tcAPIException
      tcObjectNotFoundException
      tcGroupNotFoundException

    • removeAdministrator

      @Deprecated void removeAdministrator(long plObjectKey, long plGroupKey) throws tcAPIException, tcAdminNotFoundException, tcObjectNotFoundException, tcGroupNotFoundException, tcAPIException
      Deprecated.
      Removes a group from the list of groups that have administrative access over the specified object.
      Parameters:
      plObjectKey - String holding the Object Key (corresponds to value in the OBJ_KEY column)
      plGroupKey - String holding the Group Key (corresponds to value in the UGP_KEY column)
      Throws:
      tcAPIException
      tcAdminNotFoundException
      tcObjectNotFoundException
      tcGroupNotFoundException

    • getDependencies

      Thor.API.tcResultSet getDependencies(long plObjectKey) throws tcAPIException, tcObjectNotFoundException, tcAPIException
      Gets a list of all the objects that this object depends on (requires to be provisioned before it can be provisioned).
      Parameters:
      plObjectKey - String holding the Object Key (corresponds to value in the OBJ_KEY column). This should be the key of the dependent object.
      Returns:
      A tcResultSet, each row holding information about the parent object(s) of the current object. The resultset contains the following columns:
      • Objects.Name
      • Objects.Object Dependencies.Parent Key
      • Objects.Key
      Throws:
      tcAPIException
      tcObjectNotFoundException

    • addDependency

      void addDependency(long plObjectKey, long plDependsOnObjectKey) throws tcAPIException, tcCycleDetectedException, tcObjectNotFoundException, tcAPIException
      Creates a dependency for an object.
      Parameters:
      plObjectKey - String holding the Object Key (corresponds to value in the OBJ_KEY column) to add a dependency to
      plDependsOnObjectKey - The Object key of the object it depends on
      Throws:
      tcAPIException
      tcCycleDetectedException
      tcObjectNotFoundException

    • removeDependency

      void removeDependency(long plObjectKey, long plDependsOnObjectKey) throws tcAPIException, tcObjectNotFoundException, tcAPIException
      Removes a dependency for an object.
      Parameters:
      plObjectKey - String holding the Object Key (corresponds to value in the OBJ_KEY column) to remove the dependency for
      plDependsOnObjectKey - The Object key of the object it depends on
      Throws:
      tcAPIException
      tcObjectNotFoundException

    • getObjectTypes

      String[] getObjectTypes() throws tcAPIException, tcAPIException
      Gets a list of all the object types that are defined within Xellerate.
      Returns:
      An array of strings, each string an object type defined in Xellerate.
      Throws:
      tcAPIException

    • increaseGroupPriority

      @Deprecated void increaseGroupPriority(long plObjectKey, long plGroupKey) throws tcAPIException, tcAPIException
      Deprecated.
      This method is used to increase the priority of a group authorizer for a specific Resource Object. The highest priority is 1 and the lowest priority is N.
      Parameters:
      plObjectKey - This is the resource object key
      plGroupKey - This is the key of a group that is part of the group authorizer list for the given Resource Object.
      Throws:
      tcAPIException

    • decreaseGroupPriority

      @Deprecated void decreaseGroupPriority(long plObjectKey, long plGroupKey) throws tcAPIException, tcAPIException
      Deprecated.
      This method is used to decrease the priority of a group authorizer for a specific Resource Object. The highest priority is 1 and the lowest priority is N.
      Parameters:
      plObjectKey - This is the resource object key
      plGroupKey - This is the key of a group that is part of the group authorizer list for the given Resource Object.
      Throws:
      tcAPIException

    • getAssociatedUsers

      Thor.API.tcResultSet getAssociatedUsers(long objectKey, Map attributeMap) throws tcObjectNotFoundException, tcAPIException, tcAPIException
      This method is used to get the list of users which are associated with a specified object(Provisioned, Disabled, Enabled, etc). If no filter is specified, it returns all the users who are associated with this object.
      Parameters:
      objectKey - This is the resource object key
      attributeList - A Map of key/value pairs with which the result set needs to be filtered.
      Returns:
      A resultset of all the users associated with the resource object with the specified filter criteria. The columns in the resultset are:
      • Object Instance.Key
      • Users.User ID
      • Users.Key
      • Users.Last Name
      • Users.First Name
      • Process Instance.Descriptive Data
      • Objects.Object Status.Status
      • Process Instance.Key
      • Objects.Object Form Key
      • Process.Process Definition.Process Form Key
      • Objects.Object Instance Key In Form
      • Process.Process Definition.Process Instance Key In Form
      Throws:
      tcAPIException
      tcObjectNotFoundException
      Since:
      8.0

    • getAssociatedUsersForRequest

      @Deprecated Thor.API.tcResultSet getAssociatedUsersForRequest(String actionType, long objectKey, Map attributeMap) throws tcObjectNotFoundException, tcAPIException, tcAPIException
      Deprecated.
      This method is used to get the list of users which are associated with a specified object in a specified operational context. It returns all the users as per given search criteria and authorization policies. It throws exception if logged in user doesn't have search permission on one (or more) attributes in the search criteria (map). It Returns null value for the attributes that user doesn't have view permission on.
      Parameters:
      actionType - Identifies the operational context in which the users associated with an object are being queried. The value of this parameter should be Enable, Disable, Revoke or Modify
      objectKey - This is the resource object key
      attributeList - A Map of key/value pairs with which the result set needs to be filtered. Keys can be metadata attributes of users such as Users.Status, Users.First Name, Users.Last Name etc.
      Throws:
      tcAPIException
      tcObjectNotFoundException
      Since:
      11.1.1.5.0

    • getAssociatedUsers

      Thor.API.tcResultSet getAssociatedUsers(String actionType, long objectKey, Map attributeMap) throws tcObjectNotFoundException, tcAPIException, tcAPIException
      This method is used to get the list of users which are associated with a specified object in a specified operational context. If no filter is specified, it returns all the users who are associated with this object.
      Parameters:
      actionType - Identifies the operational context in which the users associated with an object are being queried. The value of this parameter should be Enable, Disable, Revoke or Modify
      objectKey - This is the resource object key
      attributeList - A Map of key/value pairs with which the result set needs to be filtered.
      Throws:
      tcAPIException
      tcObjectNotFoundException
      Since:
      8.0

    • getAssociatedOrganizations

      Thor.API.tcResultSet getAssociatedOrganizations(long objectKey, Map attributeMap) throws tcObjectNotFoundException, tcAPIException, tcAPIException
      This method is used to get the list of organizations for whom the specified object is being provisioned. If not filter is specified, it returns all the organizations who are associated with this object in any way
      Parameters:
      objectKey - This is the resource object key
      attributeList - A Map of key/value pairs with which the result set needs to be filtered.
      Throws:
      tcAPIException
      tcObjectNotFoundException
      Since:
      8.0

    • findProvisionableObjectsForUser

      @Deprecated Thor.API.tcResultSet findProvisionableObjectsForUser(long plUsrKey, Map phAttributeList) throws tcAPIException, tcAPIException
      Deprecated.
      find all objects that are allowed to be provisioned to a user .
      Parameters:
      plUsrKey - User Key
      Returns:
      A tcResultSet, each row holding information about objects. The returning resultset contains the following columns:
      • Objects.Key
      • Objects.Name
      Throws:
      tcAPIException

    • findProvisionableObjectsForOrganizations

      Thor.API.tcResultSet findProvisionableObjectsForOrganizations(long[] orgKeys) throws tcOrganizationNotFoundException, tcBulkException, tcAPIException, tcAPIException
      find all objects that are allowed to be provisioned to an organization .
      Parameters:
      orgKeys - Organization Keys
      Returns:
      A tcResultSet, each row holding information about objects. The returning resultset has the following columns:
      • Objects.Key
      • Objects.Name
      • Structure Utility.Key
      • Structure Utility.Table Name
      • Objects.Order For
      • Objects.Auto Prepopulate
      • Objects.Type
      • Objects.Allow Multiple
      • Objects.Self Request Allowed
      • Objects.Auto Save
      • Objects.Allow All
      • Objects.Note
      • Objects.Auto Launch
      Throws:
      tcAPIException
      tcOrganizationNotFoundException
      tcBulkException

    • findProvisionableObjectsForOrganizations

      Thor.API.tcResultSet findProvisionableObjectsForOrganizations(long[] orgKeys, Map attributes) throws tcOrganizationNotFoundException, tcBulkException, tcAPIException, tcAPIException
      find all objects that are allowed to be provisioned to an organization .
      Parameters:
      orgKeys - Organization Keys
      attributes - is the attribute map to filter the result set
      Returns:
      A tcResultSet, each row holding information about objects. The returning resultset has the following columns:
      • Objects.Key
      • Objects.Name
      • Structure Utility.Key
      • Structure Utility.Table Name
      • Objects.Order For
      • Objects.Auto Prepopulate
      • Objects.Type
      • Objects.Allow Multiple
      • Objects.Self Request Allowed
      • Objects.Auto Save
      • Objects.Allow All
      • Objects.Note
      • Objects.Auto Launch
      Throws:
      tcAPIException
      tcOrganizationNotFoundException
      tcBulkException

    • removeAdministrators

      @Deprecated void removeAdministrators(long plObjectKey, long[] plGroupKeys) throws tcAPIException, tcAdminNotFoundException, tcObjectNotFoundException, tcGroupNotFoundException, tcAPIException
      Deprecated.
      Removes groups from the list of groups that have administrative access over the specified object.
      Parameters:
      plObjectKey - String holding the Object Key (corresponds to value in the OBJ_KEY column)
      plGroupKey - [] holding the Group Keys (corresponds to value in the UGP_KEY column)
      Throws:
      tcAPIException
      tcAdminNotFoundException
      tcObjectNotFoundException
      tcGroupNotFoundException

    • updateAdministrators

      @Deprecated void updateAdministrators(long plObjectKey, long[] plGroupKeys, boolean[] pbWrites, boolean[] pbDeletes) throws tcAdminNotFoundException, tcAPIException, tcObjectNotFoundException, tcGroupNotFoundException, tcAPIException
      Deprecated.
      Updates the access permissions an administrative group has over the specified object.
      Parameters:
      plObjectKey - String holding the Object Key
      plGroupKey - [] holding the Group Keys
      pbWrite - [] Whether the group has write access to the object
      pbDelete - [] Whether the group has delete access to the object
      Throws:
      tcAdminNotFoundException
      tcAPIException
      tcObjectNotFoundException
      tcGroupNotFoundException

    • addAdministrators

      @Deprecated void addAdministrators(long plObjectKey, long[] plGroupKeys, boolean[] pbWrite, boolean[] pbDelete) throws tcAdminNotFoundException, tcAPIException, tcObjectNotFoundException, tcGroupNotFoundException, tcAPIException
      Deprecated.
      Adds groups to the list of groups that have administrative access over the specified object.
      Parameters:
      plObjectKey - String holding the Object Key (corresponds to value in the OBJ_KEY column)
      plGroupKeys - holding the Group Key (corresponds to value in the UGP_KEY column)
      pbWrite - [] Whether the group has write access to the object
      pbDelete - [] Whether the group has delete access to the object
      Throws:
      tcAdminNotFoundException
      tcAPIException
      tcObjectNotFoundException
      tcGroupNotFoundException

    • addAuthorizers

      @Deprecated void addAuthorizers(long plObjectKey, long[] plGroupKeys) throws tcAPIException, tcObjectNotFoundException, tcGroupNotFoundException, tcAPIException
      Deprecated.
      Adds a group to the list of groups that have authorization access over the specified object.
      Parameters:
      plObjectKey - String holding the Object Key (corresponds to value in the OBJ_KEY column)
      plGroupKeys - holding the Group Keys (corresponds to value in the UGP_KEY column)
      Throws:
      tcAPIException
      tcObjectNotFoundException
      tcGroupNotFoundException

    • addAuditObjectives

      @Deprecated void addAuditObjectives(long plObjectKey, long[] plLKVKeys) throws tcAPIException, tcObjectNotFoundException, tcAPIException
      Deprecated.
      Parameters:
      plObjectKey - String holding the Object Key (corresponds to value in the OBJ_KEY column)
      plGroupKeys - holding the Group Keys (corresponds to value in the LKV_KEY column)
      Throws:
      tcAPIException
      tcObjectNotFoundException
      Since:
      9.1.0.0

    • addAuditObjective

      @Deprecated void addAuditObjective(long plObjectKey, long plLKVKey) throws tcAPIException, tcObjectNotFoundException, tcAPIException
      Deprecated.
      Adds an audit objective to the list.
      Parameters:
      plObjectKey - String holding the Object Key (corresponds to value in the OBJ_KEY column)
      plLKVKey - String holding the LKV Key (corresponds to value in the LKV_KEY column)
      Throws:
      tcAPIException
      tcObjectNotFoundException
      Since:
      9.1.0.0

    • removeAuditObjectives

      @Deprecated void removeAuditObjectives(long plObjectKey, long[] plLKVKeys) throws tcAPIException, tcObjectNotFoundException, tcGroupNotFoundException, tcAPIException
      Deprecated.
      Removes the list of Resource Audit Objective for the specified object.
      Parameters:
      plObjectKey - holding the Object Key (corresponds to value in the OBJ_KEY column)
      plLKVKeys - holding the LKV Keys (corresponds to value in the LKV_KEY column)
      Throws:
      tcAPIException
      tcObjectNotFoundException
      tcGroupNotFoundException
      Since:
      9.1.0.0

    • removeAuditObjective

      @Deprecated void removeAuditObjective(long plObjectKey, long plLKVKey) throws tcAPIException, tcObjectNotFoundException, tcAPIException
      Deprecated.
      Removes Resource Audit Objective for the specified object.
      Parameters:
      plObjectKey - String holding the Object Key (corresponds to value in the OBJ_KEY column)
      plLKVKey - String holding the LKV Key (corresponds to value in the LKV_KEY column)
      Throws:
      tcAPIException
      tcObjectNotFoundException
      Since:
      9.1.0.0

    • removeAuthorizers

      @Deprecated void removeAuthorizers(long plObjectKey, long[] plGroupKeys) throws tcAPIException, tcObjectNotFoundException, tcGroupNotFoundException, tcAPIException
      Deprecated.
      Removes groups from the list of groups that have authorization access over the specified object.
      Parameters:
      plObjectKey - holding the Object Key (corresponds to value in the OBJ_KEY column)
      plGroupKeys - holding the Group Keys (corresponds to value in the UGP_KEY column)
      Throws:
      tcAPIException
      tcObjectNotFoundException
      tcGroupNotFoundException

    • getUnassignedAdministrators

      @Deprecated Thor.API.tcResultSet getUnassignedAdministrators(long plObjectKey) throws tcAPIException, tcObjectNotFoundException, tcAPIException
      Deprecated.
      Gets a list of all the groups that logged in user is managing
      Parameters:
      plObjectKey - String holding the Object Key (corresponds to value in the OBJ_KEY column)
      Returns:
      A tcResultSet, each row holding information about a group. The returning resultset has the following columns:
      • Groups.Key
      • Groups.Group Name
      Throws:
      tcAPIException
      tcObjectNotFoundException
      Since:
      9.1.0.0

    • getUnassignedAdministrators

      @Deprecated Thor.API.tcResultSet getUnassignedAdministrators(long plObjectKey, String groupName) throws tcAPIException, tcObjectNotFoundException, tcAPIException
      Deprecated.
      Returns unassigned administrators on an object filtered by groupName
      Parameters:
      plObjectKey - String holding the Object Key (corresponds to value in the OBJ_KEY column)
      groupName - If this is non-empty then only groups are returned matching this group name
      Returns:
      A tcResultSet, each row holding information about a group. The returning resultset has the following columns:
      • Groups.Key
      • Groups.Group Name
      Throws:
      tcAPIException
      tcObjectNotFoundException

    • getUnassignedAuthorizers

      @Deprecated Thor.API.tcResultSet getUnassignedAuthorizers(long plObjectKey) throws tcAPIException, tcObjectNotFoundException, tcAPIException
      Deprecated.
      Gets a list of all the groups that logged in user is managing
      Parameters:
      plObjectKey - holding the Object Key (corresponds to value in the OBJ_KEY column)
      Returns:
      A tcResultSet, each row holding information about a group. The returning resultset has the following columns:
      • Groups.Key
      • Groups.Group Name
      Throws:
      tcAPIException
      tcObjectNotFoundException
      Since:
      9.1.0.0

    • getUnassignedAuthorizers

      @Deprecated Thor.API.tcResultSet getUnassignedAuthorizers(long plObjectKey, String groupName) throws tcAPIException, tcObjectNotFoundException, tcAPIException
      Deprecated.
      Gets a list of all the groups that logged in user is managing
      Parameters:
      plObjectKey - holding the Object Key (corresponds to value in the OBJ_KEY column)
      groupName - used to filter the records by groupName
      Returns:
      A tcResultSet, each row holding information about a group. The returning resultset has the following columns:
      • Groups.Key
      • Groups.Group Name
      Throws:
      tcAPIException
      tcObjectNotFoundException

    • getUnassignedAuditObjectives

      @Deprecated Thor.API.tcResultSet getUnassignedAuditObjectives(long plObjectKey) throws tcAPIException, tcObjectNotFoundException, tcAPIException
      Deprecated.
      Gets a list of all the resource audit objectives that are defined and unassigned to given resource object.
      Parameters:
      plObjectKey - holding the Object Key (corresponds to value in the OBJ_KEY column)
      Returns:
      A tcResultSet, each row holding information about a resource audit objectives. The returning resultset contains the following columns:
      • Lookup Definition.Lookup Code Information.Key
      • Lookup Definition.Lookup Code Information.Code Key
      • Lookup Definition.Lookup Code Information.Decode
      Throws:
      tcAPIException
      tcObjectNotFoundException
      Since:
      9.1.0.0

    • disableAppsForUsers

      @Deprecated void disableAppsForUsers(long[] paObjectInstanceKeys, long[] plUserKeys) throws tcObjectNotFoundException, tcUserNotFoundException, tcAPIException, tcBulkException, tcAPIException
      Deprecated.
      Disables the resource instances for specified users.
      Parameters:
      paObjectInstanceKeys - The key of the object instances for users in the system.
      plUserKeys - The key of the users.
      Throws:
      tcObjectNotFoundException
      tcUserNotFoundException
      tcAPIException
      tcBulkException

    • disableAppsForOrganizations

      void disableAppsForOrganizations(long[] paObjectInstanceKeys, long[] plOrganizationKeys) throws tcObjectNotFoundException, tcOrganizationNotFoundException, tcAPIException, tcBulkException, tcAPIException
      Disables the resource instances for specified organizations.
      Parameters:
      paObjectInstanceKeys - The key of the object instances for organizations in the system.
      plOrganizationKeys - The key of the organizations.
      Throws:
      tcObjectNotFoundException
      tcOrganizationNotFoundException
      tcAPIException
      tcBulkException

    • enableAppsForUsers

      @Deprecated void enableAppsForUsers(long[] paObjectInstanceKeys, long[] plUserKeys) throws tcObjectNotFoundException, tcUserNotFoundException, tcAPIException, tcBulkException, tcAPIException
      Deprecated.
      Enables the resource instances for specified users.
      Parameters:
      paObjectInstanceKeys - The key of the object instances for users in the system.
      plUserKeys - The key of the users.
      Throws:
      tcObjectNotFoundException
      tcUserNotFoundException
      tcAPIException
      tcBulkException

    • enableAppsForOrganizations

      void enableAppsForOrganizations(long[] paObjectInstanceKeys, long[] plOrganizationKeys) throws tcObjectNotFoundException, tcOrganizationNotFoundException, tcAPIException, tcBulkException, tcAPIException
      Enables the resource instances for specified organizations.
      Parameters:
      paObjectInstanceKeys - The key of the object instances for organizations in the system.
      plOrganizationKeys - The key of the organizations.
      Throws:
      tcObjectNotFoundException
      tcOrganizationNotFoundException
      tcAPIException
      tcBulkException

    • revokeAppsForUsers

      @Deprecated void revokeAppsForUsers(long[] paObjectInstanceKeys, long[] plUserKeys) throws tcObjectNotFoundException, tcUserNotFoundException, tcAPIException, tcBulkException, tcAPIException
      Deprecated.
      Revokes the resource instances for specified users.
      Parameters:
      paObjectInstanceKeys - The key of the object instances for users in the system.
      plUserKeys - The key of the users.
      Throws:
      tcObjectNotFoundException
      tcUserNotFoundException
      tcAPIException
      tcBulkException

    • revokeAppsForOrganizations

      void revokeAppsForOrganizations(long[] paObjectInstanceKeys, long[] plOrganizationKeys) throws tcObjectNotFoundException, tcOrganizationNotFoundException, tcAPIException, tcBulkException, tcAPIException
      Revokes the resource instances for the specified organizations.
      Parameters:
      paObjectInstanceKeys - The key of the object instances for organizations in the system.
      plOrganizationKeys - The key of the organizations.
      Throws:
      tcObjectNotFoundException
      tcOrganizationNotFoundException
      tcAPIException
      tcBulkException

    • getProcessesForObject

      Thor.API.tcResultSet getProcessesForObject(long objectKey) throws tcAPIException, tcObjectNotFoundException, tcAPIException
      Returns the all the process definitions asoociated with a given object
      Parameters:
      objectKey - Resource object Key
      Returns:
      a result set containing
      • Process Definition.Key
      • Process Definition.Name
      • Process Definition.Default Process
      • Process Definition.Type
      • Process.Process Definition.Process Key
      • Process.Process Definition.Auto Save
      • Structure Utility.Key
      • Tasks.Auto Prepopulate
      • ProcessDefinition-Groups.Write
      • ProcessDefinition-Groups.Delete
      Throws:
      tcAPIException - If an error occurs while retreving the processes data
      tcObjectNotFoundException - If the specified object does not exist in the system
      Since:
      8.0

    • getServiceAccountList

      Thor.API.tcResultSet getServiceAccountList(long objectKey, Map filterMap) throws tcObjectNotFoundException, tcAPIException, tcAPIException
      This method is used to get the details of all service accounts provisioned for this resource. If no filter is specified, it returns all the service accounts.
      Parameters:
      objectKey - This is the resource object key
      attributeMap - A Map of key/value pairs with which the result set needs to be filtered.
      Returns:
      A result containing information about the service accounts provisioned for this resource, with the specified filter criteria. The columns in the resultset are:
      • Object Instance.Key
      • Users.User ID
      • Users.Key
      • Users.Last Name
      • Users.First Name
      • Process Instance.Descriptive Data
      • Objects.Object Status.Status
      • Process Instance.Key
      • Users-Object Instance For User.Key
      • Objects.Object Form Key
      • Process.Process Definition.Process Form Key
      • Objects.Object Instance Key In Form
      • Process.Process Definition.Process Instance Key In Form
      Throws:
      tcAPIException
      tcObjectNotFoundException
      Since:
      8.0

    • findProvisionableObjects

      Thor.API.tcResultSet findProvisionableObjects(Map moAttributeMap) throws tcAPIException, tcAPIException
      Returns a list of objects (in the form of a tcResultSet) that match the provided attribute list, are provisionable, and order for users.
      Parameters:
      poaAttributeList - An array of tcMapping objects, each object holding the attribute-value pairs to match the group against. The Attribute names are the String column codes (from the Xellerate metadata). The Attribute Values are the String attributes to base the search on. The values could include wild cards (%).
      Returns:
      A tcResultSet containing multiple rows, each holding information about the object. The returning resultset contains the following columns:
      • Objects.Key
      • Objects.Name
      • Structure Utility.Key
      • Structure Utility.Table Name
      • Structure Utility.Description
      • Objects.Order For
      • Objects.Auto Prepopulate
      • Objects.Type
      • Objects.Allow Multiple
      • Objects.Self Request Allowed
      • Objects.Auto Save
      • Objects.Allow All
      • Objects.Note
      • Objects.Auto Launch
      • Objects.Admin Only
      • OBJ_INITIAL_RECON_DATE
      Throws:
      tcAPIException
      Since:
      8.0

    • getPwdPolicy

      boolean getPwdPolicy(String plObjectKey) throws tcAPIException, tcAPIException
      To check Resource Object form with password field has any Password policy applied.
      Parameters:
      object_key -
      Returns:
      boolean
      Throws:
      tcAPIException
      Since:
      8.0

    • getReconciliationFields

      @Deprecated Thor.API.tcResultSet getReconciliationFields(long plObjectKey) throws tcAPIException, tcObjectNotFoundException, tcAPIException
      Deprecated.
      This method will retrieve the reconciliation fields for the resource object
      Returns:
      A resultset containing detailed information regarding the reconciliation fields configured for the resource object. The returning resultset contains the following columnsL
      • Objects.Key
      • Objects.Reconciliation Fields.Key
      • Objects.Reconciliation Fields.Name
      • ORF_FIELDTYPE
      • ORF_REQUIRED
      • PARENTFIELD
      Throws:
      tcAPIException
      tcObjectNotFoundException
      Since:
      9.1.0.0

    • getAdministrators

      @Deprecated Thor.API.tcResultSet getAdministrators(Map searchCriteria) throws tcAPIException, tcObjectNotFoundException, tcAPIException
      Deprecated.
      Gets a list of all the groups that have administrative access over the specified object.
      Parameters:
      searchCriteria - Map holding the search criteria with key in Metadata form for filtering Groups e.g. Key=Groups.Group Name & Value=G1, Objects.Key=1 Metadata Keys that can be passed are as follows: Objects-Groups.Created By, Objects-Groups.Delete, Objects-Groups.Note, Objects-Groups.Updated By, Objects-Groups.Write, Groups.Created By, Groups.E-mail, Groups.Group Name, Groups.Key, Groups.Updated By
      Returns:
      A tcResultSet, each row holding information about a group.
      Throws:
      tcAPIException - Thrown if an error occurrs while retrieving the data about unassigned groups from the database
      tcGroupNotFoundException - If the specified Object Key does not exist in the databse
      tcObjectNotFoundException
      Since:
      9.2

    • getAuthorizers

      @Deprecated Thor.API.tcResultSet getAuthorizers(Map searchCriteria) throws tcAPIException, tcObjectNotFoundException, tcAPIException
      Deprecated.
      Gets a list of all the Authorizers for specified objects.
      Parameters:
      searchCriteria - Map holding the search criteria with key in Metadata form for filtering Groups e.g. Key=Groups.Group Name & Value=G1, Objects.Key=1 Metadata Keys that can be passed are as follows: Objects-Groups.Created By, Objects-Groups.Delete, Objects-Groups.Note, Objects-Groups.Updated By, Objects-Groups.Write, Groups.Created By, Groups.E-mail, Groups.Group Name, Groups.Key, Groups.Updated By
      Returns:
      A tcResultSet, each row holding information about a group.
      Throws:
      tcAPIException - Thrown if an error occurrs while retrieving the data about unassigned groups from the database
      tcGroupNotFoundException - If the specified Object Key does not exist in the databse
      tcObjectNotFoundException
      Since:
      9.2

    • updateResourceObject

      void updateResourceObject(long msObjectKey, Map attributes) throws tcObjectNotFoundException, tcAPIException, tcInvalidAttributeException, tcAPIException
      Updates the specified Resource object instance
      Parameters:
      msObjectKey - The key of the Resource object instance
      attributes - A map of name-value pairs, each entry holding an attribute-value pair to set/modify for this Resource object. The Attribute names are the String column codes (from the Xellerate metadata). The Attribute Values are the String attributes of the columns to set.
      Throws:
      tcObjectNotFoundException - If the specified Resource object instance not found
      tcAPIException - Thrown if an error occurs while retrieving the data about unassigned groups from the database
      tcInvalidAttributeException - If one or more of the attributes in the map are invalid attributes of the specified Resource object instance
      Since:
      11.1.1.4.0