org.hpccsystems.ws.client.wrappers.wsworkunits

Class WUQueryWrapper

java.lang.Object

org.hpccsystems.ws.client.wrappers.wsworkunits.WUQueryWrapper

public class WUQueryWrapper
extends Object

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.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	WUQueryWrapper.LogicalFileSearchType either input or output logical files can be searched; but not both, apparently.
static class	WUQueryWrapper.SortBy This enum was created to address the profound lack of documentation about what values are valid for the string sortby parameter.

Constructor Summary

Constructors

Constructor and Description
WUQueryWrapper() Instantiates a new WU query wrapper.
WUQueryWrapper(org.hpccsystems.ws.client.gen.axis2.wsworkunits.v1_81.WUQuery raw) Instantiates a new WU query wrapper.

Method Summary

Modifier and Type	Method and Description
List<ApplicationValueWrapper>	getApplicationValues() Gets the application values.
String	getCluster() Gets the cluster.
boolean	getDescending() Gets the descending.
String	getECL() Gets the ecl.
Date	getEndDate() Gets the end date.
String	getJobname() Gets the jobname.
String	getLogicalFile() Gets the logical file.
WUQueryWrapper.LogicalFileSearchType	getLogicalFileSearchType() Gets the logical file search type.
String	getOwner() Gets the owner.
Long	getPageSize() Gets the page size.
Long	getPageStartFrom() Gets the page start from.
org.hpccsystems.ws.client.gen.axis2.wsworkunits.v1_81.WUQuery	getRaw() Gets the raw.
org.hpccsystems.ws.client.gen.axis2.wsworkunits.v1_56.WUQuery	getRaw156(int appvalue) Gets the raw 156.
org.hpccsystems.ws.client.gen.axis2.wsworkunits.v1_81.WUQuery	getRawLatestVersion() Gets the raw 1 81.
WUQueryWrapper.SortBy	getSortby() Gets the sortby.
Date	getStartDate() Gets the start date.
WUState	getState() Gets the state.
String	getWuid() Gets the wuid.
WUQueryWrapper	setApplicationValues(List<ApplicationValueWrapper> applicationValues) Sets the application values.
WUQueryWrapper	setArchived(Boolean b) Sets the archived.
WUQueryWrapper	setCluster(String cluster) Sets the cluster.
WUQueryWrapper	setDescending(boolean descending) Sets the descending.
WUQueryWrapper	setECL(String eCL) Sets the ECL.
WUQueryWrapper	setEndDate(Date date) Sets the end date.
WUQueryWrapper	setJobname(String jobname) Sets the jobname.
WUQueryWrapper	setLogicalFile(String logicalFile) Sets the logical file.
WUQueryWrapper	setOutputLogicalFilesOnly(WUQueryWrapper.LogicalFileSearchType lf) Sets the output logical files only.
WUQueryWrapper	setOwner(String owner) Sets the owner.
WUQueryWrapper	setPageSize(Long pageSize) Sets the page size.
WUQueryWrapper	setPageStartFrom(Long pageStartFrom) Sets the page start from.
WUQueryWrapper	setSortBy(WUQueryWrapper.SortBy sort) Sets the sort by.
WUQueryWrapper	setStartDate(Date date) Sets the start date.
WUQueryWrapper	setState(WUState stateenum) Sets the state.
WUQueryWrapper	setWuid(String wuid) Sets the wuid.
void	validate() Validate.

Methods inherited from class java.lang.Object

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

Constructor Detail

WUQueryWrapper

public WUQueryWrapper()

Instantiates a new WU query wrapper.

WUQueryWrapper

public WUQueryWrapper(org.hpccsystems.ws.client.gen.axis2.wsworkunits.v1_81.WUQuery raw)
               throws Exception

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()

Gets the cluster.

Returns:

the cluster name to filter workunits by.

setCluster

public WUQueryWrapper setCluster(String cluster)

Sets the cluster.

Parameters:

cluster - - the cluster name to return workunits from.

Returns:

the WU query wrapper

getDescending

public boolean getDescending()

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)

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()

Gets the ecl.

Returns:

the ecl that will be searched for.

setECL

public WUQueryWrapper setECL(String eCL)

Sets the ECL.

Parameters:

eCL - the e CL

Returns:

the WU query wrapper

getEndDate

public Date getEndDate()

Gets the end date.

Returns:

- the end date to search for.

getJobname

public String getJobname()

Gets the jobname.

Returns:

jobname that will be searched for.

setJobname

public WUQueryWrapper setJobname(String jobname)

Sets the jobname.

Parameters:

jobname - - find workunits with this jobname. Wildcards (*,?) are allowed.

Returns:

the WU query wrapper

getLogicalFile

public String getLogicalFile()

Gets the logical file.

Returns:

the logical file to search for.

setLogicalFile

public WUQueryWrapper setLogicalFile(String logicalFile)

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()

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.

setOutputLogicalFilesOnly

public WUQueryWrapper setOutputLogicalFilesOnly(WUQueryWrapper.LogicalFileSearchType lf)

Sets the output logical files only.

Parameters:

lf - the lf

Returns:

the WU query wrapper

getOwner

public String getOwner()

Gets the owner.

Returns:

owner that workunits will be filtered by

setOwner

public WUQueryWrapper setOwner(String owner)

Sets the owner.

Parameters:

owner - - return only workunits created by this username. Case insensitive

Returns:

the WU query wrapper

getPageSize

public Long getPageSize()

Gets the page size.

Returns:

number of results to return

setPageSize

public WUQueryWrapper setPageSize(Long pageSize)

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()

Gets the page start from.

Returns:

Which result to begin returning results from

setPageStartFrom

public WUQueryWrapper setPageStartFrom(Long pageStartFrom)

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()

Gets the sortby.

Returns:

the SortBy enum indicating the sort order in which results will be returned.

getState

public WUState getState()

Gets the state.

Returns:

the WUState enum for the state that will be searched for.

getWuid

public String getWuid()

Gets the wuid.

Returns:

the workunit id that will be searched for.

setWuid

public WUQueryWrapper setWuid(String wuid)

Sets the wuid.

Parameters:

wuid - - the Workunit ID to search for. Case Insensitive.

Returns:

the WU query wrapper

getApplicationValues

public List<ApplicationValueWrapper> getApplicationValues()

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)

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)

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)

Sets the state.

Parameters:

stateenum - - return workunits with only the specified state.

Returns:

the WU query wrapper

setStartDate

public WUQueryWrapper setStartDate(Date date)

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)

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)

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()

Gets the start date.

Returns:

the start date for which workunits will be retrieved.

validate

public void validate()
              throws Exception

Validate.

Throws:

Exception - the exception

getRaw

public org.hpccsystems.ws.client.gen.axis2.wsworkunits.v1_81.WUQuery getRaw()

Gets the raw.

Returns:

the raw WUQuery object

getRawLatestVersion

public org.hpccsystems.ws.client.gen.axis2.wsworkunits.v1_81.WUQuery getRawLatestVersion()

Gets the raw 1 81.

Returns:

the raw 1 81

getRaw156

public org.hpccsystems.ws.client.gen.axis2.wsworkunits.v1_56.WUQuery getRaw156(int appvalue)
                                                                        throws Exception

Gets the raw 156.

Parameters:

appvalue - the appvalue

Returns:

the raw 156

Throws:

Exception - the exception