ftp.nice.ch/pub/next/tools/frontends/HKGnats.1.0.NI.bsa.tar.gz#/hk/freeware/doc/HK-Gnats/Classes/HKSendPr.rtf

This is HKSendPr.rtf in view mode; [Download] [Up]

Release 1.0  Copyright ©1994 by WSC Investment Services.  All Rights Reserved.
Developed by Hutchison Ave. Software <info@hasc.ca>






HKSendPr






Inherits From:	Object

Conforms To:	HKMailSender

Declared In:	<hk-gnats/HKSendPr.h>

Library:	libhk-gnats.a

Requires:	libhk.a (The HascKit)



Class Description

This class is used to hold the information for a GNATS problem report. It is also used in sending the problem report to the support site. When this object is initialized, some of its fields are initialized with the current configuration of the computer and the current user. 





Instance Variables

char *emailTo;
char *emailFrom;
char *emailReply;
char *submitterID;
char *originator;
char *organization;
BOOL confidential;
char *synopsis;
HKSeverity severity;
HKPriority priority;
char *category;
HKBugClass bugClass;
char *release;
id archInfo;
char *description;
char *howToRepeat;
char *howToFix;



emailTo	The electronic mail address of the support site.

emailFrom	The originator's electronic mail address.

emailReply	A return electronic mail address which replies can be sent.

submitterID	An identification code assigned by the support site. 

originator	The originator's real name.

organization	The originator's organization.

confidential	It tells if the problem report is confidential or not.

synopsis	A short description of the problem.

severity	The severity of the problem.

priority	The priority of the problem.

category	The name of the product where the problem lies.

bugClass	The class of the problem.

release	The release or the version number of the product.

archInfo	The architecture and the environment where the problem occurs

description	A precise description of the problem.

howToRepeat	A precise description on how to repeat the problem.

howToFix	Possible solutions to fix the problem.






Adopted Protocols

HKMailSender	- writeMailToStream:






Method Types


Initializing the problem	- init
	- free
	- setup
	
Sending the problem	- send
	- writeMailToStream:

Querying the problem	- architecture
	- bugClass
	- category
	- confidential
	- description
	- emailFrom
	- emailReply
	- emailTo
	- environment
	- howToFix
	- howToRepeat
	- organization
	- originator
	- priority
	- release
	- severity
	- submitterID
	- synopsis
	- system

Setting the problem	- setBugClass:
	- setCategory:
	- setConfidential:
	- setDescription:
	- setEmailFrom:
	- setEmailReply:
	- setEmailTo:
	- setHowToFix:
	- setHowToRepeat:
	- setOrganization:
	- setOriginator:
	- setPriority:
	- setRelease:
	- setSeverity:
	- setSubmitterID:
	- setSynopsis:
	- writeMailToStream:





Instance Methods

architecture
-  (const char *)architecture

Returns the architecture of your computer, it returns NULL if it can't find it..

See also:  




bugClass
-  (HKBugClass)bugClass

Returns the problem class. See the description of setBugClass: for a list of bug class constants.

See also:  - setBugClass:




category
-  (const char *)category

Returns the category of the problem.

See also:  




confidential
-  (BOOL)confidential

Returns YES if the problem is confidential and NO if not.

See also:  




description
-  (const char *)description

Returns the description of the problem.

See also:  




emailFrom
-  (const char *)emailFrom

Returns the originator's email address.

See also:  




emailReply
-  (const char *)emailReply

Returns the return electronic mail address which replies can be sent.

See also:  




emailTo
-  (const char *)emailTo

Returns the electronic mail address of the support site.

See also:  




environment
-  (const char *)environment

Returns the environment of your computer. Returns NULL if it can't be found. The information is taken from the file "/usr/Devices/System.config/Instance0.table".

See also:  




howToFix
-  (const char *)howToFix

Returns the description on how to fix the problem.

See also:  




howToRepeat
-  (const char *)howToRepeat

Returns the description on how to fix the problem.

See also:  




organization
-  (const char *)organization

Returns the originator's organization.

See also:  




originator
-  (const char *)originator

Returns the originator's real name.

See also:  




