JAMS 6.x Help
CurReport Class Members
Properties  Methods  Events


The following tables list the members exposed by CurReport.

Public Constructors
 NameDescription
Public ConstructorCurReport ConstructorCreates a CurReport.  
Top
Public Properties
 NameDescription
Public PropertyCopiesGets or sets the number of copies of the report which should be printed. If you specifiy 0, the report is not sent to a print queue.  
Public PropertyErrorGets an error message that describes the errors in the object. (Inherited from MVPSI.JAMS.BasePublicObject)
Public PropertyFullFilenameGets or sets a valid file name for the Report. The use of this property is determined by the template definitions. The default JAMS template uses this value as the base for a report's file name and any missing parts are replaced as follows:
  • A missing device/directory is replaced with the specification from the Job's System definition.
  • A missing filename is replaced with the Report I.D.
  • A missing extension is replaced with the Job's run occurence number.
 
Public PropertyHasErrorsThe HasErrors property can be used to determine if the object has any errors. If the object needs to be validated, it is done before returning. (Inherited from MVPSI.JAMS.BasePublicObject)
Public PropertyInEditIs this object in the middle of an edit? (Inherited from MVPSI.JAMS.BasePublicObject)
Public PropertyItemReturns any error messages currently associated with this column. (Inherited from MVPSI.JAMS.BasePublicObject)
Public PropertyLoadedFromGets the JAMS server where this CurReport is stored.  
Public PropertyLogicalNameGets or sets the Report's logical name. When JAMS parses a Job, it can create the batch commands needed to define logical names which point to the actual report listing file. If unassigned, the Report ID is used as the value for the logical name.

The LogicalName is also used when a Job needs to print the same report more than one time, such as to two different print queues. To accomplish this, define two Reports for the Job (which must have different Report IDs) but enter the same value in the logical name property for both Reports. When JAMS parses the command procedure, it will define the logical name only once but it will generate two print commands, one for each report.

 
Public PropertyModifiedThe Modified property keeps track of modified state of this object. You cannot set the Modified property. If you modify the object, the modified property will be true until you end or cancel the update. (Inherited from MVPSI.JAMS.BasePublicObject)
Public PropertyNewObjectThe NewObject property indicates that this object has just been created and has never been saved on a JAMS Server. (Inherited from MVPSI.JAMS.BasePublicObject)
Public PropertyParentListGets the list that this object is contained in.  
Public PropertyPrintFormGets or sets the print Form that will be used when the Report is submitted to a print queue. If unassigned, the default form of the Report's print queue will be used.  
Public PropertyPrintQualifiersGets or sets the command which is appended to the print command when JAMS parses the Job file. The text entered here must consist of valid print qualifiers.  
Public PropertyPrintQueueGets or sets the print queue where the Report should be printed at the conclusion of the Job. If not assigned, the Default Print Queue in the Job's System definition is used.  
Public PropertyReportIDGets or sets the Report ID, which is an identifier used to name a report. It must be unique within a Job. This is required.  
Public PropertyRetentionDaysGets or sets the number of days that the Report file should be retained.  
Public PropertyValidatedThe Validated property keeps track of the validation state of this object. If the object has been modified, Validated will be false until the object has been successfully validated by the Validate method. (Inherited from MVPSI.JAMS.BasePublicObject)
Top
Public Methods
 NameDescription
Public MethodBeginEditStarts an edit of this object. (Inherited from MVPSI.JAMS.BasePublicObject)
Public MethodCancelEditCancels an edit of this object. (Inherited from MVPSI.JAMS.BasePublicObject)
Public MethodClearErrorClears the error message for a property. (Inherited from MVPSI.JAMS.BasePublicObject)
Public MethodClearModifiedClearModified is designed to be used internally and should not be called from end-user code. Call Update() which saves the modifications and then calls ClearModified. (Inherited from MVPSI.JAMS.BasePublicObject)
Public MethodCloneImplementation of ICloneable Clone method.  
Public MethodCompareToImplementation of IComparable CompareTo. Compares this instance to the one specified.  
Public MethodEndEditEnds an edit of this object. Any changes are saved. (Inherited from MVPSI.JAMS.BasePublicObject)
Public Methodstatic (Shared in Visual Basic)FindCreates and loads a new CurReportList.  
Public MethodInitializeInitializes all CurReport properties to their default values.  
Public MethodSetErrorSets the error message for a property. (Inherited from MVPSI.JAMS.BasePublicObject)
Public MethodSetModifiedMarks the object as modified. (Inherited from MVPSI.JAMS.BasePublicObject)
Public MethodToStringReturns a string representation of this CurReport.  
Public MethodUndoEditsOverridden. Undo changes that have not been saved to the database.  
Public MethodUpdateOverridden. Save pending updates.  
Public MethodValidateThe Validate method is a virtual method used to validate the object. The default implantation does no validation it simply marks the object as valid. (Inherited from MVPSI.JAMS.BasePublicObject)
Top
Protected Methods
 NameDescription
Protected MethodRaisePropertyChangedAttempts to raise the PropertyChanged event (Inherited from MVPSI.JAMS.BasePublicObject)
Protected MethodRaisePropertyChangingAttempts to raise the PropertyChanging event (Inherited from MVPSI.JAMS.BasePublicObject)
Protected MethodSaveOriginalOverridden. Save the original values incase we have to Undo.  
Top
Public Events
 NameDescription
Public EventPropertyChangedEvent Handler for Property Changed Event (Inherited from MVPSI.JAMS.BasePublicObject)
Public EventPropertyChangingEvent Handler for Property Changing Event (Inherited from MVPSI.JAMS.BasePublicObject)
Top
See Also

Reference

CurReport Class
MVPSI.JAMS Namespace

Send Feedback