Files
win8phoneApp/Doc/man/man3/CampusAppWPortalLib8_Model_AbstractMainModel_ T _.3
2013-10-18 09:32:53 +02:00

521 lines
15 KiB
Groff

.TH "CampusAppWPortalLib8.Model.AbstractMainModel< T >" 3 "Fri Oct 18 2013" "Version 1.0.0" "CampusAppW8" \" -*- nroff -*-
.ad l
.nh
.SH NAME
CampusAppWPortalLib8.Model.AbstractMainModel< T > \-
.PP
abstract Base model io handling class\&.
.SH SYNOPSIS
.br
.PP
.PP
Inherited by \fBCampusAppWP8\&.Model\&.MainModel< T >\fP\&.
.SS "Public Member Functions"
.in +1c
.ti -1c
.RI "\fBAbstractMainModel\fP (\fBModelType\fP modelType, string fileName, string url)"
.br
.RI "\fIInitializes a new instance of the AbstractMainModel{T} class\&. \fP"
.ti -1c
.RI "\fBAbstractMainModel\fP (\fBModelType\fP modelType, string sourceName)"
.br
.RI "\fIInitializes a new instance of the AbstractMainModel{T} class\&. \fP"
.ti -1c
.RI "delegate void \fBOnIO\fP ()"
.br
.RI "\fIDelegate of the OnIO callback function\&. \fP"
.ti -1c
.RI "delegate void \fBOnFailed\fP ()"
.br
.RI "\fIDelegate of the OnFailed(File/Web) callback function\&. \fP"
.ti -1c
.RI "delegate bool \fBIsModelUpToDate\fP (T model)"
.br
.RI "\fIDelegate of the IsModelUpToDate callback function\&. \fP"
.ti -1c
.RI "void \fBFireLoadFailEvents\fP ()"
.br
.RI "\fIMethod Fire all Events for fail load\&. \fP"
.ti -1c
.RI "void \fBFireLoadCompletedEvents\fP ()"
.br
.RI "\fIMethod Fire all Events for load is complete\&. \fP"
.ti -1c
.RI "void \fBForceWebUpdate\fP ()"
.br
.RI "\fIForces a update from web\&. \fP"
.ti -1c
.RI "void \fBForceReadFile\fP ()"
.br
.RI "\fIForces a update from file\&. \fP"
.ti -1c
.RI "void \fBLoadData\fP (\fBForceType\fP force=ForceType\&.INVALID)"
.br
.RI "\fILoad the data if necessary, from web or from file, regarding if the file data is up to date\&. \fP"
.ti -1c
.RI "void \fBSaveData\fP (bool force=false)"
.br
.RI "\fISave the model data if necessary\&. \fP"
.ti -1c
.RI "\fBModelType\fP \fBGetModelType\fP ()"
.br
.RI "\fIReturn the model io type\&. \fP"
.ti -1c
.RI "void \fBSetUriParams\fP (List< \fBUrlParamModel\fP > parameters)"
.br
.RI "\fICreate the parameterized uri\&. \fP"
.ti -1c
.RI "void \fBClearUriParams\fP ()"
.br
.RI "\fIClear the parameterized uri\&. \fP"
.in -1c
.SS "Protected Member Functions"
.in +1c
.ti -1c
.RI "abstract bool \fBDeserializeModel\fP (byte[] modelData)"
.br
.RI "\fIAbstract declaration of the model deserialize function\&. \fP"
.ti -1c
.RI "abstract byte[] \fBSerializeModel\fP ()"
.br
.RI "\fIAbstract declaration of the model serialize function\&. \fP"
.ti -1c
.RI "abstract void \fBSendHttpGet\fP (Uri url)"
.br
.RI "\fIMethod send a HttpGet\&. \fP"
.ti -1c
.RI "abstract bool \fBCheckIsNotUpToDate\fP (object checkFunc)"
.br
.RI "\fIMethod check if model or file is Not up-to-date\&. \fP"
.ti -1c
.RI "abstract bool \fBCheckLoadFileIsNotUpToDate\fP ()"
.br
.RI "\fIMethod check if file is Not up-to-date for load process\&. \fP"
.ti -1c
.RI "abstract bool \fBCheckSaveFileIsNotUpToDate\fP ()"
.br
.RI "\fIMethod check if file is Not up-to-date for load process\&. \fP"
.ti -1c
.RI "abstract void \fBInitFile\fP ()"
.br
.RI "\fIInitializes the file object\&. \fP"
.ti -1c
.RI "abstract void \fBInitHttpApi\fP ()"
.br
.RI "\fIInitializes the web object\&. \fP"
.ti -1c
.RI "bool \fBIsFile\fP ()"
.br
.RI "\fICheck if the model io type is file\&. \fP"
.ti -1c
.RI "bool \fBIsHttpApi\fP ()"
.br
.RI "\fICheck if the model io type is feed\&. \fP"
.in -1c
.SS "Properties"
.in +1c
.ti -1c
.RI "T \fBModel\fP\fC [get, set]\fP"
.br
.RI "\fIGets or sets the \fBModel\fP\&. \fP"
.ti -1c
.RI "\fBAbstractFile\fP \fBFile\fP\fC [get, set]\fP"
.br
.RI "\fIGets the File\&. \fP"
.ti -1c
.RI "\fBModelType\fP \fBModelType\fP\fC [get, set]\fP"
.br
.RI "\fIGets the ModelType\&. \fP"
.ti -1c
.RI "\fBAbstractHttpRequest\fP \fBApi\fP\fC [get, set]\fP"
.br
.RI "\fIGets the Api\&. \fP"
.ti -1c
.RI "Uri \fBHttpApiUri\fP\fC [get, set]\fP"
.br
.RI "\fIGets the ApiUrl\&. \fP"
.ti -1c
.RI "string \fBFileName\fP\fC [get, set]\fP"
.br
.RI "\fIGets the FileName\&. \fP"
.in -1c
.SS "Events"
.in +1c
.ti -1c
.RI "\fBOnIO\fP \fBOnLoading\fP = null"
.br
.RI "\fICallback pointer, called before loading\&. \fP"
.ti -1c
.RI "\fBOnIO\fP \fBOnLoaded\fP = null"
.br
.RI "\fICallback pointer, called after loading\&. \fP"
.ti -1c
.RI "\fBOnIO\fP \fBOnSaving\fP = null"
.br
.RI "\fICallback pointer, called before saving\&. \fP"
.ti -1c
.RI "\fBOnIO\fP \fBOnSaved\fP = null"
.br
.RI "\fICallback pointer, called after saving\&. \fP"
.ti -1c
.RI "\fBOnFailed\fP \fBOnFailedFile\fP = null"
.br
.RI "\fICallback pointer, called after failed file loading\&. \fP"
.ti -1c
.RI "\fBOnFailed\fP \fBOnFailedWeb\fP = null"
.br
.RI "\fICallback pointer, called after failed web loading\&. \fP"
.ti -1c
.RI "\fBOnFailed\fP \fBOnFailedLoad\fP = null"
.br
.RI "\fICallback pointer, called after failed file or web loading, if there is no specialized onFailed callback set\&. \fP"
.ti -1c
.RI "\fBOnFailed\fP \fBOnFailedSave\fP = null"
.br
.RI "\fICallback pointer, called after failed saving data to file\&. \fP"
.ti -1c
.RI "\fBIsModelUpToDate\fP \fBIsModelUpToDateOnLoad\fP = null"
.br
.RI "\fICallback pointer, for checking if model is up to date at loading\&. \fP"
.ti -1c
.RI "\fBIsModelUpToDate\fP \fBIsModelUpToDateOnSave\fP = null"
.br
.RI "\fICallback pointer, for checking if model is up to date at saving\&. (currently unused) \fP"
.in -1c
.SH "Detailed Description"
.PP
abstract Base model io handling class\&.
fiedlchr, 15\&.10\&.2013\&.
.PP
\fBTemplate Parameters:\fP
.RS 4
\fIT\fP model type\&.
.RE
.PP
.SH "Constructor & Destructor Documentation"
.PP
.SS "CampusAppWPortalLib8\&.Model\&.AbstractMainModel< T >\&.AbstractMainModel (\fBModelType\fPmodelType, stringfileName, stringurl)"
.PP
Initializes a new instance of the AbstractMainModel{T} class\&. fiedlchr, 15\&.10\&.2013\&.
.PP
\fBParameters:\fP
.RS 4
\fImodelType\fP \fBModel\fP IO type\&.
.br
\fIfileName\fP name of the file\&.
.br
\fIurl\fP url of the feed\&.
.RE
.PP
.SS "CampusAppWPortalLib8\&.Model\&.AbstractMainModel< T >\&.AbstractMainModel (\fBModelType\fPmodelType, stringsourceName)"
.PP
Initializes a new instance of the AbstractMainModel{T} class\&. fiedlchr, 15\&.10\&.2013\&.
.PP
\fBExceptions:\fP
.RS 4
\fINotSupportedException\fP Thrown when the requested operation is not supported\&.
.RE
.PP
\fBParameters:\fP
.RS 4
\fImodelType\fP \fBModel\fP IO type\&.
.br
\fIsourceName\fP name of the file or the url of the feed\&.
.RE
.PP
.SH "Member Function Documentation"
.PP
.SS "abstract bool CampusAppWPortalLib8\&.Model\&.AbstractMainModel< T >\&.CheckIsNotUpToDate (objectcheckFunc)\fC [protected]\fP, \fC [pure virtual]\fP"
.PP
Method check if model or file is Not up-to-date\&. fiedlchr, 15\&.10\&.2013\&.
.PP
\fBParameters:\fP
.RS 4
\fIcheckFunc\fP the check function\&.
.RE
.PP
\fBReturns:\fP
.RS 4
true if it is not up-to-date, otherwise false\&.
.RE
.PP
.PP
Implemented in \fBCampusAppWP8\&.Model\&.MainModel< T >\fP\&.
.SS "abstract bool CampusAppWPortalLib8\&.Model\&.AbstractMainModel< T >\&.CheckLoadFileIsNotUpToDate ()\fC [protected]\fP, \fC [pure virtual]\fP"
.PP
Method check if file is Not up-to-date for load process\&. fiedlchr, 15\&.10\&.2013\&.
.PP
\fBReturns:\fP
.RS 4
true if it is not up-to-date, otherwise false\&.
.RE
.PP
.PP
Implemented in \fBCampusAppWP8\&.Model\&.MainModel< T >\fP\&.
.SS "abstract bool CampusAppWPortalLib8\&.Model\&.AbstractMainModel< T >\&.CheckSaveFileIsNotUpToDate ()\fC [protected]\fP, \fC [pure virtual]\fP"
.PP
Method check if file is Not up-to-date for load process\&. fiedlchr, 15\&.10\&.2013\&.
.PP
\fBReturns:\fP
.RS 4
true if it is not up-to-date, otherwise false\&.
.RE
.PP
.PP
Implemented in \fBCampusAppWP8\&.Model\&.MainModel< T >\fP\&.
.SS "void CampusAppWPortalLib8\&.Model\&.AbstractMainModel< T >\&.ClearUriParams ()"
.PP
Clear the parameterized uri\&. fiedlchr, 15\&.10\&.2013\&.
.SS "abstract bool CampusAppWPortalLib8\&.Model\&.AbstractMainModel< T >\&.DeserializeModel (byte[]modelData)\fC [protected]\fP, \fC [pure virtual]\fP"
.PP
Abstract declaration of the model deserialize function\&. fiedlchr, 15\&.10\&.2013\&.
.PP
\fBParameters:\fP
.RS 4
\fImodelData\fP model data as byte array\&.
.RE
.PP
\fBReturns:\fP
.RS 4
true, is succeeded\&.
.RE
.PP
.PP
Implemented in \fBCampusAppWP8\&.Model\&.XmlModel< T >\fP, and \fBCampusAppWP8\&.Model\&.BinaryModel\fP\&.
.SS "void CampusAppWPortalLib8\&.Model\&.AbstractMainModel< T >\&.FireLoadCompletedEvents ()"
.PP
Method Fire all Events for load is complete\&. fiedlchr, 15\&.10\&.2013\&.
.SS "void CampusAppWPortalLib8\&.Model\&.AbstractMainModel< T >\&.FireLoadFailEvents ()"
.PP
Method Fire all Events for fail load\&. fiedlchr, 15\&.10\&.2013\&.
.SS "void CampusAppWPortalLib8\&.Model\&.AbstractMainModel< T >\&.ForceReadFile ()"
.PP
Forces a update from file\&. fiedlchr, 15\&.10\&.2013\&.
.SS "void CampusAppWPortalLib8\&.Model\&.AbstractMainModel< T >\&.ForceWebUpdate ()"
.PP
Forces a update from web\&. fiedlchr, 15\&.10\&.2013\&.
.SS "\fBModelType\fP CampusAppWPortalLib8\&.Model\&.AbstractMainModel< T >\&.GetModelType ()"
.PP
Return the model io type\&. fiedlchr, 15\&.10\&.2013\&.
.PP
\fBReturns:\fP
.RS 4
model io type\&.
.RE
.PP
.SS "abstract void CampusAppWPortalLib8\&.Model\&.AbstractMainModel< T >\&.InitFile ()\fC [protected]\fP, \fC [pure virtual]\fP"
.PP
Initializes the file object\&. fiedlchr, 15\&.10\&.2013\&.
.PP
Implemented in \fBCampusAppWP8\&.Model\&.MainModel< T >\fP\&.
.SS "abstract void CampusAppWPortalLib8\&.Model\&.AbstractMainModel< T >\&.InitHttpApi ()\fC [protected]\fP, \fC [pure virtual]\fP"
.PP
Initializes the web object\&. fiedlchr, 15\&.10\&.2013\&.
.PP
Implemented in \fBCampusAppWP8\&.Model\&.MainModel< T >\fP\&.
.SS "bool CampusAppWPortalLib8\&.Model\&.AbstractMainModel< T >\&.IsFile ()\fC [protected]\fP"
.PP
Check if the model io type is file\&. fiedlchr, 15\&.10\&.2013\&.
.PP
\fBReturns:\fP
.RS 4
true, if the model io type has file\&.
.RE
.PP
.SS "bool CampusAppWPortalLib8\&.Model\&.AbstractMainModel< T >\&.IsHttpApi ()\fC [protected]\fP"
.PP
Check if the model io type is feed\&. fiedlchr, 15\&.10\&.2013\&.
.PP
\fBReturns:\fP
.RS 4
true if the model io type has feed\&.
.RE
.PP
.SS "delegate bool CampusAppWPortalLib8\&.Model\&.AbstractMainModel< T >\&.IsModelUpToDate (Tmodel)"
.PP
Delegate of the IsModelUpToDate callback function\&. fiedlchr, 15\&.10\&.2013\&.
.PP
\fBParameters:\fP
.RS 4
\fImodel\fP data model\&.
.RE
.PP
\fBReturns:\fP
.RS 4
true, model is up to date\&.
.RE
.PP
.SS "void CampusAppWPortalLib8\&.Model\&.AbstractMainModel< T >\&.LoadData (\fBForceType\fPforce = \fCForceType\&.INVALID\fP)"
.PP
Load the data if necessary, from web or from file, regarding if the file data is up to date\&. fiedlchr, 15\&.10\&.2013\&.
.PP
\fBParameters:\fP
.RS 4
\fIforce\fP (Optional) if set/not invalid/not default, force to load from web or file\&.
.RE
.PP
.SS "delegate void CampusAppWPortalLib8\&.Model\&.AbstractMainModel< T >\&.OnFailed ()"
.PP
Delegate of the OnFailed(File/Web) callback function\&. fiedlchr, 15\&.10\&.2013\&.
.SS "delegate void CampusAppWPortalLib8\&.Model\&.AbstractMainModel< T >\&.OnIO ()"
.PP
Delegate of the OnIO callback function\&. fiedlchr, 15\&.10\&.2013\&.
.SS "void CampusAppWPortalLib8\&.Model\&.AbstractMainModel< T >\&.SaveData (boolforce = \fCfalse\fP)"
.PP
Save the model data if necessary\&. fiedlchr, 15\&.10\&.2013\&.
.PP
\fBParameters:\fP
.RS 4
\fIforce\fP (Optional) force saving\&. DEFAULT: false\&.
.RE
.PP
.SS "abstract void CampusAppWPortalLib8\&.Model\&.AbstractMainModel< T >\&.SendHttpGet (Uriurl)\fC [protected]\fP, \fC [pure virtual]\fP"
.PP
Method send a HttpGet\&. fiedlchr, 15\&.10\&.2013\&.
.PP
\fBParameters:\fP
.RS 4
\fIurl\fP the url\&.
.RE
.PP
.PP
Implemented in \fBCampusAppWP8\&.Model\&.MainModel< T >\fP\&.
.SS "abstract byte [] CampusAppWPortalLib8\&.Model\&.AbstractMainModel< T >\&.SerializeModel ()\fC [protected]\fP, \fC [pure virtual]\fP"
.PP
Abstract declaration of the model serialize function\&. fiedlchr, 15\&.10\&.2013\&.
.PP
\fBReturns:\fP
.RS 4
model data as byte array\&.
.RE
.PP
.PP
Implemented in \fBCampusAppWP8\&.Model\&.XmlModel< T >\fP, and \fBCampusAppWP8\&.Model\&.BinaryModel\fP\&.
.SS "void CampusAppWPortalLib8\&.Model\&.AbstractMainModel< T >\&.SetUriParams (List< \fBUrlParamModel\fP >parameters)"
.PP
Create the parameterized uri\&. fiedlchr, 15\&.10\&.2013\&.
.PP
\fBParameters:\fP
.RS 4
\fIparameters\fP uri parameter list\&.
.RE
.PP
.SH "Property Documentation"
.PP
.SS "\fBAbstractHttpRequest\fP CampusAppWPortalLib8\&.Model\&.AbstractMainModel< T >\&.Api\fC [get]\fP, \fC [set]\fP"
.PP
Gets the Api\&. The API\&.
.SS "\fBAbstractFile\fP CampusAppWPortalLib8\&.Model\&.AbstractMainModel< T >\&.File\fC [get]\fP, \fC [set]\fP"
.PP
Gets the File\&. The file\&.
.SS "string CampusAppWPortalLib8\&.Model\&.AbstractMainModel< T >\&.FileName\fC [get]\fP, \fC [set]\fP"
.PP
Gets the FileName\&. The name of the file\&.
.SS "Uri CampusAppWPortalLib8\&.Model\&.AbstractMainModel< T >\&.HttpApiUri\fC [get]\fP, \fC [set]\fP"
.PP
Gets the ApiUrl\&. The HTTP API URI\&.
.SS "T CampusAppWPortalLib8\&.Model\&.AbstractMainModel< T >\&.Model\fC [get]\fP, \fC [set]\fP"
.PP
Gets or sets the \fBModel\fP\&. The model\&.
.SS "\fBModelType\fP CampusAppWPortalLib8\&.Model\&.AbstractMainModel< T >\&.\fBModelType\fP\fC [get]\fP, \fC [set]\fP"
.PP
Gets the ModelType\&. The type of the model\&.
.SH "Event Documentation"
.PP
.SS "\fBIsModelUpToDate\fP CampusAppWPortalLib8\&.Model\&.AbstractMainModel< T >\&.IsModelUpToDateOnLoad = null"
.PP
Callback pointer, for checking if model is up to date at loading\&.
.SS "\fBIsModelUpToDate\fP CampusAppWPortalLib8\&.Model\&.AbstractMainModel< T >\&.IsModelUpToDateOnSave = null"
.PP
Callback pointer, for checking if model is up to date at saving\&. (currently unused) Occurs when Is \fBModel\fP Up To Date On Save\&.
.SS "\fBOnFailed\fP CampusAppWPortalLib8\&.Model\&.AbstractMainModel< T >\&.OnFailedFile = null"
.PP
Callback pointer, called after failed file loading\&.
.SS "\fBOnFailed\fP CampusAppWPortalLib8\&.Model\&.AbstractMainModel< T >\&.OnFailedLoad = null"
.PP
Callback pointer, called after failed file or web loading, if there is no specialized onFailed callback set\&.
.SS "\fBOnFailed\fP CampusAppWPortalLib8\&.Model\&.AbstractMainModel< T >\&.OnFailedSave = null"
.PP
Callback pointer, called after failed saving data to file\&.
.SS "\fBOnFailed\fP CampusAppWPortalLib8\&.Model\&.AbstractMainModel< T >\&.OnFailedWeb = null"
.PP
Callback pointer, called after failed web loading\&.
.SS "\fBOnIO\fP CampusAppWPortalLib8\&.Model\&.AbstractMainModel< T >\&.OnLoaded = null"
.PP
Callback pointer, called after loading\&.
.SS "\fBOnIO\fP CampusAppWPortalLib8\&.Model\&.AbstractMainModel< T >\&.OnLoading = null"
.PP
Callback pointer, called before loading\&.
.SS "\fBOnIO\fP CampusAppWPortalLib8\&.Model\&.AbstractMainModel< T >\&.OnSaved = null"
.PP
Callback pointer, called after saving\&.
.SS "\fBOnIO\fP CampusAppWPortalLib8\&.Model\&.AbstractMainModel< T >\&.OnSaving = null"
.PP
Callback pointer, called before saving\&.
.SH "Author"
.PP
Generated automatically by Doxygen for CampusAppW8 from the source code\&.