## Uses of Interface
com.ibm.openpages.api.resource.IResource

- Packages that use IResource
  Package | Description
  --- | ---
  com.ibm.openpages.api.resource | Provides interfaces to work with the OpenPages content data: folders, GRC objects and document attachments.
  com.ibm.openpages.api.service | Provides the main interfaces to work with the API services.
  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 IResource in com.ibm.openpages.api.resource

    Subinterfaces of IResource in com.ibm.openpages.api.resource
    Modifier and Type | Interface and Description
    --- | ---
    `interface` | `IDocument` Represents a single version of a document stored in the system.
    `interface` | `IFolder` Represents a folder in the system.
    `interface` | `IGRCObject` Represents a GRC Object instance.

    Methods in com.ibm.openpages.api.resource that return types with arguments of type IResource
    Modifier and Type | Method and Description
    --- | ---
    `java.util.List<IResource>` | IFolder.`getContainees()` Returns contained objects including both folders and GRCObjects with all fields, and for all types, based on the reporting period of the folder.
    `java.util.List<IResource>` | IFolder.`getContainees(ContaineeFilter filter)` Returns contained object based on the supplied filter.

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

    Methods in com.ibm.openpages.api.service with type parameters of type IResource
    Modifier and Type | Method and Description
    --- | ---
    `<T extends IResource> T` | IResourceService.`saveResource(T resource)` Save a resource.

    Methods in com.ibm.openpages.api.service with parameters of type IResource
    Modifier and Type | Method and Description
    --- | ---
    `void` | IResourceService.`deleteResource(IResource resource)` Deletes a resource by object and all its associated primary children resources as well.

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

    Methods in com.ibm.openpages.api.trigger.events that return IResource
    Modifier and Type | Method and Description
    --- | ---
    `IResource` | CreateResourceEvent.`getCreatedResource()` If available, as in a POST event, Returns the created resource object that was the result of this create event i.e.
    `IResource` | AbstractResourceEvent.`getResource()` Return the resource object that is the focus of the event.
    `IResource` | UpdateResourceEvent.`getUpdatedResource()` If available, as in during a POST event, it returns the updated resource object that resulted from this update event.

    Methods in com.ibm.openpages.api.trigger.events with parameters of type IResource
    Modifier and Type | Method and Description
    --- | ---
    `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.

    Constructors in com.ibm.openpages.api.trigger.events with parameters of type IResource
    Constructor and Description
    `AbstractResourceEvent(TriggerEventType triggerEventType, IResource resource, TriggerPositionType position, Context context)` Constructor for resource event with the resource provided.
    `CreateResourceEvent(IResource resource, TriggerPositionType position, Context context)` Constructor with the resource to be created.
    `CreateResourceEvent(TriggerEventType triggerEventType, IResource resource, TriggerPositionType position, Context context)`
    `CreateResourceWithRelationsEvent(IResource resource, TriggerPositionType position, Context context, Id[] additionalParents, Id[] children)`
    `UpdateResourceEvent(IResource resource, TriggerPositionType position, Context context)` Constructor with the resource to be created.

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

    Methods in com.ibm.openpages.api.workflow that return IResource
    Modifier and Type | Method and Description
    --- | ---
    `IResource` | IWFProcessContext.`getResourceContext()` Returns the context of resource to retrieve system fields without susequent fetch operation.

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.