## Uses of Class
com.ibm.openpages.api.Context

- Packages that use Context
  Package | Description
  --- | ---
  com.ibm.openpages.api | OpenPages with Watson Risk API
  com.ibm.openpages.api.application | Provides OpenPages application specific functions
  com.ibm.openpages.api.scheduler |
  com.ibm.openpages.api.service | Provides the main interfaces to work with the API services.
  com.ibm.openpages.api.trigger | The GRC Trigger framework for extending OpenPages with custom business rules.
  com.ibm.openpages.api.trigger.events | All types of events supported by the GRC Trigger framework.
  com.ibm.openpages.ext.rest | Classes in this package when deployed to Openpages server will be scanned by Spring Framework's annotation driven configuration.

- - ### Uses of Context in com.ibm.openpages.api

    Constructors in com.ibm.openpages.api with parameters of type Context
    Constructor and Description
    `Context(Context context)` Copy constructor.

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

    Methods in com.ibm.openpages.api.application that return Context
    Modifier and Type | Method and Description
    --- | ---
    `Context` | EmailOptions.`getContext()` Gets the API context

    Methods in com.ibm.openpages.api.application with parameters of type Context
    Modifier and Type | Method and Description
    --- | ---
    `static void` | EmailUtil.`sendEmail(java.lang.String from, java.lang.String recipients, java.lang.String subjectTextKey, java.lang.Object[] subjectParams, java.lang.String bodyKey, java.lang.Object[] bodyParams, boolean ignoreError, Context context, java.lang.StringBuffer linkBuffer, java.util.Locale locale)` Send email by using OpenPages Application Strings.
    `static void` | EmailUtil.`sendEmailBySecuredServer(java.lang.String from, java.lang.String recipients, java.lang.String subjectTextKey, java.lang.Object[] subjectParams, java.lang.String bodyKey, java.lang.Object[] bodyParams, boolean ignoreError, Context context, java.lang.String secureType, java.lang.String username, java.lang.String password, java.lang.String port, java.lang.StringBuffer linkBuffer, java.util.Locale locale)` Send out emails by using a secured SMTP server and gets Subject and Body from OpenPages application string.
    `void` | EmailOptions.`setContext(Context context)` Sets the API context

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

    Methods in com.ibm.openpages.api.scheduler that return Context
    Modifier and Type | Method and Description
    --- | ---
    `Context` | AbstractScheduledProcess.`getApplicationContext()`

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

    Methods in com.ibm.openpages.api.service that return Context
    Modifier and Type | Method and Description
    --- | ---
    `Context` | IServiceFactory.`getContext()` Returns the `Context` used to create this `IServiceFactory`

    Methods in com.ibm.openpages.api.service with parameters of type Context
    Modifier and Type | Method and Description
    --- | ---
    `static IServiceFactory` | ServiceFactory.`getServiceFactory(Context context)` Instantiates a service factory based on the factory class name specified by the com.ibm.openpages.sdk.service.factory key in the context.

  - ### Uses of Context in com.ibm.openpages.api.trigger

    Methods in com.ibm.openpages.api.trigger with parameters of type Context
    Modifier and Type | Method and Description
    --- | ---
    `void` | AbstractEventHandler.`throwException(java.lang.String message, java.util.List<java.lang.Object> parameters, java.lang.Throwable cause, Context apiContext)` Allows the trigger to throw a formatted exception object and stop the execution of the current operation.

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

    Methods in com.ibm.openpages.api.trigger.events that return Context
    Modifier and Type | Method and Description
    --- | ---
    `Context` | AbstractEvent.`getContext()` Provides access to the API context object.

    Methods in com.ibm.openpages.api.trigger.events with parameters of type Context
    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)` 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)` 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.
    `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.
    `AbstractEvent` | GRCTriggerEventFactory.`createEvent(TriggerEventType eventType, java.lang.String query, int startIndex, com.ibm.openpages.service.query.QueryOptions options, TriggerPositionType position, Context context)` Creates a new event for the event type, query string, query options, position and context.
    `AbstractEvent` | GRCTriggerEventFactory.`createEvent(TriggerEventType eventType, TriggerPositionType position, Context context, java.lang.Object[] args)` Creates a new event for the event type, position and context.

    Constructors in com.ibm.openpages.api.trigger.events with parameters of type Context
    Constructor and Description
    `AbstractEvent(TriggerEventType triggerEventType, TriggerPositionType position, Context context)` Default constructor
    `AbstractResourceEvent(TriggerEventType triggerEventType, IResource resource, TriggerPositionType position, Context context)` Constructor for resource event with the resource provided.
    `AbstractResourceEvent(TriggerEventType triggerEventType, TriggerPositionType position, Context context)` Default constructor
    `AbstractResourceOperationEvent(TriggerEventType triggerEventType, TriggerPositionType position, Context context)`
    `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)`
    `CopyResourceEvent(TriggerPositionType position, Context context)`
    `CreateResourceEvent(IResource resource, TriggerPositionType position, Context context)` Constructor with the resource to be created.
    `CreateResourceEvent(TriggerEventType triggerEventType, IResource resource, TriggerPositionType position, Context context)`
    `CreateResourceEvent(TriggerPositionType position, Context context)` Default constructor.
    `CreateResourceWithRelationsEvent(IResource resource, TriggerPositionType position, Context context, Id[] additionalParents, Id[] children)`
    `DeleteResourceEvent(Id resourceId, TriggerPositionType position, Context context)` Constructor for single resource Id
    `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.
    `MoveResourceEvent(TriggerEventType type, Id sourceId, Id targetId, MoveObjectOptions options, TriggerPositionType position, Context context)`
    `QueryEvent(TriggerEventType triggerEventType, java.lang.String sqlQuery, int startIndex, com.ibm.openpages.service.query.QueryOptions queryOptions, TriggerPositionType position, Context context)` Constructor with query event parameters.
    `QueryEvent(TriggerPositionType position, Context context)` Default constructor.
    `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)`
    `SearchEvent(TriggerPositionType position, Context context, java.lang.Object[] sdkArgs)`
    `UpdateResourceEvent(IResource resource, TriggerPositionType position, Context context)` Constructor with the resource to be created.
    `UpdateResourceEvent(TriggerPositionType position, Context context)` Default constructor.

  - ### Uses of Context in com.ibm.openpages.ext.rest

    Methods in com.ibm.openpages.ext.rest that return Context
    Modifier and Type | Method and Description
    --- | ---
    `Context` | BaseExtController.`getContext(HttpServletRequest request)` Attempts to retrieve or initialize a new GRC API Context using the Http Request object.

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.