org.gecko.emf.utilities

Interface Request

All Known Implementing Classes:

RequestImpl

public interface Request

A representation of the model object 'Request'. General purpose request object

The following features are supported:

• Id
• Object Id
• From
• To
• Page
• Page Size
• Return Result Size
• Sorting
• Filtering
• Projection

See Also:

UtilPackage.getRequest()

Method Summary

Modifier and Type	Method and Description
<any>	getFiltering() Returns the value of the 'Filtering' containment reference list.
java.util.Date	getFrom() Returns the value of the 'From' attribute.
java.lang.String	getId() Returns the value of the 'Id' attribute.
<any>	getObjectId() Returns the value of the 'Object Id' attribute list.
int	getPage() Returns the value of the 'Page' attribute.
int	getPageSize() Returns the value of the 'Page Size' attribute.
<any>	getProjection() Returns the value of the 'Projection' attribute list.
<any>	getSorting() Returns the value of the 'Sorting' containment reference list.
java.util.Date	getTo() Returns the value of the 'To' attribute.
boolean	isReturnResultSize() Returns the value of the 'Return Result Size' attribute.
void	setFrom(java.util.Date value) Sets the value of the 'From' attribute.
void	setId(java.lang.String value) Sets the value of the 'Id' attribute.
void	setPage(int value) Sets the value of the 'Page' attribute.
void	setPageSize(int value) Sets the value of the 'Page Size' attribute.
void	setReturnResultSize(boolean value) Sets the value of the 'Return Result Size' attribute.
void	setTo(java.util.Date value) Sets the value of the 'To' attribute.

Method Detail

getId

java.lang.String getId()

Returns the value of the 'Id' attribute.

If the meaning of the 'Id' attribute isn't clear, there really should be more of a description here...

Returns:

the value of the 'Id' attribute.

See Also:

setId(String), UtilPackage.getRequest_Id()

setId

void setId(java.lang.String value)

Sets the value of the 'Id' attribute.

Parameters:

value - the new value of the 'Id' attribute.

See Also:

getId()

getObjectId

<any> getObjectId()

Returns the value of the 'Object Id' attribute list. The list contents are of type String. One or many primary key filter values

Returns:

the value of the 'Object Id' attribute list.

See Also:

UtilPackage.getRequest_ObjectId()

getFrom

java.util.Date getFrom()

Returns the value of the 'From' attribute. The from value for a time range query

Returns:

the value of the 'From' attribute.

See Also:

setFrom(Date), UtilPackage.getRequest_From()

setFrom

void setFrom(java.util.Date value)

Sets the value of the 'From' attribute.

Parameters:

value - the new value of the 'From' attribute.

See Also:

getFrom()

getTo

java.util.Date getTo()

Returns the value of the 'To' attribute. The to value for a time range query

Returns:

the value of the 'To' attribute.

See Also:

setTo(Date), UtilPackage.getRequest_To()

setTo

void setTo(java.util.Date value)

Sets the value of the 'To' attribute.

Parameters:

value - the new value of the 'To' attribute.

See Also:

getTo()

getPage

int getPage()

Returns the value of the 'Page' attribute. Paging: the page offset, should be 1-based index

Returns:

the value of the 'Page' attribute.

See Also:

setPage(int), UtilPackage.getRequest_Page()

setPage

void setPage(int value)

Sets the value of the 'Page' attribute.

Parameters:

value - the new value of the 'Page' attribute.

See Also:

getPage()

getPageSize

int getPageSize()

Returns the value of the 'Page Size' attribute. Paging: Entries size per page

Returns:

the value of the 'Page Size' attribute.

See Also:

setPageSize(int), UtilPackage.getRequest_PageSize()

setPageSize

void setPageSize(int value)

Sets the value of the 'Page Size' attribute.

Parameters:

value - the new value of the 'Page Size' attribute.

See Also:

getPageSize()

isReturnResultSize

boolean isReturnResultSize()

Returns the value of the 'Return Result Size' attribute. Parameter to force the response to return the result size value for the query, if paging is set

Returns:

the value of the 'Return Result Size' attribute.

See Also:

setReturnResultSize(boolean), UtilPackage.getRequest_ReturnResultSize()

setReturnResultSize

void setReturnResultSize(boolean value)

Sets the value of the 'Return Result Size' attribute.

Parameters:

value - the new value of the 'Return Result Size' attribute.

See Also:

isReturnResultSize()

getSorting

<any> getSorting()

Returns the value of the 'Sorting' containment reference list. The list contents are of type Sort. Sort definition

Returns:

the value of the 'Sorting' containment reference list.

See Also:

UtilPackage.getRequest_Sorting()

getFiltering

<any> getFiltering()

Returns the value of the 'Filtering' containment reference list. The list contents are of type Filter. Additional filter definition

Returns:

the value of the 'Filtering' containment reference list.

See Also:

UtilPackage.getRequest_Filtering()

getProjection

<any> getProjection()

Returns the value of the 'Projection' attribute list. The list contents are of type String. The fields to project to

Returns:

the value of the 'Projection' attribute list.

See Also:

UtilPackage.getRequest_Projection()