Package com.technia.dsx.threedspace.eng.instance

Interface EngInstanceService

All Superinterfaces:
Service<EngInstanceObjectFactory>
public interface EngInstanceService extends Service<EngInstanceObjectFactory>
Service interface for managing engineering instances within the 3DSpace.

  • Method Details

    • getAll

      @Remote(READ) EngInstanceResult<? extends DefaultRelationship> getAll(com.technia.dsx.common.TenantSession session, String itemId, EngInstanceMask mask, EngInstanceField... fields)
      Get all engineering instances for a given item.
      Parameters:
      session - The tenant session.
      itemId - The ID of the engineering item.
      mask - The mask to apply for filtering.
      fields - The fields to include in the result.
      Returns:
      The result containing engineering instances.

    • getEngInstances

      @Remote(READ) EngInstanceResult<? extends DefaultRelationship> getEngInstances(com.technia.dsx.common.TenantSession session, String itemId, EngInstanceMask mask, Integer maxResult, Integer skip, EngInstanceField... fields)
      Get a specific range of engineering instances for a given item.
      Parameters:
      session - The tenant session.
      itemId - The ID of the engineering item.
      mask - The mask to apply for filtering.
      maxResult - The maximum number of results to return.
      skip - The number of results to skip.
      fields - The fields to include in the result.
      Returns:
      The result containing engineering instances.

    • bulkFetch

      @Remote(READ) EngInstanceBulkResult<? extends DefaultRelationship> bulkFetch(com.technia.dsx.common.TenantSession session, List<String> engInstanceIds, EngInstanceMask mask, EngInstanceField... fields)
      Bulk fetch engineering instances by their IDs.
      Parameters:
      session - The tenant session.
      engInstanceIds - The list of engineering instance IDs to fetch.
      mask - The mask to apply for filtering.
      fields - The fields to include in the result.
      Returns:
      The bulk fetch result containing engineering instances.

    • bulkUpdate

      @Remote(READ) EngInstanceResult<? extends DefaultRelationship> bulkUpdate(com.technia.dsx.common.TenantSession session, String engItemId, List<EngInstanceBulkUpdateData> bulkUpdateInput, EngInstanceMask mask, EngInstanceField... fields)
      Bulk update engineering instances for a given item.
      Parameters:
      session - The tenant session.
      engItemId - The ID of the engineering item.
      bulkUpdateInput - The list of bulk update data for engineering instances.
      mask - The mask to apply for filtering.
      fields - The fields to include in the result.
      Returns:
      The bulk result containing updated engineering instances.

    • detach

      @Remote(DELETE) com.technia.dsx.common.StatusWithMessage detach(com.technia.dsx.common.TenantSession session, List<String> instanceIds)
      Detach engineering instances.
      Parameters:
      session - The tenant session.
      instanceIds - The list of engineering instance IDs to detach.
      Returns:
      The status of the detach operation.

    • delete

      @Remote(DELETE) com.technia.dsx.common.StatusWithMessage delete(com.technia.dsx.common.TenantSession session, String engItemId, String engInstanceId)
      Delete an engineering instance for a given item.
      Parameters:
      session - The tenant session.
      engItemId - The ID of the engineering item.
      engInstanceId - The ID of the engineering instance to delete.
      Returns:
      The status of the delete operation.

    • modify

      @Remote(UPDATE) DefaultRelationship modify(com.technia.dsx.common.TenantSession session, String engItemId, String engInstanceId, EngInstanceModifyData input, EngInstanceMask mask, EngInstanceField... fields)
      Modify an engineering instance for a given item.
      Parameters:
      session - The tenant session.
      engItemId - The ID of the engineering item.
      engInstanceId - The ID of the engineering instance to modify.
      input - The modification data.
      mask - The mask to apply for filtering.
      fields - The fields to include in the result.
      Returns:
      The modified relationship.

    • create

      @Remote(CREATE) List<? extends DefaultRelationship> create(com.technia.dsx.common.TenantSession session, String engItemId, CreateEngInstancesData createInput, EngInstanceMask mask, EngInstanceField... fields)
      Create new Engineering Item Instance(s).
      Parameters:
      session - The tenant session.
      engItemId - The ID of the engineering item.
      createInput - The creation data.
      mask - The mask to apply for filtering.
      fields - The fields to include in the result.
      Returns:
      A list of created relationships.

    • load

      @Remote(READ) DefaultRelationship load(com.technia.dsx.common.TenantSession session, String engItemId, String engInstanceId, EngInstanceMask mask, EngInstanceField... fields)
      Load an engineering instance for a given item.
      Parameters:
      session - The tenant session.
      engItemId - The ID of the engineering item.
      engInstanceId - The ID of the engineering instance to load.
      mask - The mask to apply for filtering.
      fields - The fields to include in the result.
      Returns:
      The loaded relationship.

    • replace

      @Remote(UPDATE) DefaultRelationship replace(com.technia.dsx.common.TenantSession session, String engItemId, String engInstanceId, ReplaceData replaceData, EngInstanceMask mask, EngInstanceField... fields)
      Replace the Engineering Item Instance
      Parameters:
      session - The tenant session.
      engItemId - The ID of the engineering item.
      engInstanceId - The ID of the engineering instance to replace.
      replaceData - The replacement data.
      mask - The mask to apply for filtering.
      fields - The fields to include in the result.
      Returns:
      The replaced relationship.

    • getFilterable

      @Remote(READ) FilterableDetails getFilterable(com.technia.dsx.common.TenantSession session, String engItemId, String engInstanceId, FilterableMask mask, FilterableField... fields)
      Get filterable details for an engineering instance.
      Parameters:
      session - The tenant session.
      engItemId - The ID of the engineering item.
      engInstanceId - The ID of the engineering instance.
      mask - The mask to apply for filtering.
      fields - The fields to include in the result.
      Returns:
      The filterable details.