priority
-  (HKPriority)priority

Returns the priority of the problem. See the description of setPriority: for a list of priority constants

See also:  




release
-  (const char *)release

Returns the release or the version number of the product.

See also:  




send
-  (BOOL)send

Sends the problem report by electronic mail using the information containted in itself.

See also:  




setBugClass:
-  setBugClass:(HKBugClass)aBugClass

Sets the bug class of the problem which can be one of the values listed in the following table. The default bug class is HK_SofwareBug.

Value	Meaning
HK_SofwareBug	A general product problem
HK_DocumentationBug	A problem with the documentation
HK_ChangeRequest	A request for a change in behavior, etc.
HK_Support	A support problem or question


See also:  




setCategory:
-  setCategory:(const char *)aCategory

Sets the category of the problem.

See also:  




setConfidential:
-  setConfidential:(BOOL)aFlag

Sets if the problem is confidential or not. By default it's NO.

See also:  




setDescription:
-  setDescription:(const char *)aDescription

Sets the description of the problem.

See also:  




setEmailFrom:
-  setEmailFrom:(const char *)emailAddress

Sets the originator's electronic mail address. By default it's the user name.

See also:  




setEmailReply:
-  setEmailReply:(const char *)emailAddress

Sets the return electronic mail address which replies can be sent. By default it's the user name.

See also:  




setEmailTo:
-  setEmailTo:(const char *)emailAddress

Sets the electronic mail address of the support site.

See also:  




setHowToFix:
-  setHowToFix:(const char *)aDescription

Sets the description on how to fix the problem.

See also:  




setHowToRepeat:
-  setHowToRepeat:(const char *)aDescription

Sets the description on how to repeat the problem.

See also:  




setOrganization:
-  setOrganization:(const char *)anOrganization

Sets the originator's organization. By default this field is taken from the DEFAULT_ORGANIZATION environment variable.

See also:  




setOriginator:
-  setOriginator:(const char *)anOriginator

Sets the originator's real name. By default it's the user name.

See also:  




setPriority:
-  setPriority:(HKPriority)aPriority

Sets the priority of the problem which can be one of the values listed in the following table. The default priority is HK_LowPriority. 

Value	Meaning
HK_LowPriority	A solution is needed as soon as possible for the problem.
HK_MediumnPriority	The problem should be solved in the next release.
HK_HighPriority	The problem should be solved in a future release.



See also:  




setRelease:
-  setRelease:(const char *)aRelease

Sets the release of the product.

See also:  




setSeverity:
-  setSeverity:(HKSeverity)severityLevel

Sets the severity of the problem which can be one of the values listed in the following table. The default priority is HK_NonCriticalSeverity.

Value	Meaning
HK_NonCriticalSeverity	The product is working in general, but lacks features, has irritating behavior, does something wrong, or doesn't match its documentation.
HK_SeriousSeverity	The product is not working properly or significant functionality is missing. A work around is known.
HK_CriticalSeverity	The product is completely non-operational or some essential functionality is missing. No work around is known.

See also:  




setSubmitterID:
-  setSubmitterID:(const char *)aSubmitter

Sets the identification code assigned by the support site. By default it's "net".

See also:  




setSynopsis:
-  setSynopsis:(const char *)aSynopsis

Sets a short description of the problem.

See also:  




setup
-  setup

Initializes instance variables to their default values.

See also:  




severity
-  (HKSeverity)severity

Returns the severity of the problem. See the description of setSeverity: for a list of severity constants

See also:  - setSeverity:




submitterID
-  (const char *)submitterID

Returns the identification code assigned by the support site.

See also:  




synopsis
-  (const char *)synopsis

Returns a short description of the problem.

See also:  




system
-  (const char *)system

Returns the operating system and its version of your computer. Returns NULL if it can't be found. The information is taken from the file "/usr/lib/NextStep/software_version".

See also:  




writeMailToStream:
-  writeMailToStream:(FILE *)stream

Writes the problem report to a stream for electronic mail submission.

See also:  




These are the contents of the former NiCE NeXT User Group NeXTSTEP/OpenStep software archive, currently hosted by Netfuture.ch.