Package de.uplanet.lucy.server.auxiliaries.datatransfer

Class DataTransferCallableV2

java.lang.Object
de.uplanet.lucy.server.auxiliaries.datatransfer.DataTransferCallableV2
@VelocityCallable("singleton") @VelocityVariable("DataTransferCallable2") public final class DataTransferCallableV2 extends Object

  • Constructor Summary

    Constructors
    Constructor
    Description
    DataTransferCallableV2()
     

  • Method Summary

    Modifier and Type
    Method
    Description
    de.uplanet.lucy.server.auxiliaries.datatransfer.VCDataTransferResult<de.uplanet.lucy.server.auxiliaries.datatransfer.VCDataTransferJobListEntry>
    getConnections(de.uplanet.lucy.server.IProcessingContext p_ctx, String p_appGuid, int p_page, int p_pageSize, String p_sortField, boolean p_ascending, int p_statusFilter, String p_titleFilter)
     
    de.uplanet.lucy.server.auxiliaries.datatransfer.VCDataTransferResult<de.uplanet.lucy.server.auxiliaries.datatransfer.VCSchedulerJobExecution>
    getJobExecutions(de.uplanet.lucy.server.IProcessingContext p_ctx, String p_appGuid, String p_strJobGuid, int p_page, int p_pageCount, String p_sortField, boolean p_ascending, int p_statusFilter)
    Returns the partial sorted list of job history for the connection with the specified name.
    String
    getJobMessages(String p_strGuid)
    Returns the message for the job with the specified GUID.
    String
    getLastJobMessage(String p_strJobDefinitionGuid)
    Returns the message of the last job executed for the specified connection.
    void
    startJob(String p_strGuid)
    Starts the specified scheduler job.

    Methods inherited from class java.lang.Object

    equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

  • Constructor Details

    • DataTransferCallableV2

      public DataTransferCallableV2()

  • Method Details

    • getConnections

      public de.uplanet.lucy.server.auxiliaries.datatransfer.VCDataTransferResult<de.uplanet.lucy.server.auxiliaries.datatransfer.VCDataTransferJobListEntry> getConnections(de.uplanet.lucy.server.IProcessingContext p_ctx, String p_appGuid, int p_page, int p_pageSize, String p_sortField, boolean p_ascending, int p_statusFilter, String p_titleFilter)
      Parameters:
      p_ctx - The processing context.
      p_appGuid - The application GUID. (Used to get the application language constant values).
      p_page - The start page index. 0 for the first page
      p_pageSize - The size of the page.
      p_sortField - Valid values are DESCRIPTION, DESTINATION, END, SOURCE, START, STATUS, TITLE or null for title
      p_ascending - In Ascending order
      p_statusFilter - The status filter value. -1 for not status filter otherwise a valid status id to filter
      p_titleFilter - The title filter or null for nothing. (*, ?) allowed. If filter string contains a * or ?
      Returns:
      The ordered jobs result object

    • getJobExecutions

      public de.uplanet.lucy.server.auxiliaries.datatransfer.VCDataTransferResult<de.uplanet.lucy.server.auxiliaries.datatransfer.VCSchedulerJobExecution> getJobExecutions(de.uplanet.lucy.server.IProcessingContext p_ctx, String p_appGuid, String p_strJobGuid, int p_page, int p_pageCount, String p_sortField, boolean p_ascending, int p_statusFilter) throws Exception
      Returns the partial sorted list of job history for the connection with the specified name.
      Parameters:
      p_ctx - The processing context-.
      p_appGuid - The application GUID. (Used to get the application language constant values).
      p_strJobGuid - The job GUID.
      p_page - The startPage
      p_pageCount - The pageSize and max return item size
      p_sortField - Valid values are START, END, STATUS or null for START
      p_ascending - In Ascending order
      p_statusFilter - The status filter. If -1 not filter set otherwise entries will be filtered by the status.
      Returns:
      The ordered jobs executions result object. (not null)
      Throws:
      Exception - If an error occurred.

    • getLastJobMessage

      public String getLastJobMessage(String p_strJobDefinitionGuid) throws Exception
      Returns the message of the last job executed for the specified connection.
      Parameters:
      p_strJobDefinitionGuid - The job GUID.
      Throws:
      Exception - If an error occurred.

    • getJobMessages

      public String getJobMessages(String p_strGuid) throws Exception
      Returns the message for the job with the specified GUID.
      Parameters:
      p_strGuid - The job execution GUID.
      Returns:
      The message.
      Throws:
      IOException - If an I/O error occurred.
      Exception

    • startJob

      public void startJob(String p_strGuid)
      Starts the specified scheduler job.
      Parameters:
      p_strGuid - The job GUID.