Class WUQueryWrapper


  • @Deprecated
    public class WUQueryWrapper
    extends Object
    Deprecated.
    Wrapper class for inputs to WUQuery. the fields aren't an exact 1-to-1 with the esp service fields. some fields are deprecated and no longer used, some fields have been replaced by others, some string fields are actually expecting specific enum values.
    • Constructor Detail

      • WUQueryWrapper

        public WUQueryWrapper()
        Deprecated.
        Instantiates a new WU query wrapper.
      • WUQueryWrapper

        public WUQueryWrapper​(org.hpccsystems.ws.client.gen.axis2.wsworkunits.latest.WUQuery raw)
                       throws Exception
        Deprecated.
        Instantiates a new WU query wrapper.
        Parameters:
        raw - - the soap-version-specific WUQuery to use to initialize this WUQueryInfo object.
        Throws:
        Exception - if the input start date / end date are not null and are invalid date strings.
    • Method Detail

      • getCluster

        public String getCluster()
        Deprecated.
        Gets the cluster.
        Returns:
        the cluster name to filter workunits by.
      • setCluster

        public WUQueryWrapper setCluster​(String cluster)
        Deprecated.
        Sets the cluster.
        Parameters:
        cluster - - the cluster name to return workunits from.
        Returns:
        the WU query wrapper
      • getDescending

        public boolean getDescending()
        Deprecated.
        Gets the descending.
        Returns:
        if a sortby param is specified and getDescending is true, results will be returned descending.
      • setDescending

        public WUQueryWrapper setDescending​(boolean descending)
        Deprecated.
        Sets the descending.
        Parameters:
        descending - - if a sortby parameter is specified, descending will make that parameter sort descending.
        Returns:
        the WU query wrapper
      • getECL

        public String getECL()
        Deprecated.
        Gets the ecl.
        Returns:
        the ecl that will be searched for.
      • setECL

        public WUQueryWrapper setECL​(String eCL)
        Deprecated.
        Sets the ECL.
        Parameters:
        eCL - the e CL
        Returns:
        the WU query wrapper
      • getEndDate

        public Date getEndDate()
        Deprecated.
        Gets the end date.
        Returns:
        - the end date to search for.
      • getJobname

        public String getJobname()
        Deprecated.
        Gets the jobname.
        Returns:
        jobname that will be searched for.
      • setJobname

        public WUQueryWrapper setJobname​(String jobname)
        Deprecated.
        Sets the jobname.
        Parameters:
        jobname - - find workunits with this jobname. Wildcards (*,?) are allowed.
        Returns:
        the WU query wrapper
      • getLogicalFile

        public String getLogicalFile()
        Deprecated.
        Gets the logical file.
        Returns:
        the logical file to search for.
      • setLogicalFile

        public WUQueryWrapper setLogicalFile​(String logicalFile)
        Deprecated.
        Sets the logical file.
        Parameters:
        logicalFile - - the name of the logical file to search for. Wildcards allowed (*,?) Should not start with "~"
        Returns:
        the WU query wrapper
      • getLogicalFileSearchType

        public WUQueryWrapper.LogicalFileSearchType getLogicalFileSearchType()
        Deprecated.
        Gets the logical file search type.
        Returns:
        the type of logical files that will be searched for, Input or Output (can't be both). If null, input files are searched.
      • getOwner

        public String getOwner()
        Deprecated.
        Gets the owner.
        Returns:
        owner that workunits will be filtered by
      • setOwner

        public WUQueryWrapper setOwner​(String owner)
        Deprecated.
        Sets the owner.
        Parameters:
        owner - - return only workunits created by this username. Case insensitive
        Returns:
        the WU query wrapper
      • getPageSize

        public Long getPageSize()
        Deprecated.
        Gets the page size.
        Returns:
        number of results to return
      • setPageSize

        public WUQueryWrapper setPageSize​(Long pageSize)
        Deprecated.
        Sets the page size.
        Parameters:
        pageSize - - the number of results to return. Overrides getPageEndAt. EG if 100 results are found, getPageStartFrom is 10, getPageEndAt is 50, and getPageSize is 10, workunits 10-20 will be returned.
        Returns:
        the WU query wrapper
      • getPageStartFrom

        public Long getPageStartFrom()
        Deprecated.
        Gets the page start from.
        Returns:
        Which result to begin returning results from
      • setPageStartFrom

        public WUQueryWrapper setPageStartFrom​(Long pageStartFrom)
        Deprecated.
        Sets the page start from.
        Parameters:
        pageStartFrom - - Which result to begin returning results from. e.g. if 100 workunits were found and this value is 4, the first three workunits will not be included in the results. Default value is 1
        Returns:
        the WU query wrapper
      • getSortby

        public WUQueryWrapper.SortBy getSortby()
        Deprecated.
        Gets the sortby.
        Returns:
        the SortBy enum indicating the sort order in which results will be returned.
      • getState

        public WUState getState()
        Deprecated.
        Gets the state.
        Returns:
        the WUState enum for the state that will be searched for.
      • getWuid

        public String getWuid()
        Deprecated.
        Gets the wuid.
        Returns:
        the workunit id that will be searched for.
      • setWuid

        public WUQueryWrapper setWuid​(String wuid)
        Deprecated.
        Sets the wuid.
        Parameters:
        wuid - - the Workunit ID to search for. Case Insensitive.
        Returns:
        the WU query wrapper
      • getApplicationValues

        public List<ApplicationValueWrapper> getApplicationValues()
        Deprecated.
        Gets the application values.
        Returns:
        the application values that will be searched for. If none have been specified, an empty list is returned.
      • setApplicationValues

        public WUQueryWrapper setApplicationValues​(List<ApplicationValueWrapper> applicationValues)
        Deprecated.
        Sets the application values.
        Parameters:
        applicationValues - - the application values to search for. Any workunits containing these application values will be returned.
        Returns:
        the WU query wrapper
      • setSortBy

        public WUQueryWrapper setSortBy​(WUQueryWrapper.SortBy sort)
        Deprecated.
        Sets the sort by.
        Parameters:
        sort - how to sort the returned workunits. If null, results are returned by wuid descending.
        Returns:
        the WU query wrapper
      • setState

        public WUQueryWrapper setState​(WUState stateenum)
        Deprecated.
        Sets the state.
        Parameters:
        stateenum - - return workunits with only the specified state.
        Returns:
        the WU query wrapper
      • setStartDate

        public WUQueryWrapper setStartDate​(Date date)
        Deprecated.
        Sets the start date.
        Parameters:
        date - - the start date for which workunits will be retrieved.
        Returns:
        the WU query wrapper
      • setEndDate

        public WUQueryWrapper setEndDate​(Date date)
        Deprecated.
        Sets the end date.
        Parameters:
        date - - the end date for which workunits will be retrieved.
        Returns:
        the WU query wrapper
      • setArchived

        public WUQueryWrapper setArchived​(Boolean b)
        Deprecated.
        Sets the archived.
        Parameters:
        b - - if true, only archived workunits will be returned. if false or null, only unarchived workunits will be returned.
        Returns:
        the WU query wrapper
      • getStartDate

        public Date getStartDate()
        Deprecated.
        Gets the start date.
        Returns:
        the start date for which workunits will be retrieved.
      • validate

        public void validate()
                      throws Exception
        Deprecated.
        Validate.
        Throws:
        Exception - the exception
      • getRaw

        public org.hpccsystems.ws.client.gen.axis2.wsworkunits.latest.WUQuery getRaw()
        Deprecated.
        Gets the raw.
        Returns:
        the raw WUQuery object
      • getRawLatestVersion

        public org.hpccsystems.ws.client.gen.axis2.wsworkunits.latest.WUQuery getRawLatestVersion()
        Deprecated.
        Gets the latest raw.
        Returns:
        the latest raw
      • getRaw156

        public org.hpccsystems.ws.client.gen.axis2.wsworkunits.v1_56.WUQuery getRaw156​(int appvalue)
                                                                                throws Exception
        Deprecated.
        Gets the raw 156.
        Parameters:
        appvalue - the appvalue
        Returns:
        the raw 156
        Throws:
        Exception - the exception