## Uses of Class
com.ibm.openpages.api.metadata.Id

- Packages that use Id
  Package | Description
  --- | ---
  com.ibm.openpages.api.application | Provides OpenPages application specific functions
  com.ibm.openpages.api.audit | Provides interfaces to work with the OpenPages audit trail.
  com.ibm.openpages.api.configuration | Provides interfaces to work with the OpenPages system configuration.
  com.ibm.openpages.api.metadata | This package and its components provides access to OpenPages metadata.
  com.ibm.openpages.api.process | This package and its components provides access to long running process objects.
  com.ibm.openpages.api.questionnaire | This package and its components provides access to questionnaire objects.
  com.ibm.openpages.api.resource | Provides interfaces to work with the OpenPages content data: folders, GRC objects and document attachments.
  com.ibm.openpages.api.respview | Provides interfaces to work with the OpenPages responsive views.
  com.ibm.openpages.api.rule |
  com.ibm.openpages.api.scheduler |
  com.ibm.openpages.api.search | Provides interfaces to work with the OpenPages Global Search, allowing for cross-object search against all data configured by administrators to be indexed for search.
  com.ibm.openpages.api.security | Provides interfaces to work with the OpenPages security data: users, groups, and role-based security.
  com.ibm.openpages.api.service | Provides the main interfaces to work with the API services.
  com.ibm.openpages.api.solution |
  com.ibm.openpages.api.theme |
  com.ibm.openpages.api.trigger.events | All types of events supported by the GRC Trigger framework.
  com.ibm.openpages.api.workflow | Provides interfaces to work with native workflow system.

