Class GetJournalizedCasesByParamsRequest

A request to be sent by consumer when requesting a journalized cases by specified parameters.

Inheritance

object

PlatinaMessageBase

GetJournalizedCasesByParamsRequest

Inherited Members

PlatinaMessageBase.UserName

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

Namespace: Integration.MessageContracts.CaseManagement

Syntax

[MessageContract]
public class GetJournalizedCasesByParamsRequest : PlatinaMessageBase

Remarks

The requesting user needs full control to the diary.

Properties

Filters

Specifies filters.

Declaration

[MessageBodyMember]
public IList<InfoHeapFilter> Filters { get; set; }

Property Value

Type	Description
IList<InfoHeapFilter>	The filters for objects.

Remarks

The requesting user needs full control to the diary.

OrderByField

Specifies field for ordering.

Declaration

[MessageBodyMember]
public GetJournalizedCasesByParamsRequest.OrderBy OrderByField { get; set; }

Property Value

Type	Description
GetJournalizedCasesByParamsRequest.OrderBy	The field for ordering

Remarks

The requesting user needs full control to the diary.

PageNumber

The page number of the list, in case there are several pages in the list.

Declaration

[MessageBodyMember]
public int PageNumber { get; set; }

Property Value

Type	Description
int	[required] The page number of the list, in case there are several pages in the list. The first page in the list has number 1.

Remarks

May be used by the consumer when paging through many pages.

RecordsPerPage

Specifies the number of objects to be returned per page by the system.

Declaration

[MessageBodyMember]
public int RecordsPerPage { get; set; }

Property Value

Type	Description
int	[required] Specifies the number of objects to be returned per page by the system.

Remarks

The requesting user needs full control to the diary.

SearchString

The value to search by specific fields.

Declaration

[MessageBodyMember]
public string SearchString { get; set; }

Property Value

Type	Description
string	The value to search by specific fields.

Remarks

Search is performed by title, diary number, case type title and case type identifier.

SortDirection

Specifies sort order direction.

Declaration

[MessageBodyMember]
public SortDirection SortDirection { get; set; }

Property Value

Type	Description
SortDirection	The sort order direction.

Remarks

The requesting user needs full control to the diary.

Methods

IsValid()

Check if message request is valid.

Declaration

public override IsValidResult IsValid()

Returns

Type	Description
IsValidResult	IsValidResult containing an error message if invalid.

Overrides

PlatinaMessageBase.IsValid()

Remarks

The requesting user needs full control to the diary.