- - ### Uses of Id in com.ibm.openpages.api.application

    Methods in com.ibm.openpages.api.application that return Id
    Modifier and Type | Method and Description
    --- | ---
    `Id` | TypeAssociationToHonor.`getChildTypeId()` Gets the child type Id of the TypeAssociationToHonor
    `Id` | TypeAssociationToHonor.`getParentTypeId()` Gets the non primary parent type Id of the TypeAssociationToHonor

    Methods in com.ibm.openpages.api.application that return types with arguments of type Id
    Modifier and Type | Method and Description
    --- | ---
    `java.util.Map<Id,java.lang.String>` | CopyObjectOptions.`getNameOverrides()` Specifies a name to set on the copy of each Id.

    Methods in com.ibm.openpages.api.application with parameters of type Id
    Modifier and Type | Method and Description
    --- | ---
    `void` | TypeAssociationToHonor.`setChildTypeId(Id childTypeId)` Sets the child type Id of the TypeAssociationToHonor
    `void` | TypeAssociationToHonor.`setParentTypeId(Id parentTypeId)` Sets the non primary parent type Id of the TypeAssociationToHonor

    Method parameters in com.ibm.openpages.api.application with type arguments of type Id
    Modifier and Type | Method and Description
    --- | ---
    `void` | CopyObjectOptions.`setNameOverrides(java.util.Map<Id,java.lang.String> nameOverrides)` Optionally specifies an explicit name to set on the copy of each Id.

    Constructors in com.ibm.openpages.api.application with parameters of type Id
    Constructor and Description
    `TypeAssociationToHonor(Id parentTypeId, Id childTypeId)` Constructor to get the instance of TypeAssociationToHonor

  - ### Uses of Id in com.ibm.openpages.api.audit

    Methods in com.ibm.openpages.api.audit that return Id
    Modifier and Type | Method and Description
    --- | ---
    `Id` | IAuditLog.`getId()` Gets the Id of the object.

  - ### Uses of Id in com.ibm.openpages.api.configuration

    Methods in com.ibm.openpages.api.configuration that return Id
    Modifier and Type | Method and Description
    --- | ---
    `Id` | IReportingPeriod.`getId()`
    `Id` | IProfile.`getId()` Returns the profile unique Id.
    `Id` | IExchangeRate.`getId()` Returns the id associated to an exchange rate.
    `Id` | ICurrency.`getId()` Returns id associated to a currency.
    `Id` | IProfileFieldDefinition.`getProfileFieldId()` Returns the unique Profile Field Id for this Field Definition in the requested Profile.
    `Id` | IProfileFieldDefinition.`getProfileTypeDefinitionId()` Returns the Profile Object Type Definition Id for the Type that this Field Definition belongs to on the requested Type and Profile.

    Methods in com.ibm.openpages.api.configuration with parameters of type Id
    Modifier and Type | Method and Description
    --- | ---
    `IDashboardView` | IConfigurationFactory.`createDashboardView(Id profileId, java.lang.String name)` Creates an on-memory instance of dashboard view.

  - ### Uses of Id in com.ibm.openpages.api.metadata

    Methods in com.ibm.openpages.api.metadata that return Id
    Modifier and Type | Method and Description
    --- | ---
    `Id` | ITypeDefinition.`getId()` Returns the unique identifier for this type.
    `Id` | IFileTypeDefinition.`getId()` Return the unique Id associated with the file type definition.
    `Id` | IFieldDefinition.`getId()` Returns the unique id associated with the field definition.
    `Id` | IEnumValue.`getId()` Returns `Id` - unique identifier of the enum value.
    `Id` | IAssociationDefinition.`getId()` Returns the Id of the association.
    `Id` | IEnumValue.`getParentId()` Returns the parenid for hierarchical `IEnumValue`s, or null.
    `Id` | ITypeDefinition.`getRootFolderId()` Returns the unique identifier for this type root folder.

    Methods in com.ibm.openpages.api.metadata with parameters of type Id
    Modifier and Type | Method and Description
    --- | ---
    `IAssociationDefinition` | ITypeDefinition.`getAssociationDefinition(Id id)` Returns the association based on the Id.
    `java.util.List<IEnumValue>` | IFieldDefinition.`getDescendantEnumValuesByParentId(Id enumValueId)` Returns the IEnumValue by its Id.
    `IEnumValue` | IFieldDefinition.`getEnumValueById(Id enumValueId)` Returns the IEnumValue by its Id.
    `IFieldDefinition` | ITypeDefinition.`getField(Id id)` Returns the field definition with the specified Id.

  - ### Uses of Id in com.ibm.openpages.api.process

    Methods in com.ibm.openpages.api.process that return Id
    Modifier and Type | Method and Description
    --- | ---
    `Id` | ProcessQueryOptions.`getCreatedById()` The creator (user) id of querying processes.
    `Id` | IProcessLog.`getErrorMessageId()` Returns the id of the error code of the process log.
    `Id` | AbstractExternalProcess.`getInternalObjId()`
    `Id` | ProcessQueryOptions.`getParentProcessId()` The parent process id of querying processes.
    `Id` | IProcessInfo.`getParentProcessId()` Returns the creator (user) of the process.
    `Id` | ProcessQueryOptions.`getProcessId()` The process id to query.
    `Id` | IProcessLog.`getProcessId()` Returns the id of the process.
    `Id` | IProcessInfo.`getProcessId()` Returns the id of the process.
    `Id` | AbstractExternalProcess.`getProcessId()`
    `Id` | IProcessLog.`getProcessLogId()` Returns the id of the process log.
    `Id` | IProcessType.`getProcessTypeId()` Returns the id of the process type.
    `Id` | IProcessInfo.`getProcessTypeId()` Returns the process type id of the process.
    `Id` | IProcessLog.`getStatusTranslationStringId()` Returns the id of the message of the process log.

    Methods in com.ibm.openpages.api.process that return types with arguments of type Id
    Modifier and Type | Method and Description
    --- | ---
    `java.util.List<Id>` | ProcessQueryOptions.`getProcessTypes()` The process types of querying processes.

    Methods in com.ibm.openpages.api.process with parameters of type Id
    Modifier and Type | Method and Description
    --- | ---
    `void` | ProcessQueryOptions.`addProcessType(Id processTypeId)` Add a process type id of querying processes.
    `void` | ProcessQueryOptions.`setCreatedById(Id createdById)` Set the creator (user) id of querying processes.
    `void` | ProcessQueryOptions.`setParentProcessId(Id parentProcessId)` Set the parent process id of querying processes.
    `void` | ProcessQueryOptions.`setProcessId(Id processId)` Set The process id to query.
    `void` | AbstractExternalProcess.`setProcessId(Id processId)`

  - ### Uses of Id in com.ibm.openpages.api.questionnaire

    Methods in com.ibm.openpages.api.questionnaire that return Id
    Modifier and Type | Method and Description
    --- | ---
    `Id` | ProgramValidationResult.`getAssetContentTypeId()`
    `Id` | ProgramValidationResult.`getCopyFromTemplateId()` The Id of the copy from Questionnaire Template object used by the Program.
    `Id` | IQuestionnaireBase.`getId()` Returns the Id of this questionnaire resource.
    `Id` | IComment.`getId()`
    `Id` | IAttachment.`getId()`
    `Id` | IQuestionnaireBase.`getParentId()` Returns the Id of the parent resource for sub-sections and questions.
    `Id` | IComment.`getQuestionId()`
    `Id` | IAttachment.`getQuestionId()`
    `Id` | ProgramValidationResult.`getTemplateId()` The Id of the Questionnaire Template object used by the Program.

    Methods in com.ibm.openpages.api.questionnaire with parameters of type Id
    Modifier and Type | Method and Description
    --- | ---
    `IAttachment` | IQuestionnaireFactory.`createAttachment(Id questionId, Id attachmentId)` Creates an attachment object in memory, which is persisted via `IQuestionnaireService.saveQuestionnaire(IQuestionnaire)` after being added to `IQuestionnaire` by `IQuestionnaire.addAttachment(IAttachment)`.
    `IComment` | IQuestionnaireFactory.`createComment(Id questionId, java.lang.String text, boolean isRejection)` Deprecated. This method is deprecated as of release 7.3.0.1, use method `IQuestionnaireFactory.createComment(Id, String, CommentType)` instead.
    `IComment` | IQuestionnaireFactory.`createComment(Id questionId, java.lang.String text, boolean isRejection, boolean isAcceptance)` Deprecated. This method is deprecated as of release 7.3.0.1, use method `IQuestionnaireFactory.createComment(Id, String, CommentType)` instead.
    `IComment` | IQuestionnaireFactory.`createComment(Id questionId, java.lang.String text, CommentType commentType)` Creates a comment object in memory, which is persisted via `IQuestionnaireService.saveQuestionnaire(IQuestionnaire)` after being added to `IQuestionnaire` by `IQuestionnaire.addComment(IComment)` .
    `IQuestion` | IQuestionnaireFactory.`createQuestion(Id parentSubSectionId)` Creates a question object in memory, which is persisted via `IQuestionnaireService.saveQuestionnaire(IQuestionnaire)` after being added to `IQuestionnaire` by `IQuestionnaire.addQuestion(IQuestion)`.
    `ISection` | IQuestionnaireFactory.`createSubSection(Id parentSectionId)` Creates a subsection object in memory, which is persisted via `IQuestionnaireService.saveQuestionnaire(IQuestionnaire)` after being added to `IQuestionnaire` by `IQuestionnaire.addSection(ISection)`.
    `IQuestion` | IQuestionnaire.`getQuestionBy(Id id)` Returns a question that has the specified id.
    `ISection` | IQuestionnaire.`getSectionBy(Id id)` Returns a section or sub-section that has the specified id.
    `void` | IQuestionnaire.`removeQuestion(Id questionId)` Remove a question from the question.
    `void` | IQuestionnaire.`removeSection(Id sectionId)` Remove a section from the section.

    Constructors in com.ibm.openpages.api.questionnaire with parameters of type Id
    Constructor and Description
    `ProgramValidationResult(Id templateId, Id assetContentTypeId, int totalAssets, int totalAssessments, java.lang.String messageKey, java.util.List<java.lang.String> messageParams)` The constructor of ProgramValidationResult.
    `ProgramValidationResult(Id templateId, Id assetContentTypeId, int totalAssets, int totalAssessments, java.lang.String messageKey, java.util.List<java.lang.String> messageParams, Id copyFromTemplateId, boolean allQuestionsMatched, int totalMatchingQuestions)` The constructor of ProgramValidationResult.

  - ### Uses of Id in com.ibm.openpages.api.resource

    Methods in com.ibm.openpages.api.resource that return Id
    Modifier and Type | Method and Description
    --- | ---
    `Id` | IDeletedResource.`getCreator()` Returns the creator id of this resource.
    `Id` | IResource.`getId()` Returns the Id of this resource.
    `Id` | IField.`getId()` Returns the id for this field.
    `Id` | IDeletedResource.`getId()` Returns the Id of this resource.
    `Id` | IAssociationNode.`getId()` Returns the id of this node.
    `Id` | IDeletedResource.`getLastModifiedBy()` Returns the user id who last modified this resource.
    `Id` | IGRCObject.`getPrimaryParent()` Returns the primary parent GRCObject Id.
    `Id` | IResourcePermission.`getResourceId()` The Resource Permissions are describing the access to a particular OpenPages resource.
    `Id` | IDeletedResource.`getTypeDefinitionId()` Returns the type definition id for this resource.
    `Id` | IReferenceField.`getValue()` Returns the field value as a reference Id.
    `Id` | IIdField.`getValue()` Returns the value as an Id.

    Methods in com.ibm.openpages.api.resource that return types with arguments of type Id
    Modifier and Type | Method and Description
    --- | ---
    `java.util.List<Id>` | IGRCObject.`getActiveWorkflowIds()` Returns a list of ids for the active workflows associated with this GRC Object.
    `java.util.Map<Id,java.util.List<OpenPagesException>>` | IGRCObject.`getCalcLogs()` Returns a Map of calculation error results if there is, such as circular calculation.

    Methods in com.ibm.openpages.api.resource with parameters of type Id
    Modifier and Type | Method and Description
    --- | ---
    `IField` | IGRCObject.`getField(Id fieldId)` Returns a field based on its field definition Id.
    `IEnumAnswer` | IEnumAnswersField.`removeEnumAnswerById(Id id)` Removes an enum answer entry by Id.
    `void` | IGRCObject.`setPrimaryParent(Id grcObjectId)` Sets the primary parent.
    `void` | IReferenceField.`setValue(Id value)` Sets the field value with a reference Id.

    Method parameters in com.ibm.openpages.api.resource with type arguments of type Id
    Modifier and Type | Method and Description
    --- | ---
    `void` | IGRCObject.`addChildren(java.util.List<Id> children)` Adds children for object creation via `IResourceService.saveResource(IResource)`.
    `void` | IGRCObject.`addParents(java.util.List<Id> parents)` Adds additional non-primary parents for object creation via `IResourceService.saveResource(IResource)`.

  - ### Uses of Id in com.ibm.openpages.api.respview

    Methods in com.ibm.openpages.api.respview that return Id
    Modifier and Type | Method and Description
    --- | ---
    `Id` | IDashboardWidget.`getFilterId()` Returns the filter Id
    `Id` | IDashboardPanel.`getFilterId()` Returns the filter Id
    `Id` | IRespViewContainer.`getId()` Returns the unique identifier for this responsive view.
    `Id` | IDashboardView.`getProfileId()` Returns object profile ID
    `Id` | IRespViewField.`getRelationFilterId()` Returns the id of the relation filter.
    `Id` | IDashboardTab.`getReportId()` Returns the reportId of the report tab
    `Id` | RespViewFilter.`getTypeDefinitionId()` Returns Id of the type definition that is used for filtering

    Methods in com.ibm.openpages.api.respview with parameters of type Id
    Modifier and Type | Method and Description
    --- | ---
    `void` | IDashboardWidget.`setFilterId(Id filterId)` Sets the filter Id
    `void` | IDashboardPanel.`setFilterId(Id filterId)` Sets the filter Id
    `void` | IRespViewField.`setRelationFilterId(Id filterId)` Sets the id of the relation filter.
    `void` | IDashboardTab.`setReportId(Id id)` Sets the report id of the report tab
    `void` | RespViewFilter.`setTypeDefinitionId(Id typeDefinitionId)` Sets Id of the type definition that is used for filtering

  - ### Uses of Id in com.ibm.openpages.api.rule

    Methods in com.ibm.openpages.api.rule that return Id
    Modifier and Type | Method and Description
    --- | ---
    `Id` | TBCalcLog.`getCalcId()` Returns calculation definition Id
    `Id` | ITBRuleDefinition.`getId()` Returns unique identifier of the rule definition
    `Id` | ITBRuleAction.`getId()` Returns unique identifier of the rule action definition
    `Id` | BulkRunCalculationsOptions.`getRuleDefinitionId()` Returns Id of the rule definition to start.
    `Id` | ITBRuleAction.`getRuleId()` Returns identifier of the rule definition
    `Id` | ITBRuleAction.`getRuleVersionId()` Returns version id of the rule definition.
    `Id` | ITBRuleDefinition.`getVersionId()` Returns version id of the rule definition.
    `Id` | ITBRuleAction.`getWFProcessDefinitionId()` Returns id of the workflow process definition.

    Methods in com.ibm.openpages.api.rule that return types with arguments of type Id
    Modifier and Type | Method and Description
    --- | ---
    `java.util.List<Id>` | BulkRunCalculationsOptions.`getResourceIds()` Returns resource Ids to start calculations.

    Methods in com.ibm.openpages.api.rule with parameters of type Id
    Modifier and Type | Method and Description
    --- | ---
    `void` | ITBRuleAction.`setId(Id id)`
    `void` | BulkRunCalculationsOptions.`setRuleDefinitionId(Id ruleDefinitionId)` Assigns Id of the rule definition to start.
    `void` | ITBRuleAction.`setRuleId(Id ruleId)`
    `void` | ITBRuleAction.`setRuleVersionId(Id ruleVersionId)`
    `void` | ITBRuleAction.`setWFProcessDefinitionId(Id id)` Sets id of the workflow process definition.

    Method parameters in com.ibm.openpages.api.rule with type arguments of type Id
    Modifier and Type | Method and Description
    --- | ---
    `void` | BulkRunCalculationsOptions.`setResourceIds(java.util.List<Id> resourceIds)` Assigns resource Ids to start calculations.

    Constructors in com.ibm.openpages.api.rule with parameters of type Id
    Constructor and Description
    `TBCalcLog(Id ruleId, OpenPagesException log)`

  - ### Uses of Id in com.ibm.openpages.api.scheduler

    Methods in com.ibm.openpages.api.scheduler that return Id
    Modifier and Type | Method and Description
    --- | ---
    `Id` | ISchedJobSchedule.`getId()` Returns unique identifier of the job schedule
    `Id` | ISchedJobInstance.`getId()` Returns unique identifier of this `ISchedJobInstance`
    `Id` | ISchedJobDetail.`getId()` Returns unique identifier of the job detail
    `Id` | ISchedJobConfigurationItem.`getId()` Get the Id of the job field configuration
    `Id` | ISchedulerJobInstanceFindOptions.`getJobId()` Get Job ID
    `Id` | IScheduleJobFindOptions.`getJobId()` Get the job id.
    `Id` | ISchedJobSchedule.`getJobId()` Get the Id of the job to which this schedule belongs
    `Id` | ISchedJobInstance.`getJobId()`
    `Id` | ISchedJobConfigurationItem.`getJobId()` Get the Id of the job to which this configuration field belongs
    `Id` | ISchedJobInstance.`getJobInstanceProcId()`
    `Id` | ISchedJobInstance.`getJobScheduleId()`

    Methods in com.ibm.openpages.api.scheduler with parameters of type Id
    Modifier and Type | Method and Description
    --- | ---
    `void` | ISchedJobConfiguration.`addConfigurationItem(Id jobId, java.lang.String name, java.lang.String type, java.lang.String value, boolean isEncrypted)` Add a field definition for the job configuration
    `void` | ISchedulerJobInstanceFindOptions.`setJobId(Id jobId)` Set Job Id.
    `void` | IScheduleJobFindOptions.`setJobId(Id jobId)` Set the job id.
    `void` | ISchedJobSchedule.`setJobId(Id id)` Set the Id of the Job to which this schedule belongs
    `void` | ISchedJobConfigurationItem.`setJobId(Id jobId)` Set the Id of the job to which this configuration field belongs

  - ### Uses of Id in com.ibm.openpages.api.search

    Methods in com.ibm.openpages.api.search that return Id
    Modifier and Type | Method and Description
    --- | ---
    `Id` | ISearchResource.`getId()` Returns the Resource Id of this resource.
    `Id` | ISearchResource.`getParentFolderId()` Returns the parent folder for this resource, if it exists; otherwise null.

    Methods in com.ibm.openpages.api.search that return types with arguments of type Id
    Modifier and Type | Method and Description
    --- | ---
    `java.util.List<Id>` | SearchFacetOptions.`getMimeTypeIDs()` Get the facet value for MIME type.
    `java.util.List<Id>` | SearchFacetOptions.`getObjectTypeIDs()` Get the facet value for object-types.

    Method parameters in com.ibm.openpages.api.search with type arguments of type Id
    Modifier and Type | Method and Description
    --- | ---
    `void` | SearchFacetOptions.`setMimeTypeIDs(java.util.List<Id> mimeTypeIDs)` Set the facet value for MIME type.
    `void` | SearchFacetOptions.`setObjectTypes(java.util.List<Id> objectTypeIDs)` Set the facet value for object-types.

  - ### Uses of Id in com.ibm.openpages.api.security

    Methods in com.ibm.openpages.api.security that return Id
    Modifier and Type | Method and Description
    --- | ---
    `Id` | IUser.`getId()` Returns OpenPages system Id of the user.
    `Id` | ISecurityPrincipal.`getId()` Returns the Id for a security principal.
    `Id` | IRoleTemplate.`getId()` Returns the Id for this role template.
    `Id` | IRoleAssignment.`getId()` Returns the Id of the assignment.
    `Id` | IObjectPermission.`getId()` Returns the Id for this object-level permission.
    `Id` | IApplicationPermission.`getId()` Returns the Id associated with an application permission.
    `Id` | IAdminPermission.`getId()` Returns the Id for this administrative permission.
    `Id` | IObjectPermission.`getRootFolderId()` Returns Id of root folder associated to permission.

    Methods in com.ibm.openpages.api.security that return types with arguments of type Id
    Modifier and Type | Method and Description
    --- | ---
    `java.util.List<Id>` | IUser.`getGroupIds()` Returns a list of group Ids that the user belongs to.
    `java.util.List<Id>` | ISecurityPrincipal.`getPermissionIds()` Returns a list of Id for application permissions.
    `java.util.List<Id>` | IGroup.`getRoleAssignmentIds()` Returns a list of Id for role assignments.
    `java.util.List<Id>` | IGroup.`getUserIds()` Returns all user Ids directly associated with a security group.

    Method parameters in com.ibm.openpages.api.security with type arguments of type Id
    Modifier and Type | Method and Description
    --- | ---
    `void` | ISecurityPrincipal.`revokeAdminPermissions(java.util.List<Id> adminPermissionIds)` Revokes list of administrative permissions associated to security principal.

  - ### Uses of Id in com.ibm.openpages.api.service

    Methods in com.ibm.openpages.api.service that return Id
    Modifier and Type | Method and Description
    --- | ---
    `Id` | ISchedulerService.`createJobInstance(ISchedJobDetail jobDetail, java.lang.String triggerKey, Id processId)` Creates a new `ISchedJobInstance`.
    `Id` | IResourceService.`decryptWithExternalKey()` DecryptWithExternalKey - it starts a long running process which decrypts the following 1.
    `Id` | IResourceService.`encryptWithExternalKey()` EncryptWithExternalKey - it starts a long running process which encrypts the following 1.
    `Id` | IConfigurationService.`getApplicableAdminView(ITypeDefinition typeDefinition)` Returns Id of the responsive view that is applicable to the input GRC object, or null if there is no applicable view.
    `Id` | IConfigurationService.`getApplicableAdminView(ITypeDefinition typeDefinition, java.lang.String profileName)` Returns Id of the responsive view that is applicable to the input GRC object for a specific profile, or null if there is no applicable view.
    `Id` | IConfigurationService.`getApplicableCreationView(ITypeDefinition typeDefinition, ITypeDefinition parentTypeDefinition)` Returns Id of the responsive view that is applicable to the input GRC object, or null if there is no applicable view.
    `Id` | IConfigurationService.`getApplicableCreationView(ITypeDefinition typeDefinition, ITypeDefinition parentTypeDefinition, java.lang.String profileName)` Returns Id of the responsive view that is applicable to the input GRC object, or null if there is no applicable view.
    `Id` | IConfigurationService.`getApplicableGridView(ITypeDefinition typeDefinition)` Returns Id of the responsive view that is applicable to the input GRC object, or null if there is no applicable view.
    `Id` | IConfigurationService.`getApplicableTaskView(IGRCObject grcObject)` Returns Id of the responsive view that is applicable to the input GRC object, or null if there is no applicable view.
    `Id` | IResourceService.`getIdForPath(java.lang.String fullPath)` Retrieves just the Id for a GRC Object or Folder given a full path without retrieving the entire object.
    `Id` | IApplicationService.`launchLogCollector(LaunchLogCollectorOptions options)` Launch Log Collector tool Starting 8.3 release, the log collector is run on all the clustered application servers and log zips are available on the child processes
    `Id` | IApplicationService.`launchLogCollector(LaunchLogCollectorOptions options, ProcessId parentProcessID)` Launch log collector tool only on the current application server
    `Id` | ISchedulerService.`launchProcess(AbstractScheduledProcess process)` Runs the process within the Long Running Process framework.
    `Id` | IQuestionnaireService.`launchProgram(Id programId, LaunchProgramOptions options)` Launch a program - it starts a long running process which creates assessment objects for asset objects one-by-one and send e-mail to the asset owners.
    `Id` | IWorkflowService.`startBulkWorkflowAction(BulkWorkflowActionOptions wfOptions)` Executes the selected action on the given set of resources, through a long running process
    `Id` | ITBRuleService.`startCalculationsInBulk(BulkRunCalculationsOptions options)` Starts calculations on any objects that meet the following criteria, through a long running process - on the object type of the calculation - object is unlocked - the object meets the applicability criteria of the calculation definition
    `Id` | IWorkflowService.`startProcessesInBulk(StartProcessesOptions wfOptions)` Starts workflow process on any objects that meet the following criteria, through a long running process - on the object type referred by the process definition - there is no active workflow on the object - object is unlocked - the object meets the applicability criteria of the process definition

    Methods in com.ibm.openpages.api.service that return types with arguments of type Id
    Modifier and Type | Method and Description
    --- | ---
    `java.util.List<Id>` | IResourceService.`canCreateObjectsForTypes(Id userId, java.util.List<Id> typesToCreate)` Considers Folder based security, Role based security and Rule based security globally to check for a list of potential object types which ones the user may have access to create.
    `java.util.List<Id>` | IResourceService.`canCreateObjectsForTypes(java.util.List<Id> typesToCreate, Id intendedParentObject)` Considers Folder based security, Role based security and Rule based security to check for a list of potential object types which ones the current user may have access to create for a specific intended parent GRC Object.
    `java.util.List<Id>` | ISecurityService.`getActorImpersonates(Id actorId)` Find all actors, users or groups, that the given actor impersonates.
    `java.util.Map<Id,java.util.Set<Id>>` | ITBRuleService.`getAsyncCalculationRequests(java.util.Set<Id> resourceIds)` Returns the resources in the asynchronous calculation queue.
    `java.util.Map<Id,java.util.Set<Id>>` | ITBRuleService.`getAsyncCalculationRequests(java.util.Set<Id> resourceIds)` Returns the resources in the asynchronous calculation queue.
    `java.util.Map<Id,TBCalcCounts>` | ITBRuleService.`getCalcStats(java.util.Set<Id> calcDefIds)` Returns the statistics of the calculations such as how many resources are in the queue for asynchronous calculation, or how many resources have calculation errors for a given calculation definition.

    Methods in com.ibm.openpages.api.service with parameters of type Id
    Modifier and Type | Method and Description
    --- | ---
    `java.util.List<ISolutionTypeDefinition>` | ISolutionService.`addTypeDefinitionsToSolution(java.util.List<java.lang.String> typeDefinitionNames, Id solutionId)` Creates the associations between a solution and the list of typedefinitions.
    `ISolutionTypeDefinition` | ISolutionService.`addTypeDefinitionToSolution(java.lang.String typeDefinitionName, Id solutionId)` Creates the association between a solution and a typedefinition.
    `void` | ISecurityService.`anonymizeUser(Id userId, java.lang.String anonymizedText)` Anonymize the specified user attributes from OpenPages security system.
    `void` | IResourceService.`associate(Id grcObject, java.util.List<Id> parents, java.util.List<Id> children)` Associate a list of parents, children to a given object.
    `void` | IConfigurationService.`associateProfilesToUser(Id userId, java.util.List<Id> profileIds)` Associates a list of profiles to a user.
    `void` | IConfigurationService.`associateUsersToProfile(Id profileId, java.util.List<Id> userIds)` Associates a list of users to a profile.
    `boolean` | IResourceService.`canCreate(ITypeDefinition intendedTypeToCreate, Id intendedFolder, Id intendedParent)` Checks if the current user has the permissions to create a GRC Object.
    `java.util.List<Id>` | IResourceService.`canCreateObjectsForTypes(Id userId, java.util.List<Id> typesToCreate)` Considers Folder based security, Role based security and Rule based security globally to check for a list of potential object types which ones the user may have access to create.
    `java.util.List<Id>` | IResourceService.`canCreateObjectsForTypes(java.util.List<Id> typesToCreate, Id intendedParentObject)` Considers Folder based security, Role based security and Rule based security to check for a list of potential object types which ones the current user may have access to create for a specific intended parent GRC Object.
    `java.util.List<IGRCObject>` | IApplicationService.`copyToParent(Id parentObjectId, java.util.List<Id> childrenToCopy, CopyObjectOptions copyOptions)` Copies one or more GRCObjects to a parent GRCObject based on the CopyObjectOptions and returns the copies made for each of the childrenToCopy that are specified.
    `Id` | ISchedulerService.`createJobInstance(ISchedJobDetail jobDetail, java.lang.String triggerKey, Id processId)` Creates a new `ISchedJobInstance`.
    `void` | IQuestionnaireService.`deleteAssessmentComments(Id assessmentId, Id questionTemplateId, java.lang.String newComment)` Deletes question comments for a specific assessment, and add a new comment to questions whose comments been deleted for the deleting operation.
    `void` | IResourceService.`deleteResource(Id resourceId)` Delete a resource by id and all its associated primary children resources as well.
    `void` | ISolutionService.`deleteSolution(Id solutionId)` Deletes a solution object by Id.
    `void` | ISolutionService.`deleteSolutionLayout(Id solutionLayoutId)` Deletes a solution layout object by Id.
    `void` | IConfigurationService.`disassociateProfilesFromUser(Id userId, java.util.List<Id> profileIds)` Disassociates a list of profiles from a user.
    `void` | IConfigurationService.`disassociateUsersFromProfile(Id profileId, java.util.List<Id> userIds)` Disassociates a list of users to a profile.
    `IWFProcessDefinition` | IWorkflowService.`discardDraftDefinition(Id processDefinitionId)` Discard the draft content of the process definition.
    `ITBRuleDefinition` | ITBRuleService.`discardDraftRuleDefinition(Id ruleDefinitionId)` Discard the draft content of the rule definition.
    `void` | IResourceService.`dissociate(Id grcObject, java.util.List<Id> parents, java.util.List<Id> children)` Dissociate a list of parents, children to a given object.
    `int` | ITBRuleService.`estimateStartingCalculationsInBulk(Id ruleDefinitionId)` Returns estimated count that would meet the criteria to run the calculation in bulk
    `int` | IWorkflowService.`estimateStartingProcessesInBulk(Id processDefinitionId)` Returns estimated count that would meet the criteria to start the workflow processes in bulk
    `boolean` | IWorkflowService.`evaluateCondition(IWFConditionEval conditionEval, Id resourceId)` Evaluates condition in the context of specified resource that does not necessarily have active workflow.
    `java.util.List<ITBRuleDefinition>` | ITBRuleService.`evaluateRules(java.util.List<ITBRuleDefinition> rules, Id resourceId)` Evaluates a list of rules against a resource and returns the valid rules.
    `void` | ITBRuleService.`executeRules(java.util.List<ITBRuleDefinition> rules, Id resourceId)` Evaluates and executes a list of rules on a resource.
    `boolean` | IResourceService.`exists(Id parentFolderId, java.lang.String resourcName, boolean defaultSuffix)` Checks whether a resource with the name already exists in the folder.
    `java.util.List<IWFProcess>` | IWorkflowService.`getActiveProcesses(Id resourceId)` Returns list of active processes (open/executing) for the given resource id.
    `IWFActivity` | IWorkflowService.`getActivity(Id activityId, Id procDefId)`
    `java.util.List<IWFActivityInstance>` | IWorkflowService.`getActivityInstances(Id processId)` Retrieves the list of activity instances for the given process id.
    `java.util.List<Id>` | ISecurityService.`getActorImpersonates(Id actorId)` Find all actors, users or groups, that the given actor impersonates.
    `IApplicationPermission` | ISecurityService.`getApplicationPermission(Id id)` Retrieves application permission by Id.
    `java.util.List<IAuditLog>` | IAuditService.`getAssociationAuditLog(Id id)` Retrieves a List of AssociationAuditLogs for a given GRCObject Id.
    `java.util.List<IAuditLog>` | IAuditService.`getAssociationAuditLog(Id id, AuditLogFilter filter)` Retrieves a list of AssociationAuditLogs for a given GRCObject Id.
    `java.util.List<IAuditLog>` | IAuditService.`getAuditLog(Id id)` Retrieves a list of all AuditLogs (IFieldAuditLog, IAssociationAuditLog) for a given GRCObject Id.
    `java.util.List<IAuditLog>` | IAuditService.`getAuditLog(Id id, AuditLogFilter filter)` Retrieves a list of all AuditLogs (IFieldAuditLog, IAssociationAuditLog) for a given GRCObject Id and AuditLogFilter.
    `IDashboardView` | IConfigurationService.`getDashboard(Id dashboardId, RespViewState viewState)` Returns a dashboard view
    `IDashboardView` | IConfigurationService.`getDashboard(Id profileId, java.lang.String viewName, RespViewState viewState)` Returns a dashboard view
    `IResourcePermission` | IResourceService.`getEffectivePermissions(Id userOrGroup, Id resourceToCheck)` Retrieves the effective resource permissions, read, write, delete, and associate that a user has for a specific OpenPages resource.
    `IFieldDefinition` | IMetaDataService.`getField(Id id)` Returns a Field Definition by propertyid.
    `java.util.List<IAuditLog>` | IAuditService.`getFieldAuditLog(Id id)` Retrieves a list of FieldAuditLogs for a given GRCObject Id.
    `java.util.List<IAuditLog>` | IAuditService.`getFieldAuditLog(Id id, AuditLogFilter filter)` Retrieves a list of FieldAuditLogs for a given GRCObject Id.
    `IFileTypeDefinition` | IMetaDataService.`getFileType(Id id)` Return a supported file type based on it's Id.
    `IFolder` | IResourceService.`getFolder(Id id)` Get a Folder object by Id for the current period.
    `IFolder` | IResourceService.`getFolder(Id id, FolderFilter filter)` Get a Folder object by Id.
    `IGRCObject` | IResourceService.`getGRCObject(Id id)` Get a GRC object by Id for the the current period including all fields and no associations.
    `IGRCObject` | IResourceService.`getGRCObject(Id id, GRCObjectFilter filter)` Get a GRC object by ID with specified filter for fields and associations.
    `IGroup` | ISecurityService.`getGroup(Id groupId)` Retrieves group by Id.
    `IGroup` | ISecurityService.`getGroup(Id groupId, GroupOptions options)` Retrieves group by Id.
    `ISchedJobDetail` | ISchedulerService.`getJob(Id jobId)`
    `ISchedJobConfiguration` | ISchedulerService.`getJobConfiguration(Id jobId)`
    `SchedulerJobInstanceList` | ISchedulerService.`getJobInstances(Id jobId)`
    `ISchedJobInstance` | ISchedulerService.`getLastManualRun(Id jobId, java.lang.String category)`
    `ISchedJobInstance` | ISchedulerService.`getLastScheduledRun(Id jobId, java.lang.String category)`
    `IProcessInfo` | IProcessService.`getLatestProcess(Id processTypeId)` Get latest process information of a specific process type.
    `java.lang.String` | IConfigurationService.`getLocalizedApplicationText(Id keyId)` Retrieve the translated string associated with the key id.
    `IWFProcess` | IWorkflowService.`getProcess(Id processId)` Retrieves a process object for the given id.
    `IProcessInfo` | IProcessService.`getProcess(Id processId)` Get the process information of a specific process.
    `IWFProcessDefinition` | IWorkflowService.`getProcessDefinition(Id processDefinitionId, boolean draft)` Returns a process definition by ID
    `IWFProcessDefinition` | IWorkflowService.`getProcessDefinition(java.lang.String name, Id typeDefinitionId, boolean draft)` Returns a process definition by name, type definition ID
    `IWFProcessDefinition` | IWorkflowService.`getProcessDefinitionByVersionId(Id versionId)` Returns a process definition by the version ID
    `java.util.List<IWFProcessDefinition>` | IWorkflowService.`getProcessDefinitions(Id processDefinitionId)` Returns the published and draft versions of the process definition if they exist.
    `java.util.List<IWFProcessEvent>` | IWorkflowService.`getProcessEventLog(Id processId)` Retrieves the list of process events for the given process id.
    `java.util.List<IWFProcessEvent>` | IWorkflowService.`getProcessEventLog(Id processId, Id activityInstanceId, java.util.List<WFProcessEventType> types)` Retrieves process events for the given parameters.
    `java.util.List<IProcessLog>` | IProcessService.`getProcessLogs(Id processId, ProcessLogQueryOptions options)` Get process logs of a specific process.
    `IProfile` | IConfigurationService.`getProfile(Id profileId)` Returns the profile associated with the specified profile Identifier.
    `IQuestionnaire` | IQuestionnaireService.`getQuestionnaire(Id id)` Get a questionnaire object by Id for the the current period including all sections and questions
    `IRespView` | IConfigurationService.`getRespView(Id respViewId, RespViewState viewState)` Returns a responsive view
    `IRespView` | IConfigurationService.`getRespViewForWFActivity(IWFActivity activity, Id resourceContentTypeId, RespViewState viewState)` Returns a responsive view
    `IRoleAssignment` | ISecurityService.`getRoleAssignment(Id id)` Returns the role assignment corresponding to the specified Id.
    `IRoleTemplate` | ISecurityService.`getRoleTemplate(Id id)` Retrieves role template by Id.
    `ITBRuleDefinition` | ITBRuleService.`getRuleDefinition(Id ruleDefinitionId, boolean draft)` Returns a rule definition by ID
    `ITBRuleDefinition` | ITBRuleService.`getRuleDefinition(java.lang.String name, Id typeDefinitionId, boolean draft)` Returns a rule definition by name, type definition ID
    `ITBRuleDefinition` | ITBRuleService.`getRuleDefinitionByVersionId(Id versionId)` Returns the rule definition by the version ID
    `java.util.List<ITBRuleDefinition>` | ITBRuleService.`getRuleDefinitions(Id ruleDefinitionId)` Returns the published and draft versions of the rule definition if they exist.
    `java.util.List<ITBRuleDefinition>` | ITBRuleService.`getRuleDefinitionsByType(Id objectType)` Returns the latest version of all `ITBRuleDefinition`s by object type
    `java.util.List<ITBRuleDefinition>` | ITBRuleService.`getRunnableRules(Id objectType, TBRuleDefinitionType ruleType)` Get all runnable rules for an object type
    `ISolution` | ISolutionService.`getSolution(Id id)` Retrieves a solution by Id.
    `ISolutionLayout` | ISolutionService.`getSolutionLayout(Id solutionLayoutId)` Retrieves a solution layout by Id.
    `java.util.List<ISolutionLayout>` | ISolutionService.`getSolutionLayouts(Id solutionId)` Returns all solution layouts for the specified solution id.
    `java.util.List<ISolutionTypeDefinition>` | ISolutionService.`getSolutionTypeDefinitions(Id solutionId, ISolutionTypeDefinitionOptions options)` Retrieves all associations between a solution and typedefinitions.
    `java.util.List<IWFProcess>` | IWorkflowService.`getStartedProcesses(Id resourceId)` Returns list of started processes (open/executing/initialization error) for the given resource id.
    `ITheme` | IThemeService.`getTheme(Id theme)` Returns the theme specified by the given theme id
    `java.util.List<IWFTransition>` | IWorkflowService.`getTransitions(Id processId)` Returns currently valid transitions for the given process id.
    `ITypeDefinition` | IMetaDataService.`getType(Id id)` Returns a type definition by id.
    `IUser` | ISecurityService.`getUser(Id userId)` Retrieves user by Id.
    `java.lang.String` | IApplicationService.`invokeReportFragment(Id id, IFieldDefinition field)` Invoke report fragment on a given object and return the report fragment as a String
    `boolean` | ISecurityService.`isUser(Id id)` Check if the id represents an IUser instance
    `Id` | IQuestionnaireService.`launchProgram(Id programId, LaunchProgramOptions options)` Launch a program - it starts a long running process which creates assessment objects for asset objects one-by-one and send e-mail to the asset owners.
    `void` | IApplicationService.`lockGRCObject(Id grcObject)` Apply a direct lock to specified GRCObject.
    `void` | IApplicationService.`moveGRCObject(Id parentObjectId, java.util.List<Id> childrenToMove, MoveObjectOptions moveOptions)` Moves one or more GRCObjects to a new parent GRCObject.
    `void` | IResourceService.`overwriteProperties(Id id, java.util.List<Id> fieldDefinitionIds, java.lang.String newValue)` Overwrite text properties of a object with a specific value.
    `void` | IWorkflowService.`processTransition(Id processId, java.lang.String transitionName)` Deprecated.
    `void` | IWorkflowService.`processTransition(Id processId, java.lang.String transitionName, IWFTransitionOptions options)` Processes the transition for the given process id.
    `IDashboardView` | IConfigurationService.`publishDashboard(Id dashboardId)` publishes the draft state of the dashboard
    `IWFProcessDefinition` | IWorkflowService.`publishProcessDefinition(Id processDefinitionId)` Publish the draft content of the process definition, so it can be started on a resource during the resource creation or the user's submission.
    `IRespView` | IConfigurationService.`publishRespView(Id respViewId)` publishes the draft state of the view
    `ITBRuleDefinition` | ITBRuleService.`publishRuleDefinition(Id ruleDefinitionId)` Publish the draft content of the rule definition, so it can be used during the resource creation or the user's submission.
    `void` | IResourceService.`purgeResource(Id id)` Fully removes all references to the object from the system, including past versions, audit trail, OpenPages storage and records from reporting periods.
    `void` | IApplicationService.`removeAllLocks(Id grcObject)` Removes all locks, direct and inherited, for a tree of GRC Objects starting from the specified grcObject.
    `void` | ISolutionService.`removeTypeDefinitionToSolution(java.lang.String typeDefinitionName, Id solutionId)` Removes the association between a solution and a typedefinition.
    `IDashboardView` | IConfigurationService.`revertDraftDashboard(Id dashboardId)` Reverts the draft of the dashboard back to the previously published state
    `IRespView` | IConfigurationService.`revertDraftRespView(Id respViewId)` Reverts the draft of the view back to the previously published state
    `void` | ISchedulerService.`runJobNow(Id jobId)` Start the job now
    `ISchedJobSchedule` | ISchedulerService.`scheduleJob(Id jobDetailId, java.lang.String cronExpression, java.util.Date startAt, java.util.Date endAt)` Creates a new `ISchedJobSchedule` instance for a `ISchedJobDetail`, given a valid new cron expression.
    `void` | IWorkflowService.`setAssignees(Id activityInstanceId, java.util.List<java.lang.String> newAssignees, boolean append)` Sets the list of assignees on the given activity instance.
    `IWFProcess` | IWorkflowService.`startProcess(Id processDefinitionId, Id resourceId)` Instantiates a workflow process for the given resource id.
    `IWFProcess` | IWorkflowService.`startProcess(Id processDefinitionId, Id resourceId, java.util.Map<java.lang.String,java.lang.Object> processVariables)` Instantiates a workflow process for the given resource id with given process variables.
    `void` | IWorkflowService.`syncProcess(Id processId)` The process/activity fields are typically set based on related objects.
    `void` | IProcessService.`terminateProcess(Id processId)` Terminate a specific process.
    `void` | IApplicationService.`unlockGRCObject(Id grcObject)` Unlock a locked GRCObject.
    `void` | ISchedulerService.`unscheduleJob(Id jobScheduleId)` Deletes an existing `ISchedJobSchedule` instance from the job.
    `ISchedJobSchedule` | ISchedulerService.`updateJobSchedule(Id jobScheduleId, java.lang.String cronExpression, java.util.Date startAt, java.util.Date endAt)` Updates an existing `ISchedJobSchedule` instance.
    `ProgramValidationResult` | IQuestionnaireService.`validateProgram(Id programId, LaunchProgramOptions options)` Validate if a program is ready to launch.
    `void` | IQuestionnaireService.`validateQuestionnaire(Id id)` Validate if a QuestionnaireTemplate is valid.
    `WFConditionReport` | IWorkflowService.`validateTransition(Id processId, java.lang.String transitionName)` Validates all the validations defined for the transition for the given process id.

    Method parameters in com.ibm.openpages.api.service with type arguments of type Id
    Modifier and Type | Method and Description
    --- | ---
    `void` | IResourceService.`associate(Id grcObject, java.util.List<Id> parents, java.util.List<Id> children)` Associate a list of parents, children to a given object.
    `void` | IResourceService.`associate(Id grcObject, java.util.List<Id> parents, java.util.List<Id> children)` Associate a list of parents, children to a given object.
    `void` | IConfigurationService.`associateProfilesToUser(Id userId, java.util.List<Id> profileIds)` Associates a list of profiles to a user.
    `void` | IConfigurationService.`associateUsersToProfile(Id profileId, java.util.List<Id> userIds)` Associates a list of users to a profile.
    `java.util.List<Id>` | IResourceService.`canCreateObjectsForTypes(Id userId, java.util.List<Id> typesToCreate)` Considers Folder based security, Role based security and Rule based security globally to check for a list of potential object types which ones the user may have access to create.
    `java.util.List<Id>` | IResourceService.`canCreateObjectsForTypes(java.util.List<Id> typesToCreate, Id intendedParentObject)` Considers Folder based security, Role based security and Rule based security to check for a list of potential object types which ones the current user may have access to create for a specific intended parent GRC Object.
    `java.util.List<IGRCObject>` | IApplicationService.`copyToParent(Id parentObjectId, java.util.List<Id> childrenToCopy, CopyObjectOptions copyOptions)` Copies one or more GRCObjects to a parent GRCObject based on the CopyObjectOptions and returns the copies made for each of the childrenToCopy that are specified.
    `void` | ISchedulerService.`deleteJobs(java.util.Set<Id> jobIds)` Soft deletes `ISchedJobDetail`s, along with any associated `ISchedJobSchedule` and `ISchedJobInstance`s.
    `void` | ISchedulerService.`deleteJobSchedules(java.util.Set<Id> jobScheduleIds)` Soft deletes `ISchedJobSchedule`s.
    `void` | IWorkflowService.`deleteProcessDefinitions(java.util.Set<Id> processDefinitionIds)` Deletes process definitions by IDs.
    `void` | IConfigurationService.`deleteRespViews(java.util.Set<Id> respViewIds)` Deletes the responsive view
    `void` | ITBRuleService.`deleteRuleDefinitions(java.util.Set<Id> ruleDefinitionIds)` Deletes rule definitions by IDs
    `void` | IThemeService.`deleteThemes(java.util.Set<Id> ids)` Deletes the themes specified in the list of ids, but maintains a record of the themes in the database for audit and reporting purposes
    `void` | ISchedulerService.`disableJobs(java.util.Set<Id> jobIds)` Updates `ISchedJobDetail`s to be disabled.
    `void` | IConfigurationService.`disassociateProfilesFromUser(Id userId, java.util.List<Id> profileIds)` Disassociates a list of profiles from a user.
    `void` | IConfigurationService.`disassociateUsersFromProfile(Id profileId, java.util.List<Id> userIds)` Disassociates a list of users to a profile.
    `void` | IResourceService.`dissociate(Id grcObject, java.util.List<Id> parents, java.util.List<Id> children)` Dissociate a list of parents, children to a given object.
    `void` | IResourceService.`dissociate(Id grcObject, java.util.List<Id> parents, java.util.List<Id> children)` Dissociate a list of parents, children to a given object.
    `void` | ISchedulerService.`enableJobs(java.util.Set<Id> jobIds)` Updates `ISchedJobDetail`s to be enabled.
    `void` | IWorkflowService.`enableProcessDefinitions(java.util.Set<Id> processDefinitionIds, boolean enabled)` enable or disable process definitions by IDs
    `void` | IConfigurationService.`enableRespViews(java.util.Set<Id> ids, boolean enable)` Enable/disable views with the specified IDs.
    `void` | ITBRuleService.`enableRuleDefinitions(java.util.Set<Id> ruleDefinitionIds, boolean enabled)` enable or disable rule definitions by IDs
    `void` | IThemeService.`enableThemes(java.util.Set<Id> ids, boolean isEnabled)` Enables or disables the themes as specified in the list of ids
    `java.util.List<IWFActivityInstance>` | IWorkflowService.`getActivityInstances(java.util.List<Id> activityInstanceIds)` Retrieves the list of activity instances for the given list of activity instance ids.
    `java.util.List<IAdminPermission>` | ISecurityService.`getAdminPermissions(java.util.List<Id> groupIds, java.util.List<Id> administratorIds)` Finds administrator permissions for provided list of group ids and list of administrator ids.
    `java.util.List<IAdminPermission>` | ISecurityService.`getAdminPermissions(java.util.List<Id> groupIds, java.util.List<Id> administratorIds)` Finds administrator permissions for provided list of group ids and list of administrator ids.
    `java.util.Map<Id,java.util.Set<Id>>` | ITBRuleService.`getAsyncCalculationRequests(java.util.Set<Id> resourceIds)` Returns the resources in the asynchronous calculation queue.
    `java.util.Map<Id,TBCalcCounts>` | ITBRuleService.`getCalcStats(java.util.Set<Id> calcDefIds)` Returns the statistics of the calculations such as how many resources are in the queue for asynchronous calculation, or how many resources have calculation errors for a given calculation definition.
    `SchedulerScheduleList` | ISchedulerService.`getSchedules(java.util.Optional<Id> jobId)`
    `void` | ISchedulerService.`hardDeleteJobs(java.util.Set<Id> jobIds)` Hard deletes `ISchedJobDetail`s, along with any associated `ISchedJobSchedule` and `ISchedJobInstance`s.
    `void` | IWorkflowService.`hardDeleteProcessDefinitions(java.util.Set<Id> processDefinitionIds)` Hard-deletes process definitions by IDs.
    `void` | ITBRuleService.`hardDeleteRuleDefinitions(java.util.Set<Id> ruleDefinitionIds)` Hard-deletes rule definitions by IDs.
    `void` | IThemeService.`hardDeleteThemes(java.util.Set<Id> ids)` Permanently removes the themes specified in the list of ids from the database
    `void` | IApplicationService.`moveGRCObject(Id parentObjectId, java.util.List<Id> childrenToMove, MoveObjectOptions moveOptions)` Moves one or more GRCObjects to a new parent GRCObject.
    `void` | IResourceService.`overwriteProperties(Id id, java.util.List<Id> fieldDefinitionIds, java.lang.String newValue)` Overwrite text properties of a object with a specific value.
    `void` | ITBRuleService.`processAsyncCalculations(java.util.Set<Id> resourceIds, boolean synchronous)` Requests asynchronous calculations of the given resources to handle earlier than others by increasing the priority.
    `void` | IConfigurationService.`reorderRespViewRules(ITypeDefinition typeDefinition, RespViewType viewType, java.util.Map<Id,java.lang.Integer> orders)` Reorder identification rules for responsive views.
    `void` | IWorkflowService.`terminateProcesses(java.util.Set<Id> processIds)` Terminates the given processes and any active activities.
    `java.util.List<IWFActivityNotification>` | IWorkflowService.`updateActivityNotificationsSent(java.util.Set<Id> notificationIds)` Updates activity instance notifications that have already been sent as part of the scheduled `JobDetailCategory.workflowDueDateReminders` job

  - ### Uses of Id in com.ibm.openpages.api.solution

    Methods in com.ibm.openpages.api.solution that return Id
    Modifier and Type | Method and Description
    --- | ---
    `Id` | ISolutionTypeDefinition.`getId()` Returns the id of this object.
    `Id` | ISolutionLayout.`getId()` Returns local unique identifier of the solution layout
    `Id` | ISolution.`getId()` Returns local unique identifier of the solution
    `Id` | ISolution.`getLatestVersionId()` Returns the id of the latest solution version
    `Id` | ISolutionTypeDefinition.`getSolutionId()` Returns the Id of the Solution.
    `Id` | ISolutionLayout.`getSolutionId()` Returns local unique identifier of the solution
    `Id` | ISolutionTypeDefinition.`getSolutionVersionId()` Returns the Id of the Solution Version.
    `Id` | ISolutionLayout.`getSolutionVersionId()` Returns local unique identifier of the version of the solution

    Methods in com.ibm.openpages.api.solution with parameters of type Id
    Modifier and Type | Method and Description
    --- | ---
    `ISolutionLayout` | ISolutionFactory.`createSolutionLayout(java.lang.String name, Id solutionId, Id solutionVerId)` Creates a new instance of a solution layout to be persisted on the system

  - ### Uses of Id in com.ibm.openpages.api.theme

    Methods in com.ibm.openpages.api.theme that return Id
    Modifier and Type | Method and Description
    --- | ---
    `Id` | ITheme.`getThemeId()`

  - ### Uses of Id in com.ibm.openpages.api.trigger.events

    Methods in com.ibm.openpages.api.trigger.events that return Id
    Modifier and Type | Method and Description
    --- | ---
    `Id[]` | CreateResourceWithRelationsEvent.`getAdditionalParents()`
    `Id` | ReassignPrimaryParentEvent.`getChild()` Returns the single child Id for the child object of this event.
    `Id` | DisassociateResourceEvent.`getChild()` Returns the single child Id for the child object of this event.
    `Id` | AssociateResourceEvent.`getChild()` Returns the single child Id for the child object of this event.
    `Id[]` | CreateResourceWithRelationsEvent.`getChildren()`
    `Id` | CopyResourceEvent.`getCopiedObjectId()` Returns the Id of the copied object in this event.
    `Id` | ReassignPrimaryParentEvent.`getParent()` Returns the single parent Id for the parent object of this event.
    `Id` | DisassociateResourceEvent.`getParent()` Returns the single parent Id for the parent object of this event.
    `Id` | AssociateResourceEvent.`getParent()` Returns the single parent Id for the parent object of this event.
    `Id` | DeleteResourceEvent.`getResourceId()` Returns the single Id for the resource being deleted for this event.
    `Id` | MoveResourceEvent.`getSourceId()`
    `Id` | CopyResourceEvent.`getSourceResouceId()` Returns the source Id for the object to be copied in this event.
    `Id` | MoveResourceEvent.`getTargetId()`
    `Id` | CopyResourceEvent.`getTargetResourceId()` The target Id for the destination of where the source is to be copied to in this event.

    Methods in com.ibm.openpages.api.trigger.events that return types with arguments of type Id
    Modifier and Type | Method and Description
    --- | ---
    `java.util.List<Id>` | DisassociateResourceEvent.`getChildren()` Returns the list of Ids of the children objects of this event.
    `java.util.List<Id>` | AssociateResourceEvent.`getChildren()` Returns the list of Ids of the children objects of this event.
    `java.util.List<Id>` | DisassociateResourceEvent.`getParents()` Returns the list of Ids of the parent objects of this event.
    `java.util.List<Id>` | AssociateResourceEvent.`getParents()` Returns the list of Ids of the parent objects of this event.
    `java.util.List<Id>` | DeleteResourceEvent.`getResourceIds()` Returns list of resource Ids being deleted.

    Methods in com.ibm.openpages.api.trigger.events with parameters of type Id
    Modifier and Type | Method and Description
    --- | ---
    `AbstractEvent` | GRCTriggerEventFactory.`createEvent(TriggerEventType eventType, Id sourceId, Id targetId, java.lang.String destinationName, CopyOptions copyOptions, TriggerPositionType position, Context context, java.lang.Object returnedObject)` Creates a new event for the event type, Resource Ids, destination name, position and context.
    `AbstractEvent` | GRCTriggerEventFactory.`createEvent(TriggerEventType eventType, Id sourceId, Id targetId, java.lang.String newName, MoveObjectOptions options, TriggerPositionType position, Context context)` Creates a new event for the event type, resource(s), position and context.
    `AbstractEvent` | GRCTriggerEventFactory.`createEvent(TriggerEventType eventType, Id sourceId, Id targetId, TriggerPositionType position, Context context)` Creates a new event for the event type, Resource Ids, position and context.
    `AbstractEvent` | GRCTriggerEventFactory.`createEvent(TriggerEventType eventType, Id parentGrcObjectId, java.util.List<Id> childGrcObjectIds, TriggerPositionType position, Context context)` Creates a new event for the event type, resource(s), position and context.
    `AbstractEvent` | GRCTriggerEventFactory.`createEvent(TriggerEventType eventType, Id id, TriggerPositionType position, Context context)` Creates a new event for the event type, Resource Id, position and context.
    `AbstractEvent` | GRCTriggerEventFactory.`createEvent(TriggerEventType eventType, IResource resource, IResource retResource, TriggerPositionType position, Context context, Id[] additionalParents, Id[] children)` Creates a new event for the event type, resource(s), position and context.
    `AbstractEvent` | GRCTriggerEventFactory.`createEvent(TriggerEventType eventType, IResource resource, IResource retResource, TriggerPositionType position, Context context, Id[] additionalParents, Id[] children)` Creates a new event for the event type, resource(s), position and context.
    `AbstractEvent` | GRCTriggerEventFactory.`createEvent(TriggerEventType eventType, IResource resource, TriggerPositionType position, Context context, Id[] additionalParents, Id[] children)` Creates a new event for the event type, resource, position and context.
    `AbstractEvent` | GRCTriggerEventFactory.`createEvent(TriggerEventType eventType, IResource resource, TriggerPositionType position, Context context, Id[] additionalParents, Id[] children)` Creates a new event for the event type, resource, position and context.
    `AbstractEvent` | GRCTriggerEventFactory.`createEvent(TriggerEventType eventType, java.util.List<Id> parentIds, Id childId, TriggerPositionType position, Context context)` Creates a new event for the event type, Resource Ids, position and context.

    Method parameters in com.ibm.openpages.api.trigger.events with type arguments of type Id
    Modifier and Type | Method and Description
    --- | ---
    `AbstractEvent` | GRCTriggerEventFactory.`createEvent(TriggerEventType eventType, Id parentGrcObjectId, java.util.List<Id> childGrcObjectIds, TriggerPositionType position, Context context)` Creates a new event for the event type, resource(s), position and context.
    `AbstractEvent` | GRCTriggerEventFactory.`createEvent(TriggerEventType eventType, java.util.List<Id> parentIds, Id childId, TriggerPositionType position, Context context)` Creates a new event for the event type, Resource Ids, position and context.
    `AbstractEvent` | GRCTriggerEventFactory.`createEvent(TriggerEventType eventType, java.util.List<Id> ids, TriggerPositionType position, Context context)` Creates a new event for the event type, Resource Ids, position and context.

    Constructors in com.ibm.openpages.api.trigger.events with parameters of type Id
    Constructor and Description
    `AssociateResourceEvent(Id parentId, java.util.List<Id> childIds, TriggerPositionType position, Context context)` Constructor for single parent.
    `AssociateResourceEvent(java.util.List<Id> parentIds, Id childId, TriggerPositionType position, Context context)` Constructor for multiple parents.
    `CopyResourceEvent(Id sourceId, Id targetId, java.lang.String destinationName, TriggerPositionType position, Context context)`
    `CopyResourceEvent(Id sourceId, Id targetId, TriggerPositionType position, Context context)`
    `CreateResourceWithRelationsEvent(IResource resource, TriggerPositionType position, Context context, Id[] additionalParents, Id[] children)`
    `CreateResourceWithRelationsEvent(IResource resource, TriggerPositionType position, Context context, Id[] additionalParents, Id[] children)`
    `DeleteResourceEvent(Id resourceId, TriggerPositionType position, Context context)` Constructor for single resource Id
    `DisassociateResourceEvent(Id parentId, java.util.List<Id> childIds, TriggerPositionType position, Context context)` Constructor for single parent.
    `DisassociateResourceEvent(java.util.List<Id> parentIds, Id childId, TriggerPositionType position, Context context)` Constructor for multiple parents.
    `MoveResourceEvent(TriggerEventType type, Id sourceId, Id targetId, MoveObjectOptions options, TriggerPositionType position, Context context)`
    `ReassignPrimaryParentEvent(Id parentId, Id childId, TriggerPositionType position, Context context)`
    `RenameResourceEvent(Id sourceId, Id targetId, java.lang.String newName, MoveObjectOptions options, TriggerPositionType position, Context context)`
    `RenameResourceEvent(Id sourceId, java.lang.String newName, TriggerPositionType position, Context context)`

    Constructor parameters in com.ibm.openpages.api.trigger.events with type arguments of type Id
    Constructor and Description
    `AssociateResourceEvent(Id parentId, java.util.List<Id> childIds, TriggerPositionType position, Context context)` Constructor for single parent.
    `AssociateResourceEvent(java.util.List<Id> parentIds, Id childId, TriggerPositionType position, Context context)` Constructor for multiple parents.
    `DeleteResourceEvent(java.util.List<Id> resourceIds, TriggerPositionType position, Context context)` Constructor for list of resource Ids
    `DisassociateResourceEvent(Id parentId, java.util.List<Id> childIds, TriggerPositionType position, Context context)` Constructor for single parent.
    `DisassociateResourceEvent(java.util.List<Id> parentIds, Id childId, TriggerPositionType position, Context context)` Constructor for multiple parents.

  - ### Uses of Id in com.ibm.openpages.api.workflow

    Methods in com.ibm.openpages.api.workflow that return Id
    Modifier and Type | Method and Description
    --- | ---
    `Id` | IWFActivityInstance.`getActivityId()` Returns the identifier of the activity definition.
    `Id` | IWFProcessEvent.`getActivityInstanceId()` Returns the Id of the activity the event occurred in.
    `Id` | IWFActivityNotification.`getActivityInstanceId()` Get the ID of the activity instance
    `Id` | IWFActivityNotification.`getAssigneeId()` Get the ID of the individual assigned to the workflow task
    `Id` | IWFProcessEvent.`getErrorMessageId()` Returns an error message id for exception events.
    `Id` | WFEvalResult.`getFieldId()`
    `Id` | IWFProcessEvent.`getI18NKeyId()` Returns a I18N key for a localized message.
    `Id` | IWFProcessEvent.`getId()` Returns the id of the event.
    `Id` | IWFProcessDefinition.`getId()` Returns unique identifier of the process definition
    `Id` | IWFProcessContext.`getId()` Returns the identifier of the process instance.
    `Id` | IWFActivityNotification.`getId()` Get the ID of the activity notification instance
    `Id` | IWFActivityInstance.`getId()` Returns the identifier of the activity instance
    `Id` | IWFActivity.`getId()` Returns unique identifier of the process definition
    `Id` | IWFProcess.`getOriginatingProcessId()` If this process was started by another process, this method returns the Id value of that process.
    `Id` | IWFActivityInstance.`getParentId()` Returns the identifier of the parent activity instance when the activity instance is created by the hierarchical launch operation.
    `Id` | IWFActivityInstance.`getPreviousActivityId()` Returns the identifier of the previous activity instance when the activity instance is created.
    `Id` | StartProcessesOptions.`getProcessDefinitionId()` Returns Id of the workflow definition to start.
    `Id` | IWFProcessEvent.`getProcessId()` Returns the Id of the process the event occurred in.
    `Id` | IWFActivityInstance.`getProcessInstanceId()` Returns the identifier of the process instance
    `Id` | IWFProcessContext.`getProcessVersionId()` Returns the identifier of the process definition version.
    `Id` | IWFProcessContext.`getResourceId()` Returns the identifier of the resource where the process instance is associated to.
    `Id` | IWFActivityNotification.`getResourceId()` Get the Resource ID for which the workflow was started
    `Id` | IWFActivityInstance.`getResourceId()` Returns the identifier of the resource.
    `Id` | IEvaluationContext.`getResourceId()` Returns the id of the GRCObject associated in this context.
    `Id` | IWFActivityNotification.`getSubscriberId()` Get the ID of the workflow task subscriber
    `Id` | IWFProcessDefinition.`getVersionId()` Returns version id of the process definition.

    Methods in com.ibm.openpages.api.workflow that return types with arguments of type Id
    Modifier and Type | Method and Description
    --- | ---
    `java.util.List<Id>` | WFActivityInstanceList.`getContextualActivityIds()` Returns a list of activity ids relevant to the result set.
    `java.util.List<Id>` | WFActivityInstanceList.`getContextualObjectTypes()` Returns a list of object type ids relevant to the result set.
    `java.util.List<Id>` | WFActivityInstanceList.`getContextualProcessDefinitions()` Returns a list of process definition ids relevant to the result set.
    `java.util.List<Id>` | WFEvalResult.`getObjectIds()`
    `java.util.List<Id>` | StartProcessesOptions.`getResourceIds()` Returns resource Ids to start workflows.

    Methods in com.ibm.openpages.api.workflow with parameters of type Id
    Modifier and Type | Method and Description
    --- | ---
    `void` | WFEvalResult.`addObjectId(Id objectId)`
    `IWFProcessDefinition` | IWorkflowFactory.`createProcessDefinition(java.lang.String name, Id typeId)` Creates a new instance of process definition to be persisted on the system
    `IWFActivity` | IWFProcessDefinition.`getActivity(Id id)` Returns the activity by the activity ID.
    `IWFActivityInstance` | IWFProcess.`getActivityInstance(Id activityInstanceId)` Returns an `IWFActivityInstance` by the activity instance ID.
    `void` | StartProcessesOptions.`setProcessDefinitionId(Id processDefinitionId)` Assigns Id of the workflow definition to start.

    Method parameters in com.ibm.openpages.api.workflow with type arguments of type Id
    Modifier and Type | Method and Description
    --- | ---
    `void` | StartProcessesOptions.`setResourceIds(java.util.List<Id> resourceIds)` Assigns resource Ids to start workflows.

    Constructors in com.ibm.openpages.api.workflow with parameters of type Id
    Constructor and Description
    `WFEvalResult(IWFEvalUnit evaluationUnit, java.lang.Object fieldVal, Id objectId, Id fieldId)`

    Constructor parameters in com.ibm.openpages.api.workflow with type arguments of type Id
    Constructor and Description
    `WFActivityInstanceList(int totalResultCount, java.util.List<IWFActivityInstance> activityInstances, java.util.List<Id> contextualObjectTypes, java.util.List<Id> contextualProcessDefinitions, java.util.List<Id> contextualActivityIds, java.util.List<java.lang.String> contextualActivityLabels, java.util.List<IWFResultDateCount> dueDateCounts)`
    `WFActivityInstanceList(int totalResultCount, java.util.List<IWFActivityInstance> activityInstances, java.util.List<Id> contextualObjectTypes, java.util.List<Id> contextualProcessDefinitions, java.util.List<Id> contextualActivityIds, java.util.List<java.lang.String> contextualActivityLabels, java.util.List<IWFResultDateCount> dueDateCounts)`
    `WFActivityInstanceList(int totalResultCount, java.util.List<IWFActivityInstance> activityInstances, java.util.List<Id> contextualObjectTypes, java.util.List<Id> contextualProcessDefinitions, java.util.List<Id> contextualActivityIds, java.util.List<java.lang.String> contextualActivityLabels, java.util.List<IWFResultDateCount> dueDateCounts)`

Licensed Materials - Property of IBM
OpenPages with Watson (PID: 5725-D51)
© Copyright IBM Corporation 2013, 2022. All Rights Reserved.
US Government Users Restricted Rights - Use, duplication or disclosure restricted by GSA ADP Schedule Contract with IBM Corp.